prmd 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74cb8c4e07101320893a1a99c2cbbdb9d1db05e9
-  data.tar.gz: 54623e6a8c00abdc86f1800d327df8fe091f8b5f
+  metadata.gz: b88e4f305b59c16a0117cfb8a91f5fa890ed4431
+  data.tar.gz: a13809a6a6d33936359c7ab04248dd6d43a4b798
 SHA512:
-  metadata.gz: cf7f7a284348b34634f2ee4ce6c6135fecd460b1d1be153477fd9a8d1a29e5537cbe9d5150bdacfec2c38844b0b0eb71c8f5c4488d20be204026a97e757867e3
-  data.tar.gz: 6075c2f9d282c53f7317ae6c41ba0411f9793e0a4ce755edc14567a5fecc2ca404462f78aa574011b9206e407dba74f24d309a2070df839b73fe9bc0f82fecf8
+  metadata.gz: 705022feeb033937ef9c2c08257f9cd4daefd7ea369fe05dce114ced1af67305fcf2060c559ca60519e2d64ef0f0b1b5652e957c94c3e711f2cad773c3beec47
+  data.tar.gz: 2277f2883652417e4dbe0fd0064dea23997def5044622c641a1684ee537795c81f3c0ab54d6f79675006bf796f9e924d7ceec71e63150b59763c2e0c71599323

data/CONTRIBUTORS.md

@@ -1,14 +1,20 @@
 * Adel Qalieh <aqalieh95@gmail.com>
+* Alex Fedorov <alexey.fedorov@wimdu.com>
 * Alex Sergeyev <alex.sergeyev@gmail.com>
+* Alexey Fedorov <waterlink000@gmail.com>
 * Arnold <arnoldcano@yahoo.com>
 * Brandur <brandur@heroku.com>
 * Brandur <brandur@mutelight.org>
+* Camilo Aguilar <camilo.aguilar@gmail.com>
+* Cesar Andreu <cesarandreu@gmail.com>
 * Chris Continanza <christopher.continanza@gmail.com>
 * Corey Powell <mistdragon100@gmail.com>
 * Dan Peterson <dpiddy@gmail.com>
 * Dane Harrigan <dane.harrigan@gmail.com>
+* Dominik Honnef <dominik@honnef.co>
 * Eric J. Holmes <eric@ejholmes.net>
 * Ernesto Jiménez <me@ernesto-jimenez.com>
+* Guillaume Coderre <guillaume.coderre@bookwitty.com>
 * Jason Rudolph <github@jasonrudolph.com>
 * Juan Pablo Buritica <juanpablo@buritica.org>
 * Justin Halsall <justin@juice10.com>
@@ -17,11 +23,16 @@
 * Lucas Carvalho <lucas.carvalho@corp.globo.com>
 * Mark McGranaghan <mmcgrana@gmail.com>
 * Martin Seeler <developer@chasmo.de>
+* Matt Gauger <matt.gauger@gmail.com>
 * Matthew Conway <himself@mattonrails.com>
+* Matthew Tylee Atkinson <matatk@gmail.com>
+* Nikolay Markov <mainameiz@gmail.com>
 * Olivier Lance <olance@users.noreply.github.com>
 * Scott Clasen <scott@heroku.com>
+* Takehiro Adachi <takehiro0740@gmail.com>
 * Timothée Peignier <timothee.peignier@tryphon.org>
 * Wesley Beary <geemus+github@gmail.com>
 * Wesley Beary <geemus@gmail.com>
+* Willem Dekker <wdekker@gmail.com>
 * Zack Shapiro <zack.shapiro@kontagent.com>
 * geemus <geemus@gmail.com>

data/bin/prmd

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require 'prmd'
-require 'prmd/cli'
+require_relative '../lib/prmd'
+require_relative '../lib/prmd/cli'
 
 Prmd::CLI.run(ARGV.dup, bin: File.basename(__FILE__))

data/lib/prmd.rb

@@ -1,7 +1,8 @@
-require 'prmd/version'
-require 'prmd/load_schema_file'
-require 'prmd/commands'
-require 'prmd/schema'
-require 'prmd/template'
-require 'prmd/url_generator'
-require 'prmd/hash_helpers'
+require_relative 'prmd/version'
+require_relative 'prmd/load_schema_file'
+require_relative 'prmd/commands'
+require_relative 'prmd/schema'
+require_relative 'prmd/link'
+require_relative 'prmd/template'
+require_relative 'prmd/url_generator'
+require_relative 'prmd/hash_helpers'

data/lib/prmd/cli.rb

@@ -1,9 +1,9 @@
-require 'prmd/core_ext/optparse'
-require 'prmd/cli/combine'
-require 'prmd/cli/doc'
-require 'prmd/cli/generate'
-require 'prmd/cli/render'
-require 'prmd/cli/verify'
+require_relative 'core_ext/optparse'
+require_relative 'cli/combine'
+require_relative 'cli/doc'
+require_relative 'cli/generate'
+require_relative 'cli/render'
+require_relative 'cli/verify'
 
 # :nodoc:
 module Prmd

data/lib/prmd/cli/base.rb

@@ -1,6 +1,6 @@
 require 'json'
-require 'prmd/core_ext/optparse'
-require 'prmd/load_schema_file'
+require_relative '../core_ext/optparse'
+require_relative '../load_schema_file'
 
 module Prmd
   module CLI

data/lib/prmd/cli/combine.rb

@@ -1,5 +1,5 @@
-require 'prmd/cli/base'
-require 'prmd/commands/combine'
+require_relative 'base'
+require_relative '../commands/combine'
 
 module Prmd
   module CLI

data/lib/prmd/cli/doc.rb

@@ -1,6 +1,6 @@
-require 'prmd/cli/base'
-require 'prmd/commands/render'
-require 'prmd/hash_helpers'
+require_relative 'base'
+require_relative '../commands/render'
+require_relative '../hash_helpers'
 
 module Prmd
   module CLI

data/lib/prmd/cli/generate.rb

@@ -1,5 +1,5 @@
-require 'prmd/cli/base'
-require 'prmd/commands/init'
+require_relative 'base'
+require_relative '../commands/init'
 
 module Prmd
   module CLI

data/lib/prmd/cli/render.rb

@@ -1,5 +1,5 @@
-require 'prmd/cli/base'
-require 'prmd/commands/render'
+require_relative 'base'
+require_relative '../commands/render'
 
 module Prmd
   module CLI

data/lib/prmd/cli/verify.rb

@@ -1,5 +1,5 @@
-require 'prmd/cli/base'
-require 'prmd/commands/verify'
+require_relative 'base'
+require_relative '../commands/verify'
 
 module Prmd
   module CLI

data/lib/prmd/commands.rb

@@ -1,4 +1,4 @@
-require 'prmd/commands/combine'
-require 'prmd/commands/init'
-require 'prmd/commands/render'
-require 'prmd/commands/verify'
+require_relative 'commands/combine'
+require_relative 'commands/init'
+require_relative 'commands/render'
+require_relative 'commands/verify'

data/lib/prmd/commands/combine.rb

@@ -1,6 +1,6 @@
-require 'prmd/load_schema_file'
-require 'prmd/core/schema_hash'
-require 'prmd/core/combiner'
+require_relative '../load_schema_file'
+require_relative '../core/schema_hash'
+require_relative '../core/combiner'
 
 # :nodoc:
 module Prmd

data/lib/prmd/commands/init.rb

@@ -1,6 +1,6 @@
 require 'json'
-require 'prmd/template'
-require 'prmd/core/generator'
+require_relative '../template'
+require_relative '../core/generator'
 
 # :nodoc:
 module Prmd

data/lib/prmd/commands/render.rb

@@ -1,4 +1,4 @@
-require 'prmd/core/renderer'
+require_relative '../core/renderer'
 
 # :nodoc:
 module Prmd

data/lib/prmd/core/combiner.rb

@@ -1,6 +1,6 @@
-require 'prmd/schema'
-require 'prmd/core/schema_hash'
-require 'prmd/core/reference_localizer'
+require_relative '../schema'
+require_relative 'schema_hash'
+require_relative 'reference_localizer'
 
 # :nodoc:
 module Prmd

data/lib/prmd/core/generator.rb

@@ -1,5 +1,5 @@
 require 'json'
-require 'prmd/schema'
+require_relative '../schema'
 
 # :nodoc:
 module Prmd

data/lib/prmd/core/renderer.rb

@@ -1,4 +1,4 @@
-require 'prmd/template'
+require_relative '../template'
 
 # :nodoc:
 module Prmd

data/lib/prmd/link.rb

@@ -0,0 +1,56 @@
+module Prmd
+  class Link
+    def initialize(link_schema)
+      @link_schema = link_schema 
+    end
+
+    def required_and_optional_parameters
+      @params = {required: {}, optional: {} }
+      recurse_properties(Schema.new(@link_schema["schema"]), "")
+      [@params[:required], @params[:optional]]
+    end
+
+    private
+
+    def recurse_properties(schema, prefix ="", parent_required= false )
+      return unless schema.has_properties?
+
+      schema.properties.keys.each do |prop_name|
+        prop = schema.properties[prop_name]
+        pref = "#{prefix}#{prop_name}"
+        required = parent_required || schema.property_is_required?(prop_name)
+
+        handle_property(prop, pref, required)
+      end
+    end
+
+    def handle_property(property, prefix, required = false)
+      case
+      when property_is_object?(property["type"])
+        recurse_properties(Schema.new(property), "#{prefix}:", required)
+      else
+        categorize_parameter(prefix, property, required)
+      end
+    end
+
+    def property_is_object?(type)
+      return false unless type
+      type == "object" || type.include?("object")
+    end
+
+    def categorize_parameter(name, param,  required=false)
+      @params[(required ? :required : :optional)][name] = param
+    end
+
+    class Schema < OpenStruct
+      def has_properties?
+        !self.properties.empty?
+      end
+
+      def property_is_required?(property_name)
+        return false unless required
+        return required.include?(property_name)
+      end
+    end
+  end
+end

data/lib/prmd/load_schema_file.rb

@@ -1,6 +1,6 @@
 require 'yaml'
 require 'json'
-require 'prmd/multi_loader'
+require_relative 'multi_loader'
 
 module Prmd #:nodoc:
   # Attempts to load either a json or yaml file, the type is determined by

data/lib/prmd/multi_loader.rb

@@ -1,2 +1,2 @@
-require 'prmd/multi_loader/json'
-require 'prmd/multi_loader/yaml'
+require_relative 'multi_loader/json'
+require_relative 'multi_loader/yaml'

data/lib/prmd/multi_loader/json.rb

@@ -1,4 +1,4 @@
-require 'prmd/multi_loader/loader'
+require_relative 'loader'
 require 'json'
 
 module Prmd #:nodoc:

data/lib/prmd/multi_loader/toml.rb

@@ -1,4 +1,4 @@
-require 'prmd/multi_loader/loader'
+require_relative 'loader'
 require 'toml'
 
 module Prmd #:nodoc:

data/lib/prmd/multi_loader/yajl.rb

@@ -1,4 +1,4 @@
-require 'prmd/multi_loader/loader'
+require_relative 'loader'
 require 'yajl'
 
 module Prmd #:nodoc:

data/lib/prmd/multi_loader/yaml.rb

@@ -1,4 +1,4 @@
-require 'prmd/multi_loader/loader'
+require_relative 'loader'
 require 'yaml'
 
 module Prmd #:nodoc:

data/lib/prmd/multi_loader/yml.rb

@@ -1,2 +1,2 @@
 # alias for yaml
-require 'prmd/multi_loader/yaml'
+require_relative 'yaml'

data/lib/prmd/rake_tasks/doc.rb

@@ -1,6 +1,7 @@
 require 'prmd/commands/render'
 require 'prmd/rake_tasks/base'
 require 'prmd/load_schema_file'
+require 'prmd/url_generator'
 require 'prmd/template'
 require 'prmd/schema'
 

data/lib/prmd/templates/schemata/helper.erb

@@ -44,13 +44,28 @@
           attribute[0] = "#{key}:#{attribute[0]}"
         end
         attributes.concat(nested)
+
       # found an array with nested objects
-      elsif value['items'] && value['items']['properties']
-        nested = extract_attributes(schema, value['items']['properties'])
-        nested.each do |attribute|
-          attribute[0] = "#{key}/#{attribute[0]}"
+      elsif value['items'] 
+        if value['items']['properties']
+          nested = extract_attributes(schema, value['items']['properties'])
+          nested.each do |attribute|
+            attribute[0] = "#{key}/#{attribute[0]}"
+          end
+          attributes.concat(nested)
         end
-        attributes.concat(nested)
+        if value['items']['oneOf']
+          value['items']['oneOf'].each_with_index do |oneof, index|
+          ref,  oneof_definition = schema.dereference(oneof)
+          oneof_name = ref ? ref.split('/').last : index
+          nested = extract_attributes(schema, oneof_definition['properties'])
+          nested.each do |attribute|
+            attribute[0] = "#{key}/[#{oneof_name.upcase}].#{attribute[0]}"
+          end
+          attributes.concat(nested)
+        end
+      end
+
       # just a regular attribute
       else
         attributes << build_attribute(schema, key, value)

data/lib/prmd/templates/schemata/link.md.erb

@@ -13,9 +13,7 @@
 
 <%- if link.has_key?('schema') && link['schema'].has_key?('properties') %>
   <%-
-    required, optional = link['schema']['properties'].partition do |k, v|
-      (link['schema']['required'] || []).include?(k)
-    end.map { |partition| Hash[partition] }
+    required, optional = Prmd::Link.new(link).required_and_optional_parameters
   %>
   <%- unless required.empty? %>
 #### Required Parameters

data/lib/prmd/url_generator.rb

@@ -1,5 +1,5 @@
-require 'prmd/url_generators/generators/default'
-require 'prmd/url_generators/generators/json'
+require_relative 'url_generators/generators/default'
+require_relative 'url_generators/generators/json'
 
 # :nodoc:
 module Prmd

data/lib/prmd/version.rb

@@ -2,7 +2,7 @@
 module Prmd
   # Well, duh, its a Version module, what did you expect?
   module Version
-    MAJOR, MINOR, TEENY, PATCH = 0, 7, 4, nil
+    MAJOR, MINOR, TEENY, PATCH = 0, 8, 0, nil
     # version string
     # @return [String]
     STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze

data/schemas/interagent-hyper-schema.json

@@ -107,7 +107,7 @@
         "resourceLink": {
             "properties": {
                 "href": {
-                    "pattern": "^(/([a-z][a-z\\-]*[a-z]|\\{\\(.*\\)\\}))+$"
+                    "pattern": "^(/([a-z0-9][a-z0-9_\\-]*[a-z0-9]|\\{\\(.*\\)\\}))+$"
                 },
                 "schema": {
                     "anyOf": [

data/test/commands/render_test.rb

@@ -20,11 +20,20 @@ class InteragentRenderTest < Minitest::Test
         }
       }
     })
-
     markdown = render
     assert_match /version.*v10\.9\.rc1/, markdown
   end
 
+
+  def test_render_for_schema_with_property_defined_with_oneOf
+    markdown = render
+
+   assert_match /\*\*options\/\[OPTION1\]\.type\*\*/, markdown
+   assert_match /\*\*options\/\[OPTION2\]\.type\*\*/, markdown
+  end
+
+
+
   def test_render_for_example_as_an_array
     # matches -d '[{...}]' taking into account line breaks and spacing
     expression = /-d '\[[\s\n]+\{[\n\s]+\"name\": \"EXAMPLE\",[\n\s]+\"value\": \"example\"[\s\n]+\}[\n\s]+\]/
@@ -85,6 +94,43 @@ class InteragentRenderTest < Minitest::Test
               'type'        => 'string',
               'example'     => 'example'
             },
+            'option-type1' => {
+              'type' => 'string', 
+              'example' => 'OPTION1', 
+              'enum' => 'OPTION1'                   
+            },
+            'option-type2' => {
+              'type' => 'string', 
+              'example' => 'OPTION2',
+              'enum' => 'OPTION2'
+            },
+            'option1' => {
+              'properties' => {
+                'type' => {
+                    '$ref' => '#/definitions/config-var/definitions/option-type1'    
+                }
+              }
+            },
+            'option2' => {
+              'properties' => {
+                'type' => {
+                    '$ref' => '#/definitions/config-var/definitions/option-type2'    
+                }
+              }
+            },
+            'options' => {                      
+              'items' => {
+                'example'=> 'CHOICE1',
+                'oneOf' => [
+                  { 
+                    '$ref' => '#/definitions/config-var/definitions/option1'
+                  },
+                  { 
+                   '$ref' => '#/definitions/config-var/definitions/option2'
+                  }
+                ]
+              }
+            }
           },
           'links' => [
             {
@@ -117,6 +163,9 @@ class InteragentRenderTest < Minitest::Test
             },
             'value' => {
               '$ref' => '#/definitions/config-var/definitions/value'
+            },
+            'options' => {
+              '$ref' => '#/definitions/config-var/definitions/options'
             }
           }
         }

data/test/commands/verify_test.rb

@@ -107,12 +107,12 @@ class InteragentHyperSchemaVerifyTest < Minitest::Test
 
   def test_resource_link_href_format
     pointer('#/definitions/app/links/0').merge!({
-      'href' => '/my_apps'
+      'href' => '/my~apps'
     })
     errors = verify
     assert_equal 1, errors.count
     assert_match %r{^#/definitions/app/links/0/href: }, errors[0]
-    assert_match /\/my_apps does not match /, errors[0]
+    assert_match /\/my~apps does not match /, errors[0]
   end
 
   def test_resource_link_required

data/test/helpers.rb

@@ -86,3 +86,95 @@ end
 def user_input_schema
   @user_input_schema ||= Prmd.combine(input_schemas_path('user.json'))
 end
+
+module PrmdLinkTestHelpers
+  def link_parent_required
+    {
+      "description"=>"Create User",
+      "href"=>"/users",
+      "method"=>"POST",
+      "rel"=>"create",
+      "schema"=> {
+        "properties"=>{
+          "user"=>{
+            "type"=>["object"], "properties"=>{"email"=>"string", "name"=>"string"}}
+        },
+        "type"=>["object"],
+        "required"=>["user"]
+      },
+      "title"=>"Create"
+    }
+  end
+
+  def link_no_required
+    {
+      "description"=>"Create User",
+      "href"=>"/users",
+      "method"=>"POST",
+      "rel"=>"create",
+      "schema"=> {
+        "properties"=>{
+          "user"=>{
+            "type"=>["object"], "properties"=>{"email"=>"string", "name"=>"string"}}
+        },
+        "type"=>["object"]
+      },
+      "title"=>"Create"
+    }
+  end
+
+  def link_child_required
+    {
+      "description"=>"Create user",
+      "href"=>"/users",
+      "method"=>"POST",
+      "rel"=>"create",
+      "schema"=> {
+        "properties"=>{
+          "user"=>{
+            "type"=>["object"],
+            "properties"=>{
+              "email"=>"string",
+              "name"=>"string"
+            },
+            "required" =>  ["email"]
+          }
+        },
+        "type"=>["object"]
+      },
+      "title"=>"Create"
+    }
+  end
+
+  def link_multiple_nested_required
+    {
+      "description"=>"Create user",
+      "href"=>"/users",
+      "method"=>"POST",
+      "rel"=>"create",
+      "schema"=> {
+        "properties"=>{
+          "user"=>{
+            "type"=>["object"],
+            "properties"=>{
+              "email"=>"string",
+              "name"=>"string"
+            },
+            "required" =>  ["email"]
+          },
+          "address" => {
+            "type"=>["object"],
+            "properties"=>{
+              "street"=>"string",
+              "zip"=>"string"
+            }
+          }
+        },
+        "type"=>["object"],
+        "required" => ["address"]
+      },
+      "title"=>"Create"
+    }
+
+  end
+end

data/test/link_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '.', 'helpers'))
+module Prmd
+  class LinkTest < MiniTest::Test
+    include PrmdLinkTestHelpers
+
+    [
+      {
+        title: "no_required",
+        required: {},
+        optional: {"user:email" => "string", "user:name" => "string"}
+      },
+      {
+        title: "parent_required",
+        optional: {},
+        required: {"user:email" => "string", "user:name" => "string"}
+      },
+      {
+        title: "child_required",
+        optional: {"user:name" => "string"},
+        required: {"user:email" => "string"}
+      },
+      {
+        title: "multiple_nested_required" ,
+        optional: {"user:name" => "string"},
+        required: {"user:email" => "string", 
+                   "address:street" => "string",
+                   "address:zip" => "string"}
+      }
+    ].each do |test_hash|
+
+      define_method "test_#{test_hash[:title]}" do
+        subject = Prmd::Link.new( send("link_#{test_hash[:title]}"))
+        required, optional = subject.required_and_optional_parameters
+
+        assert_equal required, test_hash[:required]
+        assert_equal optional, test_hash[:optional]
+      end
+    end
+
+  end
+end

data/test/schemata/input/user.json

@@ -42,10 +42,19 @@
       "rel": "create",
       "schema": {
         "properties": {
+          "user": {
+             "type": "object",
+             "properties" : {
+                "email": "string",
+                "name": "string"
+             },
+             "required": ["email"]
+          }
         },
         "type": [
           "object"
-        ]
+        ],
+        "required": ["user"]
       },
       "title": "Create"
     },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -124,6 +124,7 @@ files:
 - lib/prmd/core/schema_hash.rb
 - lib/prmd/core_ext/optparse.rb
 - lib/prmd/hash_helpers.rb
+- lib/prmd/link.rb
 - lib/prmd/load_schema_file.rb
 - lib/prmd/multi_loader.rb
 - lib/prmd/multi_loader/json.rb
@@ -165,6 +166,7 @@ files:
 - test/commands/verify_test.rb
 - test/core/reference_localizer_test.rb
 - test/helpers.rb
+- test/link_test.rb
 - test/multi_loader/common.rb
 - test/multi_loader/json_test.rb
 - test/multi_loader/toml_test.rb
@@ -220,6 +222,7 @@ test_files:
 - test/commands/verify_test.rb
 - test/core/reference_localizer_test.rb
 - test/helpers.rb
+- test/link_test.rb
 - test/multi_loader/common.rb
 - test/multi_loader/json_test.rb
 - test/multi_loader/toml_test.rb