Module: JsonSchemaDocs

Defined in:
lib/json-schema-docs.rb,
lib/json-schema-docs/parser.rb,
lib/json-schema-docs/helpers.rb,
lib/json-schema-docs/version.rb,
lib/json-schema-docs/renderer.rb,
lib/json-schema-docs/generator.rb,
lib/json-schema-docs/configuration.rb

Defined Under Namespace

Modules: Configuration, Helpers Classes: Generator, Parser, Renderer

Constant Summary collapse

VERSION = 
'0.2.2'.freeze

Class Method Summary collapse

Class Method Details

.build(options) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/json-schema-docs.rb', line 16

def build(options)
  options = JsonSchemaDocs::Configuration::JSON_SCHEMA_DOCS_DEFAULTS.merge(options)

  filename = options[:filename]
  schema = options[:schema]

  if !filename.nil? && !schema.nil?
    raise ArgumentError, 'Pass in `filename` or `schema`, but not both!'
  end

  if filename.nil? && schema.nil?
    raise ArgumentError, 'Pass in either `filename` or `schema`'
  end

  if filename
    unless filename.is_a?(String)
      raise TypeError, "Expected `String`, got `#{filename.class}`"
    end

    unless File.exist?(filename)
      raise ArgumentError, "#{filename} does not exist!"
    end

    schema = File.read(filename)
  else
    if !schema.is_a?(String) && !schema.is_a?(Prmd::Schema)
      raise TypeError, "Expected `String` or `Prmd::Schema`, got `#{schema.class}`"
    end

    schema = schema
  end

  parser = JsonSchemaDocs::Parser.new(schema, options)
  parsed_schema = parser.parse

  generator = JsonSchemaDocs::Generator.new(parsed_schema, options)

  generator.generate
end