schema_validator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 014747701ba67637e5e989074b3ed9aa6ecfb3fb
+  data.tar.gz: aecae5997c01f64b0923ddb5d809fc6d2cd27333
+SHA512:
+  metadata.gz: bf3ad748562558bf0725bc71dd97aef14c8bf528897824106925db4109f35f0b872f5007f7bb7c62f3bf27ebcff9241e2141838e38efed1d9a1eb0cde8e551c0
+  data.tar.gz: 7e8ffacf9ffbe31e651d662d31458ebe8a4a0fa962dff2a052a134a86e61a9ee86095bc4093a92b3da35ee28915abc18191001b3ee4687ce7c53de680e27c9ec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Patrice Lebel
+
+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,54 @@
+# SchemaValidator
+
+### Usage
+
+Just define a json schema definition and assign it to any constant within the class definition:
+
+```ruby
+# app/schemas/any_schema.rb
+
+class AnySchema < Schema::Base
+  SCHEMA_NAME = ::IceNine.deep_freeze(
+    type: 'object', properties: {
+      nested_blocks_attributes: {
+        type: 'array', minItems: 1, items: {
+          type: 'object', properties: {
+            date: { type: 'string', format: 'date-time' },
+            values: {
+              type: 'object', properties: {
+                attr_1: { type: 'array', items: { type: ['number', 'integer'] }, minItems: 5, maxItems: 5 },
+                attr_2: { type: 'array', items: { type: ['number'] }, minItems: 4, maxItems: 4 },
+                attr_3: { type: 'array', items: { type: ['integer'], minimum: 0, maximum: 1 }, minItems: 64, maxItems: 64 },
+                attr_4: { type: 'array', items: { type: ['integer'] }, minItems: 4, maxItems: 4 },
+              }
+            }
+          }
+        }
+      }
+    }
+  )
+end
+```
+
+Then, you just need to call either `validate`, `validate!` or `fully_validate`:
+
+```ruby
+AnySchema.validate! params_hash
+```
+
+### Options
+
+It's possible to have multiple schema definitions within the same class, the name must be specified in that case:
+
+```ruby
+AnySchema.validate! params_hash, schema: 'OTHER_SCHEMA_NAME'
+```
+
+Other options are the one in use with the [json-schema](https://github.com/ruby-json-schema/json-schema) gem.
+
+Default options already set are `strict: true, parse_data: false, insert_defaults: true`.
+
+Since most schema definitions are static configurations, `IceNine` deep_freeze is recommended and included within the gemspec.
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SchemaValidator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/schema_validator.rb

@@ -0,0 +1,11 @@
+require "ice_nine"
+require "json-schema"
+require 'active_support/core_ext/hash/reverse_merge'
+
+module Schema
+  autoload :Base, "schema_validator/schema/base"
+end
+
+module SchemaValidator
+  # Your code goes here...
+end

data/lib/schema_validator/schema/base.rb

@@ -0,0 +1,13 @@
+module Schema
+  class Base
+    %i[ validate validate! fully_validate ].each do |method_name|
+      define_singleton_method method_name do |params, **options|
+        JSON::Validator.send(method_name,
+          const_get(options.delete(:schema) || constants.first),
+          params,
+          options.reverse_merge(strict: true, parse_data: false, insert_defaults: true)
+        )
+      end
+    end
+  end
+end

data/lib/schema_validator/version.rb

@@ -0,0 +1,3 @@
+module SchemaValidator
+  VERSION = '0.1.1'
+end

data/spec/dummy/app/models/product.rb

@@ -0,0 +1,2 @@
+class Product
+end

data/spec/dummy/app/models/product/schema.rb

@@ -0,0 +1,25 @@
+class Product::Schema < Schema::Base
+  COMMENTS = ::IceNine.deep_freeze(
+    type: 'object', properties: {
+      comments_attributes: {
+        type: 'array', minItems: 1, items: {
+          type: 'object', properties: {
+            comment: { type: 'string' },
+            timestamp: { type: 'string', format: 'date-time' },
+            tags:    { type: 'array', items: { type: ['integer'] }, minItems: 1, maxItems: 2, default: [0] },
+          }
+        }
+      }
+    }
+  )
+
+  TAGS = ::IceNine.deep_freeze(
+    type: 'object', properties: {
+      tags_attributes: {
+        type: 'array', items: {
+          type: 'string'
+        }
+      }
+    }
+  )
+end

data/spec/lib/schema/base_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Schema::Base do
+  subject { Schema::Base }
+
+  it { is_expected.to respond_to(:validate) }
+  it { is_expected.to respond_to(:validate!) }
+  it { is_expected.to respond_to(:fully_validate) }
+end

data/spec/models/product/schema_spec.rb

@@ -0,0 +1,38 @@
+describe Product::Schema do
+  describe '#validate' do
+    context 'with COMMENTS schema' do
+      let(:product_params) {
+        { comments_attributes: [
+          { comment: 'Comment', timestamp: Time.now.iso8601, tags: [1, 2] },
+        ]
+        }
+      }
+
+      it { expect(Product::Schema.validate product_params).to be_truthy }
+
+      context 'with missing attribute and strict true' do
+        before { product_params[:comments_attributes][0].delete(:comment) }
+
+        it { expect(Product::Schema.validate product_params).to be_falsey }
+      end
+
+      context 'with insert defaults true' do
+        before { product_params[:comments_attributes][0].delete(:tags) }
+
+        it { expect(Product::Schema.validate product_params).to be_truthy }
+      end
+    end
+
+    context 'with TAGS schema' do
+      let(:product_params) { { tags_attributes: ['tag'] } }
+
+      it { expect(Product::Schema.validate product_params, schema: :TAGS).to be_truthy }
+
+      context 'with invalid schema' do
+        before { product_params[:tags_attributes] << 1 }
+
+        it { expect(Product::Schema.validate product_params, schema: :TAGS).to be_falsey }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,107 @@
+require 'schema_validator'
+require 'require_all'
+require_all 'spec/dummy/**/*.rb'
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: schema_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Patrice Lebel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: require_all
+  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'
+description: SchemaValidator
+email:
+- patleb@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/schema_validator.rb
+- lib/schema_validator/schema/base.rb
+- lib/schema_validator/version.rb
+- spec/dummy/app/models/product.rb
+- spec/dummy/app/models/product/schema.rb
+- spec/lib/schema/base_spec.rb
+- spec/models/product/schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/patleb/schema_validator
+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.5.1
+signing_key: 
+specification_version: 4
+summary: SchemaValidator
+test_files:
+- spec/models/product/schema_spec.rb
+- spec/lib/schema/base_spec.rb
+- spec/spec_helper.rb
+- spec/dummy/app/models/product.rb
+- spec/dummy/app/models/product/schema.rb
+has_rdoc: