prmd 0.6.2 → 0.7.0

data/test/helpers.rb

@@ -1,11 +1,66 @@
-require "minitest"
-require "minitest/autorun"
-require "prmd"
+require 'minitest'
+require 'minitest/autorun'
+require 'prmd'
+require 'prmd/cli/base'
 
-def input_schemas_path
-  @@data_path ||= File.join(File.dirname(__FILE__), 'schemata', 'input')
+module Prmd
+  module CLI
+    module Base
+      # silence noop_execute
+      def noop_execute(options = {})
+        options
+      end
+    end
+  end
+end
+
+module CliBaseTestHelpers
+  def argv_for_test_run
+    []
+  end
+
+  def options_for_test_run
+    { }
+  end
+
+  def validate_parse_options(options)
+    #
+  end
+
+  def validate_run_options(options)
+    assert_equal options[:noop], true
+    validate_parse_options options
+  end
+
+  def command_module
+    #
+  end
+
+  def test_make_parser
+    parser = command_module.make_parser
+    assert_kind_of OptionParser, parser
+  end
+
+  def test_parse_options
+    opts = command_module.parse_options(argv_for_test_run, options_for_test_run)
+
+    validate_parse_options opts
+  end
+
+  def test_run
+    opts = command_module.run(argv_for_test_run,
+                              options_for_test_run.merge(noop: true))
+
+    validate_run_options opts
+  end
+end
+
+def input_schemas_path(*args)
+  @data_path ||= File.expand_path(File.join(*args),
+                                  File.join(File.dirname(__FILE__),
+                                            'schemata/input'))
 end
 
 def user_input_schema
-  @@user_input_schema ||= Prmd.combine(File.join(input_schemas_path, 'user.json'))
+  @user_input_schema ||= Prmd.combine(input_schemas_path('user.json'))
 end

data/test/schema_test.rb

@@ -2,33 +2,39 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'helpers'))
 
 class SchemaTest < Minitest::Test
   def test_dereference_with_ref
-    key, value = user_input_schema.dereference({
+    key, value = user_input_schema.dereference(
       '$ref' => '#/definitions/user/definitions/id'
-    })
+    )
     assert_equal(key,   '#/definitions/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
+    user_id = user_input_schema['definitions']['user']['definitions']['id']
+    assert_equal(value, user_id)
   end
 
   def test_dereference_without_ref
-    key, value = user_input_schema.dereference('#/definitions/user/definitions/id')
+    key, value = user_input_schema.dereference(
+      '#/definitions/user/definitions/id'
+    )
     assert_equal(key,   '#/definitions/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
+    user_id = user_input_schema['definitions']['user']['definitions']['id']
+    assert_equal(value, user_id)
   end
 
   def test_dereference_with_nested_ref
-    key, value = user_input_schema.dereference({
+    key, value = user_input_schema.dereference(
       '$ref' => '#/definitions/user/definitions/identity'
-    })
+    )
     assert_equal(key,   '#/definitions/user/definitions/id')
-    assert_equal(value, user_input_schema['definitions']['user']['definitions']['id'])
+    user_id = user_input_schema['definitions']['user']['definitions']['id']
+    assert_equal(value, user_id)
   end
 
   def test_dereference_with_local_context
-    key, value = user_input_schema.dereference({
+    key, value = user_input_schema.dereference(
       '$ref'     => '#/definitions/user/properties/id',
       'override' => true
-    })
+    )
     assert_equal(key,   '#/definitions/user/definitions/id')
-    assert_equal(value, {'override' => true}.merge(user_input_schema['definitions']['user']['definitions']['id']))
+    user_id = user_input_schema['definitions']['user']['definitions']['id']
+    assert_equal(value, { 'override' => true }.merge(user_id))
   end
 end

data/test/schemata/input/doc-settings.json

@@ -0,0 +1,4 @@
+{
+  // don't ask, its just for testing
+  "content_type": "application/bread"
+}

metadata

@@ -1,85 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: json_schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.2'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.2'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.4'
 description: scaffold, verify and generate docs from JSON Schema
 email:
 - geemus@gmail.com
@@ -88,8 +94,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -100,28 +106,59 @@ files:
 - bin/prmd
 - docs/schemata.md
 - lib/prmd.rb
+- lib/prmd/cli.rb
+- lib/prmd/cli/base.rb
+- lib/prmd/cli/combine.rb
+- lib/prmd/cli/doc.rb
+- lib/prmd/cli/generate.rb
+- lib/prmd/cli/render.rb
+- lib/prmd/cli/verify.rb
+- lib/prmd/commands.rb
 - lib/prmd/commands/combine.rb
-- lib/prmd/commands/expand.rb
 - lib/prmd/commands/init.rb
 - lib/prmd/commands/render.rb
 - lib/prmd/commands/verify.rb
+- lib/prmd/core/combiner.rb
+- lib/prmd/core/generator.rb
+- lib/prmd/core/renderer.rb
+- lib/prmd/core/schema_hash.rb
+- lib/prmd/core_ext/optparse.rb
+- lib/prmd/hash_helpers.rb
+- lib/prmd/load_schema_file.rb
+- lib/prmd/rake_tasks/base.rb
+- lib/prmd/rake_tasks/combine.rb
+- lib/prmd/rake_tasks/doc.rb
+- lib/prmd/rake_tasks/verify.rb
 - lib/prmd/schema.rb
 - lib/prmd/template.rb
-- lib/prmd/templates/link_schema_properties.erb
+- lib/prmd/templates/combine_head.json
+- lib/prmd/templates/init_default.json
+- lib/prmd/templates/init_resource.json.erb
+- lib/prmd/templates/link_schema_properties.md.erb
 - lib/prmd/templates/schema.erb
-- lib/prmd/templates/schemata.erb
+- lib/prmd/templates/schemata.md.erb
 - lib/prmd/templates/schemata/helper.erb
-- lib/prmd/templates/schemata/link.erb
-- lib/prmd/templates/schemata/link_curl_example.erb
+- lib/prmd/templates/schemata/link.md.erb
+- lib/prmd/templates/schemata/link_curl_example.md.erb
 - lib/prmd/url_generator.rb
+- lib/prmd/url_generators/generators/default.rb
+- lib/prmd/url_generators/generators/json.rb
 - lib/prmd/version.rb
 - prmd.gemspec
 - schemas/hyper-schema.json
 - schemas/interagent-hyper-schema.json
 - schemas/schema.json
+- test/cli/combine_test.rb
+- test/cli/doc_test.rb
+- test/cli/generate_test.rb
+- test/cli/render_test.rb
+- test/cli/verify_test.rb
+- test/commands/init_test.rb
+- test/commands/render_test.rb
 - test/commands/verify_test.rb
 - test/helpers.rb
 - test/schema_test.rb
+- test/schemata/input/doc-settings.json
 - test/schemata/input/meta.json
 - test/schemata/input/user.json
 homepage: https://github.com/heroku/prmd
@@ -134,23 +171,31 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: JSON Schema tooling
 test_files:
+- test/cli/combine_test.rb
+- test/cli/doc_test.rb
+- test/cli/generate_test.rb
+- test/cli/render_test.rb
+- test/cli/verify_test.rb
+- test/commands/init_test.rb
+- test/commands/render_test.rb
 - test/commands/verify_test.rb
 - test/helpers.rb
 - test/schema_test.rb
+- test/schemata/input/doc-settings.json
 - test/schemata/input/meta.json
 - test/schemata/input/user.json

data/lib/prmd/commands/expand.rb

@@ -1,108 +0,0 @@
-original = {
-  'description' => 'A foo is bar.',
-  'id'          => 'schema/foo',
-  'title'       => 'API - Foo',
-
-  'definitions' => {
-    'created-at' => {
-      'description' => 'when foo was created',
-      'format'      => 'date-time'
-    },
-    'email' => {
-      'description' => 'email for foo',
-      'format'      => 'email'
-    },
-    'id' => {
-      'description' => 'unique identifier for foo',
-      'format'      => 'uuid'
-    },
-    'updated-at' => {
-      'description' => 'when foo was created',
-      'format'      => 'date-time',
-      'type'        => ['null', 'string']
-    }
-  }
-}
-expanded = original.dup
-
-expanded = {
-  '$schema'     => 'http://json-schema.org/draft-04/hyper-schema',
-  'definitions' => {},
-  'links'       => [],
-  'properties'  => {},
-  'type'        => ['object']
-}.merge!(expanded)
-
-if original['definitions']
-  original['definitions'].each do |key, value|
-    default = case value['format']
-    when 'uuid'
-      {
-        'example'   => '01234567-89ab-cdef-0123-456789abcdef',
-        'type'      => ['string']
-      }
-    when 'email'
-      {
-        'example'   => 'username@example.com',
-        'type'      => ['string']
-      }
-    when 'date-time'
-      {
-        'example'   => '2012-01-01T12:00:00Z',
-        'type'      => ['string']
-      }
-    else
-      {}
-    end
-    expanded['definitions'][key] = default.merge!(value)
-  end
-end
-
-if original['links']
-  original['links'].each do |key, value|
-    default = case value['title']
-    when 'Create'
-      {
-        'method'  => 'POST',
-        'rel'     => 'create'
-      }
-    when 'Delete'
-      {
-        'method'  => 'DELETE',
-        'rel'     => 'delete'
-      }
-    when 'Info'
-      {
-        'method'  => 'GET',
-        'rel'     => 'self'
-      }
-    when 'List'
-      {
-        'method'  => 'GET',
-        'rel'     => 'instances'
-      }
-    when 'Update'
-      {
-        'method'  => 'PATCH',
-        'rel'     => 'update'
-      }
-    end
-    expanded = original['links'][key] = default.merge!(value)
-  end
-end
-
-
-#require 'json'
-#require 'pp'
-
-#puts
-
-#puts original_json = JSON.pretty_generate(original)
-#puts original_json.split("\n").length
-
-#puts
-
-#puts expanded_json = JSON.pretty_generate(expanded)
-#puts expanded_json.split("\n").length
-
-#puts