Module: Prmd

Defined in:
lib/prmd/cli.rb,
lib/prmd/link.rb,
lib/prmd/schema.rb,
lib/prmd/cli/doc.rb,
lib/prmd/version.rb,
lib/prmd/cli/base.rb,
lib/prmd/template.rb,
lib/prmd/cli/render.rb,
lib/prmd/cli/verify.rb,
lib/prmd/cli/combine.rb,
lib/prmd/cli/generate.rb,
lib/prmd/hash_helpers.rb,
lib/prmd/commands/init.rb,
lib/prmd/core/combiner.rb,
lib/prmd/core/renderer.rb,
lib/prmd/url_generator.rb,
lib/prmd/core/generator.rb,
lib/prmd/rake_tasks/doc.rb,
lib/prmd/commands/render.rb,
lib/prmd/commands/verify.rb,
lib/prmd/rake_tasks/base.rb,
lib/prmd/commands/combine.rb,
lib/prmd/core/schema_hash.rb,
lib/prmd/load_schema_file.rb,
lib/prmd/multi_loader/json.rb,
lib/prmd/multi_loader/toml.rb,
lib/prmd/multi_loader/yajl.rb,
lib/prmd/multi_loader/yaml.rb,
lib/prmd/rake_tasks/verify.rb,
lib/prmd/rake_tasks/combine.rb,
lib/prmd/multi_loader/loader.rb,
lib/prmd/core/reference_localizer.rb,
lib/prmd/url_generators/generators/json.rb,
lib/prmd/url_generators/generators/default.rb

Overview

:nodoc:

Defined Under Namespace

Modules: CLI, Combine, Generate, HashHelpers, MultiLoader, RakeTasks, Render, Verification, Version Classes: Combiner, Generator, Link, ReferenceLocalizer, Renderer, Schema, SchemaHash, Template, UrlGenerator

Constant Summary collapse

DefaultExamples =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  "boolean" => true,
  "integer" => 42,
  "number"  => 42.0,
  "string"  => "example",

  "date-time" => "2015-01-01T12:00:00Z",
  "email"     => "[email protected]",
  "hostname"  => "example.com",
  "ipv4"      => "192.0.2.1",
  "ipv6"      => "2001:DB8::1",
  "uuid"      => "01234567-89ab-cdef-0123-456789abcdef",
}
VERSION =

Returns:

  • (String) 
Version::STRING

Class Method Summary collapse

Class Method Details

.combine(paths, options = {}) ⇒ Prmd::Schema

Merges all found schema files in the given paths into a single Schema

Parameters:

  • paths (Array<String>)
  • options (Hash<Symbol, Object>) (defaults to: {})

Returns:



97
98
99
 
# File 'lib/prmd/commands/combine.rb', line 97

def self.combine(paths, options = {})
  Combine.combine(paths, { faulty_load: false }.merge(options))
end

.init(resource, options = {}) ⇒ String

Generate a schema template

Parameters:

  • resource (String)
  • options (Hash<Symbol, Object>) (defaults to: {})

Returns:

  • (String) —

    schema template in YAML (yaml option was enabled) else JSON



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/prmd/commands/init.rb', line 24

def self.init(resource, options = {})
  gen = Generate.make_generator

  generator_options = { resource: nil, parent: nil }
  if resource
    parent = nil
    parent, resource = resource.split('/') if resource.include?('/')
    generator_options[:parent] = parent
    generator_options[:resource] = resource
  end

  schema = gen.generate(generator_options)

  if options[:yaml]
    schema.to_yaml
  else
    schema.to_json
  end
end

.load_schema_file(filename) ⇒ Object

Attempts to load either a json or yaml file, the type is determined by filename extension.

Parameters:

  • filename (String)

Returns:

  • (Object) —

    data



11
12
13
 
# File 'lib/prmd/load_schema_file.rb', line 11

def self.load_schema_file(filename)
  Prmd::MultiLoader.load_file(filename)
end

.render(schema, options = {}) ⇒ String

Render provided schema to Markdown

Parameters:

Returns:

  • (String) —

    rendered schema in Markdown



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/prmd/commands/render.rb', line 26

def self.render(schema, options = {})
  renderer = Prmd::Renderer.new(template: Render.get_template(options))
  doc = ''
  if options[:prepend]
    doc <<
    options[:prepend].map { |path| File.read(path) }.join("\n") <<
    "\n"
  end
  doc << renderer.render(schema, options)
  doc
end

.verify(schema_data) ⇒ Array<String>

Verfies that a given schema is valid

Parameters:

  • schema_data (Hash)

Returns:

  • (Array<String>) —

    errors from failed verification



91
92
93
 
# File 'lib/prmd/commands/verify.rb', line 91

def self.verify(schema_data)
  Verification.verify(schema_data)
end