prmd 0.11.9 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf244e4467c2fade05c42fc6eb2bff364124fc27
-  data.tar.gz: 6926f672aed9899c68285bec8781bb2f8f789295
+SHA256:
+  metadata.gz: 7d549096116bdd614f84c9956e2de37d34d09721c8d67be4d189beab98787934
+  data.tar.gz: ecbd1909e6258876c49165bfdaaab02a6fcd99397bdd7470ec6b033c99381113
 SHA512:
-  metadata.gz: e8a2a5ee7f81121f96ba3f467929dc2d75c756611689909e6d2e8829cf31009683423b178bff4497d629de2917ad6256c36c6473862bbbef45b6fff4d4b11103
-  data.tar.gz: caab74ead784edd5adaaa34af492a16efef66c4acc9ae5839b296fa3932611c87cbdbc955dbe75ae4914d576f74d1ed4ce11665778e3c299cded3540ba77730b
+  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/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

@@ -42,7 +42,7 @@ Each attribute MUST include the following properties:
 Each attribute MAY include the following properties:
 
 * `pattern` - a javascript regex encoded in a string that the valid values MUST match
-* `format` - format of the value. MUST be one of spec defined `["date-time", "email", "hostname", "ipv4", "ipv6", "uri"]` or defined by us `["uuid"]`
+* `format` - format of the value. MUST be one of spec defined `["date", "date-time", "email", "hostname", "ipv4", "ipv6", "uri"]` or defined by us `["uuid"]`
 
 Examples:
 
@@ -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",
@@ -138,6 +143,7 @@ Links that expect a custom http header MUST include the following attributes:
       },
       "title":        "Update"
     }
+  ]
 }
 ```
 

data/lib/prmd.rb

@@ -3,6 +3,7 @@ require_relative 'prmd/load_schema_file'
 require_relative 'prmd/commands'
 require_relative 'prmd/schema'
 require_relative 'prmd/link'
+require_relative 'prmd/utils'
 require_relative 'prmd/template'
 require_relative 'prmd/url_generator'
 require_relative 'prmd/hash_helpers'

data/lib/prmd/cli/base.rb

@@ -33,8 +33,8 @@ module Prmd
       # @param [Array<String>] argv
       # @return [Array<String>] remaining arguments
       # @private
-      def execute_parser(parser, argv)
-        parser.parse(argv)
+      def execute_parser(argv)
+        @parser.parse(argv)
       end
 
       # Set the given key and value in the given options Hash.
@@ -66,10 +66,10 @@ module Prmd
       # @return [Hash<Symbol, Object>] parsed options
       def parse_options(argv, options = {})
         opts = {}
-        parser = make_parser(options) do |key, value|
+        @parser = make_parser(options) do |key, value|
           set_option(opts, key, value)
         end
-        argv = execute_parser(parser, argv)
+        argv = execute_parser(argv)
         opts[:argv] = argv
         opts
       end

data/lib/prmd/cli/combine.rb

@@ -22,6 +22,9 @@ module Prmd
           opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
             yield :output_file, n
           end
+          opts.on('-t', '--type-as-string', 'Allow type as string') do |t|
+            options[:type_as_string] = t
+          end
         end
       end
 
@@ -30,7 +33,8 @@ module Prmd
       # @example Usage
       #   Prmd::CLI::Combine.execute(argv: ['schema/schemata/api'],
       #                              meta: 'schema/meta.json',
-      #                              output_file: 'schema/api.json')
+      #                              output_file: 'schema/api.json',
+      #                              type-as-string)
       #
       # @param (see Prmd::CLI::Base#execute)
       # @return (see Prmd::CLI::Base#execute)

data/lib/prmd/cli/generate.rb

@@ -1,5 +1,6 @@
 require_relative 'base'
 require_relative '../commands/init'
+require_relative '../utils'
 
 module Prmd
   module CLI
@@ -40,7 +41,11 @@ module Prmd
       # @return (see Prmd::CLI::Base#execute)
       def self.execute(options = {})
         name = options.fetch(:argv).first
-        write_result Prmd.init(name, options), options
+        if Prmd::Utils.blank?(name)
+          abort @parser
+        else
+          write_result Prmd.init(name, options), options
+        end
       end
     end
   end

data/lib/prmd/commands/combine.rb

@@ -32,8 +32,7 @@ module Prmd
       end
       files.flatten!
       files.delete(options[:meta])
-      # sort by name without extension for stable order
-      files.sort_by {|file| file.split('.', 2).first}
+      files
     end
 
     # @api private
@@ -64,7 +63,8 @@ module Prmd
     # @return (see .load_files)
     def self.load_schemas(paths, options = {})
       files = crawl_map(paths, options)
-      schemata = load_files(files, options)
+      # sort for stable loading across platforms
+      schemata = load_files(files.sort, options)
       handle_faulty_load(schemata, files) unless options[:faulty_load]
       schemata
     end
@@ -119,7 +119,7 @@ module Prmd
         end
         meta ||= {}
       end
-      combiner = Prmd::Combiner.new(meta: meta, base: base, schema: schema)
+      combiner = Prmd::Combiner.new(meta: meta, base: base, schema: schema, options: options)
       combiner.combine(*schemata)
     end
 

data/lib/prmd/core/combiner.rb

@@ -13,6 +13,7 @@ module Prmd
       @schema = properties.fetch(:schema)
       @base = properties.fetch(:base, {})
       @meta = properties.fetch(:meta, {})
+      @options = properties.fetch(:options, {})
     end
 
     # @param [Object] datum
@@ -53,7 +54,7 @@ module Prmd
         reference_localizer(data['definitions'][id_ary])
       end
 
-      Prmd::Schema.new(data)
+      Prmd::Schema.new(data, @options)
     end
 
     private :reference_localizer

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

@@ -5,6 +5,7 @@ require 'prmd/url_generator'
 require 'prmd/template'
 require 'prmd/schema'
 require 'prmd/link'
+require_relative '../hash_helpers'
 
 # :nodoc:
 module Prmd
@@ -21,6 +22,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)
@@ -32,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

@@ -10,6 +10,7 @@ module Prmd
     "number"  => 42.0,
     "string"  => "example",
 
+    "date"      => "2015-01-01",
     "date-time" => "2015-01-01T12:00:00Z",
     "email"     => "username@example.com",
     "hostname"  => "example.com",
@@ -24,24 +25,28 @@ module Prmd
     attr_reader :data
 
     # @param [Hash<String, Object>] new_data
-    def initialize(new_data = {})
-      @data = convert_type_to_array(new_data)
+    def initialize(new_data = {}, options = {})
+      @data = convert_type_to_array(new_data, options)
       @schemata_examples = {}
     end
 
     #
     # @param [Object] datum
     # @return [Object] same type as the input object
-    def convert_type_to_array(datum)
+    def convert_type_to_array(datum, options)
       case datum
       when Array
-        datum.map { |element| convert_type_to_array(element) }
+        datum.map { |element| convert_type_to_array(element, options) }
       when Hash
-        if datum.key?('type') && datum['type'].is_a?(String)
+        if datum.key?('type') && datum['type'].is_a?(String) && !options[:type_as_string]
           datum['type'] = [*datum['type']]
         end
         datum.each_with_object({}) do |(k, v), hash|
-          hash[k] = convert_type_to_array(v)
+          if k != 'example'
+            hash[k] = convert_type_to_array(v, options)
+          else
+            hash[k] = v
+          end
         end
       else
         datum
@@ -113,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,7 +1,16 @@
+<%- 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])
 
-  schema['properties'].map do |resource, property|
+  schema['properties'].keys.sort.map do |key|
+    resource, property = key, schema['properties'][key]
     begin
       _, schemata = schema.dereference(property)
       schemata_template.result({

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

@@ -81,7 +81,8 @@
 
   def extract_schemata_refs(schema, properties)
     ret = []
-    properties.each do |_, value|
+    properties.keys.sort.each do |key|
+      value = properties[key]
       ref, value = schema.dereference(value)
       if value['properties']
         refs = extract_schemata_refs(schema, value['properties'])
@@ -136,7 +137,10 @@
     end
 
     if value['pattern']
-      description += "<br/> **pattern:** `#{value['pattern'].gsub /\|/, '&#124;'}`"
+      # 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']
@@ -174,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
 
@@ -182,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,8 +3,12 @@
   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'] %>"></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

@@ -0,0 +1,11 @@
+<%- 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>
+  <% schemata.fetch('links', []).each do |l| %>
+  - <a href="#link-<%= l['method'] %>-<%= resource %>-<%= l['href'] %>"><%= l['method'] %> <%= build_link_path(schema, l) %></a>
+  <% end %>
+<% end %>

data/lib/prmd/utils.rb

@@ -0,0 +1,19 @@
+module Prmd
+  # For any tid bits, or core extension methods, without the "core" extension
+  module Utils
+    # For checking if the string contains only spaces
+    BLANK_REGEX = /\A\s+\z/
+
+    def self.blank?(obj)
+      if obj.nil?
+        true
+      elsif obj.is_a?(String)
+        obj.empty? || !!(obj =~ BLANK_REGEX)
+      elsif obj.respond_to?(:empty?)
+        obj.empty?
+      else
+        false
+      end
+    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, 11, 9, 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/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"
                         }
                     },
@@ -90,10 +90,6 @@
                 {
                     "required": ["example", "type"]
                 },
-                {
-                    "required": ["type"],
-                    "type": ["array"]
-                },
                 {
                     "required": ["type"],
                     "type": ["object"]

data/test/cli/combine_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 require 'prmd/cli/combine'
 
 class PrmdCliCombineTest < Minitest::Test

data/test/cli/doc_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 require 'prmd/cli/doc'
 
 class PrmdCliDocTest < Minitest::Test

data/test/cli/generate_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 require 'prmd/cli/generate'
 
 class PrmdCliGenerateTest < Minitest::Test

data/test/cli/render_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 require 'prmd/cli/render'
 
 class PrmdCliRenderTest < Minitest::Test

data/test/cli/verify_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 require 'prmd/cli/verify'
 
 class PrmdCliVerifyTest < Minitest::Test

data/test/commands/combine_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 
 require 'json_pointer'
 

data/test/commands/init_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 
 class PrmdInitTest < Minitest::Test
   def test_init

data/test/commands/render_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 
 require 'json_pointer'
 
@@ -6,7 +6,7 @@ class InteragentRenderTest < Minitest::Test
   def test_render_for_valid_schema
     markdown = render
 
-    assert_match /An app in our PaaS ecosystem./, markdown
+    assert_match(/An app in our PaaS ecosystem./, markdown)
   end
 
   def test_render_for_schema_with_property_defined_with_anyOf
@@ -21,18 +21,27 @@ class InteragentRenderTest < Minitest::Test
       }
     })
     markdown = render
-    assert_match /version.*v10\.9\.rc1/, markdown
+    assert_match(/version.*v10\.9\.rc1/, markdown)
   end
 
 
   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"></a>', markdown
+  end
 
   def test_render_for_example_as_an_array
     # matches -d '[{...}]' taking into account line breaks and spacing
@@ -41,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
@@ -95,37 +110,43 @@ class InteragentRenderTest < Minitest::Test
               'example'     => 'example'
             },
             'option-type1' => {
-              'type' => 'string', 
-              'example' => 'OPTION1', 
-              'enum' => 'OPTION1'                   
+              'type' => 'string',
+              'example' => 'OPTION1',
+              'enum' => 'OPTION1'
             },
             'option-type2' => {
-              'type' => 'string', 
+              'type' => 'string',
               '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' => {
-                    '$ref' => '#/definitions/config-var/definitions/option-type1'    
+                    '$ref' => '#/definitions/config-var/definitions/option-type1'
                 }
               }
             },
             'option2' => {
               'properties' => {
                 'type' => {
-                    '$ref' => '#/definitions/config-var/definitions/option-type2'    
+                    '$ref' => '#/definitions/config-var/definitions/option-type2'
                 }
               }
             },
-            'options' => {                      
+            'options' => {
               'items' => {
                 'example'=> 'CHOICE1',
                 'oneOf' => [
-                  { 
+                  {
                     '$ref' => '#/definitions/config-var/definitions/option1'
                   },
-                  { 
+                  {
                    '$ref' => '#/definitions/config-var/definitions/option2'
                   }
                 ]
@@ -166,7 +187,10 @@ class InteragentRenderTest < Minitest::Test
             },
             'options' => {
               '$ref' => '#/definitions/config-var/definitions/options'
-            }
+            },
+            'patterned-string' => {
+              '$ref' => '#/definitions/config-var/definitions/patterned-string'
+            },
           }
         }
       },

data/test/commands/verify_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helpers'))
+require_relative '../helpers'
 
 require 'json_pointer'
 

data/test/core/reference_localizer_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helpers', File.dirname(__FILE__))
+require_relative '../helpers'
 
 module Prmd
   class ReferenceLocalizerTest < Minitest::Test

data/test/link_test.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '.', 'helpers'))
+require_relative 'helpers'
+
 module Prmd
   class LinkTest < MiniTest::Test
     include PrmdLinkTestHelpers
@@ -22,7 +23,7 @@ module Prmd
       {
         title: "multiple_nested_required" ,
         optional: {"user:name" => "string"},
-        required: {"user:email" => "string", 
+        required: {"user:email" => "string",
                    "address:street" => "string",
                    "address:zip" => "string"}
       }

data/test/multi_loader/common.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helpers', File.dirname(__FILE__))
+require_relative '../helpers'
 
 module PrmdLoaderTests
   # @abstrac

data/test/multi_loader/json_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('common', File.dirname(__FILE__))
+require_relative 'common'
 require 'prmd/multi_loader/json'
 
 class PrmdMultiLoaderJsonTest < Minitest::Test

data/test/multi_loader/toml_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('common', File.dirname(__FILE__))
+require_relative 'common'
 begin
   require 'prmd/multi_loader/toml'
 rescue LoadError

data/test/multi_loader/yajl_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('common', File.dirname(__FILE__))
+require_relative 'common'
 begin
   require 'prmd/multi_loader/yajl'
 rescue LoadError

data/test/multi_loader/yaml_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('common', File.dirname(__FILE__))
+require_relative 'common'
 require 'prmd/multi_loader/yaml'
 
 class PrmdMultiLoaderYamlTest < Minitest::Test

data/test/rake_tasks/combine_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helpers', File.dirname(__FILE__))
+require_relative '../helpers'
 require 'prmd/rake_tasks/combine'
 require 'rake'
 

data/test/rake_tasks/doc_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helpers', File.dirname(__FILE__))
+require_relative '../helpers'
 require 'prmd/rake_tasks/doc'
 require 'rake'
 

data/test/rake_tasks/verify_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../helpers', File.dirname(__FILE__))
+require_relative '../helpers'
 require 'prmd/rake_tasks/verify'
 require 'rake'
 

data/test/schema_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helpers'))
+require_relative 'helpers'
 
 class SchemaTest < Minitest::Test
   def test_dereference_with_ref

data/test/utils_test.rb

@@ -0,0 +1,16 @@
+require_relative 'helpers'
+
+class UtilsTest < Minitest::Test
+  def test_blank?
+    assert_equal true, Prmd::Utils.blank?(nil)
+    assert_equal true, Prmd::Utils.blank?([])
+    assert_equal true, Prmd::Utils.blank?({})
+    assert_equal true, Prmd::Utils.blank?("")
+    assert_equal true, Prmd::Utils.blank?(" ")
+    assert_equal true, Prmd::Utils.blank?("       ")
+    assert_equal false, Prmd::Utils.blank?([nil])
+    assert_equal false, Prmd::Utils.blank?({ a: nil })
+    assert_equal false, Prmd::Utils.blank?("A")
+    assert_equal false, Prmd::Utils.blank?(Object.new)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.11.9
+  version: 0.14.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 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
@@ -149,9 +149,11 @@ 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
+- lib/prmd/utils.rb
 - lib/prmd/version.rb
 - prmd.gemspec
 - schemas/hyper-schema.json
@@ -189,6 +191,7 @@ files:
 - test/schemata/input/rake_doc.json
 - test/schemata/input/rake_verify.json
 - test/schemata/input/user.json
+- test/utils_test.rb
 homepage: https://github.com/heroku/prmd
 licenses:
 - MIT
@@ -208,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
@@ -246,3 +248,4 @@ test_files:
 - test/schemata/input/rake_doc.json
 - test/schemata/input/rake_verify.json
 - test/schemata/input/user.json
+- test/utils_test.rb