activerecord_json_validator 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e122734c159cf841ab43d38bdc6efd2e4d554605
-  data.tar.gz: 96c99ba0cde8902483245991ccab6b2bc03870d6
+  metadata.gz: 53b4aea1bc7007643f31d936e12b78804f96ab9f
+  data.tar.gz: 70f49f4c9bc9930dec7cdaede3d612cd387fd00b
 SHA512:
-  metadata.gz: 3d060208f9aebadac25bd9b6c3a72db71eb689e775c9a3be343c45f05d0e5d7a5e36c4b91a6341b2823c3b6b7bce7a2c2efe7a3b1972a0b4d97a618b3da2a759
-  data.tar.gz: 5aff819411acfe4a894c3e5f4d6422f7ffdef61c78cf07b8551025c8b7d0ab6794ed51283e9d90a1f4c479c32fe65622e2c548fd526ef7e2f0059ed560d04a72
+  metadata.gz: c360ce94176ec1471287f51ad23224a4cd6fe8caeee92d62df27d04df6fa518af18cd92969167282a6e6886aca46ec0221196e825db5ad8758f657165c85f4c9
+  data.tar.gz: f1586c5cca10f3eef4dbb31d602b29f633daf2a778557642816026092db2bfc9c3ed54b672c39e9835bea877280129580d30bb55d9754a3ed47c70f6b2cac589

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
 
 gemfile:
   - gemfiles/Gemfile.activerecord-4.2.x
-  - gemfiles/Gemfile.activerecord-4.1.x
 
 sudo: false
 

data/README.md

@@ -1,9 +1,15 @@
-# ActiveRecord::JSONValidator
-
-`ActiveRecord::JSONValidator` makes it easy to validate JSON attributes against a JSON schema.
-
-[![Gem Version](http://img.shields.io/gem/v/activerecord_json_validator.svg)](https://rubygems.org/gems/activerecord_json_validator)
-[![Build Status](http://img.shields.io/travis/mirego/activerecord_json_validator.svg)](https://travis-ci.org/mirego/activerecord_json_validator)
+<p align="center">
+  <a href="https://github.com/mirego/activerecord_json_validator">
+    <img src="https://cloud.githubusercontent.com/assets/11348/6099354/cffcf35e-afc3-11e4-9a4d-d872941bbcf6.png" alt="" />
+  </a>
+  <br />
+  <code>ActiveRecord::JSONValidator</code> makes it easy to validate<br /> JSON attributes against a <a href="http://json-schema.org/">JSON schema</a>.
+  <br /><br />
+  <a href="https://rubygems.org/gems/activerecord_json_validator"><img src="http://img.shields.io/gem/v/activerecord_json_validator.svg" /></a>
+  <a href="https://travis-ci.org/mirego/activerecord_json_validator"><img src="http://img.shields.io/travis/mirego/activerecord_json_validator.svg" /></a>
+</p>
+
+---
 
 ## Installation
 
@@ -20,11 +26,12 @@ gem 'activerecord_json_validator'
 ```json
 {
   "type": "object",
-  "$schema": "http://json-schema.org/draft-03/schema",
+  "$schema": "http://json-schema.org/draft-04/schema",
   "properties": {
-    "city": { "type": "string", "required": false },
-    "country": { "type": "string", "required": true }
-  }
+    "city": { "type": "string" },
+    "country": { "type": "string" }
+  },
+  "required": ["country"]
 }
 ```
 
@@ -60,86 +67,64 @@ user.profile_invalid_json # => '{invalid JSON":}'
 
 | Option     | Description
 |------------|-----------------------------------------------------
-| `:schema`  | The JSON schema to validate the data against (see **JSON schema option** section)
-| `:message` | The ActiveRecord message added to the record errors (default: `:invalid_json`)
+| `:schema`  | The JSON schema to validate the data against (see **Schema** section)
+| `:message` | The ActiveRecord message added to the record errors (see **Message** section)
 
-##### JSON schema option
+##### Schema
 
-You can specify four kinds of value for the `:schema` option.
+`ActiveRecord::JSONValidator` uses the `json-schema` gem to validate the JSON
+data against a JSON schema. You can use [any value](https://github.com/ruby-json-schema/json-schema/tree/master#usage) that
+`JSON::Validator.validate` would take as the `schema` argument.
 
-###### A path to a file containing a JSON schema
+Additionally, you can use a `Symbol` or a `Proc`. Both will be executed in the
+context of the validated record (`Symbol` will be sent as a method and the
+`Proc` will be `instance_exec`ed)
 
 ```ruby
 class User < ActiveRecord::Base
   # Constants
-  PROFILE_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema').to_s
+  PROFILE_REGULAR_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema').to_s
+  PROFILE_ADMIN_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile_admin.json_schema').to_s
 
   # Validations
-  validates :profile, presence: true, json: { schema: PROFILE_JSON_SCHEMA }
-end
-```
+  validates :profile, presence: true, json: { schema: lambda { dynamic_profile_schema } } # `schema: :dynamic_profile_schema` would also work
 
-###### A Ruby `Hash` representing a JSON schema
-
-```ruby
-class User < ActiveRecord::Base
-  # Constants
-  PROFILE_JSON_SCHEMA = {
-    type: 'object',
-    :'$schema' => 'http://json-schema.org/draft-03/schema',
-    properties: {
-      city: { type: 'string', required: false },
-      country: { type: 'string', required: true }
-    }
-  }
-
-  # Validations
-  validates :profile, presence: true, json: { schema: PROFILE_JSON_SCHEMA }
+  def dynamic_profile_schema
+    admin? ? PROFILE_ADMIN_JSON_SCHEMA : PROFILE_REGULAR_JSON_SCHEMA
+  end
 end
 ```
 
-###### A plain JSON schema as a Ruby `String`
+##### Message
 
-```ruby
-class User < ActiveRecord::Base
-  # Constants
-  PROFILE_JSON_SCHEMA = '{
-    "type": "object",
-    "$schema": "http://json-schema.org/draft-03/schema",
-    "properties": {
-      "city": { "type": "string", "required": false },
-      "country": { "type": "string", "required": true }
-    }
-  }'
+Like any other ActiveModel validation, you can specify either a `Symbol` or
+`String` value for the `:message` option. The default value is `:invalid_json`.
 
-  # Validations
-  validates :profile, presence: true, json: { schema: PROFILE_JSON_SCHEMA }
-end
-```
-
-###### A lambda that will get evaluated in the context of the validated record
-
-The lambda must return a valid value for the `:schema` option (file path, JSON `String` or Ruby `Hash`).
+However, you can also specify a `Proc` that returns an array of errors. The
+`Proc` will be called with a single argument — an array of errors returned by
+the JSON schema validator. So, if you’d like to add each of these errors as
+a first-level error for the record, you can do this:
 
 ```ruby
 class User < ActiveRecord::Base
-  # Constants
-  PROFILE_REGULAR_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema').to_s
-  PROFILE_ADMIN_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile_admin.json_schema').to_s
-
   # Validations
-  validates :profile, presence: true, json: { schema: lambda { dynamic_profile_schema } }
-
-  def dynamic_profile_schema
-    admin? ? PROFILE_ADMIN_JSON_SCHEMA : PROFILE_REGULAR_JSON_SCHEMA
-  end
+  validates :profile, presence: true, json: { message: ->(errors) { errors }, schema: 'foo.json_schema' }
 end
+
+user = User.new.tap(&:valid?)
+user.errors.full_messages
+# => [
+#      'The property '#/email' of type Fixnum did not match the following type: string in schema 2d44293f-cd9d-5dca-8a6a-fb9db1de722b#',
+#      'The property '#/full_name' of type Fixnum did not match the following type: string in schema 2d44293f-cd9d-5dca-8a6a-fb9db1de722b#',
+#    ]
 ```
 
 ## License
 
 `ActiveRecord::JSONValidator` is © 2013-2015 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/activerecord_json_validator/blob/master/LICENSE.md) file.
 
+The tree logo is based on [this lovely icon](http://thenounproject.com/term/tree/51004/) by [Sara Quintana](http://thenounproject.com/sara.quintana.75), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.
+
 ## About Mirego
 
 [Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).

data/activerecord_json_validator.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.28'
 
   spec.add_dependency 'json-schema', '~> 2.5'
-  spec.add_dependency 'activerecord', '>= 4.1.0', '< 5'
+  spec.add_dependency 'activerecord', '>= 4.2.0', '< 5'
 end

data/lib/active_record/json_validator/validator.rb

@@ -7,18 +7,7 @@ class JsonValidator < ActiveModel::EachValidator
 
     super
 
-    # Rails 4.1 and above expose a `class` option
-    if options[:class]
-      inject_setter_method(options[:class], @attributes)
-
-    # Rails 4.0 and below calls a `#setup` method
-    elsif !respond_to?(:setup)
-      class_eval do
-        define_method :setup do |model|
-          inject_setter_method(model, @attributes)
-        end
-      end
-    end
+    inject_setter_method(options[:class], @attributes)
   end
 
   # Validate the JSON value with a JSON schema path or String
@@ -30,7 +19,9 @@ class JsonValidator < ActiveModel::EachValidator
     return if errors.empty? && record.send(:"#{attribute}_invalid_json").blank?
 
     # Add error message to the attribute
-    record.errors.add(attribute, options.fetch(:message), value: value)
+    message(errors).each do |error|
+      record.errors.add(attribute, error, value: value)
+    end
   end
 
 protected
@@ -72,4 +63,13 @@ protected
     return value if value.is_a?(String)
     ::ActiveSupport::JSON.encode(value)
   end
+
+  def message(errors)
+    message = options.fetch(:message)
+
+    case message
+      when Proc then [message.call(errors)].flatten if message.is_a?(Proc)
+      else [message]
+    end
+  end
 end

data/lib/active_record/json_validator/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JSONValidator
-    VERSION = '0.5.1'
+    VERSION = '1.0.0'
   end
 end

data/spec/json_validator_spec.rb

@@ -86,6 +86,21 @@ describe JsonValidator do
 
       specify { validate_each! }
     end
+
+    context 'with multiple error messages' do
+      let(:options) { { attributes: [attribute], message: message, options: { strict: true } } }
+      let(:message) { ->(errors) { errors.to_a } }
+
+      before do
+        expect(validator_errors).to receive(:empty?).and_return(false)
+        expect(validator_errors).to receive(:to_a).and_return(%i(first_error second_error))
+        expect(record).not_to receive(:"#{attribute}_invalid_json")
+        expect(record_errors).to receive(:add).with(attribute, :first_error, value: value)
+        expect(record_errors).to receive(:add).with(attribute, :second_error, value: value)
+      end
+
+      specify { validate_each! }
+    end
   end
 
   describe :schema do
@@ -152,4 +167,21 @@ describe JsonValidator do
       it { expect(validatable_value).to eql(value) }
     end
   end
+
+  describe :message do
+    let(:validator) { JsonValidator.new(options) }
+    let(:options) { { attributes: [:foo], message: message_option } }
+    let(:message) { validator.send(:message, errors) }
+    let(:errors) { %i(first_error second_error) }
+
+    context 'with Symbol message' do
+      let(:message_option) { :invalid_json }
+      it { expect(message).to eql([:invalid_json]) }
+    end
+
+    context 'with String value' do
+      let(:message_option) { ->(errors) { errors } }
+      it { expect(message).to eql(%i(first_error second_error)) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,7 +148,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -158,7 +158,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -179,7 +179,6 @@ files:
 - README.md
 - Rakefile
 - activerecord_json_validator.gemspec
-- gemfiles/Gemfile.activerecord-4.1.x
 - gemfiles/Gemfile.activerecord-4.2.x
 - lib/active_record/json_validator/validator.rb
 - lib/active_record/json_validator/version.rb
@@ -211,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ActiveRecord::JSONValidator makes it easy to validate JSON attributes with

data/gemfiles/Gemfile.activerecord-4.1.x

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '../'
-
-gem 'activerecord', '~> 4.1'