activerecord_json_validator 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22cf2432dfb4427ba383de56c603a6ab9a02ff74
-  data.tar.gz: eb005d90645dcf4e6471d7bd784523d67146418d
+  metadata.gz: b48b4031de5f8c6acbebdf18140fcedba69ed87c
+  data.tar.gz: c378d6029f74ab611000db2ade4b785beec0f031
 SHA512:
-  metadata.gz: 637ba361b8d482dbe0edea5e27a96a815af724b9cfa5a2cdf7504d0f7f64a26b0e82e3228ad34a044b3e5ea64129f36556889dfa23a6a8d01d22830feb706705
-  data.tar.gz: 910b92a51b66a283b60a15d79854ca58c05104c786de9d0a7a578e21c9ef782c5a5e0bba46ef88df12aed68d5a80f6ec03e71156e4610751cd16dee254a05461
+  metadata.gz: 587e07e4a9fbb7dabc6e82dc880dd7069ee1eaf89b32f9523512d0d6e5ec5724e383f1e0301b2ef76c820b09a2370c59e7ed0e62d5fd4a919a2279b7ffda9e60
+  data.tar.gz: 6d8edfea72e360af096bf8abc94c8b9b56db6e4028f712e06488aa179a1dec59df06cf386bfe7bb986a779bba8ae3eabe67c552182c3cb59d0fab52046e59c9b

data/.rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - activerecord_json_validator.gemspec
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+      - memo
+      - item
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/ExtraSpacing:
+  Enabled: true

data/.travis.yml

@@ -18,7 +18,9 @@ before_script:
   - mysql -e 'create database activerecord_json_validator_test;'
   - psql -c 'create database activerecord_json_validator_test;' -U postgres
 
-script: "echo 'DO IT' && bundle exec rake spec"
+script:
+  - 'echo "Checking code style" && bundle exec phare'
+  - 'echo "Running tests" && bundle exec rake spec'
 
 addons:
   postgresql: 9.3

data/README.md

@@ -56,6 +56,86 @@ user.valid? # => false
 user.profile_invalid_json # => '{invalid JSON":}'
 ```
 
+#### Options
+
+| 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`)
+
+##### JSON schema option
+
+You can specify four kinds of value for the `:schema` option.
+
+###### A path to a file containing a JSON schema
+
+```ruby
+class User < ActiveRecord::Base
+  # Constants
+  PROFILE_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema').to_s
+
+  # Validations
+  validates :profile, presence: true, json: { schema: PROFILE_JSON_SCHEMA }
+end
+```
+
+###### 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 }
+end
+```
+
+###### A plain JSON schema as a Ruby `String`
+
+```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 }
+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`).
+
+```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
+end
+```
+
 ## 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.

data/Rakefile

@@ -12,7 +12,7 @@ end
 
 desc 'Start an IRB session with the gem'
 task :console do
-  $:.unshift File.expand_path('..', __FILE__)
+  $LOAD_PATH.unshift File.expand_path('..', __FILE__)
   require 'activerecord_json_validator'
   require 'irb'
 

data/activerecord_json_validator.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'activesupport', '>= 4.1.0', '< 5'
+  spec.add_development_dependency 'phare'
+  spec.add_development_dependency 'rubocop', '~> 0.28'
 
   spec.add_dependency 'json-schema', '~> 2.5'
   spec.add_dependency 'activerecord', '>= 4.1.0', '< 5'

data/lib/active_record/json_validator/validator.rb

@@ -28,11 +28,15 @@ class JsonValidator < ActiveModel::EachValidator
       json_value = ''
     end
 
-    errors = ::JSON::Validator.fully_validate(options.fetch(:schema), json_value)
+    # Validate value with JSON::Validator
+    schema = fetch_schema_for_record(record)
+    errors = ::JSON::Validator.fully_validate(schema, json_value)
 
-    if errors.any? || record.send(:"#{attribute}_invalid_json").present?
-      record.errors.add(attribute, options.fetch(:message), value: value)
-    end
+    # Everything is good if we don’t have any errors and we got valid JSON value
+    return true if errors.empty? && record.send(:"#{attribute}_invalid_json").blank?
+
+    # Add error message to the attribute
+    record.errors.add(attribute, options.fetch(:message), value: value)
   end
 
 protected
@@ -51,10 +55,17 @@ protected
             super(args)
           rescue MultiJson::LoadError, JSON::ParserError
             @#{attribute}_invalid_json = args
-            super(invalid_json: true)
+            super({})
           end
         end
       RUBY
     end
   end
+
+  def fetch_schema_for_record(record)
+    schema = options.fetch(:schema)
+    return schema unless schema.is_a?(Proc)
+
+    record.instance_exec(&schema)
+  end
 end

data/lib/active_record/json_validator/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JSONValidator
-    VERSION = '0.3'
+    VERSION = '0.4'
   end
 end

data/spec/json_validator_spec.rb

@@ -9,23 +9,36 @@ describe JsonValidator do
       end
     end
 
+    json_schema = schema
     spawn_model :User do
-      schema = {
-        type: 'object',
-        :'$schema' => 'http://json-schema.org/draft-03/schema',
-        properties: {
-          city: { type: 'string', required: false },
-          country: { type: 'string', required: true }
-        }
-      }
-
       serialize :profile, JSON
       validates :name, presence: true
-      validates :profile, presence: true, json: { schema: schema }
+      validates :profile, presence: true, json: { schema: json_schema }
+
+      def dynamic_json_schema
+        {
+          type: 'object',
+          :'$schema' => 'http://json-schema.org/draft-03/schema',
+          properties: {
+            foo: { type: 'string', required: false },
+            bar: { type: 'string', required: true }
+          }
+        }
+      end
     end
   end
 
   let(:user) { User.create(attributes) }
+  let(:schema) do
+    {
+      type: 'object',
+      :'$schema' => 'http://json-schema.org/draft-03/schema',
+      properties: {
+        city: { type: 'string', required: false },
+        country: { type: 'string', required: true }
+      }
+    }
+  end
 
   context 'with blank JSON value' do
     let(:attributes) { { name: 'Samuel Garneau', profile: {} } }
@@ -61,7 +74,23 @@ describe JsonValidator do
 
     specify do
       expect(user).to_not be_valid
+      expect(user.profile).to eql({})
       expect(user.profile_invalid_json).to eql('foo:}bar')
     end
   end
+
+  context 'with lambda schema option' do
+    # The dynamic schema makes `country` and `city` keys mandatory
+    let(:schema) { -> { dynamic_json_schema } }
+
+    context 'with valid JSON value' do
+      let(:attributes) { { name: 'Samuel Garneau', profile: { foo: 'bar', bar: 'foo' } } }
+      it { expect(user).to be_valid }
+    end
+
+    context 'with invalid JSON value' do
+      let(:attributes) { { name: 'Samuel Garneau', profile: {} } }
+      it { expect(user).not_to be_valid }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$:.unshift File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 
 require 'active_support/all'
 require 'rspec'

data/spec/support/macros/database_macros.rb

@@ -5,7 +5,7 @@ module DatabaseMacros
     klass = Class.new(ActiveRecord::Migration)
 
     # Create a new `up` that executes the argument
-    klass.send(:define_method, :up) { self.instance_exec(&block) }
+    klass.send(:define_method, :up) { instance_exec(&block) }
 
     # Create a new instance of it and execute its `up` method
     klass.new.up

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: phare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +186,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.md