prmd 0.7.0 → 0.7.1

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

data/test/commands/render_test.rb

@@ -25,6 +25,13 @@ class InteragentRenderTest < Minitest::Test
     assert_match /version.*v10\.9\.rc1/, markdown
   end
 
+  def test_render_for_example_as_an_array
+    # matches -d '[{...}]' taking into account line breaks and spacing
+    expression = /-d '\[[\s\n]+\{[\n\s]+\"name\": \"EXAMPLE\",[\n\s]+\"value\": \"example\"[\s\n]+\}[\n\s]+\]/
+    markdown = render
+    assert_match expression, markdown
+  end
+
   private
 
   def data
@@ -62,6 +69,56 @@ class InteragentRenderTest < Minitest::Test
           ],
           'properties' => {
           }
+        },
+        'config-var' => {
+          'description' => 'A configuration variable for an app.',
+          'title' => 'Config-var',
+          'type' => 'object',
+          'definitions' => {
+            'name' => {
+              'description' => 'The config-var\'s name.',
+              'type'        => 'string',
+              'example'     => 'EXAMPLE'
+            },
+            'value' => {
+              'description' => 'The config-var\'s value.',
+              'type'        => 'string',
+              'example'     => 'example'
+            },
+          },
+          'links' => [
+            {
+              'description' => 'Create many config-vars.',
+              'href' => '/config-vars',
+              'method' => 'PATCH',
+              'rel' => 'instances',
+              'title' => 'Create Config-var',
+              'schema' => {
+                'type' => [
+                  'array'
+                ],
+                'items' => {
+                  'name' => {
+                    '$ref' => '#/definitions/config-var/definitions/name'
+                  },
+                  'value' => {
+                    '$ref' => '#/definitions/config-var/definitions/value'
+                  },
+                  'example' => [
+                    { 'name' => 'EXAMPLE', 'value' => 'example' }
+                  ]
+                }
+              }
+            }
+          ],
+          'properties' => {
+            'name' => {
+              '$ref' => '#/definitions/config-var/definitions/name'
+            },
+            'value' => {
+              '$ref' => '#/definitions/config-var/definitions/value'
+            }
+          }
         }
       },
       'links' => [
@@ -73,6 +130,9 @@ class InteragentRenderTest < Minitest::Test
       'properties' => {
         'app' => {
           '$ref' => '#/definitions/app'
+        },
+        'config-var' => {
+          '$ref' => '#/definitions/config-var'
         }
       },
       'type' => 'object'

data/test/core/reference_localizer_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../helpers', File.dirname(__FILE__))
+
+module Prmd
+  class ReferenceLocalizerTest < Minitest::Test
+    def base_object
+      {
+        "type" => ["object"],
+        "properties" => {
+          "name" => {
+            "type" => ["nil", "string"],
+            "example" => "john",
+          },
+          "age" => {
+            "type" => ["nil", "number"],
+            "example" => 37,
+          },
+        },
+      }
+    end
+
+    def test_no_references
+      object = base_object
+      assert_equal object, ReferenceLocalizer.localize(object)
+    end
+
+    def test_simple_ref
+      object = base_object.merge(
+        "properties" => base_object["properties"].merge(
+          "name" => { "$ref" => "#/attributes/definitions/name" },
+        ),
+      )
+
+      new_object = ReferenceLocalizer.localize(object)
+      assert_equal "#/definitions/attributes/definitions/name",
+                   new_object["properties"]["name"]["$ref"]
+    end
+
+    def test_simple_href
+      object = base_object.merge("href" => "%23%2Fschemata%2Fhello%2Fworld")
+      new_object = ReferenceLocalizer.localize(object)
+      assert_equal "%23%2Fdefinitions%2Fhello%2Fworld", new_object["href"]
+
+      object = base_object.merge("href" => "%23%2Fhello%2Fworld")
+      new_object = ReferenceLocalizer.localize(object)
+      assert_equal "%2Fhello%2Fworld", new_object["href"]
+    end
+
+    def test_aliases
+      object = base_object.merge(
+        "properties" => base_object["properties"].merge(
+          "name" => { "$ref" => "#/attributes/definitions/name" },
+        ),
+      )
+      object["properties"]["translated_name"] = object["properties"]["name"]
+
+      new_object = ReferenceLocalizer.localize(object)
+
+      assert_equal "#/definitions/attributes/definitions/name",
+                   new_object["properties"]["name"]["$ref"]
+
+      assert_equal "#/definitions/attributes/definitions/name",
+                   new_object["properties"]["translated_name"]["$ref"]
+    end
+  end
+end

data/test/helpers.rb

@@ -55,10 +55,32 @@ module CliBaseTestHelpers
   end
 end
 
+module PrmdTestHelpers
+  module Paths
+    def self.schemas(*args)
+      File.join(File.expand_path('schemata', File.dirname(__FILE__)), *args)
+    end
+
+    def self.input_schemas(*args)
+      schemas('input', *args)
+    end
+
+    def self.output_schemas(*args)
+      schemas('output', *args)
+    end
+  end
+end
+
+def schemas_path(*args)
+  PrmdTestHelpers::Paths.schemas(*args)
+end
+
 def input_schemas_path(*args)
-  @data_path ||= File.expand_path(File.join(*args),
-                                  File.join(File.dirname(__FILE__),
-                                            'schemata/input'))
+  PrmdTestHelpers::Paths.input_schemas(*args)
+end
+
+def output_schemas_path(*args)
+  PrmdTestHelpers::Paths.output_schemas(*args)
 end
 
 def user_input_schema

data/test/multi_loader/common.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../helpers', File.dirname(__FILE__))
+
+module PrmdLoaderTests
+  # @abstrac
+  def testing_filename
+    #
+  end
+
+  # @abstract
+  def loader_module
+    #
+  end
+
+  def assert_test_data(data)
+    assert_kind_of Hash, data
+    assert_equal 'yes', data['test']
+    assert_kind_of Hash, data['object']
+    assert_equal 'Object', data['object']['is_a']
+  end
+
+  def test_load_data
+    data = File.read(testing_filename)
+    assert_test_data loader_module.load_data(data)
+  end
+
+  def test_load_stream
+    File.open(testing_filename, 'r') do |f|
+      assert_test_data loader_module.load_stream(f)
+    end
+  end
+
+  def test_load_file
+    assert_test_data loader_module.load_file(testing_filename)
+  end
+end

data/test/multi_loader/json_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('common', File.dirname(__FILE__))
+require 'prmd/multi_loader/json'
+
+class PrmdMultiLoaderJsonTest < Minitest::Test
+  include PrmdLoaderTests
+
+  def loader_module
+    Prmd::MultiLoader::Json
+  end
+
+  def testing_filename
+    schemas_path('data/test.json')
+  end
+end

data/test/multi_loader/toml_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path('common', File.dirname(__FILE__))
+begin
+  require 'prmd/multi_loader/toml'
+rescue LoadError
+  #
+end
+
+class PrmdMultiLoaderTomlTest < Minitest::Test
+  include PrmdLoaderTests
+
+  def loader_module
+    Prmd::MultiLoader::Toml
+  end
+
+  def testing_filename
+    schemas_path('data/test.toml')
+  end
+end if defined?(TOML)

data/test/multi_loader/yajl_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path('common', File.dirname(__FILE__))
+begin
+  require 'prmd/multi_loader/yajl'
+rescue LoadError
+  #
+end
+
+class PrmdMultiLoaderYajlTest < Minitest::Test
+  include PrmdLoaderTests
+
+  def loader_module
+    Prmd::MultiLoader::Yajl
+  end
+
+  def testing_filename
+    schemas_path('data/test.json')
+  end
+end if defined?(Yajl)

data/test/multi_loader/yaml_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('common', File.dirname(__FILE__))
+require 'prmd/multi_loader/yaml'
+
+class PrmdMultiLoaderYamlTest < Minitest::Test
+  include PrmdLoaderTests
+
+  def loader_module
+    Prmd::MultiLoader::Yaml
+  end
+
+  def testing_filename
+    schemas_path('data/test.yaml')
+  end
+end

data/test/rake_tasks/combine_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../helpers', File.dirname(__FILE__))
+require 'prmd/rake_tasks/combine'
+require 'rake'
+
+# due to the nature of these Rake Tests, this should not be executed in a
+# read-only filesystem or directory.
+class PrmdRakeTaskCombineTest < Minitest::Test
+  def test_define_wo_options
+    paths = [input_schemas_path('rake_combine')]
+    #output_file = output_schemas_path('rake_combine_with_options.json')
+    output_file = nil
+    File.delete(output_file) if File.exist?(output_file) if output_file
+    Prmd::RakeTasks::Combine.new do |t|
+      t.name = :combine_wo_options
+      t.options[:meta] = input_schemas_path('rake-meta.json')
+      t.paths.concat(paths)
+      t.output_file = output_file
+    end
+    Rake::Task['combine_wo_options'].invoke
+    assert File.exist?(output_file) if output_file
+  end
+
+  def test_define_with_options
+    paths = [input_schemas_path('rake_combine')]
+    #output_file = output_schemas_path('rake_combine_with_options.json')
+    output_file = nil
+    options = {
+      meta: input_schemas_path('rake-meta.json')
+    }
+    File.delete(output_file) if File.exist?(output_file) if output_file
+    Prmd::RakeTasks::Combine.new(name: :combine_with_options,
+                                 paths: paths,
+                                 output_file: output_file,
+                                 options: options)
+    Rake::Task['combine_with_options'].invoke
+    assert File.exist?(output_file) if output_file
+  end
+end

data/test/rake_tasks/doc_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../helpers', File.dirname(__FILE__))
+require 'prmd/rake_tasks/doc'
+require 'rake'
+
+# due to the nature of these Rake Tests, this should not be executed in a
+# read-only filesystem or directory.
+class PrmdRakeTaskDocTest < Minitest::Test
+  def test_define_wo_options
+    input_file = input_schemas_path('rake_doc.json')
+    #output_file = output_schemas_path('rake_doc_with_options.md')
+    output_file = nil
+    File.delete(output_file) if File.exist?(output_file) if output_file
+    Prmd::RakeTasks::Doc.new do |t|
+      t.name = :doc_wo_options
+      t.files = { input_file => output_file }
+    end
+    Rake::Task['doc_wo_options'].invoke
+    assert File.exist?(output_file) if output_file
+  end
+
+  def test_define_with_options
+    input_file = input_schemas_path('rake_doc.json')
+    #output_file = output_schemas_path('rake_doc_with_options.md')
+    output_file = nil
+    File.delete(output_file) if File.exist?(output_file) if output_file
+    Prmd::RakeTasks::Doc.new(name: :doc_with_options,
+                             files: { input_file => output_file })
+    Rake::Task['doc_with_options'].invoke
+    assert File.exist?(output_file) if output_file
+  end
+end

data/test/rake_tasks/verify_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../helpers', File.dirname(__FILE__))
+require 'prmd/rake_tasks/verify'
+require 'rake'
+
+# due to the nature of these Rake Tests, this should not be executed in a
+# read-only filesystem or directory.
+class PrmdRakeTaskVerifyTest < Minitest::Test
+  def test_define_wo_options
+    input_file = input_schemas_path('rake_verify.json')
+    Prmd::RakeTasks::Verify.new do |t|
+      t.name = :verify_wo_options
+      t.files = [input_file]
+    end
+    Rake::Task['verify_wo_options'].invoke
+  end
+
+  def test_define_with_options
+    input_file = input_schemas_path('rake_verify.json')
+    Prmd::RakeTasks::Verify.new(name: :verify_with_options,
+                                files: [input_file])
+    Rake::Task['verify_with_options'].invoke
+  end
+end

data/test/schemata/data/test.json

@@ -0,0 +1,6 @@
+{
+  "test": "yes",
+  "object": {
+    "is_a": "Object"
+  }
+}

data/test/schemata/data/test.toml

@@ -0,0 +1,4 @@
+test = "yes"
+
+[object]
+is_a = "Object"

data/test/schemata/data/test.yaml

@@ -0,0 +1,3 @@
+test: "yes"
+object:
+  is_a: "Object"

data/test/schemata/input/rake-meta.json

@@ -0,0 +1,9 @@
+{
+  "id": "rake_task_meta",
+  "title": "Rake Task Test",
+  "links": [{
+    "href": "https://prmd.rake_task_test.io",
+    "rel": "self"
+  }],
+  "description": "Testing schema for Prmd RakeTasks"
+}

data/test/schemata/input/rake_combine/post.json

@@ -0,0 +1,100 @@
+{
+  "$schema": "http://json-schema.org/draft-04/hyper-schema",
+  "title": "Post",
+  "definitions": {
+    "id": {
+      "description": "unique identifier of post",
+      "example": "01234567-89ab-cdef-0123-456789abcdef",
+      "format": "uuid",
+      "type": [
+        "string"
+      ]
+    },
+    "identity": {
+      "$ref": "/schemata/post#/definitions/id"
+    },
+    "created_at": {
+      "description": "when post was created",
+      "example": "2012-01-01T12:00:00Z",
+      "format": "date-time",
+      "type": [
+        "string"
+      ]
+    },
+    "updated_at": {
+      "description": "when post was updated",
+      "example": "2012-01-01T12:00:00Z",
+      "format": "date-time",
+      "type": [
+        "string"
+      ]
+    }
+  },
+  "description": "FIXME",
+  "links": [
+    {
+      "description": "Create a new post.",
+      "href": "/posts",
+      "method": "POST",
+      "rel": "create",
+      "schema": {
+        "properties": {
+        },
+        "type": [
+          "object"
+        ]
+      },
+      "title": "Create"
+    },
+    {
+      "description": "Delete an existing post.",
+      "href": "/posts/{(%2Fschemata%2Fpost%23%2Fdefinitions%2Fidentity)}",
+      "method": "DELETE",
+      "rel": "destroy",
+      "title": "Delete"
+    },
+    {
+      "description": "Info for existing post.",
+      "href": "/posts/{(%2Fschemata%2Fpost%23%2Fdefinitions%2Fidentity)}",
+      "method": "GET",
+      "rel": "self",
+      "title": "Info"
+    },
+    {
+      "description": "List existing posts.",
+      "href": "/posts",
+      "method": "GET",
+      "rel": "instances",
+      "title": "List"
+    },
+    {
+      "description": "Update an existing post.",
+      "href": "/posts/{(%2Fschemata%2Fpost%23%2Fdefinitions%2Fidentity)}",
+      "method": "PATCH",
+      "rel": "update",
+      "schema": {
+        "properties": {
+        },
+        "type": [
+          "object"
+        ]
+      },
+      "title": "Update"
+    }
+  ],
+  "properties": {
+    "created_at": {
+      "$ref": "/schemata/post#/definitions/created_at"
+    },
+    "id": {
+      "$ref": "/schemata/post#/definitions/id"
+    },
+    "updated_at": {
+      "$ref": "/schemata/post#/definitions/updated_at"
+    }
+  },
+  "type": [
+    "object"
+  ],
+  "id": "schemata/post"
+}