prmd 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1010706b78a9b6d770bb52a5a3bc0dd40cbb516
-  data.tar.gz: 0c6021aedeb0bbeaee1af485ffdddcb7c4a83ec5
+  metadata.gz: 906209c8a327e103f1392faff3f4c7a35caac7b9
+  data.tar.gz: 42fbce50f4e8477a1a5c1607521b49101a37b349
 SHA512:
-  metadata.gz: 812720e3b67bcf3f524a545364129751e4b87afb10dc67c74aaf586f6d18f5de644eaa20852bbe68017439004a3a6571eb4230dee4222221344c243a1ad26c99
-  data.tar.gz: 442813d217485037daf7aa7a9854c99ec76ddd6371f4d0945c69a9d0000812a232a6b8e8acc6d793f8a4a94952f41335c83a39fd4b592cda212e9526fd5cdc81
+  metadata.gz: 1b246f23874af73656586f681cc2002ce8f37ba313ec128dc17ae4ee84814b641fd6bd42fd05007d4f040a289276b8be1fe7167990f6041b43c66ea2009339fb
+  data.tar.gz: 7bb6505cccc8df5313a2fd1b87411feac21ac4e7f126046be329a3a0d52e7bcd7f58428f66b8295c3583d5892d63b4f6b74c98499873031e8971f3cac302cede

data/README.md

@@ -129,7 +129,8 @@ Available options (and their defaults)
 {
   "doc": {
     "url_style": "default", // can also be "json"
-    "disable_title_and_description": false // remove the title and the description, useful when using your own custom header
+    "disable_title_and_description": false, // remove the title and the description, useful when using your own custom header
+    "toc": false // insert the table of content for json scheme documentation to the top of the file. (default disable)
   }
 }
 ```

data/docs/schemata.md

@@ -138,6 +138,7 @@ Links that expect a custom http header MUST include the following attributes:
       },
       "title":        "Update"
     }
+  ]
 }
 ```
 

data/lib/prmd/core/renderer.rb

@@ -28,7 +28,8 @@ module Prmd
     def append_default_options(options)
       options[:doc] = {
         url_style: 'default',
-        disable_title_and_description: false
+        disable_title_and_description: false,
+        toc: false
       }.merge(options[:doc])
     end
 

data/lib/prmd/rake_tasks/doc.rb

@@ -21,6 +21,8 @@ module Prmd
       # @return [Array<String>, Hash<String, String>] list of files
       attr_accessor :files
 
+      attr_accessor :toc
+
       # Creates a new task with name +name+.
       #
       # @overload initialize(name)

data/lib/prmd/templates/schema.erb

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

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

@@ -137,7 +137,7 @@
     end
 
     if value['pattern']
-      description += "<br/> **pattern:** `#{value['pattern'].gsub /\|/, '&#124;'}`"
+      description += "<br/> **pattern:** `#{value['pattern']}`"
     end
 
     if value['minLength'] || value['maxLength']

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

@@ -3,7 +3,7 @@
   response_example = link['response_example']
   link_schema_properties_template = Prmd::Template.load_template('link_schema_properties.md.erb', options[:template])
 -%>
-### <%= title %> <%= link['title'] %>
+### <a name="link-<%= link['method'] %>-<%= resource %>-<%= link['href'] %>"><%= title %> <%= link['title'] %></a>
 
 <%= link['description'] %>
 

data/lib/prmd/templates/table_of_contents.erb

@@ -0,0 +1,9 @@
+# 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>
+  <% schemata.fetch('links', []).each do |l| %>
+    - <a href="#link-<%= l['method'] %>-<%= resource %>-<%= l['href'] %>"><%= l['method'] %> <%= l['href'] %></a>
+  <% 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, 12, 0, nil
+    MAJOR, MINOR, TEENY, PATCH = 0, 13, 0, nil
     # version string
     # @return [String]
     STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze

data/schemas/interagent-hyper-schema.json

@@ -66,7 +66,7 @@
                 },
                 "properties": {
                     "patternProperties": {
-                        "^[a-z][a-zA-Z_]*[a-zA-Z]$": {
+                        "^[a-z0-9][a-zA-Z0-9_]*[a-zA-Z0-9]$": {
                             "$ref": "#/definitions/resourceProperty"
                         }
                     },

data/test/commands/render_test.rb

@@ -28,11 +28,20 @@ class InteragentRenderTest < Minitest::Test
   def test_render_for_schema_with_property_defined_with_oneOf
     markdown = render
 
-   assert_match(/\*\*options\/\[OPTION1\]\.type\*\*/, markdown)
-   assert_match(/\*\*options\/\[OPTION2\]\.type\*\*/, markdown)
+    assert_match(/\*\*options\/\[OPTION1\]\.type\*\*/, markdown)
+    assert_match(/\*\*options\/\[OPTION2\]\.type\*\*/, markdown)
   end
 
+  def test_render_for_toc
+    schema = Prmd::Schema.new(data)
+    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 '<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
+  end
 
   def test_render_for_example_as_an_array
     # matches -d '[{...}]' taking into account line breaks and spacing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -149,6 +149,7 @@ files:
 - lib/prmd/templates/schemata/helper.erb
 - lib/prmd/templates/schemata/link.md.erb
 - lib/prmd/templates/schemata/link_curl_example.md.erb
+- lib/prmd/templates/table_of_contents.erb
 - lib/prmd/url_generator.rb
 - lib/prmd/url_generators/generators/default.rb
 - lib/prmd/url_generators/generators/json.rb