json-schema_builder 0.0.1

data/lib/json/schema_builder/schema.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+module JSON
+  module SchemaBuilder
+    class Schema < OpenStruct
+      def merge(schema)
+        self.class.new to_h.deep_merge schema.to_h
+      end
+
+      def merge!(schema)
+        @table = to_h.deep_merge schema.to_h
+        self
+      end
+    end
+  end
+end

data/lib/json/schema_builder/string.rb

@@ -0,0 +1,12 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class String < Entity
+      register :string
+      attribute :min_length
+      attribute :max_length
+      attribute :pattern
+    end
+  end
+end

data/lib/json/schema_builder/version.rb

@@ -0,0 +1,5 @@
+module JSON
+  module SchemaBuilder
+    VERSION = '0.0.1'
+  end
+end

data/spec/integration/entity_literals_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe Examples::EntityLiterals, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :object,
+        required: [:one],
+        properties: {
+          one: {
+            enum: [:string, :null]
+          },
+          two: {
+            allOf: [
+              { type: :integer, minimum: 1 },
+              { type: :string }
+            ]
+          },
+          three: {
+            anyOf: [
+              { type: :integer, minimum: 1 },
+              { type: :null }
+            ]
+          },
+          four: {
+            not: {
+              type: :null
+            }
+          },
+          five: {
+            oneOf: [
+              { type: :string },
+              { type: :number }
+            ]
+          }
+        }
+      }
+    end
+  end
+end

data/spec/integration/mixed_arrays_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe Examples::MixedArrays, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :array,
+        items: {
+          type: :array,
+          items: [{ }, { }],
+          additionalItems: false
+        }
+      }
+    end
+  end
+end

data/spec/integration/schema_builder_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Examples::SchemaBuilder, type: :integration do
+  types = %w(array boolean integer null number object string)
+
+  types.each do |type|
+    describe "##{ type }" do
+      let(:klass){ "JSON::SchemaBuilder::#{ type.classify }".constantize }
+
+      it "should register #{ type } type" do
+        expect(subject.types[type.to_sym]).to be klass
+      end
+
+      it "should define a #{ type } method" do
+        expect(subject).to respond_to type.to_sym
+      end
+    end
+  end
+end

data/spec/integration/terse_arrays_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Examples::TerseArrays, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :array,
+        uniqueItems: true,
+        items: {
+          type: :string,
+          minLength: 1,
+          maxLength: 5,
+          pattern: '^test'
+        }
+      }
+    end
+  end
+end

data/spec/integration/terse_objects_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe Examples::TerseObjects, 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
+                }
+              }
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/spec/integration/verbose_arrays_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Examples::VerboseArrays, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :array,
+        uniqueItems: true,
+        items: {
+          type: :string,
+          minLength: 1,
+          maxLength: 5,
+          pattern: '^test'
+        }
+      }
+    end
+  end
+end

data/spec/integration/verbose_objects_spec.rb

@@ -0,0 +1,30 @@
+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
+                }
+              }
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'pry'
+%w(lib spec/support).each do |path|
+  Dir["./#{ path }/**/*.rb"].sort.each{ |file| require file }
+end
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec/its'
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.include IntegrationHelper, type: :integration
+end

data/spec/support/attribute_matcher.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec::Matchers.define :define_attribute do |attribute|
+  match do |entity_klass|
+    entity = entity_klass.new 'entity'
+    entity.respond_to?(attribute) &&
+    entity.respond_to?("#{ attribute }=")
+  end
+
+  failure_message do |entity_klass|
+    "#{ entity_klass.class } does not define attribute #{ attribute.inspect }"
+  end
+
+  failure_message_when_negated do |entity_klass|
+    "#{ entity_klass.class } does define attribute #{ attribute.inspect }"
+  end
+end

data/spec/support/examples/entity_literals.rb

@@ -0,0 +1,33 @@
+module Examples
+  class EntityLiterals
+    include JSON::SchemaBuilder
+
+    def example
+      object do
+        entity 'one', required: true do
+          enum [:string, :null]
+        end
+
+        entity 'two' do
+          all_of positive_int, string
+        end
+
+        entity 'three' do
+          any_of [positive_int, null]
+        end
+
+        entity 'four' do
+          not_a null
+        end
+
+        entity 'five' do
+          one_of string, number
+        end
+      end
+    end
+
+    def positive_int
+      integer minimum: 1
+    end
+  end
+end

data/spec/support/examples/mixed_arrays.rb

@@ -0,0 +1,14 @@
+module Examples
+  class MixedArrays
+    include JSON::SchemaBuilder
+
+    def example
+      array do
+        items type: :array do
+          items [{ }, { }]
+          additional_items false
+        end
+      end
+    end
+  end
+end

data/spec/support/examples/schema_builder.rb

@@ -0,0 +1,5 @@
+module Examples
+  class SchemaBuilder
+    include JSON::SchemaBuilder
+  end
+end

data/spec/support/examples/terse_arrays.rb

@@ -0,0 +1,11 @@
+module Examples
+  class TerseArrays
+    include JSON::SchemaBuilder
+
+    def example
+      array unique_items: true do
+        items type: :string, min_length: 1, max_length: 5, pattern: '^test'
+      end
+    end
+  end
+end

data/spec/support/examples/terse_objects.rb

@@ -0,0 +1,16 @@
+module Examples
+  class TerseObjects
+    include JSON::SchemaBuilder
+
+    def example
+      object do
+        string :name, min_length: 1
+        array :ids, min_items: 1 do
+          items type: :object do
+            integer :id, required: true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/examples/verbose_arrays.rb

@@ -0,0 +1,19 @@
+module Examples
+  class VerboseArrays
+    include JSON::SchemaBuilder
+
+    def example
+      array do
+        unique_items true
+
+        items do
+          string do
+            min_length 1
+            max_length 5
+            pattern '^test'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/examples/verbose_objects.rb

@@ -0,0 +1,24 @@
+module Examples
+  class VerboseObjects
+    include JSON::SchemaBuilder
+
+    def example
+      object do
+        string :name do
+          min_length 1
+        end
+
+        array :ids do
+          min_items 1
+
+          items do
+            object do
+              required :id
+              integer :id
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/integration_helper.rb

@@ -0,0 +1,12 @@
+module IntegrationHelper
+  extend RSpec::SharedContext
+  let(:schema){ described_class.new.example }
+  let(:json){ schema.as_json }
+  let(:expected_json){ { } }
+
+  RSpec.shared_examples_for 'a builder' do
+    it 'should produce the correct json schema' do
+      expect(json).to eql expected_json.as_json
+    end
+  end
+end

data/spec/support/shared_contexts_for_entity.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.shared_context 'an entity' do
+  let(:klass) do
+    Class.new JSON::SchemaBuilder::Entity do
+      attribute :test
+      attribute :test_name
+      attribute :test_list, array: true
+      attribute :test_as, as: :testOther
+      def initialize(*args); end
+    end
+  end
+
+  subject{ klass.new }
+end
+
+RSpec.shared_context 'an entity with a parent' do
+  let(:parent){ OpenStruct.new children: [], required: [] }
+  subject do
+    JSON::SchemaBuilder::Entity.new 'name', title: 'test', parent: parent do
+      schema.evaluated_block = true
+    end
+  end
+end

data/spec/support/shared_examples_for_numeric.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+RSpec.shared_examples_for 'a numeric entity' do
+  subject{ described_class }
+  it{ is_expected.to define_attribute :multiple_of }
+  it{ is_expected.to define_attribute :minimum }
+  it{ is_expected.to define_attribute :maximum }
+  it{ is_expected.to define_attribute :exclusive_minimum }
+  it{ is_expected.to define_attribute :exclusive_maximum }
+end

data/spec/unit/array_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe JSON::SchemaBuilder::Array, type: :unit do
+  subject{ described_class }
+
+  it{ is_expected.to define_attribute :additional_items }
+  it{ is_expected.to define_attribute :min_items }
+  it{ is_expected.to define_attribute :max_items }
+  it{ is_expected.to define_attribute :unique_items }
+  its(:registered_type){ is_expected.to eql :array }
+
+  describe '#items' do
+    context 'with a simple array' do
+      let(:array) do
+        described_class.new 'name' do
+          min_items 2
+          items type: :string do
+            min_length 3
+          end
+        end
+      end
+
+      subject{ array.as_json }
+      its(['type']){ is_expected.to eql 'array' }
+      its(['minItems']){ is_expected.to eql 2 }
+      its(['items']){ is_expected.to eql 'type' => 'string', 'minLength' => 3 }
+    end
+
+    context 'with nested structure' do
+      let(:array) do
+        described_class.new 'name' do
+          items do
+            object do
+              string :key_name, required: true
+            end
+          end
+        end
+      end
+
+      subject{ array.as_json }
+      its(['type']){ is_expected.to eql 'array' }
+
+      describe 'items' do
+        subject{ array.as_json['items'] }
+        its(['type']){ is_expected.to eql 'object' }
+        its(['required']){ is_expected.to eql ['key_name'] }
+
+        describe "items['properties']" do
+          subject{ array.as_json['items']['properties'] }
+          its(['key_name']){ is_expected.to eql 'type' => 'string' }
+        end
+      end
+    end
+  end
+end