Example in Readme does not work

[JanStevens]

Hello,

Following the recommended folder structure and some example json schema's (auto generated) I cannot run prmd example rake tasks

rake aborted!
LoadError: cannot load such file -- prmd/multi_loader/

KeyError: key not found: ""

Tasks: TOP => schema:combine
(See full trace by running task with --trace)

require 'prmd/rake_tasks/combine'
require 'prmd/rake_tasks/verify'
require 'prmd/rake_tasks/doc'

namespace :schema do
  Prmd::RakeTasks::Combine.new do |t|
    t.options[:meta] = 'doc/schema/meta.json'    # use meta.yml if you prefer YAML format
    t.paths << 'schema/schemata/*'
    t.output_file = 'schema/api.json'
  end

  Prmd::RakeTasks::Verify.new do |t|
    t.files << 'schema/api.json'
  end

  Prmd::RakeTasks::Doc.new do |t|
    t.files = { 'schema/api.json' => 'schema/api.md' }
  end
end

task default: ['schema:combine', 'schema:verify', 'schema:doc']

[geemus]

I think the multiloader depends on file extensions to determine what to do. Is it possible one or more of the sub-schema files are lacking a file extension?

[JanStevens]

Everything is json and ends in.json

[geemus]

@JanStevens could you share the schema, or at least the particular commands you run to generate them? Then I can hopefully work backwards from there to get this fixed. Thanks!

[clowder]

I was hitting this too. The issue was the path not being expanded, switching to Dir.glob('schemas/*') fixed the issue.

[geemus]

@clowder mind submitting a PR? Thanks!

[clowder]

@geemus On closer inspection it look like a PEBKAC issue. The example in the README works, the issue is that the OP & I were using glob syntax but it isn't supported.

Prmd::RakeTasks::Combine.new do |t|
  # Won't work, PRMD doesn't expand the glob
  t.paths << 'schema/schemata/*'

  # Will work, PRMD likes full paths to files
  t.paths << Dir['schema/schemata/*']

  # Will work, PRMD will automatically find all schema files in directories
  t.paths << 'schema/schemata'
end

[geemus]

Ah, the check just a bit further into the thing tries to see if the path is a directory (and globs then), but otherwise it assumes you are giving an explicit path. I'd certainly welcome your thoughts on either making the code more flexible or, barring that, improving the documentation to make it clear (or both perhaps). Thanks!

[bjnord]

For me, the problem was (as @JanStevens says above) "Following the recommended folder structure". The README (at the bottom) recommends putting things in docs/schema/* whereas the Rake tasks are configured to find them in schema/*.

Once I added the docs/ prefix to all paths in the Rake tasks, to match where the files actually were, the cannot load such file -- prmd/multi_loader/ error went away. Don't know if there's some way to produce a more helpful "not found" message in this case?

[geemus]

We could probably check for existence in the loader, prior to trying to open the file? I think that is the point at which things error in the unhelpful way any how. I'd certainly be happy to discuss and would welcome help on a PR.

Additionally, from the sounds of things, maybe we should just update the README suggested paths to reflect the defaults in the rake to reduce confusion?