prmd 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 906209c8a327e103f1392faff3f4c7a35caac7b9
-  data.tar.gz: 42fbce50f4e8477a1a5c1607521b49101a37b349
+SHA256:
+  metadata.gz: 7d549096116bdd614f84c9956e2de37d34d09721c8d67be4d189beab98787934
+  data.tar.gz: ecbd1909e6258876c49165bfdaaab02a6fcd99397bdd7470ec6b033c99381113
 SHA512:
-  metadata.gz: 1b246f23874af73656586f681cc2002ce8f37ba313ec128dc17ae4ee84814b641fd6bd42fd05007d4f040a289276b8be1fe7167990f6041b43c66ea2009339fb
-  data.tar.gz: 7bb6505cccc8df5313a2fd1b87411feac21ac4e7f126046be329a3a0d52e7bcd7f58428f66b8295c3583d5892d63b4f6b74c98499873031e8971f3cac302cede
+  metadata.gz: 92c5e9081ae01609eac6223fe89e1a487bf9924001d60ef14baf3557c7ea053ecefe010ab4ae2ba7f771c82266abc6c891cb610662c1d5d32b426331bb2dce0b
+  data.tar.gz: 9874013f4b85083bf9405dad926be63584a5856fa6810463f727bec82a81d363d350117a122db2fd90e865306f3dc3ec9f29e8a8de57d74d7c9512414dcb8d55

data/.travis.yml

@@ -1,11 +1,13 @@
 language: ruby
 rvm:
-- 2.0
-- 2.1
-- 2.2
+- 2.3.8
+- 2.4.10
+- 2.5.8
+- 2.6.6
+- 2.7.2
 - ruby-head
 before_install:
-- gem install bundler -v '~> 1.10'
+- gem install bundler -v '~> 2.0'
 script: "bundle exec rake"
 notifications:
   email: false

data/docs/schemata.md

@@ -55,6 +55,11 @@ Examples:
       "format":       "uuid",
       "type":         ["string"]
     },
+    "identity": {
+      "anyOf": [
+        { "$ref": "/schemata/example#/definitions/id" }
+      ]
+    },
     "url": {
       "description":  "URL of resource",
       "example":      "http://example.com",

data/lib/prmd/rake_tasks/doc.rb

@@ -5,6 +5,7 @@ require 'prmd/url_generator'
 require 'prmd/template'
 require 'prmd/schema'
 require 'prmd/link'
+require_relative '../hash_helpers'
 
 # :nodoc:
 module Prmd
@@ -34,6 +35,10 @@ module Prmd
         options = legacy_parameters(*args)
         @files = options.fetch(:files) { [] }
         super options, &block
+        if @options[:settings].is_a? String
+          settings = Prmd.load_schema_file(@options[:settings])
+          @options.merge! HashHelpers.deep_symbolize_keys(settings)
+        end
         @options[:template] ||= Prmd::Template.template_dirname
       end
 

data/lib/prmd/schema.rb

@@ -118,6 +118,8 @@ module Prmd
         end
         ref = id_ref || value['anyOf'].first
         schema_example(ref)
+      elsif value.key?('allOf')
+        value['allOf'].map { |ref| schema_example(ref) }.reduce({}, &:merge)
       elsif value.key?('properties') # nested properties
         schema_example(value)
       elsif value.key?('items') # array of objects

data/lib/prmd/templates/schema.erb

@@ -1,4 +1,11 @@
-<% if options[:doc][:toc] %><%= Prmd::Template::load('table_of_contents.erb', options[:template]).result({schema: schema}) %> <%end %>
+<%- if options[:doc][:toc] -%>
+<%=
+  Prmd::Template::load('table_of_contents.erb', options[:template]).result({
+    options: options,
+    schema:  schema
+  })
+%>
+<%- end -%>
 <%=
   schemata_template = Prmd::Template::load('schemata.md.erb', options[:template])
 

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

@@ -9,7 +9,8 @@
   title = schemata['title'].split(' - ', 2).last
 -%>
 <%- unless options[:doc][:disable_title_and_description] %>
-## <a name="resource-<%= resource %>"><%= title %></a>
+<a name="#resource-<%= resource %>"></a>
+## <%= title %>
 
 <%- if schemata['stability'] && !schemata['stability'].empty? %>
 Stability: `<%= schemata['stability'] %>`
@@ -19,8 +20,13 @@ Stability: `<%= schemata['stability'] %>`
 <%- end -%>
 
 <%- if schemata['properties'] && !schemata['properties'].empty? %>
+
 ### Attributes
 
+<details>
+  <summary>Details</summary>
+
+
 | Name | Type | Description | Example |
 | ------- | ------- | ------- | ------- |
 <%- refs = extract_schemata_refs(schema, schemata['properties']).map {|v| v && v.split("/")} %>
@@ -33,6 +39,8 @@ Stability: `<%= schemata['stability'] %>`
 | **<%= name %>** | *<%= type %>* | <%= description %> | <%= example %> |
 <%- end %>
 
+</details>
+
 <%- end %>
 <%- (schemata['links'] || []).each do |link, datum| %>
 <%=

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

@@ -137,7 +137,10 @@
     end
 
     if value['pattern']
-      description += "<br/> **pattern:** `#{value['pattern']}`"
+      # Prevent the pipe regex pattern characters from being interpreted as markdown table:
+      pattern = value['pattern'].gsub(/\|/, '&#x7c;')
+
+      description += "<br/> **pattern:** <pre>#{pattern}</pre>"
     end
 
     if value['minLength'] || value['maxLength']
@@ -175,7 +178,7 @@
     else
       ''
     end
-    type += (value['format'] || (value['type'] - ['null']).first)
+    type += (value['format'] || (value['type'] - ['null']).join(' or '))
     [key, type, description, example]
   end
 
@@ -183,8 +186,8 @@
   def build_link_path(schema, link)
     link['href'].gsub(%r|(\{\([^\)]+\)\})|) do |ref|
       ref = ref.gsub('%2F', '/').gsub('%23', '#').gsub(%r|[\{\(\)\}]|, '')
-      ref_resource = ref.split('#/definitions/').last.split('/').first.gsub('-','_')
       identity_key, identity_value = schema.dereference(ref)
+      ref_resource = identity_key.split('#/definitions/').last.split('/').first.gsub('-','_')
       if identity_value.has_key?('anyOf')
         '{' + ref_resource + '_' + identity_value['anyOf'].map {|r| r['$ref'].split('/').last}.join('_or_') + '}'
       else

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

@@ -3,7 +3,11 @@
   response_example = link['response_example']
   link_schema_properties_template = Prmd::Template.load_template('link_schema_properties.md.erb', options[:template])
 -%>
-### <a name="link-<%= link['method'] %>-<%= resource %>-<%= link['href'] %>"><%= title %> <%= link['title'] %></a>
+<a name="link-<%= link['method'] %>-<%= resource %>-<%= link['href'] %>"></a>
+### <%= title %> <%= link['title'] %>
+
+<details>
+  <summary>Details</summary>
 
 <%= link['description'] %>
 
@@ -78,3 +82,5 @@ HTTP/1.1 <%=
 <%- end %>
 ```
 <%- end %>
+
+</details>

data/lib/prmd/templates/table_of_contents.erb

@@ -1,9 +1,11 @@
-# The table of contents
+<%- Prmd::Template.render('schemata/helper.erb', options[:template]) -%>
+## The table of contents
+
 <% schema['properties'].keys.sort.map do |key| %>
   <% resource, property = key, schema['properties'][key] %>
   <% _, schemata = schema.dereference(property) %>
-  - <a href="#resource-<%= resource %>"><%= schemata['title'].split(' - ', 2).last %></a>
+- <a href="#resource-<%= resource %>"><%= schemata['title'].split(' - ', 2).last %></a>
   <% schemata.fetch('links', []).each do |l| %>
-    - <a href="#link-<%= l['method'] %>-<%= resource %>-<%= l['href'] %>"><%= l['method'] %> <%= l['href'] %></a>
+  - <a href="#link-<%= l['method'] %>-<%= resource %>-<%= l['href'] %>"><%= l['method'] %> <%= build_link_path(schema, l) %></a>
   <% 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, 13, 0, nil
+    MAJOR, MINOR, TEENY, PATCH = 0, 14, 0, nil
     # version string
     # @return [String]
     STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze

data/prmd.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   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.3'
+  spec.add_development_dependency 'bundler',  '~> 2.0'
+  spec.add_development_dependency 'rake',     '>= 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.4'
 end

data/test/commands/render_test.rb

@@ -37,10 +37,10 @@ class InteragentRenderTest < Minitest::Test
     template = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib', 'prmd', 'templates'))
     markdown = Prmd.render(schema, template: template, doc: { toc: true })
 
-    assert_match /^# The table of contents/, markdown
+    assert_match /^## The table of contents/, markdown
     assert_match '<a href="#resource-app"', markdown
     assert_match '- <a href="#link-POST-app-/apps">POST /apps', markdown
-    assert_match '<a name="link-POST-app-/apps"', markdown
+    assert_match '<a name="link-POST-app-/apps"></a>', markdown
   end
 
   def test_render_for_example_as_an_array
@@ -50,6 +50,12 @@ class InteragentRenderTest < Minitest::Test
     assert_match expression, markdown
   end
 
+  def test_render_for_regex_patterns_with_pipes
+    expression = /<pre>\(\^first\$&#x7c;\^second\$\)<\/pre> \| \`"second"\` \|\n/
+    markdown = render
+    assert_match expression, markdown
+  end
+
   private
 
   def data
@@ -113,6 +119,12 @@ class InteragentRenderTest < Minitest::Test
               'example' => 'OPTION2',
               'enum' => 'OPTION2'
             },
+            'patterned-string' => {
+              'description' => 'A string with a regex pattern applied to it.',
+              'type' => 'string',
+              'example' => 'second',
+              'pattern' => '(^first$|^second$)'
+            },
             'option1' => {
               'properties' => {
                 'type' => {
@@ -175,7 +187,10 @@ class InteragentRenderTest < Minitest::Test
             },
             'options' => {
               '$ref' => '#/definitions/config-var/definitions/options'
-            }
+            },
+            'patterned-string' => {
+              '$ref' => '#/definitions/config-var/definitions/patterned-string'
+            },
           }
         }
       },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -211,8 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: JSON Schema tooling