activerecord-postgres-json 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 805b94f4d910fc64b531ccfc98bf0ba9394d5b59
-  data.tar.gz: b6615bedfb5ba1c479dfe16058ee7ff0ce070508
+  metadata.gz: b385f869eb3d9e0de150fc2762c1dd04f1d66c0e
+  data.tar.gz: 86fe3304395044c2c36ba0218851bddbec25c34f
 SHA512:
-  metadata.gz: ca014d4c22084bcd77590f5013c7a306cfc300810da5ad3fa09d2a69c741e7bf8cc40d2312698042dc5d961786b5d6ff514423bb451011eee00ce7f4529176f7
-  data.tar.gz: 006e6e22717445da67a7f5422bc5a82a1da5b789f530983f29ed58fe02f236a70e053f03aa875c74733071fc5911c17e7bcc2b085bbe3398e0b3dc48b187ede9
+  metadata.gz: d4c5751709d4ff8b2b10bb9e962d9b0dee214db3cf7e08e488ae52a94dd1bac1fcce72d65352ea6435ecf4282db7cfb7ebd5470525d45c2ec59d5d57b465f596
+  data.tar.gz: d3a15934cbc4039345e3a295bea2dfe806373648d1aab150af13d246ca85d1cf7e9a986831cbfc0a72b5303d907de4037d4667d1a577939860e2d078954267df

data/.rubocop.yml

@@ -0,0 +1,28 @@
+LineLength:
+  Max: 200
+
+HashSyntax:
+  EnforcedStyle: ruby19
+
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 26
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 20
+
+TrailingComma:
+  Enabled: false
+AllCops:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/**/*'
+    - '**/Rakefile'

data/Gemfile

@@ -2,10 +2,14 @@ source 'http://rubygems.org'
 
 gem 'activerecord', '>= 3.2', '< 4'
 gem 'multi_json'
-gem 'hashie'
+
+group :development, :test do
+  gem 'rspec', '~> 2.0'
+  gem 'pg'
+end
 
 group :development do
-  gem 'rspec'
+  gem 'rubocop'
   gem 'rdoc'
   gem 'bundler'
   gem 'jeweler'

data/README.md

@@ -1,19 +1,20 @@
 # activerecord-postgres-json
 
-A minimal JSON column type support for ActiveRecord 3.2.x
+A minimal JSON/JSONB column type support for ActiveRecord 3.2.x
 This gem adds the following support:
 
-1. Using json column type in migrations, e.g. `add_column :foo, :bar, :json`
+1. Using json/jsonb column type in migrations, e.g. `add_column :foo, :bar, :json` or `add_column :foo, :bar, :jsonb`
 2. json field support in the schema definitions
 3. JSON coder for using with the `serialize` class method:
 
 ```ruby
 class User < ActiveRecord::Base
   serialize :settings, ActiveRecord::Coders::JSON
+  serialize :settings, ActiveRecord::Coders::JSON.new(symbolize_keys: true) # for symbolize keys
 end
 
-User.first.settings.class # => Hashie::Mash
-User.first.settings.show_popups # => true
+User.first.settings.class # => Hash
+User.first.settings[:show_popups] # => true
 ...
 ```
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/activerecord-postgres-json.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: activerecord-postgres-json 0.1.2 ruby lib
+# stub: activerecord-postgres-json 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "activerecord-postgres-json"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Roman Shterenzon"]
-  s.date = "2014-06-13"
+  s.date = "2015-01-16"
   s.description = "Active Record support for PostgreSQL JSON type"
   s.email = "romanbsd@yahoo.com"
   s.extra_rdoc_files = [
@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".rubocop.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -32,11 +32,14 @@ Gem::Specification.new do |s|
     "lib/activerecord-postgres-json/activerecord.rb",
     "lib/activerecord-postgres-json/coders.rb",
     "spec/activerecord-postgres-json_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/coder_spec.rb",
+    "spec/database.yml",
+    "spec/spec_helper.rb",
+    "spec/support/database_setup.rb"
   ]
   s.homepage = "http://github.com/romanbsd/activerecord-postgres-json"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.3"
   s.summary = "Active Record support for PostgreSQL JSON type"
 
   if s.respond_to? :specification_version then
@@ -45,16 +48,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activerecord>, ["< 4", ">= 3.2"])
       s.add_runtime_dependency(%q<multi_json>, [">= 0"])
-      s.add_runtime_dependency(%q<hashie>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<pg>, [">= 0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
       s.add_dependency(%q<activerecord>, ["< 4", ">= 3.2"])
       s.add_dependency(%q<multi_json>, [">= 0"])
-      s.add_dependency(%q<hashie>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<pg>, [">= 0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
@@ -62,8 +67,9 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activerecord>, ["< 4", ">= 3.2"])
     s.add_dependency(%q<multi_json>, [">= 0"])
-    s.add_dependency(%q<hashie>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<pg>, [">= 0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/lib/activerecord-postgres-json.rb

@@ -1,4 +1,4 @@
-ActiveSupport.on_load :active_record do
+ActiveSupport.on_load :active_record do # rubocop:disable Style/FileName
   require 'activerecord-postgres-json/activerecord'
 end
 require 'activerecord-postgres-json/coders'

data/lib/activerecord-postgres-json/activerecord.rb

@@ -2,17 +2,25 @@ require 'active_record'
 require 'active_record/connection_adapters/postgresql_adapter'
 
 module ActiveRecord
-
   module ConnectionAdapters
-    PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:json] = {name: 'json'}
+    PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:json]  = { name: 'json' }
+    PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:jsonb] = { name: 'jsonb' }
 
     class PostgreSQLColumn < Column
       # Adds the json type for the column.
       def simplified_type_with_json(field_type)
-        field_type == 'json' ? :json : simplified_type_without_json(field_type)
+        return :json  if field_type == 'json'
+        simplified_type_without_json(field_type)
+      end
+
+      # Adds the json type for the column.
+      def simplified_type_with_jsonb(field_type)
+        return :jsonb if field_type == 'jsonb'
+        simplified_type_without_jsonb(field_type)
       end
 
       alias_method_chain :simplified_type, :json
+      alias_method_chain :simplified_type, :jsonb
 
       class << self
         def extract_value_from_default_with_json(default)
@@ -25,12 +33,23 @@ module ActiveRecord
             extract_value_from_default_without_json(default)
           end
         end
+
+        def extract_value_from_default_with_jsonb(default)
+          case default
+          when "'{}'::jsonb"
+            '{}'
+          when "'[]'::jsonb"
+            '[]'
+          else
+            extract_value_from_default_without_jsonb(default)
+          end
+        end
         alias_method_chain :extract_value_from_default, :json
+        alias_method_chain :extract_value_from_default, :jsonb
       end
     end
 
     class TableDefinition
-
       # Adds json type for migrations. So you can add columns to a table like:
       #   create_table :people do |t|
       #     ...
@@ -43,10 +62,14 @@ module ActiveRecord
         column_names.each { |name| column(name, 'json', options) }
       end
 
+      def jsonb(*args)
+        options = args.extract_options!
+        column_names = args
+        column_names.each { |name| column(name, 'jsonb', options) }
+      end
     end
 
     class Table
-
       # Adds json type for migrations. So you can add columns to a table like:
       #   change_table :people do |t|
       #     ...
@@ -58,6 +81,12 @@ module ActiveRecord
         column_names = args
         column_names.each { |name| column(name, 'json', options) }
       end
+
+      def jsonb(*args)
+        options = args.extract_options!
+        column_names = args
+        column_names.each { |name| column(name, 'jsonb', options) }
+      end
     end
   end
 end

data/lib/activerecord-postgres-json/coders.rb

@@ -1,5 +1,4 @@
 require 'multi_json'
-require 'hashie'
 
 module ActiveRecord
   module Coders
@@ -12,12 +11,19 @@ module ActiveRecord
         new.dump(json)
       end
 
-      def initialize(default = Hashie::Mash.new)
-        @default = default
+      def initialize(params = {})
+        @default = {}
+        return unless params.class.name == 'Hash'
+        @default   = params[:default] if params[:default]
+        @symbolize_keys = params[:symbolize_keys] if params[:symbolize_keys]
       end
 
       def dump(obj)
-        obj.nil? ? (@default.nil? ? nil : to_json(@default)) : to_json(obj)
+        if obj.nil?
+          @default.nil? ? nil : to_json(@default)
+        else
+          to_json(obj)
+        end
       end
 
       def load(json)
@@ -25,13 +31,22 @@ module ActiveRecord
       end
 
       private
+
       def to_json(obj)
         MultiJson.dump(obj)
       end
 
-      # FIXME: support arrays
       def from_json(json)
-        Hashie::Mash.new MultiJson.load(json)
+        convert_object MultiJson.load(json, symbolize_keys: @symbolize_keys)
+      end
+
+      def convert_object(obj)
+        case obj
+        when Array
+          obj.map { |member| convert_object(member) }
+        else
+          obj
+        end
       end
     end
   end

data/spec/activerecord-postgres-json_spec.rb

@@ -1,4 +1,103 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/support/database_setup')
 
-describe "ActiverecordPostgresJson" do
+class Post < ActiveRecord::Base
+  serialize :data, ActiveRecord::Coders::JSON.new(symbolize_keys: true)
+end
+
+class PostQuestions < ActiveRecord::Base
+  serialize :tags, ActiveRecord::Coders::JSON
+end
+
+describe 'ActiverecordPostgresJson', db: true do
+  before(:all) do
+    ActiveRecord::Schema.define do
+      create_table :posts, force: true do |t|
+        t.column :data, :jsonb
+      end
+    end
+
+    Post.reset_column_information
+
+    ActiveRecord::Base.connection.execute <<-SQL
+      CREATE INDEX index_posts_data_gin ON posts
+      USING  gin (data);
+    SQL
+
+    ActiveRecord::Base.connection.execute <<-SQL
+      CREATE OR REPLACE VIEW post_questions as
+      SELECT
+        id,
+        data ->> 'title'            AS title,
+        data #>> '{author,name}'    AS author_name,
+        data #>> '{author,email}'   AS author_email,
+        (data ->> 'tags')::json     AS tags,
+        (data ->> 'draft')::boolean AS draft
+      FROM posts
+    SQL
+  end
+
+  after(:all) do
+    ActiveRecord::Base.connection.execute 'DROP INDEX IF EXISTS index_posts_data_gin'
+    ActiveRecord::Base.connection.execute 'DROP VIEW IF EXISTS post_questions'
+  end
+
+  before { Post.delete_all }
+
+  let!(:hdd) do
+    Post.create!(data: [
+                     {f1: 6, f2: 5, value: true, intencity: 2.0},
+                     {f1: 9, f2: 3, value: false, intencity: 1.0}
+                     ]).reload
+  end
+
+  let!(:tdd) do
+    Post.create!(data: [
+                     {f1: 1, f2: 2, value: false, intencity: 2.0},
+                     {f1: 1, f2: 4, value: true, intencity: 1.0}
+                     ]).reload
+  end
+
+  let!(:bdd) do
+    Post.create!(data: {
+                         title: 'BDD is woot',
+                         author: { name: 'Philippe', email: 'philippe@example.com'},
+                         tags:   ['bdd', 'testing', 'woot',  true],
+                         word_count: 42
+                     }).reload
+  end
+
+  let!(:foo) do
+    Post.create!(data: {
+                         title: 'FOO is bar',
+                         author: { name: 'Philippe', email: 'philippe@example.com'},
+                         tags:   ['foo', 'bar', 42],
+                         draft:  true
+                     }).reload
+  end
+
+  it 'maps fields' do
+    post = PostQuestions.find_by_title! 'FOO is bar'
+    expect(post.author_name).to eq('Philippe')
+    expect(post.author_email).to eq('philippe@example.com')
+    expect(post.tags).to eq ['foo', 'bar', 42]
+    expect(post).to be_draft
+  end
+
+  it 'provides search as if it was a good old table' do
+    expect(PostQuestions.where(author_name: 'Philippe').pluck(:title)).to eq ['BDD is woot', 'FOO is bar']
+    expect(PostQuestions.where(draft: true).count).to eq(1)
+  end
+
+  it 'when retrieve objects as array' do
+    expect(Post.where('data @> \'[{"f1":1}]\'').first.data)
+      .to eq [
+               {f1: 1, f2: 2, value: false, intencity: 2.0},
+               {f1: 1, f2: 4, value: true, intencity: 1.0}
+             ]
+  end
+
+  it 'when search in objects array' do
+    expect(Post.where('data @> \'[{"f1":6}]\'').count).to eq(1)
+  end
 end

data/spec/coder_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ActiveRecord::Coders::JSON do
+  it 'converts hashes' do
+    res = described_class.load('{"foo":"bar", "bar":[1,2]}')
+    expect(res).to eq('foo' => 'bar', 'bar' => [1,2])
+  end
+
+  it 'converts arrays' do
+    res = described_class.load('[{"foo":"bar"}, [{"bar":"baz"}], [[1,2],{"baz":"foo"}]]')
+    expect(res).to eq([{'foo' => 'bar'}, [{'bar' => 'baz'}], [[1,2], {'baz' => 'foo'}]])
+  end
+end

data/spec/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: ar_postgres_json_test

data/spec/spec_helper.rb

@@ -1,29 +1,26 @@
-require 'simplecov'
-
-module SimpleCov::Configuration
-  def clean_filters
-    @filters = []
-  end
-end
-
-SimpleCov.configure do
-  clean_filters
-  load_adapter 'test_frameworks'
-end
-
-ENV["COVERAGE"] && SimpleCov.start do
-  add_filter "/.rvm/"
-end
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
+require 'active_record'
 require 'activerecord-postgres-json'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-
+  config.around db: true do |example|
+    if example.metadata[:disable_transactions]
+      example.call
+    else
+      ActiveRecord::Base.transaction do
+        begin
+          example.call
+        ensure
+          raise ActiveRecord::Rollback
+        end
+      end
+    end
+  end
 end

data/spec/support/database_setup.rb

@@ -0,0 +1,22 @@
+require 'logger'
+require 'pg'
+
+db_config = YAML.load_file(File.expand_path('../../database.yml', __FILE__))
+
+begin
+  ActiveRecord::Base.establish_connection db_config['test']
+  ActiveRecord::Base.connection.active?
+rescue Exception => e
+  encoding = db_config['test']['encoding'] || ENV['CHARSET'] || 'utf8'
+  begin
+    ActiveRecord::Base.establish_connection(db_config['test'].merge('database' => 'postgres', 'schema_search_path' => 'public'))
+    ActiveRecord::Base.connection.create_database(db_config['test']['database'], db_config['test'].merge('encoding' => encoding))
+    ActiveRecord::Base.establish_connection(db_config['test'])
+  rescue Exception => ec
+    $stderr.puts ec, *(ec.backtrace)
+    $stderr.puts "Couldn't create database for #{db_config['test'].inspect}"
+  end
+ensure
+  ActiveRecord::Base.logger = Logger.new(STDOUT)
+  ActiveRecord::Base.logger.formatter = ->(_, _, _, msg) { "#{msg}\n" }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-json
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Shterenzon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,13 +45,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,8 +138,8 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -135,7 +149,10 @@ files:
 - lib/activerecord-postgres-json/activerecord.rb
 - lib/activerecord-postgres-json/coders.rb
 - spec/activerecord-postgres-json_spec.rb
+- spec/coder_spec.rb
+- spec/database.yml
 - spec/spec_helper.rb
+- spec/support/database_setup.rb
 homepage: http://github.com/romanbsd/activerecord-postgres-json
 licenses:
 - MIT
@@ -156,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Active Record support for PostgreSQL JSON type

data/Gemfile.lock

@@ -1,81 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.2.18)
-      activesupport (= 3.2.18)
-      builder (~> 3.0.0)
-    activerecord (3.2.18)
-      activemodel (= 3.2.18)
-      activesupport (= 3.2.18)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.18)
-      i18n (~> 0.6, >= 0.6.4)
-      multi_json (~> 1.0)
-    addressable (2.3.6)
-    arel (3.0.3)
-    builder (3.0.4)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
-    faraday (0.9.0)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.6)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (2.1.1)
-    highline (1.6.21)
-    i18n (0.6.9)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    jwt (1.0.0)
-    mini_portile (0.6.0)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.2.1)
-      mini_portile (= 0.6.0)
-    oauth2 (0.9.4)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.3.2)
-    rdoc (4.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    thread_safe (0.3.4)
-    tzinfo (0.3.39)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (>= 3.2, < 4)
-  bundler
-  hashie
-  jeweler
-  multi_json
-  rdoc
-  rspec