activerecord_json_validator 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e0a6948c155c358b3345637b6df84dc3b77ac1ea22ded1db53b35eefa4ad7c
-  data.tar.gz: 1a4c6092ee7635dd0b43767d08272a5b389c10ce9daa7ff379e89e04d4ee6766
+  metadata.gz: 851b94edf54cbfdcd0a66a80dab95bcdeeea0e1c4a8831f634bc55aad5cba226
+  data.tar.gz: bf3a8280ffa8300469e793422adc68e83ab444047db67d9e6cbafec528f69803
 SHA512:
-  metadata.gz: 1f4f46c2db2c1b5f808fc98e003c4728b07a958a233218b1c565cb71a0bcf50118b7c1fb921735b4ee4e071f51fe458dca0e85e2267f262f30815c7b816afaac
-  data.tar.gz: 823a2e6c404e9939976177d6c0221d2ed1d0762315ec1767721492ce764302f734c0563c4e04d2f1ccf114ac40aeeb07027550dc48f1977616df548882fcf4d7
+  metadata.gz: 33766dfbea4cf464c499709f76b742f3bfe9b37dcc656206a15794f93733ec6711f127057ff2efb67bb75b6e439e64e75ada856d62fcdb2fece42e4ddd81b6ff
+  data.tar.gz: 7192194e8663dfbd9d343b66866ebab63d843200581bbe59be2c3f3bd485819fb13bba58bfb29241afa661c180399acce0d6fa3cf24a9d6fd5852b1d300a1be8

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
@@ -70,6 +70,7 @@ user.profile_invalid_json # => '{invalid JSON":}'
 | Option     | Description                                                                                                                    |
 | ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
 | `:schema`  | The JSON schema to validate the data against (see **Schema** section)                                                          |
+| `:value`   | The actual value to use when validating (see **Value** 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 |
 
@@ -111,6 +112,34 @@ class User < ActiveRecord::Base
 end
 ```
 
+##### Value
+
+By default, the validator will use the “getter” method to the fetch attribute
+value and validate the schema against it.
+
+```ruby
+# Will validate `self.foo`
+validates :foo, json: { schema: SCHEMA }
+```
+
+But you can change this behavior if the getter method doesn’t return raw JSON data (a `Hash`):
+
+```ruby
+# Will validate `self[:foo]`
+validates :foo, json: { schema: SCHEMA, value: ->(record, _, _) { record[:foo] } }
+```
+
+You could also implement a “raw getter” if you want to avoid the `value` option:
+
+```ruby
+# Will validate `self[:foo]`
+validates :raw_foo, json: { schema: SCHEMA }
+
+def raw_foo
+  self[:foo]
+end
+```
+
 ##### Message
 
 Like any other ActiveModel validation, you can specify either a `Symbol` or

data/lib/active_record/json_validator/validator.rb

@@ -5,6 +5,7 @@ class JsonValidator < ActiveModel::EachValidator
     options.reverse_merge!(message: :invalid_json)
     options.reverse_merge!(schema: nil)
     options.reverse_merge!(options: {})
+    options.reverse_merge!(value: ->(_record, _attribute, value) { value })
     @attributes = options[:attributes]
 
     super
@@ -13,9 +14,9 @@ class JsonValidator < ActiveModel::EachValidator
   end
 
   # Validate the JSON value with a JSON schema path or String
-  def validate_each(record, attribute, _value)
+  def validate_each(record, attribute, value)
     # Get the _actual_ attribute value, not the getter method value
-    value = record[attribute]
+    value = options.fetch(:value).call(record, attribute, value)
 
     # Validate value with JSON Schemer
     errors = JSONSchemer.schema(schema(record), **options.fetch(:options)).validate(value).to_a
@@ -24,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
 
@@ -67,10 +69,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.2'
+    VERSION = '2.1.4'
   end
 end

data/spec/json_validator_spec.rb

@@ -28,7 +28,7 @@ describe JsonValidator do
         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(' ') } } }
-        validates :smart_data, json: { schema: schema, message: ->(errors) { errors } }
+        validates :smart_data, json: { value: ->(record, _, _) { record[:smart_data] }, schema: schema, message: ->(errors) { errors } }
 
         def smart_data
           OpenStruct.new(self[:smart_data])
@@ -48,6 +48,12 @@ describe JsonValidator do
       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
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler