json-schema_builder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e166709b6daba83a54ba1774b1bbae0207b8480
-  data.tar.gz: 0af74a28bd06737381ad31e8aae3ca5f94c692f9
+  metadata.gz: 4f5b78c7099bde185d4a86c992f62027591989dc
+  data.tar.gz: 62ab154f7d358f6192203cd46859d13bbdc92c9b
 SHA512:
-  metadata.gz: 9750809f3276af4d79e4eae367efbaa2a4434e25d8c07d788ab9b778569f6bf3e84581432e7890f990e53245a87c354c3a24f05ff44cf78c4a7ffca377f8556a
-  data.tar.gz: 79fbfcccad68fb29152e13886c169895ae0499ca5f6253f4cd45c6b13ec8ef28200b9eb966f69bf7e3c7c6de5d5a1574f60141cac5e374f8317ba2ebd6595496
+  metadata.gz: c12f9f064e511bf3b49ff204202be34464ea51050758f58d7ad841adf1f6f336ed9aae5f80b50f9b587273bd05878b1762e8dff12679803ff5f1901c333055f5
+  data.tar.gz: 4a410940b32b0b3b87560f3932b64e744ce792b016328a3614a9456ccd1152e7014b14371639485036045289d8cfb90da966b052aefaa6b7a8b650f2ff8eadfd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json-schema_builder (0.0.3)
+    json-schema_builder (0.0.4)
       activesupport (~> 4.0, = 4.2.0.rc2)
       json-schema (~> 2.5)
 

data/lib/json/schema_builder.rb

@@ -16,6 +16,9 @@ module JSON
 
     included do |klass|
       extend JSON::SchemaBuilder::Configuration
+      class << self
+        attr_accessor :root_key
+      end
     end
 
     def self.default_options
@@ -27,5 +30,18 @@ module JSON
         instance_variable_set "@#{ key }", value
       end
     end
+
+    def root(key = nil, &block)
+      root_key = key || self.class.root_key.to_sym
+      object do
+        object root_key, required: true, &block
+      end
+    end
+
+    module ClassMethods
+      def root(key)
+        @root_key = key
+      end
+    end
   end
 end

data/lib/json/schema_builder/rspec.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+require_relative 'rspec_helper/deep_open_struct'
+require_relative 'rspec_helper/rspec_helper'

data/lib/json/schema_builder/rspec_helper/deep_open_struct.rb

@@ -0,0 +1,38 @@
+module JSON
+  module SchemaBuilder
+    module RSpecHelper
+      class DeepOpenStruct < OpenStruct
+        def initialize(hash = { })
+          @table = { }
+          hash.each_pair do |key, value|
+            key = key.to_sym
+            @table[key] = _transform value
+            new_ostruct_member key
+          end
+        end
+
+        def ==(other)
+          to_h == other.to_h
+        end
+        alias_method :eql?, :==
+
+        def inspect
+          to_h.inspect
+        end
+
+        private
+
+        def _transform(object)
+          case object
+          when Hash
+            DeepOpenStruct.new object
+          when Array
+            object.map{ |item| _transform item }
+          else
+            object
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/rspec_helper/rspec_helper.rb

@@ -0,0 +1,31 @@
+module JSON
+  module SchemaBuilder
+    module RSpecHelper
+      extend ::RSpec::SharedContext
+      let(:schema_method){ raise 'undefined schema method' }
+      let(:schema_context){ { } }
+      let(:schema){ described_class.new(schema_context).send schema_method }
+      let(:json){ schema.as_json }
+      subject{ DeepOpenStruct.new json }
+
+      def self.included(klass)
+        super klass
+        klass.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def with(key, &block)
+          describe ".#{ key }" do
+            eval "def subject; super.#{ key }; end"
+
+            it 'should return an entity' do
+              expect(schema).to be_a JSON::SchemaBuilder::Entity
+            end
+
+            instance_exec &block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/version.rb

@@ -1,5 +1,5 @@
 module JSON
   module SchemaBuilder
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/spec/integration/context_delegation_spec.rb

@@ -1,43 +1,47 @@
 require 'spec_helper'
 
 RSpec.describe Examples::ContextDelegation, type: :integration do
-  context 'with an admin' do
-    it_behaves_like 'a builder' do
-      let(:schema_context) do
-        {
-          user: Examples::ContextDelegation::User.new(role: :admin)
-        }
-      end
+  [:example, :alternate_example].each do |method_name|
+    context 'with an admin' do
+      it_behaves_like 'a builder' do
+        let(:schema_method){ method_name }
+        let(:schema_context) do
+          {
+            user: Examples::ContextDelegation::User.new(role: :admin)
+          }
+        end
 
-      let(:expected_json) do
-        {
-          type: :object,
-          additionalProperties: false,
-          properties: {
-            name: { type: :string },
-            role: { type: :string }
+        let(:expected_json) do
+          {
+            type: :object,
+            additionalProperties: false,
+            properties: {
+              name: { type: :string },
+              role: { type: :string }
+            }
           }
-        }
+        end
       end
     end
-  end
 
-  context 'with a user' do
-    it_behaves_like 'a builder' do
-      let(:schema_context) do
-        {
-          user: Examples::ContextDelegation::User.new(role: :user)
-        }
-      end
+    context 'with a user' do
+      it_behaves_like 'a builder' do
+        let(:schema_method){ method_name }
+        let(:schema_context) do
+          {
+            user: Examples::ContextDelegation::User.new(role: :user)
+          }
+        end
 
-      let(:expected_json) do
-        {
-          type: :object,
-          additionalProperties: false,
-          properties: {
-            name: { type: :string }
+        let(:expected_json) do
+          {
+            type: :object,
+            additionalProperties: false,
+            properties: {
+              name: { type: :string }
+            }
           }
-        }
+        end
       end
     end
   end

data/spec/integration/rooted_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe Examples::Rooted, type: :integration do
+  context 'with a root key' do
+    it_behaves_like 'a builder' do
+      let(:expected_json) do
+        {
+          type: :object,
+          required: [:rooted],
+          properties: {
+            rooted: {
+              type: :object,
+              properties: {
+                name: { type: :string }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+
+  context 'with an alternate root key' do
+    it_behaves_like 'a builder' do
+      let(:schema_method){ :alternate_root }
+      let(:expected_json) do
+        {
+          type: :object,
+          required: [:other_root],
+          properties: {
+            other_root: {
+              type: :object,
+              properties: {
+                name: { type: :string }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/spec/integration/verbose_objects_spec.rb

@@ -1,30 +1,22 @@
 require 'spec_helper'
 
 RSpec.describe Examples::VerboseObjects, type: :integration do
-  it_behaves_like 'a builder' do
-    let(:expected_json) do
-      {
-        type: :object,
-        properties: {
-          name: {
-            type: :string,
-            minLength: 1
-          },
-          ids: {
-            type: :array,
-            minItems: 1,
-            items: {
-              type: :object,
-              required: [:id],
-              properties: {
-                id: {
-                  type: :integer
-                }
-              }
-            }
-          }
-        }
-      }
+  include JSON::SchemaBuilder::RSpecHelper
+  let(:schema_method){ :example }
+  its(:type){ is_expected.to eql 'object' }
+
+  with :properties do
+    its(:name){ is_expected.to eql type: 'string', minLength: 1 }
+
+    with :ids do
+      its(:type){ is_expected.to eql 'array' }
+      its(:minItems){ is_expected.to eql 1 }
+
+      with :items do
+        its(:type){ is_expected.to eql 'object' }
+        its(:required){ is_expected.to eql ['id'] }
+        its('properties.id.type'){ is_expected.to eql 'integer' }
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'pry'
 require 'simplecov'
 SimpleCov.configure do
+  add_filter '/lib/json/schema_builder/rspec_helper'
   add_filter '/spec'
 end
 

data/spec/support/examples/context_delegation.rb

@@ -1,6 +1,7 @@
 module Examples
   class ContextDelegation
     include JSON::SchemaBuilder
+    attr_accessor :user
     delegate :admin?, to: :@user
 
     def example
@@ -10,6 +11,13 @@ module Examples
       end
     end
 
+    def alternate_example
+      object additional_properties: false do
+        string :name
+        string :role if user.admin?
+      end
+    end
+
     class User < OpenStruct
       def admin?
         role == :admin

data/spec/support/examples/rooted.rb

@@ -0,0 +1,19 @@
+module Examples
+  class Rooted
+    include JSON::SchemaBuilder
+
+    root :rooted
+
+    def example
+      root do
+        string :name
+      end
+    end
+
+    def alternate_root
+      root :other_root do
+        string :name
+      end
+    end
+  end
+end

data/spec/support/integration_helper.rb

@@ -1,7 +1,8 @@
 module IntegrationHelper
   extend RSpec::SharedContext
   let(:schema_context){ { } }
-  let(:schema){ described_class.new(schema_context).example }
+  let(:schema_method){ :example }
+  let(:schema){ described_class.new(schema_context).send schema_method }
   let(:json){ schema.as_json }
   let(:expected_json){ { } }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Michael Parrish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,9 @@ files:
 - lib/json/schema_builder/number.rb
 - lib/json/schema_builder/numeric.rb
 - lib/json/schema_builder/object.rb
+- lib/json/schema_builder/rspec.rb
+- lib/json/schema_builder/rspec_helper/deep_open_struct.rb
+- lib/json/schema_builder/rspec_helper/rspec_helper.rb
 - lib/json/schema_builder/schema.rb
 - lib/json/schema_builder/string.rb
 - lib/json/schema_builder/validation.rb
@@ -166,6 +169,7 @@ files:
 - spec/integration/mixed_arrays_spec.rb
 - spec/integration/mixed_objects_spec.rb
 - spec/integration/object_definitions_spec.rb
+- spec/integration/rooted_spec.rb
 - spec/integration/schema_builder_spec.rb
 - spec/integration/terse_arrays_spec.rb
 - spec/integration/terse_objects_spec.rb
@@ -180,6 +184,7 @@ files:
 - spec/support/examples/mixed_arrays.rb
 - spec/support/examples/mixed_objects.rb
 - spec/support/examples/object_definitions.rb
+- spec/support/examples/rooted.rb
 - spec/support/examples/schema_builder.rb
 - spec/support/examples/terse_arrays.rb
 - spec/support/examples/terse_objects.rb
@@ -229,6 +234,7 @@ test_files:
 - spec/integration/mixed_arrays_spec.rb
 - spec/integration/mixed_objects_spec.rb
 - spec/integration/object_definitions_spec.rb
+- spec/integration/rooted_spec.rb
 - spec/integration/schema_builder_spec.rb
 - spec/integration/terse_arrays_spec.rb
 - spec/integration/terse_objects_spec.rb
@@ -243,6 +249,7 @@ test_files:
 - spec/support/examples/mixed_arrays.rb
 - spec/support/examples/mixed_objects.rb
 - spec/support/examples/object_definitions.rb
+- spec/support/examples/rooted.rb
 - spec/support/examples/schema_builder.rb
 - spec/support/examples/terse_arrays.rb
 - spec/support/examples/terse_objects.rb