prmd 0.11.4 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37247187ebe2f63d0ae1420104e88476ddae1a4a
-  data.tar.gz: d6cc52e9d913ff0a2751b56830954f46e5134598
+  metadata.gz: 573ad3e1fa10e064ea941c603c154006bac1b82a
+  data.tar.gz: c7d39916a98b4cea871768fdfada42654ca59112
 SHA512:
-  metadata.gz: 1fb29d50c819e7046eec3797d4f3e8dbe06bdd013eb2937ffd3387f23cbf8c9f73a68713d75cb3d9f5a61b79857d69084542fb0b79b9fd298a4fdb96e588bb5a
-  data.tar.gz: fb55e50632b5414bde83ac978189f5ec673285d69d8c8615afe6b84da1b0620ce1984cbeb31b73d11566cdda18a697a29fc6d0a5ebddc5ad41d50ec8eb066105
+  metadata.gz: 9de89fa807a0528ddbe07ceac525b45eb75738246f682a0120ae76b79b3cb204502a805afa4d786defff9856302efa93746f1535430f163c2f5702e803293c1a
+  data.tar.gz: 752b8909cd8c3d050c628378f9c4a06486711a339d129eb63fa2b894fed00a543b99a8aabcb5131b64ffba96912cdf3fae8bf580affbcbb25cb478eba8655b7c

data/.travis.yml

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

data/lib/prmd/commands/combine.rb

@@ -69,13 +69,43 @@ module Prmd
       schemata
     end
 
+    # Escape '#' and '/' in 'href' keys. They need to be escaped in JSON schema,
+    # but to make it easier to write JSON schema with Prmd, those two characters
+    # are escaped automatically when they appear between '{()}'.
+    # See https://github.com/interagent/prmd/issues/106.
+    #
+    # @api private
+    # @param [Array<SchemaHash>] schema hashes
+    # @return [Array<SchemaHash>] schema hashes
+    def self.escape_hrefs(data)
+      if data.is_a? Array
+        data.map! {
+          |x| escape_hrefs(x)
+        }
+      elsif data.is_a? Hash
+        data.each { |k,v|
+          if k == 'href'
+            if v.is_a? String
+              v = v.gsub(/\{\(.*?\)\}/) { |x|
+                x.gsub('#', '%23').gsub('/', '%2F')
+              }
+            end
+          else
+            v = escape_hrefs(v)
+          end
+          data[k] = v
+        }
+      end
+      data
+    end
+
     # Merges all found schema files in the given paths into a single Schema
     #
     # @param [Array<String>] paths
     # @param [Hash<Symbol, Object>] options
     # @return (see Prmd::Combiner#combine)
     def self.combine(paths, options = {})
-      schemata = load_schemas(paths)
+      schemata = escape_hrefs(load_schemas(paths))
       base = Prmd::Template.load_json('combine_head.json')
       schema = base['$schema']
       meta = {}
@@ -99,6 +129,7 @@ module Prmd
       private :load_schema_hash
       private :load_files
       private :load_schemas
+      private :escape_hrefs
     end
   end
 

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

@@ -9,7 +9,11 @@
   title = schemata['title'].split(' - ', 2).last
 -%>
 <%- unless options[:doc][:disable_title_and_description] %>
-## <a name="resource-<%= resource %>"></a><%= title %>
+## <a name="resource-<%= resource %>"><%= title %></a>
+
+<%- if schemata['stability'] && !schemata['stability'].empty? %>
+Stability: `<%= schemata['stability'] %>`
+<%- end -%>
 
 <%= schemata['description'] %>
 <%- end -%>

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

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

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

data/test/commands/combine_test.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+
+require 'json_pointer'
+
+class InteragentHyperSchemaCombineTest < Minitest::Test
+
+  #
+  # resource link readable href
+  #
+
+  def test_resource_link_href_escaping
+    pointer('#/definitions/app/links/0').merge!({
+      'href' => '/apps/{(#/definitions/app)}'
+    })
+    assert_equal "/apps/{(%23%2Fdefinitions%2Fapp)}", escaped_href
+  end
+
+  def test_resource_link_href_no_double_escaping
+    pointer('#/definitions/app/links/0').merge!({
+      'href' => '/apps/{(%23%2Fdefinitions%2Fapp)}'
+    })
+    assert_equal "/apps/{(%23%2Fdefinitions%2Fapp)}", escaped_href
+  end
+
+  def test_resource_link_href_no_side_effects
+    pointer('#/definitions/app/links/0').merge!({
+      'href' => '/apps/foo#bar'
+    })
+    assert_equal "/apps/foo#bar", escaped_href
+  end
+
+  private
+
+  def data
+    @data ||= {
+      '$schema'     => 'http://interagent.github.io/interagent-hyper-schema',
+      'description' => 'My simple example API.',
+      'id'          => 'http://example.com/schema',
+      'title'       => 'Example API',
+      'definitions' => {
+        'app' => {
+          'description' => 'An app in our PaaS ecosystem.',
+          'title' => 'App',
+          'type' => 'object',
+          'definitions' => {},
+          'links' => [
+            {
+              'description' => 'Create a new app.',
+              'href' => '/apps',
+              'method' => 'POST',
+              'rel' => 'create',
+              'title' => 'Create App'
+            }
+          ],
+          'properties' => {
+          }
+        }
+      },
+      'links' => [],
+      'properties' => {},
+      'type' => 'object'
+    }
+  end
+
+  def pointer(path)
+    JsonPointer.evaluate(data, path)
+  end
+
+  def escaped_href
+    escaped = Prmd::Combine.__send__(:escape_hrefs, data)
+    escaped["definitions"]["app"]["links"][0]["href"]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.5
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -162,6 +162,7 @@ files:
 - test/cli/generate_test.rb
 - test/cli/render_test.rb
 - test/cli/verify_test.rb
+- test/commands/combine_test.rb
 - test/commands/init_test.rb
 - test/commands/render_test.rb
 - test/commands/verify_test.rb
@@ -208,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JSON Schema tooling
@@ -218,6 +219,7 @@ test_files:
 - test/cli/generate_test.rb
 - test/cli/render_test.rb
 - test/cli/verify_test.rb
+- test/commands/combine_test.rb
 - test/commands/init_test.rb
 - test/commands/render_test.rb
 - test/commands/verify_test.rb
@@ -244,4 +246,3 @@ test_files:
 - test/schemata/input/rake_doc.json
 - test/schemata/input/rake_verify.json
 - test/schemata/input/user.json
-has_rdoc: