pgrel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43d4c6d3c7078b0823c3da86d1749db92e7b86f9759fb17326b3065780290649
-  data.tar.gz: ebf600d3ccb22d4bed4dc4f6a479c7f3c1aa65e300edebbcaaded0da9e8698cc
+  metadata.gz: 62a79ba274061f7a36972f8817c5ee5b61242af5d92d8d7ca77f776cfb1ee802
+  data.tar.gz: f8c8da31f5ce40f8c1e3400dd154aac9f1a8309768586d7f1049e733a1e5650b
 SHA512:
-  metadata.gz: c7a7c10c700279fbc1943d44e478ddbc096fe35af24d1733b4cc95bf564322580c177abbc56c3e76f2ffcd69053229badab34b5e9cc53b496e1d8a638118f662
-  data.tar.gz: b8381c2b638a70e58c9159b3a8ab2a3ecd2261a305d376fa2346f91dc7130ff163caafbe237bfe4f0c3c503f51c28be15dbb95e7e20421478187f4bc29c4792e
+  metadata.gz: 34d502c9098aa129c3a64acd5d48d722e31d38b3ececf9d930d9629da226e73aa9077643882341e6a01a9cf1ae95158348347a3b98f2ee92319b553aede53c8e
+  data.tar.gz: e7b38cbd1eaa94fffbecaa093caa87ebf4ae73aa128139db1efd8d022047d6775dbbf4452cb2e5ff94ccc8fc6dbc1cf0d93b29ee762230b8c2aafc9f6f450549

data/.gitignore

@@ -33,4 +33,5 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 spec/dummy/.sass-cache
 Gemfile.local
-Gemfile.lock
+Gemfile.lock
+.rspec_status

data/.travis.yml

@@ -10,7 +10,9 @@ before_script:
 
 matrix:
   include:
-    - rvm: 2.5.0
+    - rvm: 2.6.0
+      gemfile: gemfiles/railsmaster.gemfile
+    - rvm: 2.6.0
       gemfile: gemfiles/rails5.gemfile
     - rvm: 2.4.3
       gemfile: gemfiles/rails5.gemfile

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## master
 
+## 0.3.0 (2019-28-01)
+
+- Rename `#value` method to `#overlap_values`.
+- Rename `#values` method to `#contains_values`.
+- Improve `#contains_values` method:
+	eliminate multiple `avals` calls for Hstore and multiple `array_agg` calls for Jsonb.
+
+  See https://github.com/palkan/pgrel/pull/9. ([@StanisLove][])
+
+- Quote store name in queries. ([@palkan][])
+
+  Previously, we didn't quote store name in queries which could led
+  to ambiguity conflicts when joining tables.
+  Now it fixed.
+
 ## 0.2.0 (2018-06-15)
 
 - Add `#update_store` methods. ([@StanisLove][])

data/README.md

@@ -4,7 +4,7 @@
 
 ActiveRecord extension for querying hstore, array and jsonb.
 
-Compatible with **Rails** >= 4.2.
+Compatible with **Rails** >= 4.2 (including **Rails 6**).
 
 #### Install
 
@@ -57,11 +57,11 @@ Values existence:
 
 ```ruby
 # Retrieve items that have value '1' OR '2'
-Hstore.where.store(:tags).value(1, 2)
-#=> select * from hstores where (avals(tags) @> ARRAY['1'] OR avals(tags) @> ARRAY['2'] )
+Hstore.where.store(:tags).overlap_values(1, 2)
+#=> select * from hstores where (avals(tags) && ARRAY['1', '2'])
 
 # Retrieve items that have values '1' AND '2'
-Hstore.where.store(:tags).values(1, 2)
+Hstore.where.store(:tags).contains_values(1, 2)
 #=> select * from hstores where (avals(tags) @> ARRAY['1', '2'])
 ```
 

data/gemfiles/railsmaster.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', github: 'rails/rails'
+
+gemspec path: '..'

data/lib/pgrel/active_record/store_chain.rb

@@ -6,10 +6,13 @@ module ActiveRecord
     # Provides _containment_ queries methods.
     # Provides basic methods.
     class StoreChain
+      attr_reader :store_name, :quoted_store_name
+
       def initialize(scope, store_name)
         @scope = scope
         @store_name = store_name
         @inverted = false
+        @quoted_store_name = "#{@scope.klass.quoted_table_name}.#{@scope.klass.connection.quote_column_name(store_name)}"
       end
 
       # Whether the store contains provided store
@@ -33,7 +36,7 @@ module ActiveRecord
       #   data = {b: 1, c: 2}
       #   Model.store(:store).contains(data).all #=> [Model(name: 'first', ...)]
       def contained(opts)
-        update_scope "#{@store_name} <@ #{type_cast(opts)}"
+        update_scope "#{quoted_store_name} <@ #{type_cast(opts)}"
       end
 
       # Add negation to condition.
@@ -135,7 +138,7 @@ module ActiveRecord
       private
 
       def contains_clause(opts)
-        "#{@store_name} @> #{type_cast(opts)}"
+        "#{quoted_store_name} @> #{type_cast(opts)}"
       end
 
       def build_or_contains(k, vals)
@@ -154,7 +157,7 @@ module ActiveRecord
       #   # Get all records which have key 'a' in store 'store'
       #   Model.store(:store).key('a').all #=> [Model(name: 'first', ...)]
       def key(key)
-        update_scope "#{@store_name} ? :key", key: key.to_s
+        update_scope "#{quoted_store_name} ? :key", key: key.to_s
       end
 
       # Several keys existence
@@ -166,7 +169,7 @@ module ActiveRecord
       #   Model.store(:store).keys('a','b').all #=> [Model(name: 'first', ...)]
       def keys(*keys)
         update_scope(
-          "#{@store_name} ?& ARRAY[:keys]",
+          "#{quoted_store_name} ?& ARRAY[:keys]",
           keys: keys.flatten.map(&:to_s)
         )
       end
@@ -180,7 +183,7 @@ module ActiveRecord
       #   Model.store(:store).keys('a','b').count #=> 2
       def any(*keys)
         update_scope(
-          "#{@store_name} ?| ARRAY[:keys]",
+          "#{quoted_store_name} ?| ARRAY[:keys]",
           keys: keys.flatten.map(&:to_s)
         )
       end

data/lib/pgrel/active_record/store_chain/array_chain.rb

@@ -13,7 +13,7 @@ module ActiveRecord
       #   Model.store(:store).overlap('c').all #=> [Model(name: 'first', ...)]
       #   Model.store(:store).overlap(['b']).size #=> 2
       def overlap(*vals)
-        update_scope "#{@store_name} && #{type_cast(vals.flatten)}"
+        update_scope "#{quoted_store_name} && #{type_cast(vals.flatten)}"
       end
     end
   end

data/lib/pgrel/active_record/store_chain/hstore_chain.rb

@@ -4,32 +4,27 @@ module ActiveRecord
   module QueryMethods
     # Store chain for hstore columns.
     class HstoreChain < KeyStoreChain
-      # Value existence
+      # Overlap values
       #
       # Example
       #   Model.create!(name: 'first', store: {a: 1, b: 2})
       #   Model.create!(name: 'second', store: {b: 1, c: 3})
       #
-      #   Model.store(:store).value(1, 2).all
+      #   Model.store(:store).overlap_values(1, 2).all
       #   #=>[Model(name: 'first', ...), Model(name: 'second')]
-      def value(*values)
-        query = String.new
-        values.length.times do |n|
-          query.concat("avals(#{@store_name}) @> ARRAY[?]")
-          query.concat(' OR ') if n < values.length - 1
-        end
-        update_scope(query, *values.map(&:to_s))
+      def overlap_values(*values)
+        update_scope("avals(#{quoted_store_name}) && ARRAY[?]", values.map(&:to_s))
       end
 
-      # Values existence
+      # Contains values
       #
       # Example
       #   Model.create!(name: 'first', store: {a: 1, b: 2})
       #   Model.create!(name: 'second', store: {b: 1, c: 3})
       #
-      #   Model.store(:store).values(1, 2).all #=> [Model(name: 'first', ...)]
-      def values(*values)
-        update_scope("avals(#{@store_name}) @> ARRAY[?]", values.map(&:to_s))
+      #   Model.store(:store).contains_values(1, 2).all #=> [Model(name: 'first', ...)]
+      def contains_values(*values)
+        update_scope("avals(#{quoted_store_name}) @> ARRAY[?]", values.map(&:to_s))
       end
     end
   end

data/lib/pgrel/active_record/store_chain/jsonb_chain.rb

@@ -4,6 +4,8 @@ module ActiveRecord
   module QueryMethods
     # Store chain for jsonb columns.
     class JsonbChain < KeyStoreChain
+      OPERATORS = { contains: '@>', overlap: '&&' }.freeze
+
       # Query by value in path.
       #
       # Example:
@@ -30,52 +32,30 @@ module ActiveRecord
           val = val.to_s
         end
 
-        where_with_prefix "#{@store_name}#{op}", path => val
+        where_with_prefix "#{quoted_store_name}#{op}", path => val
       end
 
-      # Value existence
+      # Overlap values
       #
       # Example
       #   Model.create!(name: 'first', store: {a: 1, b: 2})
       #   Model.create!(name: 'second', store: {b: 1, c: 3})
       #
-      #   Model.store(:store).values(1, 2).all
+      #   Model.store(:store).overlap_values(1, 2).all
       #   #=>[Model(name: 'first', ...), Model(name: 'second')]
-      def value(*values)
-        query = String.new
-        values = values.map do |v|
-          case v
-          when Hash, Array, String
-            v.to_json
-          else
-            v.to_s
-          end
-        end
-
-        values.length.times do |n|
-          query.concat(value_existence_query)
-          query.concat(' OR ') if n < values.length - 1
-        end
-        update_scope(query, *values)
+      def overlap_values(*values)
+        update_scope(value_query(:overlap), cast_values(values))
       end
 
-      # Values existence
+      # Contains values
       #
       # Example
       #   Model.create!(name: 'first', store: {a: 1, b: 2})
       #   Model.create!(name: 'second', store: {b: 1, c: 3})
       #
-      #   Model.store(:store).values(1, 2).all #=> [Model(name: 'first', ...)]
-      def values(*values)
-        values = values.map do |v|
-          case v
-          when Hash, Array, String
-            v.to_json
-          else
-            v.to_s
-          end
-        end
-        update_scope(value_existence_query, values)
+      #   Model.store(:store).contains_values(1, 2).all #=> [Model(name: 'first', ...)]
+      def contains_values(*values)
+        update_scope(value_query(:contains), cast_values(values))
       end
 
       private
@@ -91,8 +71,20 @@ module ActiveRecord
         end
       end
 
-      def value_existence_query
-        "(SELECT array_agg(value) FROM jsonb_each(#{@store_name})) @> ARRAY[?]::jsonb[]"
+      def value_query(operator)
+        oper = OPERATORS[operator]
+        "(SELECT array_agg(value) FROM jsonb_each(#{quoted_store_name})) #{oper} ARRAY[?]::jsonb[]"
+      end
+
+      def cast_values(values)
+        values.map do |v|
+          case v
+          when Hash, Array, String
+            v.to_json
+          else
+            v.to_s
+          end
+        end
       end
     end
   end

data/lib/pgrel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgrel # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/pgrel/array_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe ArrayStore do
-  before do
+  before(:all) do
     @connection = ActiveRecord::Base.connection
 
     @connection.transaction do
@@ -14,7 +14,9 @@ describe ArrayStore do
     ArrayStore.reset_column_information
   end
 
-  after do
+  after { ArrayStore.delete_all }
+
+  after(:all) do
     @connection.drop_table 'array_stores', if_exists: true
   end
 
@@ -68,4 +70,18 @@ describe ArrayStore do
       expect(ArrayStore.where.store(:tags).not.overlap('b', 2).size).to eq 1
     end
   end
+
+  context "joins" do
+    before do
+      User.create!(name: "x", array_store: ArrayStore.find_by!(name: "a"))
+      User.create!(name: "y", array_store: ArrayStore.find_by!(name: "b"))
+      User.create!(name: "z", array_store: ArrayStore.find_by!(name: "c"))
+    end
+
+    it "works" do
+      users = User.joins(:array_store).merge(ArrayStore.where.store(:tags).overlap(2))
+      expect(users.size).to eq 2
+      expect(users.map(&:name)).to match_array(["x", "y"])
+    end
+  end
 end

data/spec/pgrel/hstore_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Hstore do
-  before do
+  before(:all) do
     @connection = ActiveRecord::Base.connection
 
     @connection.transaction do
@@ -14,7 +14,9 @@ describe Hstore do
     Hstore.reset_column_information
   end
 
-  after do
+  after { Hstore.delete_all }
+
+  after(:all) do
     @connection.drop_table 'hstores', if_exists: true
   end
 
@@ -99,23 +101,30 @@ describe Hstore do
     expect(records.first.name).to eq 'e'
   end
 
-  it '#value' do
-    records = Hstore.where.store(:tags).value(1, false, [1, 2, { a: 1 }])
-    expect(records.size).to eq 3
+  describe '#overlap_values' do
+    let(:records) { Hstore.where.store(:tags).overlap_values(1, false, [1, 2, { a: 1 }]) }
+
+    it 'returns records with overlapping values' do
+      expect(records.size).to eq 3
+    end
+
+    it 'calls avals function only once' do
+      expect(records.to_sql.scan(/avals/).count).to eq 1
+    end
   end
 
-  it '#values' do
-    records = Hstore.where.store(:tags).values(1)
+  it '#contains_values' do
+    records = Hstore.where.store(:tags).contains_values(1)
     expect(records.size).to eq 1
     expect(records.first.name).to eq 'a'
 
-    records = Hstore.where.store(:tags).values('2', 'b')
+    records = Hstore.where.store(:tags).contains_values('2', 'b')
     expect(records.size).to eq 2
 
-    records = Hstore.where.store(:tags).values(true)
+    records = Hstore.where.store(:tags).contains_values(true)
     expect(records.size).to eq 2
 
-    records = Hstore.where.store(:tags).values([1, 2, { a: 1 }], { a: 1, b: [1], f: false })
+    records = Hstore.where.store(:tags).contains_values([1, 2, { a: 1 }], { a: 1, b: [1], f: false })
     expect(records.size).to eq 1
   end
 
@@ -205,4 +214,24 @@ describe Hstore do
       expect(Hstore.where.store(store, a: 2)).to exist
     end
   end
+
+  context "joins" do
+    before do
+      User.create!(name: "x", hstore: Hstore.find_by!(name: "a"))
+      User.create!(name: "y", hstore: Hstore.find_by!(name: "b"))
+      User.create!(name: "z", hstore: Hstore.find_by!(name: "c"))
+    end
+
+    it "works" do
+      users = User.joins(:hstore).merge(Hstore.where.store(:tags).key(:a))
+      expect(users.size).to eq 2
+      expect(users.map(&:name)).to match_array(["x", "y"])
+    end
+
+    it "works with #contains_values" do
+      users = User.joins(:hstore).merge(Hstore.where.store(:tags).contains_values(1))
+      expect(users.size).to eq 1
+      expect(users.map(&:name)).to match_array(["x"])
+    end
+  end
 end

data/spec/pgrel/jsonb_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Jsonb do
-  before do
+  before(:all) do
     @connection = ActiveRecord::Base.connection
 
     @connection.transaction do
@@ -14,7 +14,9 @@ describe Jsonb do
     Jsonb.reset_column_information
   end
 
-  after do
+  after { Jsonb.delete_all }
+
+  after(:all) do
     @connection.drop_table 'jsonbs', if_exists: true
   end
 
@@ -108,23 +110,30 @@ describe Jsonb do
     expect(records.first.name).to eq 'e'
   end
 
-  it '#value' do
-    records = Jsonb.where.store(:tags).value(1, false, { e: 2 })
-    expect(records.size).to eq 3
+  describe '#overlap_values' do
+    let(:records) { Jsonb.where.store(:tags).overlap_values(1, false, { e: 2 }) }
+
+    it 'returns records with overlapping values' do
+      expect(records.size).to eq 3
+    end
+
+    it 'calls array_agg function only once' do
+      expect(records.to_sql.scan(/array_agg/).count).to eq 1
+    end
   end
 
-  it '#values' do
-    records = Jsonb.where.store(:tags).values(1)
+  it '#contains_values' do
+    records = Jsonb.where.store(:tags).contains_values(1)
     expect(records.size).to eq 2
 
-    records = Jsonb.where.store(:tags).values(2, 'e')
+    records = Jsonb.where.store(:tags).contains_values(2, 'e')
     expect(records.size).to eq 1
     expect(records.first.name).to eq 'e'
 
-    records = Jsonb.where.store(:tags).values(e: 1, f: { h: { k: 'a', s: 2 } })
+    records = Jsonb.where.store(:tags).contains_values(e: 1, f: { h: { k: 'a', s: 2 } })
     expect(records.size).to eq 1
 
-    records = Jsonb.where.store(:tags).values(false, { a: 1, b: '1' }, [1, '1'])
+    records = Jsonb.where.store(:tags).contains_values(false, { a: 1, b: '1' }, [1, '1'])
     expect(records.size).to eq 1
   end
 
@@ -201,4 +210,30 @@ describe Jsonb do
       expect(Jsonb.where.store(store, d: { e: 2 })).to_not exist
     end
   end
+
+  context "joins" do
+    before do
+      User.create!(name: "x", jsonb: Jsonb.find_by!(name: "a"))
+      User.create!(name: "y", jsonb: Jsonb.find_by!(name: "b"))
+      User.create!(name: "z", jsonb: Jsonb.find_by!(name: "c"))
+    end
+
+    it "works" do
+      users = User.joins(:jsonb).merge(Jsonb.where.store(:tags).key(:a))
+      expect(users.size).to eq 2
+      expect(users.map(&:name)).to match_array(["y", "z"])
+    end
+
+    it "works with #path" do
+      users = User.joins(:jsonb).merge(Jsonb.where.store(:tags).path(:a, 2))
+      expect(users.size).to eq 1
+      expect(users.map(&:name)).to match_array(["z"])
+    end
+
+    it "works with #contains_values" do
+      users = User.joins(:jsonb).merge(Jsonb.where.store(:tags).contains_values(1))
+      expect(users.size).to eq 1
+      expect(users.map(&:name)).to match_array(["y"])
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -30,5 +30,15 @@ connection.reconnect!
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  config.mock_with :rspec
+  config.example_status_persistence_file_path = '.rspec_status'
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.order = :random
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.after(:each) { User.delete_all }
 end

data/spec/support/user.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :tags
+    t.integer :jsonb_id
+    t.integer :array_store_id
+    t.integer :hstore_id
+    t.timestamps null: true
+  end
+end
+
+class User < ActiveRecord::Base
+  belongs_to :jsonb
+  belongs_to :array_store
+  belongs_to :hstore
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgrel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - gemfiles/rails42.gemfile
 - gemfiles/rails5.gemfile
+- gemfiles/railsmaster.gemfile
 - lib/pgrel.rb
 - lib/pgrel/active_record.rb
 - lib/pgrel/active_record/query_methods.rb
@@ -132,6 +133,7 @@ files:
 - spec/support/array_store.rb
 - spec/support/hstore.rb
 - spec/support/jsonb.rb
+- spec/support/user.rb
 homepage: http://github.com/palkan/pgrel
 licenses:
 - MIT