activerecord_json_validator 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2e14ebf0558c907c5f2fc289f223cf4a6d0231b
-  data.tar.gz: ae51252742c95fc74872aa574c619269efcf9393
+  metadata.gz: e29421d6ac9835c09df419b687bdc6b018314d7c
+  data.tar.gz: 7aa8a0cb8c45e9869a245b3db8da51df08e28393
 SHA512:
-  metadata.gz: 4238c09464f4a25bb409046897fc7d56d1f13235d64999f4fc01b0e7db3fe9407cea121550a0ef8de4405a12813fb4b3397cc646f659186a4013ad7fb890d6be
-  data.tar.gz: 4c963fcccd39a4fe0629f69962dcd32a88fc0267b61179b5829a7ac664c8136bac43d46a081fd4ec3cf873d5143a8890df159713b25bb245efeda4c6cbc71a81
+  metadata.gz: 43bc39dab8b9630be6bbfbf242b1e71374a51e59a192597b81eabe3751633c4b7f15f164f4bf728bee99aa3c1d376b6b40a6e6f913d2b393798efa97f3bedbcd
+  data.tar.gz: 97ca990aeb1785b15e0ce2db84b9301e26dea7267680f140dd2e22ddb2aab7e3bf0c7984dfae7947bf2e1cea5fad051bdbbfb621f6a64647e59620a5486bf9b9

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-4.0
+  - gemfiles/Gemfile.activerecord-3.2.x
+
+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 'DO IT' && bundle exec rake spec"

data/README.md

@@ -1,5 +1,11 @@
 # ActiveRecord::JSONValidator
 
+`ActiveRecord::JSONValidator` makes it easy to validate JSON attributes against a JSON schema.
+
+<a href="https://rubygems.org/gems/activerecord_json_validator"><img src="https://badge.fury.io/rb/activerecord_json_validator.png" /></a>
+<a href="https://travis-ci.org/mirego/activerecord_json_validator"><img src="https://travis-ci.org/mirego/activerecord_json_validator.png?branch=master" /></a>
+<a href='https://coveralls.io/r/mirego/activerecord_json_validator?branch=master'><img src='https://coveralls.io/repos/mirego/activerecord_json_validator/badge.png?branch=master' alt='Coverage Status' /></a>
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -10,10 +16,25 @@ gem 'activerecord_json_validator'
 
 ## Usage
 
+### JSON Schema
+
+```json
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "properties": {
+    "city": { "type": "string", "required": false },
+    "country": { "type": "string", "required": true }
+  }
+}
+```
+
+### Ruby
+
 ```ruby
 create_table "users" do |t|
-  t.string   "name"
-  t.json     "profile"
+  t.string "name"
+  t.json "profile" # First-class JSON with PostgreSQL, yo.
 end
 
 class User < ActiveRecord::Base
@@ -24,6 +45,12 @@ class User < ActiveRecord::Base
   validates :name, presence: true
   validates :profile, presence: true, json: { schema: PROFILE_JSON_SCHEMA }
 end
+
+user = User.new(name: 'Samuel Garneau', profile: { city: 'Quebec City' })
+user.valid? # => false
+
+user = User.new(name: 'Samuel Garneau', profile: { city: 'Quebec City', country: 'Canada' })
+user.valid? # => true
 ```
 
 ## License

data/activerecord_json_validator.gemspec

@@ -21,6 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'activesupport', '>= 3.0.0'
 
+  spec.add_dependency 'json-schema', '~> 2.1'
   spec.add_dependency 'activerecord', '>= 3.0.0'
 end

data/gemfiles/Gemfile.activerecord-3.2.x

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

data/gemfiles/Gemfile.activerecord-4.0

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

data/lib/active_record/json_validator/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module JSONValidator
-    VERSION = '0.0.1'
+    VERSION = '0.1'
   end
 end

data/lib/activerecord_json_validator.rb

@@ -1,3 +1,4 @@
 require 'active_record'
+require 'json-schema'
 require 'active_record/json_validator/version'
 require 'active_record/json_validator/validator'

data/spec/json_validator_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe JsonValidator do
+  before do
+    run_migration do
+      create_table(:users, force: true) do |t|
+        t.string :name
+        t.text :profile
+      end
+    end
+
+    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 }
+    end
+  end
+
+  context 'with blank JSON value' do
+    let(:attributes) { { name: 'Samuel Garneau', profile: {} } }
+    it { expect(User.new(attributes)).to_not be_valid }
+  end
+
+  context 'with invalid JSON value' do
+    let(:attributes) { { name: 'Samuel Garneau', profile: { city: 'Quebec City' } } }
+    it { expect(User.new(attributes)).to_not be_valid }
+  end
+
+  context 'with valid JSON value' do
+    let(:attributes) { { name: 'Samuel Garneau', profile: { country: 'CA' } } }
+    it { expect(User.new(attributes)).to be_valid }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'active_support/all'
+require 'rspec'
+require 'mysql2'
+require 'pg'
+
+require 'activerecord_json_validator'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/**/*.rb', __FILE__)].map(&method(:require))
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
+  config.before :each do
+    adapter = ENV['DB_ADAPTER'] || 'postgresql'
+    setup_database(adapter: adapter, database: 'activerecord_json_validator_test')
+  end
+end

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

@@ -0,0 +1,9 @@
+class DatabaseAdapter
+  def initialize(opts = {})
+    @database = opts[:database]
+  end
+
+  def establish_connection!
+    ActiveRecord::Base.establish_connection(database_configuration)
+  end
+end

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

@@ -0,0 +1,16 @@
+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
+end

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

@@ -0,0 +1,17 @@
+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;')
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,22 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def setup_database(opts = {})
+    adapter = "#{opts[:adapter].capitalize}Adapter".constantize.new(database: opts[:database])
+    adapter.establish_connection!
+    adapter.reset_database!
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,8 @@
+module ModelMacros
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass = ActiveRecord::Base, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_json_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -52,6 +52,76 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: 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: coveralls
+  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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -75,14 +145,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - activerecord_json_validator.gemspec
+- gemfiles/Gemfile.activerecord-3.2.x
+- gemfiles/Gemfile.activerecord-4.0
 - lib/active_record/json_validator/validator.rb
 - lib/active_record/json_validator/version.rb
 - lib/activerecord_json_validator.rb
+- spec/json_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database/database_adapter.rb
+- spec/support/macros/database/mysql_adapter.rb
+- spec/support/macros/database/postgresql_adapter.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
 homepage: https://open.mirego.com/activerecord_json_validator
 licenses:
 - BSD 3-Clause
@@ -108,4 +189,11 @@ signing_key:
 specification_version: 4
 summary: ActiveRecord::JSONValidator makes it easy to validate JSON attributes with
   a JSON schema.
-test_files: []
+test_files:
+- spec/json_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database/database_adapter.rb
+- spec/support/macros/database/mysql_adapter.rb
+- spec/support/macros/database/postgresql_adapter.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb