activerecord_json_validator 2.1.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 851b94edf54cbfdcd0a66a80dab95bcdeeea0e1c4a8831f634bc55aad5cba226
-  data.tar.gz: bf3a8280ffa8300469e793422adc68e83ab444047db67d9e6cbafec528f69803
+  metadata.gz: 669da2ce3ee468c5d588289edf6842fbec2e90a04058b110db4fc81fe10cb0e7
+  data.tar.gz: 76b04ff20e88c285ffd5711dc1ce6bee16c7e9bdf519a3ef95dac637d7a4b147
 SHA512:
-  metadata.gz: 33766dfbea4cf464c499709f76b742f3bfe9b37dcc656206a15794f93733ec6711f127057ff2efb67bb75b6e439e64e75ada856d62fcdb2fece42e4ddd81b6ff
-  data.tar.gz: 7192194e8663dfbd9d343b66866ebab63d843200581bbe59be2c3f3bd485819fb13bba58bfb29241afa661c180399acce0d6fa3cf24a9d6fd5852b1d300a1be8
+  metadata.gz: 40ccc0aa96e3601e49a6cb38fa35b83158f5b9a4597916577416b316f144534d271c56b17b42b5fe7071cdffd8f87c2b1ac3d84bfaa0da5794372eff6c5b9d89
+  data.tar.gz: 8a79553fc7bb7ab146ab77ed0ac57e186b7f9fd0f6cb6f47dd5e7bd94b920796abafd8d3d09e99a3954cf520f4aab6bb208341cd06aa29bb68ba0175763e949d

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2022, Mirego
+Copyright (c) 2013-2024, Mirego
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -16,7 +16,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activerecord_json_validator', '~> 2.1.0'
+gem 'activerecord_json_validator', '~> 3.0.0'
 ```
 
 ## Usage
@@ -164,9 +164,18 @@ user.errors.full_messages
 #    ]
 ```
 
+## Development
+
+The tests require a database. We've provided a simple `docker-compose.yml` that will make
+it trivial to run the tests against PostgreSQL. Simply run `docker compose up -d`
+followed by `rake spec`. When you're done, run `docker compose down` to stop the database.
+
+In order to use another database, simply define the `DATABASE_URL` environment variable
+appropriately.
+
 ## License
 
-`ActiveRecord::JSONValidator` is © 2013-2022 [Mirego](https://www.mirego.com) and may be freely distributed under the [New BSD license](https://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-2024 [Mirego](https://www.mirego.com) and may be freely distributed under the [New BSD license](https://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](https://thenounproject.com/term/tree/51004/) by [Sara Quintana](https://thenounproject.com/sara.quintana.75), from The Noun Project. Used under a [Creative Commons BY 3.0](https://creativecommons.org/licenses/by/3.0/) license.
 

data/activerecord_json_validator.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec', '~> 1.44'
   spec.add_development_dependency 'rubocop-standard', '~> 6.0'
 
-  spec.add_dependency 'json_schemer', '~> 0.2.18'
+  spec.add_dependency 'json_schemer', '~> 2.2'
   spec.add_dependency 'activerecord', '>= 4.2.0', '< 8'
 end

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.2'
+
+services:
+  postgres:
+    image: postgres:10
+    ports:
+      - 5432:5432
+    restart: on-failure
+    environment:
+      POSTGRES_DB: activerecord_json_validator_test
+      POSTGRES_HOST_AUTH_METHOD: trust # don't require password

data/lib/active_record/json_validator/validator.rb

@@ -25,9 +25,9 @@ class JsonValidator < ActiveModel::EachValidator
     return if errors.empty? && record.send(:"#{attribute}_invalid_json").blank?
 
     # Add error message to the attribute
-    details = errors.map { |e| JSONSchemer::Errors.pretty(e) }
+    details = errors.map { |e| e.fetch('error') }
     message(errors).each do |error|
-      error = JSONSchemer::Errors.pretty(error) if error.is_a?(Hash)
+      error = error.fetch('error') if error.is_a?(Hash)
       record.errors.add(attribute, error, errors: details, value: value)
     end
   end
@@ -37,21 +37,23 @@ protected
   # Redefine the setter method for the attributes, since we want to
   # catch JSON parsing errors.
   def inject_setter_method(klass, attributes)
+    return if klass.nil?
+
     attributes.each do |attribute|
-      klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      klass.prepend(Module.new do
         attr_reader :"#{attribute}_invalid_json"
 
         define_method "#{attribute}=" do |args|
           begin
-            @#{attribute}_invalid_json = nil
+            instance_variable_set("@#{attribute}_invalid_json", nil)
             args = ::ActiveSupport::JSON.decode(args) if args.is_a?(::String)
             super(args)
           rescue ActiveSupport::JSON.parse_error
-            @#{attribute}_invalid_json = args
+            instance_variable_set("@#{attribute}_invalid_json", args)
             super({})
           end
         end
-      RUBY
+      end)
     end
   end
 

data/lib/active_record/json_validator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module JSONValidator
-    VERSION = '2.1.4'
+    VERSION = '3.0.0'
   end
 end

data/spec/json_validator_spec.rb

@@ -3,6 +3,18 @@
 # rubocop:disable Metrics/BlockLength
 require 'spec_helper'
 
+module CountryDefaulter
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def default_country_attribute(name, country:)
+      define_method("#{name}=") do |value|
+        self[name] = { country: country }.merge(value)
+      end
+    end
+  end
+end
+
 describe JsonValidator do
   describe :validate_each do
     before do
@@ -14,6 +26,8 @@ describe JsonValidator do
       end
 
       spawn_model 'User' do
+        include CountryDefaulter
+
         schema = '
         {
           "type": "object",
@@ -24,8 +38,11 @@ describe JsonValidator do
           "required": ["country"]
         }
         '
-        serialize :data, JSON
-        serialize :other_data, JSON
+
+        default_country_attribute :smart_data, country: 'Canada'
+
+        serialize :data, coder: JSON
+        serialize :other_data, coder: 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(' ') } } }
         validates :smart_data, json: { value: ->(record, _, _) { record[:smart_data] }, schema: schema, message: ->(errors) { errors } }
@@ -41,31 +58,53 @@ describe JsonValidator do
         User.new(
           data: '{"city":"Quebec City"}',
           other_data: '{"city":"Quebec City"}',
-          smart_data: { country: 'Canada', city: 'Quebec City' }
+          smart_data: { country: 'Ireland', city: 'Dublin' }
         )
       end
 
       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.errors.full_messages).to eql(['Data object at root is missing required properties: country', 'Other data missing_keys country'])
         expect(user.errors.group_by_attribute[:data].first).to have_attributes(
-          options: include(errors: ['root is missing required keys: country'])
+          options: include(errors: ['object at root is missing required properties: country'])
         )
         expect(user.errors.group_by_attribute[:other_data].first).to have_attributes(
-          options: include(errors: ['root is missing required keys: country'])
+          options: include(errors: ['object at root is missing required properties: country'])
         )
         expect(user.data).to eql({ 'city' => 'Quebec City' })
         expect(user.data_invalid_json).to be_nil
+        expect(user.smart_data.city).to eql('Dublin')
+        expect(user.smart_data.country).to eql('Ireland')
       end
     end
 
     context 'with invalid JSON data' do
       let(:data) { 'What? This is not JSON at all.' }
-      let(:user) { User.new(data: data) }
+      let(:user) { User.new(data: data, smart_data: data) }
 
       specify do
         expect(user.data_invalid_json).to eql(data)
         expect(user.data).to eql({})
+
+        # Ensure that both setters ran
+        expect(user.smart_data_invalid_json).to eql(data)
+        expect(user.smart_data).to eql(OpenStruct.new({ country: 'Canada' }))
+      end
+    end
+
+    context 'with missing country in smart data' do
+      let(:user) do
+        User.new(
+          data: '{"city":"Quebec City","country":"Canada"}',
+          other_data: '{"city":"Quebec City","country":"Canada"}',
+          smart_data: { city: 'Quebec City' }
+        )
+      end
+
+      specify do
+        expect(user).to be_valid
+        expect(user.smart_data.city).to eql('Quebec City')
+        expect(user.smart_data.country).to eql('Canada') # Due to CountryDefaulter
       end
     end
   end

data/spec/support/macros/database/database_adapter.rb

@@ -6,6 +6,6 @@ class DatabaseAdapter
   end
 
   def establish_connection!
-    ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+    ActiveRecord::Base.establish_connection(ENV.fetch('DATABASE_URL', 'postgres://postgres@localhost/activerecord_json_validator_test'))
   end
 end

data/spec/support/macros/database_macros.rb

@@ -25,6 +25,6 @@ module DatabaseMacros
     adapter.reset_database!
 
     # Silence everything
-    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.18
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.18
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +179,7 @@ files:
 - README.md
 - Rakefile
 - activerecord_json_validator.gemspec
+- docker-compose.yml
 - lib/active_record/json_validator/validator.rb
 - lib/active_record/json_validator/version.rb
 - lib/activerecord_json_validator.rb