json-schema_builder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f90789d3f3f12de9b7b3ae15e7e33f6fb845f7c
+  data.tar.gz: 38984c38614450bea747ee03441add545c4d5bc0
+SHA512:
+  metadata.gz: 64e60e98e0c21a9dab31b5136e6712c9c2000c97d1f3545859228041b12b02c3d69e68c7a605dfa5c52a626450ef8e4f5acb028aa13ee097a691fad41c9cdba1
+  data.tar.gz: 9046c88b826c5227990fb3456f5b529d9674b50b58c6545fdd2e0e4083caee6067b675da1d2e97083c4b5efb8e62d1ed102f1eb1597a8836c03224f2d75b246d

data/.gitignore

@@ -0,0 +1,2 @@
+/.bundle/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: rspec
+rvm:
+- 2.1.5
+addons:
+  code_climate:
+    repo_token:
+      secure: X3mDel/6C4d8uSeaKgxA2YP4Oen5N2iklmi2mH1XzK3UihzlNKcQLxYC6IMTTfYiPlLu1BTO1KTElUqWIigpHxAAJj/Lb48S8mvKFAsmv48tOP5LaTeFNdnJA49k0hCXQbItlyVBmUhEtkdyelLciP3ygcKgEcR/jZGcJM/aZBY=

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    json-schema_builder (0.0.1)
+      activesupport (~> 4.0, = 4.2.0.rc2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0.rc2)
+      i18n (>= 0.7.0.beta1, < 0.8)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    codeclimate-test-reporter (0.4.3)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0.beta1)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.1.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  codeclimate-test-reporter
+  json-schema_builder!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.1)
+  rspec-its

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Parrish
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# JSON::SchemaBuilder
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-schema_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-schema_builder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/json-schema_builder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/json-schema_builder.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path '../lib', __FILE__
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json/schema_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json-schema_builder'
+  spec.version       = JSON::SchemaBuilder::VERSION
+  spec.authors       = ['Michael Parrish']
+  spec.email         = ['michael@zooniverse.org']
+  spec.summary       = 'Build JSON schemas with Ruby'
+  spec.description   = 'Build JSON schemas with Ruby'
+  spec.homepage      = 'https://github.com/parrish/json-schema_builder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split "\x0"
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'pry'
+  spec.add_dependency 'activesupport', '~> 4.0', '4.2.0.rc2'
+end

data/lib/json/schema_builder.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'json/schema_builder/dsl'
+require 'json/schema_builder/version'
+
+%w(array boolean integer null number object string).each do |type|
+  require "json/schema_builder/#{ type }"
+end
+
+module JSON
+  module SchemaBuilder
+    include DSL
+  end
+end

data/lib/json/schema_builder/array.rb

@@ -0,0 +1,29 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class Array < Entity
+      register :array
+      attribute :additional_items
+      attribute :min_items
+      attribute :max_items
+      attribute :unique_items
+
+      def items(*args, &block)
+        opts = args.extract_options!
+        schema.items = args.first
+        schema.items ||= items_entity(opts, &block).as_json
+      end
+
+      protected
+
+      def items_entity(opts, &block)
+        if opts[:type]
+          send opts.delete(:type), opts, &block
+        else
+          Entity.new(nil, opts, &block).tap &:merge_children!
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/boolean.rb

@@ -0,0 +1,9 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class Boolean < Entity
+      register :boolean
+    end
+  end
+end

data/lib/json/schema_builder/dsl.rb

@@ -0,0 +1,42 @@
+module JSON
+  module SchemaBuilder
+    module DSL
+      extend ActiveSupport::Concern
+      mattr_accessor :types
+
+      def entity(*args, &block)
+        opts = args.extract_options!
+        klass, name = klass_and_name_from args
+        opts[:parent] ||= self if is_a?(Entity)
+        klass.new name, opts, &block
+      end
+
+      protected
+
+      def klass_and_name_from(args)
+        type, name = args
+        if DSL.types[type]
+          [DSL.types[type], name]
+        else
+          [Entity, type]
+        end
+      end
+
+      module ClassMethods
+        def register(type)
+          self.registered_type = type
+          DSL.types ||= { }
+          DSL.types[type] = self
+
+          DSL.module_eval do
+            define_method type do |*args, &block|
+              opts = args.extract_options!
+              name = args.first
+              entity type, name, opts, &block
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/entity.rb

@@ -0,0 +1,101 @@
+require_relative 'dsl'
+require_relative 'schema'
+
+module JSON
+  module SchemaBuilder
+    class Entity
+      include DSL
+      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
+
+      attribute :title
+      attribute :description
+
+      attribute :type
+      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 :definitions
+
+      def initialize(name, opts = { }, &block)
+        @name = name
+        @children = []
+        self.type = self.class.registered_type
+        initialize_parent_with opts
+        initialize_with opts
+        eval_block &block
+      end
+
+      def schema
+        @schema ||= Schema.new
+      end
+
+      def required=(*values)
+        @parent.required ||= []
+        @parent.required << @name
+      end
+
+      def merge_children!
+        children.each do |child|
+          schema.merge! child.schema
+        end
+      end
+
+      def as_json
+        schema.to_h.as_json
+      end
+
+      def respond_to?(method_name, include_all = false)
+        if @parent_context
+          @parent_context.respond_to? method_name, include_all
+        else
+          super
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        if @parent_context && respond_to?(method_name, true)
+          @parent_context.send method_name, *args, &block
+        else
+          super
+        end
+      end
+
+      protected
+
+      def initialize_parent_with(opts)
+        @parent = opts.delete :parent
+        @parent.children << self if @parent
+      end
+
+      def initialize_with(opts)
+        opts.each_pair do |key, value|
+          next if value.nil?
+          send :"#{ key }=", value
+        end
+      end
+
+      def eval_block(&block)
+        if block_given?
+          @parent_context = block.binding.eval 'self'
+          instance_exec self, &block
+        end
+      end
+    end
+  end
+end

data/lib/json/schema_builder/integer.rb

@@ -0,0 +1,9 @@
+require_relative 'numeric'
+
+module JSON
+  module SchemaBuilder
+    class Integer < Numeric
+      register :integer
+    end
+  end
+end

data/lib/json/schema_builder/null.rb

@@ -0,0 +1,9 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class Null < Entity
+      register :null
+    end
+  end
+end

data/lib/json/schema_builder/number.rb

@@ -0,0 +1,9 @@
+require_relative 'numeric'
+
+module JSON
+  module SchemaBuilder
+    class Number < Numeric
+      register :number
+    end
+  end
+end

data/lib/json/schema_builder/numeric.rb

@@ -0,0 +1,13 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class Numeric < Entity
+      attribute :multiple_of
+      attribute :minimum
+      attribute :maximum
+      attribute :exclusive_minimum
+      attribute :exclusive_maximum
+    end
+  end
+end

data/lib/json/schema_builder/object.rb

@@ -0,0 +1,36 @@
+require_relative 'entity'
+
+module JSON
+  module SchemaBuilder
+    class Object < Entity
+      register :object
+      attribute :required
+      attribute :min_properties
+      attribute :max_properties
+      attribute :properties
+      attribute :additional_properties
+      attribute :pattern_properties
+
+      def initialize(name, opts = { }, &block)
+        self.properties = { }
+        super
+        children.each do |child|
+          self.properties[child.name] = child.as_json
+        end
+      end
+
+      def required(*values)
+        case values
+        when []
+          @schema.required
+        when [true]
+          @parent.required ||= []
+          @parent.required << @name
+        else
+          @schema.required = values.flatten
+        end
+      end
+      alias_method :required=, :required
+    end
+  end
+end