activerecord_json_validator 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d73e408cd69522e53d830509f0a4772607eeee5b7a0102b25aea4a0e3f2fb62
-  data.tar.gz: 9f3b97d92b0c5f8a55608fdd590e906b576d00036c87cff151967392244b7ada
+  metadata.gz: 79e0a6948c155c358b3345637b6df84dc3b77ac1ea22ded1db53b35eefa4ad7c
+  data.tar.gz: 1a4c6092ee7635dd0b43767d08272a5b389c10ce9daa7ff379e89e04d4ee6766
 SHA512:
-  metadata.gz: f2fcf0da7354630f8619d075988f904dbb8b61b977e2f2fdd87f2f29fc545d5aaf0a0331e57c5e8d2bce5eeef9913900392a3a2978f6df17dd840546b9a706ca
-  data.tar.gz: 7fd00e24032a036bccf04d1e9c677de07ae085ee7d46f658b8dcda0e2bc35d0cb0c263662b18c0fb86ed144eb3d248cfc213f9216641abae84d0c5afd9403675
+  metadata.gz: 1f4f46c2db2c1b5f808fc98e003c4728b07a958a233218b1c565cb71a0bcf50118b7c1fb921735b4ee4e071f51fe458dca0e85e2267f262f30815c7b816afaac
+  data.tar.gz: 823a2e6c404e9939976177d6c0221d2ed1d0762315ec1767721492ce764302f734c0563c4e04d2f1ccf114ac40aeeb07027550dc48f1977616df548882fcf4d7

data/.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    services:
+      db:
+        image: postgres:10.19
+        env:
+          POSTGRES_DB: activerecord_json_validator_test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    env:
+      CANONICAL_HOST: localhost
+      DATABASE_URL: postgres://postgres:postgres@localhost/activerecord_json_validator_test
+      DB_ADAPTER: postgresql
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7.5'
+          bundler-cache: true
+      - run: bundle exec rubocop
+      - run: bundle exec rake spec

data/.rubocop.yml

@@ -1,6 +1,11 @@
 AllCops:
+  Include:
+    - Rakefile
+    - Gemfile
+    - '**/*.rb'
   Exclude:
     - activerecord_json_validator.gemspec
+    - vendor/**/*
 
 Documentation:
   Enabled: false

data/LICENSE.md

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

data/README.md

@@ -3,10 +3,10 @@
     <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>.
+  <code>ActiveRecord::JSONValidator</code> makes it easy to validate<br /> JSON attributes against a <a href="https://json-schema.org/">JSON schema</a>.
   <br /><br />
-  <a href="https://rubygems.org/gems/activerecord_json_validator"><img src="http://img.shields.io/gem/v/activerecord_json_validator.svg" /></a>
-  <a href="https://travis-ci.org/mirego/activerecord_json_validator"><img src="http://img.shields.io/travis/mirego/activerecord_json_validator.svg" /></a>
+  <a href="https://rubygems.org/gems/activerecord_json_validator"><img src="https://img.shields.io/gem/v/activerecord_json_validator.svg" /></a>
+  <a href="https://github.com/mirego/activerecord_json_validator/actions/workflows/ci.yaml"><img src="https://github.com/mirego/activerecord_json_validator/actions/workflows/ci.yaml/badge.svg" /></a>
 </p>
 
 ---
@@ -47,7 +47,7 @@ end
 
 class User < ActiveRecord::Base
   # Constants
-  PROFILE_JSON_SCHEMA = Pathname.new(Rails.root.join('config', 'schemas', 'profile.json'))
+  PROFILE_JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json')
 
   # Validations
   validates :name, presence: true
@@ -85,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
@@ -97,6 +97,20 @@ class User < ActiveRecord::Base
 end
 ```
 
+The schema is passed to the `JSONSchemer.schema` function, so it can be anything supported by it:
+
+```ruby
+class User < ActiveRecord::Base
+  # Constants
+  JSON_SCHEMA = Rails.root.join('config', 'schemas', 'profile.json_schema')
+  # JSON_SCHEMA = { 'type' => 'object', 'properties' => { 'foo' => { 'type' => 'integer', 'minimum' => 3 } } }
+  # JSON_SCHEMA = '{"type":"object","properties":{"foo":{"type":"integer","minimum":3}}}'
+
+  # Validations
+  validates :profile, presence: true, json: { schema: JSON_SCHEMA }
+end
+```
+
 ##### Message
 
 Like any other ActiveModel validation, you can specify either a `Symbol` or
@@ -123,12 +137,12 @@ 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-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.
 
-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.
+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.
 
 ## About Mirego
 
-[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+[Mirego](https://www.mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](https://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](https://www.mirego.org).
 
-We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.
+We also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.

data/activerecord_json_validator.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   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', '< 8'
-  spec.add_development_dependency 'phare'
   spec.add_development_dependency 'rubocop', '~> 0.28'
+  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 'activerecord', '>= 4.2.0', '< 8'

data/lib/active_record/json_validator/validator.rb

@@ -13,7 +13,10 @@ 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]
+
     # Validate value with JSON Schemer
     errors = JSONSchemer.schema(schema(record), **options.fetch(:options)).validate(value).to_a
 
@@ -22,6 +25,7 @@ class JsonValidator < ActiveModel::EachValidator
 
     # 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.1.0'
+    VERSION = '2.1.2'
   end
 end

data/spec/json_validator_spec.rb

@@ -9,6 +9,7 @@ describe JsonValidator do
       run_migration do
         create_table(:users, force: true) do |t|
           t.text :data
+          t.json :smart_data
         end
       end
 
@@ -24,16 +25,29 @@ describe JsonValidator do
         }
         '
         serialize :data, JSON
-        validates :data, json: { schema: schema, message: ->(errors) { errors.map { |error| error['details'].to_a.flatten.join(' ') } } }
+        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 } }
+
+        def smart_data
+          OpenStruct.new(self[:smart_data])
+        end
       end
     end
 
     context 'with valid JSON data but schema errors' do
-      let(:user) { User.new(data: '{"city":"Quebec City"}') }
+      let(:user) do
+        User.new(
+          data: '{"city":"Quebec City"}',
+          other_data: '{"city":"Quebec City"}',
+          smart_data: { country: 'Canada', city: 'Quebec City' }
+        )
+      end
 
       specify do
         expect(user).not_to be_valid
-        expect(user.errors.full_messages).to eql(['Data missing_keys country'])
+        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

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 require 'active_support/all'
 require 'rspec'
-require 'mysql2'
 require 'pg'
 
 require 'activerecord_json_validator'

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

@@ -6,6 +6,6 @@ class DatabaseAdapter
   end
 
   def establish_connection!
-    ActiveRecord::Base.establish_connection(database_configuration)
+    ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
   end
 end

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

@@ -3,15 +3,6 @@
 require_relative 'database_adapter'
 
 class Mysql2Adapter < DatabaseAdapter
-  def database_configuration
-    {
-      adapter: 'mysql2',
-      database: @database,
-      username: 'travis',
-      encoding: 'utf8'
-    }
-  end
-
   def reset_database!
     ActiveRecord::Base.connection.execute("SELECT concat('DROP TABLE IF EXISTS ', table_name, ';') FROM information_schema.tables WHERE table_schema = '#{@database}';")
   end

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

@@ -3,15 +3,6 @@
 require_relative 'database_adapter'
 
 class PostgresqlAdapter < DatabaseAdapter
-  def database_configuration
-    {
-      adapter: 'postgresql',
-      database: @database,
-      user: 'postgres',
-      schema_search_path: 'public'
-    }
-  end
-
   def reset_database!
     ActiveRecord::Base.connection.execute('drop schema public cascade;')
     ActiveRecord::Base.connection.execute('create schema public;')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -101,33 +87,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 - !ruby/object:Gem::Dependency
-  name: phare
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.28'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.28'
+        version: '1.44'
+- !ruby/object:Gem::Dependency
+  name: rubocop-standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: json_schemer
   requirement: !ruby/object:Gem::Requirement
@@ -170,19 +170,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - activerecord_json_validator.gemspec
-- 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

data/.travis.yml

@@ -1,41 +0,0 @@
-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
-
-services:
-  - mysql
-  - postgresql
-
-env:
-  - DB_ADAPTER=mysql2
-  - DB_ADAPTER=postgresql
-
-before_script:
-  - mysql -e 'create database activerecord_json_validator_test;'
-  - psql -c 'create database activerecord_json_validator_test;' -U postgres
-
-script:
-  - 'echo "Checking code style" && bundle exec phare'
-  - 'echo "Running tests" && bundle exec rake spec'

data/gemfiles/Gemfile.activerecord-4.2.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '../'
-
-gem 'activerecord', '~> 4.2'
-gem 'pg', '~> 0.15'

data/gemfiles/Gemfile.activerecord-5.0.x

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

data/gemfiles/Gemfile.activerecord-6.0.x

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

data/gemfiles/Gemfile.activerecord-7.0.x

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