json-schema_builder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f90789d3f3f12de9b7b3ae15e7e33f6fb845f7c
-  data.tar.gz: 38984c38614450bea747ee03441add545c4d5bc0
+  metadata.gz: 082f36b316c2da4de5d21d907ed6cbf6f6856054
+  data.tar.gz: 9210568145ac172ce05396f3bb529b88e9aa82a1
 SHA512:
-  metadata.gz: 64e60e98e0c21a9dab31b5136e6712c9c2000c97d1f3545859228041b12b02c3d69e68c7a605dfa5c52a626450ef8e4f5acb028aa13ee097a691fad41c9cdba1
-  data.tar.gz: 9046c88b826c5227990fb3456f5b529d9674b50b58c6545fdd2e0e4083caee6067b675da1d2e97083c4b5efb8e62d1ed102f1eb1597a8836c03224f2d75b246d
+  metadata.gz: 92ea3b1d9739cd6f7eff349d5f67a2706a9897925089bf3ed4efcb39dae9b1a83d8b8dfafe21cfb1921f886fcd0a6e24b83792c12b6b1b23fd549519d754eea7
+  data.tar.gz: 9cf96de81566436992fa384ca0cf3be326956581d36b0beb4bd006776b5846047881e61d2521b628750f3406c0e1fd5d12c51b0ce13c3b4b84ecc706b115a980

data/.gitignore

@@ -1,2 +1,4 @@
 /.bundle/
+/pkg
+/coverage
 .DS_Store

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: rspec
+script: bundle exec rspec
 rvm:
 - 2.1.5
 addons:

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    json-schema_builder (0.0.1)
+    json-schema_builder (0.0.2)
       activesupport (~> 4.0, = 4.2.0.rc2)
+      json-schema (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +14,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    addressable (2.3.6)
     codeclimate-test-reporter (0.4.3)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
@@ -20,8 +22,10 @@ GEM
     docile (1.1.5)
     i18n (0.7.0.beta1)
     json (1.8.1)
+    json-schema (2.5.0)
+      addressable (~> 2.3)
     method_source (0.8.2)
-    minitest (5.4.3)
+    minitest (5.5.0)
     multi_json (1.10.1)
     pry (0.10.1)
       coderay (~> 1.1.0)

data/README.md

@@ -1,6 +1,10 @@
 # JSON::SchemaBuilder
 
-TODO: Write a gem description
+[![Code Climate](https://codeclimate.com/github/parrish/json-schema_builder/badges/gpa.svg)](https://codeclimate.com/github/parrish/json-schema_builder)
+[![Test Coverage](https://codeclimate.com/github/parrish/json-schema_builder/badges/coverage.svg)](https://codeclimate.com/github/parrish/json-schema_builder)
+[![Gem Version](https://badge.fury.io/rb/json-schema_builder.svg)](http://badge.fury.io/rb/json-schema_builder)
+
+Build JSON schemas with Ruby
 
 ## Installation
 

data/json-schema_builder.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'pry'
   spec.add_dependency 'activesupport', '~> 4.0', '4.2.0.rc2'
+  spec.add_dependency 'json-schema', '~> 2.5'
 end

data/lib/json/schema_builder/attribute.rb

@@ -0,0 +1,45 @@
+module JSON
+  module SchemaBuilder
+    module Attribute
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def attribute(name, as: nil, array: false)
+          attr = as || snakeize(name)
+          define_method name do |*values|
+            if array
+              _array_attr attr, values.flatten
+            else
+              _attr attr, values.first
+            end
+          end
+          alias_method "#{ name }=", name
+        end
+
+        protected
+
+        def snakeize(str)
+          str.to_s.underscore.gsub(/_(\w)/){ $1.upcase }
+        end
+      end
+
+      protected
+
+      def _array_attr(attr, values)
+        if values.empty?
+          self.schema[attr]
+        else
+          self.schema[attr] = values
+        end
+      end
+
+      def _attr(attr, value)
+        if value.nil?
+          self.schema[attr]
+        else
+          self.schema[attr] = value
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/configuration.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+module JSON
+  module SchemaBuilder
+    module Configuration
+      def options
+        return @options if @options
+        defaults = JSON::SchemaBuilder.default_options
+        @options = OpenStruct.new defaults.to_h
+      end
+
+      def options=(config)
+        @options = OpenStruct.new config.to_h
+      end
+
+      def configure
+        @options = nil
+        yield(options) if block_given?
+      end
+    end
+  end
+end

data/lib/json/schema_builder/dsl.rb

@@ -7,12 +7,20 @@ module JSON
       def entity(*args, &block)
         opts = args.extract_options!
         klass, name = klass_and_name_from args
-        opts[:parent] ||= self if is_a?(Entity)
+        set_context_for opts
         klass.new name, opts, &block
       end
 
       protected
 
+      def set_context_for(opts)
+        if is_a?(Entity)
+          opts[:parent] ||= self
+        else
+          opts[:root] = self
+        end
+      end
+
       def klass_and_name_from(args)
         type, name = args
         if DSL.types[type]

data/lib/json/schema_builder/entity.rb

@@ -1,35 +1,28 @@
 require_relative 'dsl'
 require_relative 'schema'
+require_relative 'attribute'
+require_relative 'validation'
 
 module JSON
   module SchemaBuilder
     class Entity
       include DSL
+      include Attribute
+      include Validation
       class_attribute :registered_type
-      attr_accessor :name, :parent, :children
-
-      def self.attribute(name, as: nil, array: false)
-        as_name = as || name.to_s.underscore.gsub(/_(\w)/){ $1.upcase }
-        define_method name do |*values|
-          value = array ? values.flatten : values.first
-          if (array && value.empty?) || value.nil?
-            self.schema[as_name]
-          else
-            self.schema[as_name] = value
-          end
-        end
-        alias_method "#{ name }=", name
-      end
+      attr_accessor :name, :parent, :children, :options
 
       attribute :title
       attribute :description
 
       attribute :type
+      attribute :default
       attribute :enum, array: true
       attribute :all_of, array: true
       attribute :any_of, array: true
       attribute :one_of, array: true
       attribute :not_a, as: :not
+      attribute :ref, as: :$ref
       attribute :definitions
 
       def initialize(name, opts = { }, &block)
@@ -84,6 +77,7 @@ module JSON
       end
 
       def initialize_with(opts)
+        @options = opts.delete(:root).class.options.to_h if opts[:root]
         opts.each_pair do |key, value|
           next if value.nil?
           send :"#{ key }=", value

data/lib/json/schema_builder/validation.rb

@@ -0,0 +1,26 @@
+require 'json-schema'
+
+module JSON
+  module SchemaBuilder
+    module Validation
+      def validate(data, opts = { })
+        _validate :validate, data, opts
+      end
+
+      def validate!(data, opts = { })
+        _validate :validate!, data, opts
+      end
+
+      def fully_validate(data, opts = { })
+        _validate :fully_validate, data, opts
+      end
+
+      protected
+
+      def _validate(validator, data, opts)
+        opts.reverse_merge! options if options
+        JSON::Validator.send validator, as_json, data, opts
+      end
+    end
+  end
+end

data/lib/json/schema_builder/version.rb

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

data/lib/json/schema_builder.rb

@@ -2,6 +2,7 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'json/schema_builder/dsl'
 require 'json/schema_builder/version'
+require 'json/schema_builder/configuration'
 
 %w(array boolean integer null number object string).each do |type|
   require "json/schema_builder/#{ type }"
@@ -9,6 +10,16 @@ end
 
 module JSON
   module SchemaBuilder
+    extend ActiveSupport::Concern
     include DSL
+    extend JSON::SchemaBuilder::Configuration
+
+    included do |klass|
+      extend JSON::SchemaBuilder::Configuration
+    end
+
+    def self.default_options
+      @options || { }
+    end
   end
 end

data/spec/integration/array_definitions_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Examples::ArrayDefinitions, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :array,
+        definitions: {
+          positiveInt: {
+            type: :integer,
+            minimum: 0,
+            exclusiveMinimum: true
+          }
+        },
+        items: {
+          :$ref => '#/definitions/positiveInt'
+        }
+      }
+    end
+  end
+end

data/spec/integration/entity_literals_spec.rb

@@ -37,4 +37,10 @@ RSpec.describe Examples::EntityLiterals, type: :integration do
       }
     end
   end
+
+  it 'should raise through missing methods' do
+    expect {
+      described_class.new.bad_example
+    }.to raise_error NameError
+  end
 end

data/spec/integration/mixed_objects_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Examples::MixedObjects, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :object,
+        required: [:one],
+        properties: {
+          one: {
+            type: :object,
+            properties: { }
+          }
+        }
+      }
+    end
+  end
+end

data/spec/integration/object_definitions_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+RSpec.describe Examples::ObjectDefinitions, type: :integration do
+  it_behaves_like 'a builder' do
+    let(:expected_json) do
+      {
+        type: :object,
+        definitions: {
+          positiveInt: {
+            type: :integer,
+            minimum: 0,
+            exclusiveMinimum: true
+          }
+        },
+        properties: {
+          one: {
+            :$ref => '#/definitions/positiveInt'
+          }
+        }
+      }
+    end
+  end
+end

data/spec/integration/schema_builder_spec.rb

@@ -16,4 +16,60 @@ RSpec.describe Examples::SchemaBuilder, type: :integration do
       end
     end
   end
+
+  describe 'Configuration' do
+    subject{ Examples::SchemaBuilder }
+    after(:all) do
+      JSON::SchemaBuilder.configure
+      Examples::SchemaBuilder.configure
+    end
+
+    describe '.options=' do
+      before(:each){ subject.options = { a: 1 } }
+
+      its(:options){ is_expected.to be_a OpenStruct }
+      its('options.to_h'){ is_expected.to eql a: 1 }
+    end
+
+    describe '.configure' do
+      before(:each) do
+        subject.configure{ |opts| opts.validate_schema = true }
+      end
+
+      its(:options){ is_expected.to be_a OpenStruct }
+      its('options.to_h'){ is_expected.to eql validate_schema: true }
+
+      context 'with default options' do
+        after(:each){ subject.configure }
+        before(:each) do
+          JSON::SchemaBuilder.configure do |opts|
+            opts.insert_defaults = true
+            opts.validate_schema = false
+          end
+
+          subject.configure do |opts|
+            opts.validate_schema = true
+          end
+        end
+
+        its('options.insert_defaults'){ is_expected.to be true }
+        its('options.validate_schema'){ is_expected.to be true }
+      end
+
+      it 'should reset configuration first' do
+        subject.configure
+        expect(subject.options.validate_schema).to be nil
+      end
+
+      it 'should pass options to root entities' do
+        entity = subject.new.example
+        expect(entity.options).to eql validate_schema: true
+      end
+
+      it 'should not pass options to child entities' do
+        entity = subject.new.example.children.first
+        expect(entity.options).to be nil
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,15 @@
 require 'pry'
+require 'simplecov'
+SimpleCov.configure do
+  add_filter '/spec'
+end
+
+SimpleCov.start
+
 %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!

data/spec/support/examples/array_definitions.rb

@@ -0,0 +1,19 @@
+module Examples
+  class ArrayDefinitions
+    include JSON::SchemaBuilder
+
+    def example
+      array do
+        definitions positiveInt: positive_int
+        items ref: '#/definitions/positiveInt'
+      end
+    end
+
+    def positive_int
+      integer do
+        minimum 0
+        exclusive_minimum true
+      end
+    end
+  end
+end

data/spec/support/examples/entity_literals.rb

@@ -26,6 +26,14 @@ module Examples
       end
     end
 
+    def bad_example
+      object do
+        entity 'bad' do
+          not_a undefined_method
+        end
+      end
+    end
+
     def positive_int
       integer minimum: 1
     end

data/spec/support/examples/mixed_objects.rb

@@ -0,0 +1,11 @@
+module Examples
+  class MixedObjects
+    include JSON::SchemaBuilder
+
+    def example
+      object do
+        object :one, required: true
+      end
+    end
+  end
+end

data/spec/support/examples/object_definitions.rb

@@ -0,0 +1,19 @@
+module Examples
+  class ObjectDefinitions
+    include JSON::SchemaBuilder
+
+    def example
+      object do
+        definitions positiveInt: positive_int
+        entity :one, ref: '#/definitions/positiveInt'
+      end
+    end
+
+    def positive_int
+      integer do
+        minimum 0
+        exclusive_minimum true
+      end
+    end
+  end
+end

data/spec/support/examples/schema_builder.rb

@@ -1,5 +1,11 @@
 module Examples
   class SchemaBuilder
     include JSON::SchemaBuilder
+
+    def example
+      object do
+        string :name, required: true
+      end
+    end
   end
 end

data/spec/unit/dsl_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe JSON::SchemaBuilder::DSL, type: :unit do
     context 'without an entity' do
       it 'should create the type' do
         expect(instance.class).to receive(:new)
-          .with('name', { }).and_call_original
+          .with('name', { root: instance.class }).and_call_original
 
         entity = instance.entity :something, 'name'
         expect(entity).to be_a klass

data/spec/unit/entity_spec.rb

@@ -6,11 +6,13 @@ RSpec.describe JSON::SchemaBuilder::Entity, type: :unit do
   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 :default }
   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 :ref }
   it{ is_expected.to define_attribute :definitions }
 
   describe '.attribute' do
@@ -45,7 +47,12 @@ RSpec.describe JSON::SchemaBuilder::Entity, type: :unit do
       expect(subject.schema.testName).to eql 1
     end
 
-    it 'should handle array arguments' do
+    it 'should handle array argument reads' do
+      subject.schema.testList = [1, 2, 3]
+      expect(subject.test_list).to eql [1, 2, 3]
+    end
+
+    it 'should handle array argument writes' do
       subject.test_list = [1, 2, 3]
       expect(subject.schema.testList).to eql [1, 2, 3]
     end
@@ -89,6 +96,28 @@ RSpec.describe JSON::SchemaBuilder::Entity, type: :unit do
     end
   end
 
+  %w(validate validate! fully_validate).each do |validator|
+    describe "##{ validator }" do
+      let(:klass) do
+        Class.new do
+          include JSON::SchemaBuilder
+          configure{ |opts| opts.working = true }
+
+          def example
+            object{ string :name }
+          end
+        end
+      end
+      subject{ klass.new.example }
+
+      it "should #{ validator }" do
+        expect(JSON::Validator).to receive(validator)
+          .with subject.as_json, { }, working: true, opts: true
+        subject.send validator, { }, opts: true
+      end
+    end
+  end
+
   describe '#merge_children!' do
     include_context 'an entity with a parent'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Parrish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.2.0.rc2
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Build JSON schemas with Ruby
 email:
 - michael@zooniverse.org
@@ -132,7 +146,9 @@ files:
 - json-schema_builder.gemspec
 - lib/json/schema_builder.rb
 - lib/json/schema_builder/array.rb
+- lib/json/schema_builder/attribute.rb
 - lib/json/schema_builder/boolean.rb
+- lib/json/schema_builder/configuration.rb
 - lib/json/schema_builder/dsl.rb
 - lib/json/schema_builder/entity.rb
 - lib/json/schema_builder/integer.rb
@@ -142,9 +158,13 @@ files:
 - lib/json/schema_builder/object.rb
 - lib/json/schema_builder/schema.rb
 - lib/json/schema_builder/string.rb
+- lib/json/schema_builder/validation.rb
 - lib/json/schema_builder/version.rb
+- spec/integration/array_definitions_spec.rb
 - spec/integration/entity_literals_spec.rb
 - spec/integration/mixed_arrays_spec.rb
+- spec/integration/mixed_objects_spec.rb
+- spec/integration/object_definitions_spec.rb
 - spec/integration/schema_builder_spec.rb
 - spec/integration/terse_arrays_spec.rb
 - spec/integration/terse_objects_spec.rb
@@ -153,8 +173,11 @@ files:
 - spec/spec_helper.rb
 - spec/support/.keep
 - spec/support/attribute_matcher.rb
+- spec/support/examples/array_definitions.rb
 - spec/support/examples/entity_literals.rb
 - spec/support/examples/mixed_arrays.rb
+- spec/support/examples/mixed_objects.rb
+- spec/support/examples/object_definitions.rb
 - spec/support/examples/schema_builder.rb
 - spec/support/examples/terse_arrays.rb
 - spec/support/examples/terse_objects.rb
@@ -198,8 +221,11 @@ signing_key:
 specification_version: 4
 summary: Build JSON schemas with Ruby
 test_files:
+- spec/integration/array_definitions_spec.rb
 - spec/integration/entity_literals_spec.rb
 - spec/integration/mixed_arrays_spec.rb
+- spec/integration/mixed_objects_spec.rb
+- spec/integration/object_definitions_spec.rb
 - spec/integration/schema_builder_spec.rb
 - spec/integration/terse_arrays_spec.rb
 - spec/integration/terse_objects_spec.rb
@@ -208,8 +234,11 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/.keep
 - spec/support/attribute_matcher.rb
+- spec/support/examples/array_definitions.rb
 - spec/support/examples/entity_literals.rb
 - spec/support/examples/mixed_arrays.rb
+- spec/support/examples/mixed_objects.rb
+- spec/support/examples/object_definitions.rb
 - spec/support/examples/schema_builder.rb
 - spec/support/examples/terse_arrays.rb
 - spec/support/examples/terse_objects.rb