activerecord_json_validator 2.1.3 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f85c2656b56c867aa06f583528e3d315026c0537369311d6302adaeda42ad6
-  data.tar.gz: 34894b9ed770db328de8011be097b72f59bb08431b45ddeb3024af01d1cf29b3
+  metadata.gz: 46e15a1f3a280bc1f2a5d197d0631a6b0e09a4beed596e971d66e1102e3a9c65
+  data.tar.gz: dfc7b7fd68462c50be8fb565d20d965fad13a29d487013df54d5cfab708b431d
 SHA512:
-  metadata.gz: db0d5e91cbbefb083b7c55d2633ef82e87868943a54dd09254f27b4ab85a5d6474eaa277ab0e23ad988a6b7f6bfc35ca870a0b735d9007b32ef5ce638fe9e198
-  data.tar.gz: a5cc28a84fd2037ec6623fce0cbbb665723a8481b89afb07139c46e6c7a8a047c885dfb1848aca667542196cd0e6c29fabf81081ad7b98c633644dbe4af4de7b
+  metadata.gz: a6b1c7770312b89c64889d8a1abeb6b59603b1be24a431e1a68cb9800268fbe36e617a1812d85c3f508ff603ffb1672c8c13a7c136847dd5b18959d815ef3304
+  data.tar.gz: 7aaf73c426c7918abb1323cc5812c04d5d8a3700192d7a0222dee9c23f2faa638692764926d34947a752ac6cb8cb14223c414f34a2595a101839ccbb11bb2552

data/README.md

@@ -16,7 +16,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activerecord_json_validator', '~> 2.0.0'
+gem 'activerecord_json_validator', '~> 2.1.0'
 ```
 
 ## Usage
@@ -164,6 +164,15 @@ 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.

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,10 @@ 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) }
     message(errors).each do |error|
-      error = error.is_a?(Hash) ? JSONSchemer::Errors.pretty(error) : error
-      record.errors.add(attribute, error, value: value)
+      error = JSONSchemer::Errors.pretty(error) if error.is_a?(Hash)
+      record.errors.add(attribute, error, errors: details, value: value)
     end
   end
 
@@ -36,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
 
@@ -68,10 +71,7 @@ protected
 
   def message(errors)
     message = options.fetch(:message)
-
-    case message
-      when Proc then [message.call(errors)].flatten if message.is_a?(Proc)
-      else [message]
-    end
+    message = message.call(errors) if message.is_a?(Proc)
+    [message].flatten
   end
 end

data/lib/active_record/json_validator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module JSONValidator
-    VERSION = '2.1.3'
+    VERSION = '2.1.5'
   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,6 +38,9 @@ describe JsonValidator do
           "required": ["country"]
         }
         '
+
+        default_country_attribute :smart_data, country: 'Canada'
+
         serialize :data, JSON
         serialize :other_data, JSON
         validates :data, json: { schema: schema, message: ->(errors) { errors } }
@@ -41,25 +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.group_by_attribute[:data].first).to have_attributes(
+          options: include(errors: ['root is missing required keys: country'])
+        )
+        expect(user.errors.group_by_attribute[:other_data].first).to have_attributes(
+          options: include(errors: ['root is missing required keys: 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.5
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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