prmd 0.6.2 → 0.7.0

data/lib/prmd/url_generators/generators/default.rb

@@ -0,0 +1,66 @@
+require 'cgi'
+
+# :nodoc:
+module Prmd
+  # :nodoc:
+  class UrlGenerator
+    # :nodoc:
+    module Generators
+      # Default URL Generator
+      #
+      # @api private
+      class Default
+        # @param [Hash<Symbol, Object>] params
+        def self.generate(params)
+          data = {}
+          data.merge!(params[:schema].schema_example(params[:link]['schema']))
+          generate_params(data)
+        end
+
+        # @param [String] key
+        # @param [String] prefix
+        # @return [String]
+        def self.param_name(key, prefix, array = false)
+          result = if prefix
+            "#{prefix}[#{key}]"
+          else
+            key
+          end
+
+          result += '[]' if array
+          result
+        end
+
+        # @param [Hash] obj
+        # @param [String] prefix
+        # @return [String]
+        def self.generate_params(obj, prefix = nil)
+          result = []
+          obj.each do |key,value|
+            if value.is_a?(Hash)
+              newprefix = if prefix
+                "#{prefix}[#{key}]"
+              else
+                key
+              end
+              result << generate_params(value, newprefix)
+            elsif value.is_a?(Array)
+              value.each do |val|
+                result << [param_name(key, prefix, true), CGI.escape(val.to_s)].join('=')
+              end
+            else
+              next unless value # ignores parameters with empty examples
+              result << [param_name(key, prefix), CGI.escape(value.to_s)].join('=')
+            end
+          end
+          result.flatten
+        end
+
+        class << self
+          private :param_name
+          private :generate_params
+        end
+      end
+    end
+  end
+end

data/lib/prmd/url_generators/generators/json.rb

@@ -0,0 +1,30 @@
+require 'cgi'
+
+# :nodoc:
+module Prmd
+  # :nodoc:
+  class UrlGenerator
+    # :nodoc:
+    module Generators
+      # JSON URL Generator
+      #
+      # @api private
+      class JSON
+        # @param [Hash<Symbol, Object>] params
+        def self.generate(params)
+          data = {}
+          data.merge!(params[:schema].schema_example(params[:link]['schema']))
+
+          result = []
+          data.sort_by {|k,_| k.to_s }.each do |key, values|
+            [values].flatten.each do |value|
+              result << [key.to_s, CGI.escape(value.to_s)].join('=')
+            end
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/prmd/version.rb

@@ -1,3 +1,12 @@
+# :nodoc:
 module Prmd
-  VERSION = "0.6.2"
+  # Well, duh, its a Version module, what did you expect?
+  module Version
+    MAJOR, MINOR, TEENY, PATCH = 0, 7, 0, nil
+    # version string
+    # @return [String]
+    STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze
+  end
+  # @return [String]
+  VERSION = Version::STRING
 end

data/prmd.gemspec

@@ -4,24 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'prmd/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "prmd"
+  spec.name          = 'prmd'
   spec.version       = Prmd::VERSION
-  spec.authors       = ["geemus"]
-  spec.email         = ["geemus@gmail.com"]
-  spec.description   = %q{scaffold, verify and generate docs from JSON Schema}
-  spec.summary       = %q{JSON Schema tooling}
-  spec.homepage      = "https://github.com/heroku/prmd"
-  spec.license       = "MIT"
+  spec.authors       = ['geemus']
+  spec.email         = ['geemus@gmail.com']
+  spec.description   = 'scaffold, verify and generate docs from JSON Schema'
+  spec.summary       = 'JSON Schema tooling'
+  spec.homepage      = 'https://github.com/heroku/prmd'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "erubis", "~> 2.7"
-  spec.add_dependency "json_schema", "~> 0.1"
+  spec.add_dependency 'erubis',      '~> 2.7'
+  spec.add_dependency 'json_schema', '~> 0.3', '>= 0.3.1'
 
-  spec.add_development_dependency "bundler",  "~> 1.3"
-  spec.add_development_dependency "rake",     "~> 10.2"
-  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency 'bundler',  '~> 1.3'
+  spec.add_development_dependency 'rake',     '~> 10.3'
+  spec.add_development_dependency 'minitest', '~> 5.4'
 end

data/test/cli/combine_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require 'prmd/cli/combine'
+
+class PrmdCliCombineTest < Minitest::Test
+  include CliBaseTestHelpers
+
+  def command_module
+    Prmd::CLI::Combine
+  end
+
+  def argv_for_test_run
+    ['-m', 'schema/meta.json',
+     'schema/schemata',
+     '-o', 'schema/api.json']
+  end
+
+  def validate_parse_options(options)
+    assert_equal 'schema/meta.json', options[:meta]
+    assert_equal 'schema/api.json', options[:output_file]
+    assert_equal ['schema/schemata'], options[:argv]
+    super
+  end
+end

data/test/cli/doc_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require 'prmd/cli/doc'
+
+class PrmdCliDocTest < Minitest::Test
+  include CliBaseTestHelpers
+
+  def command_module
+    Prmd::CLI::Doc
+  end
+
+  def argv_for_test_run
+    ['-s', input_schemas_path('doc-settings.json'),
+     '-p', 'overview.txt',
+     'schema/api.json',
+     '-o', 'schema/verified-api.json']
+  end
+
+  def validate_parse_options(options)
+    assert_equal 'application/bread', options[:content_type]
+    assert_equal ['overview.txt'], options[:prepend]
+    assert_equal 'schema/verified-api.json', options[:output_file]
+    assert_equal ['schema/api.json'], options[:argv]
+    super
+  end
+end

data/test/cli/generate_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require 'prmd/cli/generate'
+
+class PrmdCliGenerateTest < Minitest::Test
+  include CliBaseTestHelpers
+
+  def command_module
+    Prmd::CLI::Generate
+  end
+
+  def argv_for_test_run
+    ['-y',
+     'bread',
+     '-o', 'schema/bread.yml']
+  end
+
+  def validate_parse_options(options)
+    assert_equal true, options[:yaml]
+    assert_equal ['bread'], options[:argv]
+    assert_equal 'schema/bread.yml', options[:output_file]
+    super
+  end
+end

data/test/cli/render_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require 'prmd/cli/render'
+
+class PrmdCliRenderTest < Minitest::Test
+  include CliBaseTestHelpers
+
+  def command_module
+    Prmd::CLI::Render
+  end
+
+  def argv_for_test_run
+    ['-p', 'overview.txt,somethin.txt',
+     '-t', 'templates',
+     '-o', 'schema/bread.md',
+     'schema/bread.json']
+  end
+
+  def validate_parse_options(options)
+    assert_equal ['overview.txt', 'somethin.txt'], options[:prepend]
+    assert_equal 'templates', options[:template]
+    assert_equal 'schema/bread.md', options[:output_file]
+    assert_equal ['schema/bread.json'], options[:argv]
+    super
+  end
+end

data/test/cli/verify_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require 'prmd/cli/verify'
+
+class PrmdCliVerifyTest < Minitest::Test
+  include CliBaseTestHelpers
+
+  def command_module
+    Prmd::CLI::Verify
+  end
+
+  def argv_for_test_run
+    ['-o', 'schema/buttered-bread.json',
+     'schema/bread.json']
+  end
+
+  def validate_parse_options(options)
+    assert_equal 'schema/buttered-bread.json', options[:output_file]
+    assert_equal ['schema/bread.json'], options[:argv]
+    super
+  end
+end

data/test/commands/init_test.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+
+class PrmdInitTest < Minitest::Test
+  def test_init
+    Prmd.init('Cake')
+  end
+end

data/test/commands/render_test.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+
+require 'json_pointer'
+
+class InteragentRenderTest < Minitest::Test
+  def test_render_for_valid_schema
+    markdown = render
+
+    assert_match /An app in our PaaS ecosystem./, markdown
+  end
+
+  def test_render_for_schema_with_property_defined_with_anyOf
+    pointer('#/definitions/app').merge!({
+      'properties' => {
+        'version' => {
+          'anyOf' => [
+            { 'type' => 'string', 'example' => 'v10.9.rc1', 'minLength' => 1 },
+            { 'type' => 'number', 'minimum' => 0 }
+          ]
+        }
+      }
+    })
+
+    markdown = render
+    assert_match /version.*v10\.9\.rc1/, markdown
+  end
+
+  private
+
+  def data
+    @data ||= {
+      '$schema'     => 'http://interagent.github.io/interagent-hyper-schema',
+      'description' => 'My simple example API.',
+      'id'          => 'http://example.com/schema',
+      'title'       => 'Example API',
+      'definitions' => {
+        'app' => {
+          'description' => 'An app in our PaaS ecosystem.',
+          'title' => 'App',
+          'type' => 'object',
+          'definitions' => {
+            'identity' => {
+              'anyOf' => [
+                {
+                  '$ref' => '#/definitions/app/definitions/name'
+                }
+              ]
+            },
+            'name' => {
+              'description' => 'The app\'s name.',
+              'type'        => 'string'
+            }
+          },
+          'links' => [
+            {
+              'description' => 'Create a new app.',
+              'href' => '/apps',
+              'method' => 'POST',
+              'rel' => 'create',
+              'title' => 'Create App'
+            }
+          ],
+          'properties' => {
+          }
+        }
+      },
+      'links' => [
+        {
+          'href' => 'https://example.com',
+          'rel' => 'self'
+        }
+      ],
+      'properties' => {
+        'app' => {
+          '$ref' => '#/definitions/app'
+        }
+      },
+      'type' => 'object'
+    }
+  end
+
+  def pointer(path)
+    JsonPointer.evaluate(data, path)
+  end
+
+  def render
+    schema = Prmd::Schema.new(data)
+
+    template = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'prmd', 'templates'))
+
+    Prmd.render(schema, template: template)
+  end
+end

data/test/commands/verify_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
 
-require "json_pointer"
+require 'json_pointer'
 
 class InteragentHyperSchemaVerifyTest < Minitest::Test
   def test_verifies
@@ -12,20 +12,20 @@ class InteragentHyperSchemaVerifyTest < Minitest::Test
   #
 
   def test_api_required
-    data.delete("title")
+    data.delete('title')
     errors = verify
     assert_equal 1, errors.count
-    assert_match %r{^#: }, errors[0]
-    assert_match %r{Missing required keys "title" in object}, errors[0]
+    assert_match /^#: /, errors[0]
+    assert_match /"title" wasn't supplied\./, errors[0]
   end
 
   def test_api_property_format
-    pointer("#/properties").merge!({
-      "app" => {}
+    pointer('#/properties').merge!({
+      'app' => {}
     })
     errors = verify
     assert_match %r{^#/properties/app: }, errors[0]
-    assert_match %r{Missing required keys "\$ref" in object}, errors[0]
+    assert_match /"\$ref" wasn't supplied\./, errors[0]
   end
 
   #
@@ -33,50 +33,50 @@ class InteragentHyperSchemaVerifyTest < Minitest::Test
   #
 
   def test_resource_required
-    pointer("#/definitions/app").delete("title")
+    pointer('#/definitions/app').delete('title')
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app: }, errors[0]
-    assert_match %r{Missing required keys "title" in object}, errors[0]
+    assert_match /"title" wasn't supplied\./, errors[0]
   end
 
   def test_resource_identity_format
-    pointer("#/definitions/app/definitions/identity").merge!({
-      "type" => "string"
+    pointer('#/definitions/app/definitions/identity').merge!({
+      'type' => 'string'
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/definitions/identity: }, errors[0]
-    assert_match %r{any subschema of "anyOf" condition.}, errors[0]
+    assert_match /No subschema in "anyOf" matched\./, errors[0]
   end
 
   # an empty schema can be specified to bypass the identity check
   def test_resource_identity_format_empty
-    pointer("#/definitions/app/definitions").merge!({
-      "identity" => {}
+    pointer('#/definitions/app/definitions').merge!({
+      'identity' => {}
     })
     assert_equal [], verify
   end
 
   # "my-property" does match fit our regex of lowercase letters and underscores only
   def test_resource_property_format
-    pointer("#/definitions/app/properties").merge!({
-      "my-property" => {}
+    pointer('#/definitions/app/properties').merge!({
+      'my-property' => {}
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/properties: }, errors[0]
-    assert_match %r{Extra keys in object: my-property}, errors[0]
+    assert_match /"my-property" is not a permitted key\./, errors[0]
   end
 
   def test_resource_strict_properties
-    pointer("#/definitions/app").merge!({
-      "strictProperties" => false
+    pointer('#/definitions/app').merge!({
+      'strictProperties' => false
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/strictProperties: }, errors[0]
-    assert_match %r{to be a member of enum \[true\], value was: false}, errors[0]
+    assert_match /false is not a member of \[true\]/, errors[0]
   end
 
   #
@@ -84,21 +84,21 @@ class InteragentHyperSchemaVerifyTest < Minitest::Test
   #
 
   def test_resource_definition_no_links
-    pointer("#/definitions/app/definitions/name").merge!({
-      "links" => []
+    pointer('#/definitions/app/definitions/name').merge!({
+      'links' => []
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/definitions/name: }, errors[0]
-    assert_match %r{Data matched subschema of "not" condition}, errors[0]
+    assert_match /Matched "not" subschema/, errors[0]
   end
 
   def test_resource_definition_required
-    pointer("#/definitions/app/definitions/name").delete("description")
+    pointer('#/definitions/app/definitions/name').delete('description')
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/definitions/name: }, errors[0]
-    assert_match %r{Missing required keys "description" in object}, errors[0]
+    assert_match /"description" wasn't supplied\./, errors[0]
   end
 
   #
@@ -106,74 +106,74 @@ class InteragentHyperSchemaVerifyTest < Minitest::Test
   #
 
   def test_resource_link_href_format
-    pointer("#/definitions/app/links/0").merge!({
-      "href" => "/my_apps"
+    pointer('#/definitions/app/links/0').merge!({
+      'href' => '/my_apps'
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/links/0/href: }, errors[0]
-    assert_match %r{Expected string to match pattern}, errors[0]
+    assert_match /\/my_apps does not match /, errors[0]
   end
 
   def test_resource_link_required
-    pointer("#/definitions/app/links/0").delete("method")
+    pointer('#/definitions/app/links/0').delete('method')
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/links/0: }, errors[0]
-    assert_match %r{Missing required keys "method" in object}, errors[0]
+    assert_match /"method" wasn't supplied\./, errors[0]
   end
 
   private
 
   def data
     @data ||= {
-      "$schema"     => "http://interagent.github.io/interagent-hyper-schema",
-      "description" => "My simple example API.",
-      "id"          => "http://example.com/schema",
-      "title"       => "Example API",
-      "definitions" => {
-        "app" => {
-          "description" => "An app in our PaaS ecosystem.",
-          "title" => "App",
-          "type" => "object",
-          "definitions" => {
-            "identity" => {
-              "anyOf" => [
+      '$schema'     => 'http://interagent.github.io/interagent-hyper-schema',
+      'description' => 'My simple example API.',
+      'id'          => 'http://example.com/schema',
+      'title'       => 'Example API',
+      'definitions' => {
+        'app' => {
+          'description' => 'An app in our PaaS ecosystem.',
+          'title' => 'App',
+          'type' => 'object',
+          'definitions' => {
+            'identity' => {
+              'anyOf' => [
                 {
-                  "$ref" => "#/definitions/app/definitions/name"
+                  '$ref' => '#/definitions/app/definitions/name'
                 }
               ]
             },
-            "name" => {
-              "description" => "The app's name.",
-              "type"        => "string"
+            'name' => {
+              'description' => 'The app\'s name.',
+              'type'        => 'string'
             }
           },
-          "links" => [
+          'links' => [
             {
-              "description" => "Create a new app.",
-              "href" => "/apps",
-              "method" => "POST",
-              "rel" => "create",
-              "title" => "Create App"
+              'description' => 'Create a new app.',
+              'href' => '/apps',
+              'method' => 'POST',
+              'rel' => 'create',
+              'title' => 'Create App'
             }
           ],
-          "properties" => {
+          'properties' => {
           }
         }
       },
-      "links" => [
+      'links' => [
         {
-          "href" => "https://example.com",
-          "rel" => "self"
+          'href' => 'https://example.com',
+          'rel' => 'self'
         }
       ],
-      "properties" => {
-        "app" => {
-          "$ref" => "#/definitions/app"
+      'properties' => {
+        'app' => {
+          '$ref' => '#/definitions/app'
         }
       },
-      "type" => "object"
+      'type' => 'object'
     }
   end