prmd 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 991f3f369ace8993454c827543547b3d3b16dd79
-  data.tar.gz: b75648a1d59e295af15f91ff05386cb946547b96
+  metadata.gz: 74cb8c4e07101320893a1a99c2cbbdb9d1db05e9
+  data.tar.gz: 54623e6a8c00abdc86f1800d327df8fe091f8b5f
 SHA512:
-  metadata.gz: ccc994060505e113f80b4709e6ae1bef92ae070182f3d8901028bd94b00c9b55cf2aefffdad68c4dc52b412de84b810c6cdaa084e6ad84a0c9eec78756958625
-  data.tar.gz: 8d773628f0cc4e02e42bd8cc39d8baa0ea2b4726890e5308a38cd45c3c74a68d2c51782eeec2684cee985b5d3e97cd1a5854bb21d991ca7d5d77b8bc3255d1e3
+  metadata.gz: cf7f7a284348b34634f2ee4ce6c6135fecd460b1d1be153477fd9a8d1a29e5537cbe9d5150bdacfec2c38844b0b0eb71c8f5c4488d20be204026a97e757867e3
+  data.tar.gz: 6075c2f9d282c53f7317ae6c41ba0411f9793e0a4ce755edc14567a5fecc2ca404462f78aa574011b9206e407dba74f24d309a2070df839b73fe9bc0f82fecf8

data/lib/prmd/templates/init_resource.json.erb

@@ -4,14 +4,12 @@
   "definitions": {
     "id": {
       "description": "unique identifier of <%= resource %>",
-      "example": "01234567-89ab-cdef-0123-456789abcdef",
       "readOnly": true,
       "format": "uuid",
       "type": ["string"]
     },
     "name": {
       "description": "unique name of <%= resource %>",
-      "example": "name",
       "readOnly": true,
       "type": ["string"]
     },
@@ -27,13 +25,11 @@
     },
     "created_at": {
       "description": "when <%= resource %> was created",
-      "example": "2012-01-01T12:00:00Z",
       "format": "date-time",
       "type": ["string"]
     },
     "updated_at": {
       "description": "when <%= resource %> was updated",
-      "example": "2012-01-01T12:00:00Z",
       "format": "date-time",
       "type": ["string"]
     }

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

@@ -1,6 +1,4 @@
 <%-
-  return unless schemata.has_key?('links') && !schemata['links'].empty?
-
   Prmd::Template.render('schemata/helper.erb', options[:template], {
     options:         options,
     resource:        resource,
@@ -11,7 +9,7 @@
   title = schemata['title'].split(' - ', 2).last
 -%>
 <%- unless options[:doc][:disable_title_and_description] %>
-## <%= title %>
+## <a name="resource-<%= resource %>"></a><%= title %>
 
 <%= schemata['description'] %>
 <%- end -%>
@@ -21,12 +19,18 @@
 
 | Name | Type | Description | Example |
 | ------- | ------- | ------- | ------- |
-<%- extract_attributes(schema, schemata['properties']).each do |(key, type, description, example)| %>
-| **<%= key %>** | *<%= type %>* | <%= description %> | <%= example %> |
+<%- refs = extract_schemata_refs(schema, schemata['properties']).map {|v| v && v.split("/")} %>
+<%- extract_attributes(schema, schemata['properties']).each_with_index do |(key, type, description, example), i| %>
+<%- if refs[i] && refs[i][1] == "definitions" && refs[i][2] != resource %>
+<%- name = '[%s](#%s)' % [key, 'resource-' + refs[i][2]] %>
+<%- else %>
+<%- name = key %>
+<%- end %>
+| **<%= name %>** | *<%= type %>* | <%= description %> | <%= example %> |
 <%- end %>
 
 <%- end %>
-<%- schemata['links'].each do |link, datum| %>
+<%- (schemata['links'] || []).each do |link, datum| %>
 <%=
   Prmd::Template.render('schemata/link.md.erb', options[:template], {
     options:         options,

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

@@ -58,13 +58,45 @@
     end
     attributes.map! { |key, type, description, example|
       if example.nil? && Prmd::DefaultExamples.key?(type)
-        example = Prmd::DefaultExamples[type]
+        example = "`%s`" % Prmd::DefaultExamples[type].to_json
       end
       [key, type, description, example]
     }
     return attributes
   end
 
+  def extract_schemata_refs(schema, properties)
+    ret = []
+    properties.each do |_, value|
+      ref, value = schema.dereference(value)
+      if value['properties']
+        refs = extract_schemata_refs(schema, value['properties'])
+      elsif value['items'] && value['items']['properties']
+        refs = extract_schemata_refs(schema, value['items']['properties'])
+      else
+        refs = [ref]
+      end
+      if value.has_key?('type') && value['type'].include?('null') && (value.has_key?('items') || value.has_key?('properties'))
+        # A nullable object usually isn't a reference to another schema. It's
+        # either not a reference at all, or it's a reference within the same
+        # schema. Instead, the definition of the nullable object might contain
+        # references to specific properties.
+        #
+        # If all properties refer to the same schema, we'll use that as the
+        # reference. This might even overwrite an actual, intra-schema
+        # reference.
+
+        l = refs.map {|v| v && v.split("/")[0..2]}
+        if l.uniq.size == 1 && l[0] != nil
+          ref = l[0].join("/")
+        end
+        ret << ref
+      end
+      ret.concat(refs)
+    end
+    ret
+  end
+
   def build_attribute(schema, key, value)
     description = value['description'] || ""
     if value['default']

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

@@ -64,6 +64,7 @@ HTTP/1.1 <%=
 <%- end %>
 ```
 
+<%- if response_example || link['rel'] != 'empty' %>
 ```json
 <%- if response_example %>
 <%=   response_example['body'] %>
@@ -78,3 +79,4 @@ HTTP/1.1 <%=
 <%-   end %>
 <%- end %>
 ```
+<%- end %>

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, 3, nil
+    MAJOR, MINOR, TEENY, PATCH = 0, 7, 4, nil
     # version string
     # @return [String]
     STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze

data/schemas/interagent-hyper-schema.json

@@ -10,6 +10,9 @@
     "definitions": {
         "identity": {
             "anyOf": [
+                {
+                    "$ref": "#/definitions/ref"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis