activerecord_json_validator 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5b518bda8ab28520f561dc840f47223e252530a9182ef31a164c12fb831451
-  data.tar.gz: 79e01fcce3c8cb0e27f6e3e24df4db54a312f6cef7285f38cec05689e897d042
+  metadata.gz: 1ebef8de77a6adb6c1ea4ff00c49c9e91b843952c4d226f4b149c04df9d585a6
+  data.tar.gz: 7efc4fa80a8dc82343bf1c7148e20f06df2acf127cbdbf9bc98e591e706940db
 SHA512:
-  metadata.gz: b4e5420f0c6aaad0e1e13ed296bc598e88b16974bfbaa7e55cc1680ad4ca499ba0b570de3ee26d72a993cbb9e712370f7e23fcf14e56e46ba40d7c601c5695f1
-  data.tar.gz: 93cf5acde18b71f512f2f68eaec1ba8191a721e1ace7853604d9e6ac4c6c7d03ae88a19c402a4c8b8545e8bfa5546de4ced97dfa032536f18747a5658419b752
+  metadata.gz: 1f096c0becc38bcdfb81cf70f59174509ea463f088ae02e514c612b397200aaef4dc76e7fd5cfe44ff0bf7c17fe2715a77d41d02101bac55afad19bbb076497a
+  data.tar.gz: e94f0da67f515a20eeb5699be8823c267144eeb36d09c6a1a892d24faab9bc65ca8d2d70edbe4388f088505d75875ede5cd91366393f2b71d42675713f8423ed

data/.travis.yml

@@ -3,16 +3,24 @@ language: ruby
 rvm:
   - 2.4.6
   - 2.6.3
+  - 2.7.5
 
 gemfile:
   - gemfiles/Gemfile.activerecord-4.2.x
   - gemfiles/Gemfile.activerecord-5.0.x
   - gemfiles/Gemfile.activerecord-6.0.x
+  - gemfiles/Gemfile.activerecord-7.0.x
 
 matrix:
   exclude:
   - gemfile: gemfiles/Gemfile.activerecord-6.0.x
     rvm: 2.4.6
+  - gemfile: gemfiles/Gemfile.activerecord-7.0.x
+    rvm: 2.4.6
+  - gemfile: gemfiles/Gemfile.activerecord-7.0.x
+    rvm: 2.6.3
+  - gemfile: gemfiles/Gemfile.activerecord-4.2.x
+    rvm: 2.7.5
 
 sudo: false
 

data/README.md

@@ -1,6 +1,6 @@
 <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="" />
+    <img src="https://user-images.githubusercontent.com/11348/126779905-3468eb15-d554-46d5-925b-235f68169d86.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>.
@@ -16,16 +16,17 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activerecord_json_validator'
+gem 'activerecord_json_validator', '~> 2.0.0'
 ```
 
 ## Usage
 
 ### JSON Schema
-Schemas must use be a JSON string or use string keys.
+
+Schemas should be a JSON file
 
 ```json
-'{
+{
   "type": "object",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "properties": {
@@ -33,20 +34,6 @@ Schemas must use be a JSON string or use string keys.
     "country": { "type": "string" }
   },
   "required": ["country"]
-}'
-```
-
-or
-
-```ruby
-{
-  "type" => "object",
-  "$schema" => "http://json-schema.org/draft-04/schema#",
-  "properties" => {
-    "city" => { "type" => "string" },
-    "country" => { "type" => "string" }
-  },
-  "required" => ["country"]
 }
 ```
 
@@ -60,7 +47,7 @@ end
 
 class User < ActiveRecord::Base
   # Constants
-  PROFILE_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema').to_s
+  PROFILE_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json')
 
   # Validations
   validates :name, presence: true
@@ -80,16 +67,16 @@ user.profile_invalid_json # => '{invalid JSON":}'
 
 #### Options
 
-| Option     | Description
-|------------|-----------------------------------------------------
-| `:schema`  | The JSON schema to validate the data against (see **Schema** section)
-| `:message` | The ActiveRecord message added to the record errors (see **Message** section)
-| `:options` | A `Hash` of [`json_schemer`](https://github.com/davishmcclurg/json_schemer#options)-supported options to pass to the validator
+| Option     | Description                                                                                                                    |
+| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `:schema`  | The JSON schema to validate the data against (see **Schema** section)                                                          |
+| `:message` | The ActiveRecord message added to the record errors (see **Message** section)                                                  |
+| `:options` | A `Hash` of [`json_schemer`](https://github.com/davishmcclurg/json_schemer#options)-supported options to pass to the validator |
 
 ##### Schema
 
 `ActiveRecord::JSONValidator` uses the [json_schemer](https://github.com/davishmcclurg/json_schemer) gem to validate the JSON
-data against a JSON schema. 
+data against 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
@@ -98,8 +85,8 @@ context of the validated record (`Symbol` will be sent as a method and the
 ```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
+  PROFILE_REGULAR_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema')
+  PROFILE_ADMIN_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile_admin.json_schema')
 
   # Validations
   validates :profile, presence: true, json: { schema: lambda { dynamic_profile_schema } } # `schema: :dynamic_profile_schema` would also work
@@ -136,7 +123,7 @@ user.errors.full_messages
 
 ## License
 
-`ActiveRecord::JSONValidator` is © 2013-2016 [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.
+`ActiveRecord::JSONValidator` is © 2013-2016 [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.
 

data/activerecord_json_validator.gemspec

@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler', '>= 1.12'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'activesupport', '>= 4.2.0', '< 7'
+  spec.add_development_dependency 'activesupport', '>= 4.2.0', '< 8'
   spec.add_development_dependency 'phare'
   spec.add_development_dependency 'rubocop', '~> 0.28'
 
   spec.add_dependency 'json_schemer', '~> 0.2.18'
-  spec.add_dependency 'activerecord', '>= 4.2.0', '< 7'
+  spec.add_dependency 'activerecord', '>= 4.2.0', '< 8'
 end

data/gemfiles/Gemfile.activerecord-7.0.x

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

data/lib/active_record/json_validator/validator.rb

@@ -15,13 +15,14 @@ class JsonValidator < ActiveModel::EachValidator
   # Validate the JSON value with a JSON schema path or String
   def validate_each(record, attribute, value)
     # Validate value with JSON Schemer
-    errors = JSONSchemer.schema(schema(record), options.fetch(:options)).validate(value).to_a
+    errors = JSONSchemer.schema(schema(record), **options.fetch(:options)).validate(value).to_a
 
     # Everything is good if we don’t have any errors and we got valid JSON value
     return if errors.empty? && record.send(:"#{attribute}_invalid_json").blank?
 
     # Add error message to the attribute
     message(errors).each do |error|
+      error = error.is_a?(Hash) ? JSONSchemer::Errors.pretty(error) : error
       record.errors.add(attribute, error, value: value)
     end
   end

data/lib/active_record/json_validator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module JSONValidator
-    VERSION = '2.0.0'
+    VERSION = '2.1.1'
   end
 end

data/spec/json_validator_spec.rb

@@ -4,107 +4,51 @@
 require 'spec_helper'
 
 describe JsonValidator do
-  describe :initialize do
-    # NOTE: We do not explicitely call `JsonValidator.new` in the tests,
-    # because we let Rails (ActiveModel::Validations) do that when we call
-    # `validates … json: true` on the model.
-    #
-    # This allows us to test the constructor behavior when executed in
-    # different Rails versions that do not pass the same arguments to it.
+  describe :validate_each do
     before do
       run_migration do
         create_table(:users, force: true) do |t|
-          t.string :name
           t.text :data
         end
       end
 
       spawn_model 'User' do
+        schema = '
+        {
+          "type": "object",
+          "properties": {
+            "city": { "type": "string" },
+            "country": { "type": "string" }
+          },
+          "required": ["country"]
+        }
+        '
         serialize :data, JSON
-        validates :data, json: true
+        serialize :other_data, JSON
+        validates :data, json: { schema: schema, message: ->(errors) { errors } }
+        validates :other_data, json: { schema: schema, message: ->(errors) { errors.map { |error| error['details'].to_a.flatten.join(' ') } } }
       end
-
-      record.data = data
-    end
-
-    let(:record) { User.new }
-
-    context 'with valid JSON data' do
-      let(:data) { 'What? This is not JSON at all.' }
-      it { expect(record.data_invalid_json).to eql(data) }
-    end
-
-    context 'with invalid JSON data' do
-      let(:data) { { foo: 'bar' } }
-      it { expect(record.data_invalid_json).to be_nil }
     end
-  end
 
-  describe :validate_each do
-    let(:validator) { JsonValidator.new(options) }
-    let(:options) { { attributes: [attribute], options: { format: true } } }
-    let(:validate_each!) { validator.validate_each(record, attribute, value) }
-
-    # Doubles
-    let(:attribute) { double(:attribute, to_s: 'attribute_name') }
-    let(:record) { double(:record, errors: record_errors) }
-    let(:record_errors) { double(:errors) }
-    let(:value) { double(:value) }
-    let(:schema) { double(:schema) }
-    let(:schema_validator) { double(:schema_validator) }
-    let(:raw_errors) { double(:raw_errors) }
-    let(:validator_errors) { double(:validator_errors) }
+    context 'with valid JSON data but schema errors' do
+      let(:user) { User.new(data: '{"city":"Quebec City"}', other_data: '{"city":"Quebec City"}') }
 
-    before do
-      expect(validator).to receive(:schema).with(record).and_return(schema)
-      expect(JSONSchemer).to receive(:schema).with(schema, options[:options]).and_return(schema_validator)
-      expect(schema_validator).to receive(:validate).with(value).and_return(raw_errors)
-      expect(raw_errors).to receive(:to_a).and_return(validator_errors)
-    end
-
-    context 'with JSON Schemer errors' do
-      before do
-        expect(validator_errors).to receive(:empty?).and_return(false)
-        expect(record).not_to receive(:"#{attribute}_invalid_json")
-        expect(record_errors).to receive(:add).with(attribute, options[:message], value: value)
+      specify do
+        expect(user).not_to be_valid
+        expect(user.errors.full_messages).to eql(['Data root is missing required keys: country', 'Other data missing_keys country'])
+        expect(user.data).to eql({ 'city' => 'Quebec City' })
+        expect(user.data_invalid_json).to be_nil
       end
-
-      specify { validate_each! }
     end
 
-    context 'without JSON Schemer errors but with invalid JSON data' do
-      before do
-        expect(validator_errors).to receive(:empty?).and_return(true)
-        expect(record).to receive(:"#{attribute}_invalid_json").and_return('foo"{]')
-        expect(record_errors).to receive(:add).with(attribute, options[:message], value: value)
-      end
-
-      specify { validate_each! }
-    end
-
-    context 'without JSON Schemer errors and valid JSON data' do
-      before do
-        expect(validator_errors).to receive(:empty?).and_return(true)
-        expect(record).to receive(:"#{attribute}_invalid_json").and_return(nil)
-        expect(record_errors).not_to receive(:add)
-      end
-
-      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 } }
+    context 'with invalid JSON data' do
+      let(:data) { 'What? This is not JSON at all.' }
+      let(:user) { User.new(data: data) }
 
-      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)
+      specify do
+        expect(user.data_invalid_json).to eql(data)
+        expect(user.data).to eql({})
       end
-
-      specify { validate_each! }
     end
   end
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
@@ -89,7 +89,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: phare
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -161,7 +161,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 description: ActiveRecord::JSONValidator makes it easy to validate JSON attributes
   with a JSON schema.
 email:
@@ -182,6 +182,7 @@ files:
 - gemfiles/Gemfile.activerecord-4.2.x
 - gemfiles/Gemfile.activerecord-5.0.x
 - gemfiles/Gemfile.activerecord-6.0.x
+- gemfiles/Gemfile.activerecord-7.0.x
 - lib/active_record/json_validator/validator.rb
 - lib/active_record/json_validator/version.rb
 - lib/activerecord_json_validator.rb