prmd 0.3.1 → 0.3.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjVhYzZlMzA0ODZlNDdhM2M1NWYzYzM0MjExMzM5NTZmMDQ2NDBhMw==
+    MzFkN2NlODhjNzdiNjMyN2E1YTQwMTg0MWRjMTNhMDUwZWE5YTc3OA==
   data.tar.gz: !binary |-
-    N2VlOGY4NDYwYmIwYzM4M2VhNjVjZTViZjk0MTg0YTRlMmRiNmNlZA==
+    OGQzODUzMzI3M2U5YjliZDNhNzQ0YjM2ZTUzNzA1MjI1ODQ3Y2NiZA==
 SHA512:
   metadata.gz: !binary |-
-    NDMwNDFlZWZjM2VjZDg0Yzc0YjhhNzA4MDc5NmUxM2FiMzExZjA4NzAyOTdj
-    YjE1NjZlNDc2Nzc5ZDY4MzNjZTAyZjhmNTI4ZTdlMWY0NDBhYmQwNGM0NDAy
-    MjI4NTQ3NDAxMDFhMmNmZjI2N2FhOWM4N2QyM2JjNTFlNTA0NTQ=
+    NzgxZjQyZGMxNDRhMDM3YjI0OGUyYTdiMDVjMzYzNjUzZGJkNDM4MTU0Mjg0
+    NzMyN2I0ODBiZDNmZTc0NDIzZjU4YWQwMWJkNWQ5NDNkOWYyYjY3MTRkODJm
+    NzU4OWFlM2NkMWY5NDY5MmYxYjVhN2I4NDk2OWM4NTYxNTliMTc=
   data.tar.gz: !binary |-
-    OTAwZjNiNzI2M2ZkZTBiZDQ1OGFlMjJkMTY0YmYwNDM0NDQ5MzQ0NGJhODU1
-    OGE2MTk5Y2M1YjBlOGJjOGNmMDBhM2FlM2ExMzhlYmY5NDgyZWQwOTlmZTlh
-    YzQ0NzkzODE4MmEwZjQ0ZGVlMGZiNzc2Y2MzMzI0NzYxNmViNjk=
+    NGVkMDAxMGUxMzk4ODY5NTM4N2VlNjJjMzBjMWEyOWFhY2JhMGIyOTkwMjU0
+    OWUwNTkyMTlkZWE2MjM4Yjk0NDI5MzRiZDhlOGI3MTU4OWMxZWY3ZWVlNjll
+    ZGUxYzE0N2QyZmJjZWNjOWM4N2Q3ZGFhMzg1YjdlZjc5ZmRkNzM=

data/CONTRIBUTING.md

@@ -5,14 +5,14 @@ New contributors are always welcome, when it doubt please ask questions. We stri
 ### Coding
 
 * Pick a task:
-  * Offer feedback on open [pull requests](https://github.com/heroku/prmd/pulls).
-  * Review open [issues](https://github.com/heroku/prmd/issues) for things to help on.
-  * [Create an issue](https://github.com/heroku/prmd/issues/new) to start a discussion on additions or features.
+  * Offer feedback on open [pull requests](https://github.com/interagent/prmd/pulls).
+  * Review open [issues](https://github.com/interagent/prmd/issues) for things to help on.
+  * [Create an issue](https://github.com/interagent/prmd/issues/new) to start a discussion on additions or features.
 * Fork the project, add your changes and tests to cover them in a topic branch.
-* Commit your changes and rebase against `heroku/prmd` to ensure everything is up to date.
-* [Submit a pull request](https://github.com/heroku/prmd/compare/).
+* Commit your changes and rebase against `interagent/prmd` to ensure everything is up to date.
+* [Submit a pull request](https://github.com/interagent/prmd/compare/).
 
 ### Non-Coding
 
-* Offer feedback on open [issues](https://github.com/heroku/prmd/issues).
+* Offer feedback on open [issues](https://github.com/interagent/prmd/issues).
 * Organize or volunteer at events.

data/CONTRIBUTORS.md

@@ -1,6 +1,9 @@
+* Brandur <brandur@heroku.com>
 * Brandur <brandur@mutelight.org>
 * Chris Continanza <christopher.continanza@gmail.com>
 * Dane Harrigan <dane.harrigan@gmail.com>
+* Ernesto Jiménez <me@ernesto-jimenez.com>
+* Kousuke Ebihara <Kosuke_Ebihara@voyagegroup.com>
 * Kousuke Ebihara <kousuke@co3k.org>
 * Mark McGranaghan <mmcgrana@gmail.com>
 * Olivier Lance <olance@users.noreply.github.com>

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prmd (0.2.0)
+    prmd (0.3.1)
       erubis (~> 2.7)
 
 GEM

data/lib/prmd/commands/combine.rb

@@ -25,34 +25,37 @@ module Prmd
     end
 
     schemata.each do |schema_file, schema_data|
-      id_prefix, id = schema_data['id'].split('/')
+      id = schema_data['id'].split('/').last
 
       if file = schemata_map[schema_data['id']]
         $stderr.puts "`#{schema_data['id']}` (from #{schema_file}) was already defined in `#{file}` and will overwrite the first definition"
       end
       schemata_map[schema_data['id']] = schema_file
 
-      data['definitions'][id_prefix] ||= {}
-      data['definitions'][id_prefix][id] = schema_data
+      # schemas are now in a single scope by combine
+      schema_data.delete('id')
+
+      data['definitions']
+      data['definitions'][id] = schema_data
       reference_localizer = lambda do |datum|
         case datum
         when Array
           datum.map {|element| reference_localizer.call(element)}
         when Hash
           if datum.has_key?('$ref')
-            datum['$ref'] = '#/definitions' + datum['$ref'].gsub('#', '')
+            datum['$ref'] = '#/definitions' + datum['$ref'].gsub('#', '').gsub('/schemata', '')
           end
           if datum.has_key?('href')
-            datum['href'] = datum['href'].gsub('%23', '').gsub(%r{(%2Fschemata%2F[^%]*%2F)}, '%23%2Fdefinitions\1')
+            datum['href'] = datum['href'].gsub('%23', '').gsub(%r{%2Fschemata(%2F[^%]*%2F)}, '%23%2Fdefinitions\1')
           end
           datum.each { |k,v| datum[k] = reference_localizer.call(v) }
         else
           datum
         end
       end
-      reference_localizer.call(data['definitions'][id_prefix][id])
+      reference_localizer.call(data['definitions'][id])
 
-      data['properties'][id] = { '$ref' => "#/definitions/#{id_prefix}/#{id}" }
+      data['properties'][id] = { '$ref' => "#/definitions/#{id}" }
     end
 
     Prmd::Schema.new(data)

data/lib/prmd/commands/verify.rb

@@ -1,25 +1,24 @@
 module Prmd
   def self.verify(schema)
     errors = []
-    errors << verify_schema(schema)
+    errors << verify_schema(schema['id'], schema)
     schema = Prmd::Schema.new(schema)
     if schema['properties']
       schema['properties'].each do |key, value|
-        _, schemata = schema.dereference(value)
-        errors << verify_schema(schemata)
-        errors << verify_definitions_and_links(schemata)
+        id, schemata = schema.dereference(value)
+
+        errors << verify_schema(id, schemata)
+        errors << verify_definitions_and_links(id, schemata)
       end
     end
     errors.flatten!
   end
 
-  def self.verify_schema(schema)
+  def self.verify_schema(id, schema)
     errors = []
 
-    id = schema['id']
-
     missing_requirements = []
-    %w{$schema definitions description id links properties title type}.each do |requirement|
+    %w{$schema definitions description links properties title type}.each do |requirement|
       unless schema.has_key?(requirement)
         missing_requirements << requirement
       end
@@ -31,11 +30,9 @@ module Prmd
     errors
   end
 
-  def self.verify_definitions_and_links(schema)
+  def self.verify_definitions_and_links(id, schema)
     errors = []
 
-    id = schema['id']
-
     if schema['definitions']
       unless schema['definitions'].has_key?('identity')
         errors << "Missing `#{id}#/definitions/identity`"

data/lib/prmd/schema.rb

@@ -56,26 +56,32 @@ module Prmd
       end
     end
 
-    def schema_example(schema)
-      example = {}
+    def schema_value_example(value)
+      if value.has_key?('properties') # nested properties
+        return schema_example(value)
+      elsif value.has_key?('items') # array of objects
+        _, items = dereference(value['items'])
+        if value['items'].has_key?('example')
+          return [items['example']]
+        else
+          return [schema_example(items)]
+        end
+      else
+        return value['example']
+      end
+    end
 
+    def schema_example(schema)
       if schema.has_key?('example')
-        example.merge!(schema['example'])
+        schema['example']
       elsif schema.has_key?('properties')
+        example = {}
         schema['properties'].each do |key, value|
           _, value = dereference(value)
-          if value.has_key?('properties') # nested properties
-            example[key] = {}
-            value['properties'].each do |k,v|
-              example[key][k] = dereference(v).last['example']
-            end
-          else
-            example[key] = value['example']
-          end
+          example[key] = schema_value_example(value)
         end
+        example
       end
-
-      example
     end
 
     def schemata_example(schemata_id)

data/lib/prmd/templates/schema.erb

@@ -1,10 +1,11 @@
 <%=
   schemata_template = File.read(File.join(File.dirname(options[:template]), 'schemata.erb'))
 
-  schema['properties'].map do |_, property|
+  schema['properties'].map do |resource, property|
     _, schemata = schema.dereference(property)
     Erubis::Eruby.new(schemata_template).result({
       options:         options,
+      resource:        resource,
       schema:          schema,
       schemata:        schemata
     })

data/lib/prmd/templates/schemata.erb

@@ -2,7 +2,6 @@
   return unless schemata.has_key?('links') && !schemata['links'].empty?
 
   link_schema_properties_template = File.read(File.join(File.dirname(options[:template]), 'link_schema_properties.erb'))
-  resource = schemata['id'].split('/').last
   title = schemata['title'].split(' - ', 2).last
 
   def extract_attributes(schema, properties)
@@ -52,7 +51,13 @@
         if value['enum']
           description += '<br/><b>one of:</b>' + [*value['enum']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
         end
-        example = [*value['example']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
+
+        if value.has_key?('example')
+          example = [*value['example']].map { |e| "<code>#{e.to_json}</code>" }.join(" or ")
+        elsif value['type'] == ['array'] && value.has_key?('items')
+          example = "<code>#{schema.schema_value_example(value)}</code>"
+        end
+
         type = if value['type'].include?('null')
           'nullable '
         else
@@ -92,7 +97,7 @@
   <%-
     path = link['href'].gsub(%r|(\{\([^\)]+\)\})|) do |ref|
       ref = ref.gsub('%2F', '/').gsub('%23', '#').gsub(%r|[\{\(\)\}]|, '')
-      ref_resource = ref.split('#/definitions/schemata/').last.split('/').first.gsub('-','_')
+      ref_resource = ref.split('#/definitions/').last.split('/').first.gsub('-','_')
       identity_key, identity_value = schema.dereference(ref)
       if identity_value.has_key?('anyOf')
         '{' + ref_resource + '_' + identity_value['anyOf'].map {|r| r['$ref'].split('/').last}.join('_or_') + '}'
@@ -163,9 +168,9 @@ HTTP/1.1 <%= case link['rel']
 ```
 ```javascript```
   <%- if link['rel'] == 'instances' %>
-<%= JSON.pretty_generate([schema.schemata_example(schemata['id'])]) %>
+<%= JSON.pretty_generate([schema.schemata_example(resource)]) %>
   <%- else %>
-<%= JSON.pretty_generate(schema.schemata_example(schemata['id'])) %>
+<%= JSON.pretty_generate(schema.schemata_example(resource)) %>
   <%- end %>
 ```
 <%- end -%>

data/lib/prmd/version.rb

@@ -1,3 +1,3 @@
 module Prmd
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/test/helpers.rb

@@ -2,7 +2,7 @@ require "minitest/autorun"
 require "prmd"
 
 def input_schemas_path
-  @@data_path ||= File.join(File.dirname(__FILE__), 'schemas', 'input')
+  @@data_path ||= File.join(File.dirname(__FILE__), 'schemata', 'input')
 end
 
 def user_input_schema

data/test/schema_test.rb

@@ -3,32 +3,32 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'helpers'))
 class SchemaTest < Minitest::Test
   def test_dereference_with_ref
     key, value = user_input_schema.dereference({
-      '$ref' => '#/definitions/schemata/user/definitions/id'
+      '$ref' => '#/definitions/user/definitions/id'
     })
-    assert_equal(key,   '#/definitions/schemata/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['schemata']['user']['definitions']['id'])
+    assert_equal(key,   '#/definitions/user/definitions/id')
+    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
   end
 
   def test_dereference_without_ref
-    key, value = user_input_schema.dereference('#/definitions/schemata/user/definitions/id')
-    assert_equal(key,   '#/definitions/schemata/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['schemata']['user']['definitions']['id'])
+    key, value = user_input_schema.dereference('#/definitions/user/definitions/id')
+    assert_equal(key,   '#/definitions/user/definitions/id')
+    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
   end
 
   def test_dereference_with_nested_ref
     key, value = user_input_schema.dereference({
-      '$ref' => '#/definitions/schemata/user/definitions/identity'
+      '$ref' => '#/definitions/user/definitions/identity'
     })
-    assert_equal(key,   '#/definitions/schemata/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['schemata']['user']['definitions']['id'])
+    assert_equal(key,   '#/definitions/user/definitions/id')
+    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
   end
 
   def test_dereference_with_local_context
     key, value = user_input_schema.dereference({
-      '$ref'     => '#/definitions/schemata/user/properties/id',
+      '$ref'     => '#/definitions/user/properties/id',
       'override' => true
     })
-    assert_equal(key,   '#/definitions/schemata/user/definitions/id')
-    assert_equal(value, {'override' => true}.merge(user_input_schema['definitions']['schemata']['user']['definitions']['id']))
+    assert_equal(key,   '#/definitions/user/definitions/id')
+    assert_equal(value, {'override' => true}.merge(user_input_schema['definitions']['user']['definitions']['id']))
   end
 end

data/test/{schemas → schemata}/input/meta.json

@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/draft-04/hyper-schema",
   "definitions": {},
   "description": "API lets you interact with service",
+  "id": "schemata",
   "links": [{
     "href": "https://api.example.com",
     "rel": "self"

data/test/{schemas → schemata}/input/user.json

@@ -4,6 +4,7 @@
   "type": [
     "object"
   ],
+  "description": "User represents an API account.",
   "definitions": {
     "created_at": {
       "description": "when user was created",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -99,8 +99,8 @@ files:
 - prmd.gemspec
 - test/helpers.rb
 - test/schema_test.rb
-- test/schemas/input/meta.json
-- test/schemas/input/user.json
+- test/schemata/input/meta.json
+- test/schemata/input/user.json
 homepage: https://github.com/heroku/prmd
 licenses:
 - MIT
@@ -128,6 +128,6 @@ summary: JSON Schema tooling
 test_files:
 - test/helpers.rb
 - test/schema_test.rb
-- test/schemas/input/meta.json
-- test/schemas/input/user.json
+- test/schemata/input/meta.json
+- test/schemata/input/user.json
 has_rdoc: