json-schema_builder 0.0.1

data/spec/unit/boolean_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Boolean, type: :unit do
+  subject{ described_class }
+  its(:registered_type){ is_expected.to eql :boolean }
+end

data/spec/unit/dsl_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::DSL, type: :unit do
+  let!(:klass) do
+    Class.new do
+      include JSON::SchemaBuilder::DSL
+      class_attribute :registered_type
+      register :something
+      def initialize(*args); end
+    end
+  end
+  let(:instance){ klass.new }
+
+  describe '.register' do
+    it 'should register the class' do
+      expect(subject.types).to have_key :something
+      expect(subject.types[:something]).to eql klass
+    end
+
+    it 'should store the registered type' do
+      expect(klass.registered_type).to eql :something
+    end
+
+    context 'with a type method' do
+      it 'should generate' do
+        expect(instance).to respond_to :something
+      end
+
+      it 'should dispatch to entity' do
+        expect(instance).to receive(:entity).with(:something, 1, foo: :bar).and_call_original
+        instance.something 1, foo: :bar
+      end
+
+      it 'should allow unnamed entities' do
+        expect(instance).to receive(:entity).with(:something, nil, foo: :bar).and_call_original
+        instance.something foo: :bar
+      end
+    end
+  end
+
+  describe '#entity' do
+    context 'without an entity' do
+      it 'should create the type' do
+        expect(instance.class).to receive(:new)
+          .with('name', { }).and_call_original
+
+        entity = instance.entity :something, 'name'
+        expect(entity).to be_a klass
+      end
+    end
+
+    context 'with an entity' do
+      let!(:klass) do
+        Class.new JSON::SchemaBuilder::Entity do
+          include JSON::SchemaBuilder::DSL
+          register :something
+          def initialize(*args); end
+        end
+      end
+
+      it 'should set the parent' do
+        expect(instance.class).to receive(:new)
+          .with('name', parent: kind_of(klass)).and_call_original
+
+        entity = instance.entity :something, 'name'
+        expect(entity).to be_a klass
+      end
+    end
+  end
+end

data/spec/unit/entity_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Entity, type: :unit do
+  subject{ described_class }
+
+  it{ is_expected.to define_attribute :title }
+  it{ is_expected.to define_attribute :description }
+  it{ is_expected.to define_attribute :type }
+  it{ is_expected.to define_attribute :enum }
+  it{ is_expected.to define_attribute :all_of }
+  it{ is_expected.to define_attribute :any_of }
+  it{ is_expected.to define_attribute :one_of }
+  it{ is_expected.to define_attribute :not_a }
+  it{ is_expected.to define_attribute :definitions }
+
+  describe '.attribute' do
+    include_context 'an entity'
+
+    it 'should define the attribute' do
+      expect(klass).to define_attribute :test
+    end
+
+    it 'should delegate the reader to the schema' do
+      subject.schema.test = 1
+      expect(subject.test).to eql 1
+    end
+
+    it 'should delegate the writer to the schema' do
+      subject.test = 1
+      expect(subject.schema.test).to eql 1
+    end
+
+    it 'should accept function-style writes' do
+      subject.test 1
+      expect(subject.test).to eql 1
+    end
+
+    it 'should snakeCase attribute reads' do
+      subject.schema.testName = 1
+      expect(subject.test_name).to eql 1
+    end
+
+    it 'should snakeCase attribute writes' do
+      subject.test_name = 1
+      expect(subject.schema.testName).to eql 1
+    end
+
+    it 'should handle array arguments' do
+      subject.test_list = [1, 2, 3]
+      expect(subject.schema.testList).to eql [1, 2, 3]
+    end
+
+    it 'should handle array argument lists' do
+      subject.test_list 1, 2, 3
+      expect(subject.schema.testList).to eql [1, 2, 3]
+    end
+
+    it 'should handle arbitrary key writes' do
+      subject.test_as 1
+      expect(subject.schema.testAs).to be_nil
+      expect(subject.schema.testOther).to eql 1
+    end
+
+    it 'should handle arbitrary key reads' do
+      subject.schema.testOther = 1
+      expect(subject.test_as).to eql 1
+    end
+  end
+
+  describe '#initialize' do
+    include_context 'an entity with a parent'
+
+    its(:name){ is_expected.to eql 'name' }
+    its(:title){ is_expected.to eql 'test' }
+    its(:parent){ is_expected.to eql parent }
+    its('schema.evaluated_block'){ is_expected.to be true }
+    its('parent.children'){ is_expected.to include subject }
+  end
+
+  describe '#required=' do
+    include_context 'an entity with a parent'
+
+    it 'should delegate to the parent entity' do
+      expect{
+        subject.required = 'name'
+      }.to change{
+        parent.required
+      }.to ['name']
+    end
+  end
+
+  describe '#merge_children!' do
+    include_context 'an entity with a parent'
+
+    let(:child_schema){ double 'JSON::SchemaBuilder::Schema' }
+    let(:child){ double 'JSON::SchemaBuilder::Entity', schema: child_schema }
+
+    it 'should merge children schemas' do
+      expect(child).to receive :schema
+      expect(subject).to receive(:children).and_return [child]
+      expect(subject.schema).to receive(:merge!).with child_schema
+      subject.merge_children!
+    end
+  end
+
+  describe '#as_json' do
+    include_context 'an entity'
+
+    it 'should delegate to schema' do
+      expect(subject.schema).to receive_message_chain :'to_h.as_json'
+      subject.as_json
+    end
+  end
+end

data/spec/unit/integer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Integer, type: :unit do
+  subject{ described_class }
+  it_behaves_like 'a numeric entity'
+  its(:registered_type){ is_expected.to eql :integer }
+end

data/spec/unit/null_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Null, type: :unit do
+  subject{ described_class }
+  its(:registered_type){ is_expected.to eql :null }
+end

data/spec/unit/number_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Number, type: :unit do
+  subject{ described_class }
+  it_behaves_like 'a numeric entity'
+  its(:registered_type){ is_expected.to eql :number }
+end

data/spec/unit/object_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Object, type: :unit do
+  subject{ described_class }
+
+  it{ is_expected.to define_attribute :required }
+  it{ is_expected.to define_attribute :min_properties }
+  it{ is_expected.to define_attribute :max_properties }
+  it{ is_expected.to define_attribute :properties }
+  it{ is_expected.to define_attribute :additional_properties }
+  it{ is_expected.to define_attribute :pattern_properties }
+  its(:registered_type){ is_expected.to eql :object }
+
+  describe '#initialize' do
+    subject do
+      described_class.new 'name' do
+        string :test1
+        string :test2
+      end
+    end
+
+    let(:string){ kind_of JSON::SchemaBuilder::String }
+    its(:children){ is_expected.to include string }
+    its('children.length'){ is_expected.to eql 2 }
+    its('properties'){ is_expected.to include test1: { 'type' => 'string' } }
+    its('properties'){ is_expected.to include test2: { 'type' => 'string' } }
+  end
+end

data/spec/unit/schema_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Schema, type: :unit do
+  let(:schema){ described_class.new a: 1, b: { c: 3 } }
+  let(:other){ described_class.new a: 2, b: { d: 4 } }
+  it{ is_expected.to be_a OpenStruct }
+
+  describe '#merge' do
+    it 'should deep merge' do
+      merged = schema.merge other
+      expect(merged).to be_a described_class
+      expect(merged.to_h).to eql a: 2, b: { c: 3, d: 4 }
+    end
+
+    it 'should not modify the source schema' do
+      expect{ schema.merge other }.to_not change{ schema.to_h }
+    end
+
+    it 'should not modify the merging schema' do
+      expect{ schema.merge other }.to_not change{ other.to_h }
+    end
+  end
+
+  describe '#merge!' do
+    it 'should deep merge in place' do
+      merged = schema.merge! other
+      expect(merged).to be_a described_class
+      expect(merged.to_h).to eql a: 2, b: { c: 3, d: 4 }
+    end
+
+    it 'should not modify the merging schema' do
+      expect{ schema.merge! other }.to_not change { other.to_h }
+    end
+  end
+end

data/spec/unit/string_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::String, type: :unit do
+  subject{ described_class }
+
+  it{ is_expected.to define_attribute :min_length }
+  it{ is_expected.to define_attribute :max_length }
+  it{ is_expected.to define_attribute :pattern }
+  its(:registered_type){ is_expected.to eql :string }
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: json-schema_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Parrish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0.rc2
+description: Build JSON schemas with Ruby
+email:
+- michael@zooniverse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-schema_builder.gemspec
+- lib/json/schema_builder.rb
+- lib/json/schema_builder/array.rb
+- lib/json/schema_builder/boolean.rb
+- lib/json/schema_builder/dsl.rb
+- lib/json/schema_builder/entity.rb
+- lib/json/schema_builder/integer.rb
+- lib/json/schema_builder/null.rb
+- lib/json/schema_builder/number.rb
+- lib/json/schema_builder/numeric.rb
+- lib/json/schema_builder/object.rb
+- lib/json/schema_builder/schema.rb
+- lib/json/schema_builder/string.rb
+- lib/json/schema_builder/version.rb
+- spec/integration/entity_literals_spec.rb
+- spec/integration/mixed_arrays_spec.rb
+- spec/integration/schema_builder_spec.rb
+- spec/integration/terse_arrays_spec.rb
+- spec/integration/terse_objects_spec.rb
+- spec/integration/verbose_arrays_spec.rb
+- spec/integration/verbose_objects_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep
+- spec/support/attribute_matcher.rb
+- spec/support/examples/entity_literals.rb
+- spec/support/examples/mixed_arrays.rb
+- spec/support/examples/schema_builder.rb
+- spec/support/examples/terse_arrays.rb
+- spec/support/examples/terse_objects.rb
+- spec/support/examples/verbose_arrays.rb
+- spec/support/examples/verbose_objects.rb
+- spec/support/integration_helper.rb
+- spec/support/shared_contexts_for_entity.rb
+- spec/support/shared_examples_for_numeric.rb
+- spec/unit/array_spec.rb
+- spec/unit/boolean_spec.rb
+- spec/unit/dsl_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/integer_spec.rb
+- spec/unit/null_spec.rb
+- spec/unit/number_spec.rb
+- spec/unit/object_spec.rb
+- spec/unit/schema_spec.rb
+- spec/unit/string_spec.rb
+homepage: https://github.com/parrish/json-schema_builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Build JSON schemas with Ruby
+test_files:
+- spec/integration/entity_literals_spec.rb
+- spec/integration/mixed_arrays_spec.rb
+- spec/integration/schema_builder_spec.rb
+- spec/integration/terse_arrays_spec.rb
+- spec/integration/terse_objects_spec.rb
+- spec/integration/verbose_arrays_spec.rb
+- spec/integration/verbose_objects_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep
+- spec/support/attribute_matcher.rb
+- spec/support/examples/entity_literals.rb
+- spec/support/examples/mixed_arrays.rb
+- spec/support/examples/schema_builder.rb
+- spec/support/examples/terse_arrays.rb
+- spec/support/examples/terse_objects.rb
+- spec/support/examples/verbose_arrays.rb
+- spec/support/examples/verbose_objects.rb
+- spec/support/integration_helper.rb
+- spec/support/shared_contexts_for_entity.rb
+- spec/support/shared_examples_for_numeric.rb
+- spec/unit/array_spec.rb
+- spec/unit/boolean_spec.rb
+- spec/unit/dsl_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/integer_spec.rb
+- spec/unit/null_spec.rb
+- spec/unit/number_spec.rb
+- spec/unit/object_spec.rb
+- spec/unit/schema_spec.rb
+- spec/unit/string_spec.rb