pgrel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 642a7d4b7a7b19f5acc220e6f74d41d6d0e00524
-  data.tar.gz: 007ba40877cfc0c6bdbb260502b98b1627ceaaa6
+  metadata.gz: 9b99f0c11a5e624145d178ed3bdb97dd9345ccad
+  data.tar.gz: 7db4f0a1086111e10ded6e6f9af923179ddc2012
 SHA512:
-  metadata.gz: 82cf0b3c4ed6c5ec72a55e6572ee0a197cb15079c70f48d61499acaac15d4d98bcb2262f5965a55c5c669bd4a98e04edd0e18da9b0ff7e018ae94ca82b2363e5
-  data.tar.gz: 130ed3ac3d71c6c98f72a33a881877f23f147653a1735a68a4bc8016996345cca77721713874d9f0a8d9b2991f2ccc4758b026224b4aa450e9b2cf0e0c8c8ce9
+  metadata.gz: 4ef4b9230787c49c3ccb1b24d68113cf90b57c0ae8281e6814eb6d01c01925fc04031ee3f02e1cc09abf60386b2d3c12f6b2f46674f6b75ccc27cd34d3a08619
+  data.tar.gz: 8aaeaab12dd78aac0ad21a49b68af1a5efb83aeb261e0cfd431f24662b5f8b0dc88dcc4b93c8115b3a0d4999ddf3ca842c32d75f92270ebab7113eac31b71acf

data/.gitignore

@@ -26,7 +26,8 @@ Thumbs.db
 coverage/
 
 .bundle/
-log/*.log
+*.log
+*.gem
 pkg/
 spec/dummy/log/*.log
 spec/dummy/tmp/

data/.rubocop.yml

@@ -19,10 +19,6 @@ AllCops:
   DisplayCopNames: true
   StyleGuideCopsOnly: false
 
-Style/Documentation:
-  Exclude:
-    - 'lib/**/version.rb'
-
 Metrics/LineLength:
   Max: 100
 

data/README.md

@@ -2,6 +2,112 @@
 
 ## Pgrel
 
-**Rails 5**
+ActiveRecord extension for querying hstore, array and jsonb.
+
+Compatible with **Rails** >= 4.0 (and even with upcoming **Rails 5**!).
+
+### General
+
+The functionality is based on ActiveRecord `WhereChain`. 
+To start querying call `where(:store_name)` and chain it with store-specific call (see below).
+
+#### Install
+
+In your Gemfile:
+
+```ruby
+gem "pgrel", "~>0.1"
+```
+
+### HStore
+
+Query by key value:
+
+```ruby
+Hstore.where.store(:tags, a: 1, b: 2)
+#=> select * from hstores where tags->'a' = '1' and tags->'b' = '2'
+
+Hstore.where.store(:tags, a: [1, 2])
+#=> select * from hstores where tags->'a' in ('1', '2')
+```
+
+Keys existence:
+
+```ruby
+# Retrieve items that have key 'a' in 'tags'::hstore
+Hstore.where.store(:tags).key(:a)
+#=> select * from hstores where tags ? 'a'
+
+# Retrieve items that have both keys 'a' and 'b' in 'tags'::hstore
+Hstore.where.store(:tags).keys('a', 'b')
+#=> select * from hstores where tags ?& array['a', 'b']
+
+# Retrieve items that have either key 'a' or 'b' in 'tags'::hstore
+Hstore.where.store(:tags).any('a', 'b')
+#=> select * from hstores where tags ?| array['a', 'b']
+```
+
+Containment:
+
+```ruby
+Hstore.where.store(:tags).contains(a: 1, b: 2)
+#=> select * from hstores where tags @> '\"a\"=>\"1\", \"b\"=>\"2\"'
+
+Hstore.where.store(:tags).contained(a: 1, b: 2)
+#=> select * from hstores where tags <@ '\"a\"=>\"1\", \"b\"=>\"2\"'
+```
+
+### JSONB
+
+All queries for Hstore also available for JSONB.
+
+**NOTE**. Querying by array value always resolves to `IN (...)` statement. 
+Thus it's impossible to query json array value, e.g.:
+
+```ruby
+Model.create!(tags: {main: ['a', 'b']})
+
+Model.where.store(:tags, main: ['a', 'b']).empty? == true
+#=> select * from models where  tags->'main' in ('a', 'b')
+```
+
+Path query:
+
+```ruby
+Model.create!(tags: {main: ['a', 'b'], user: { name: 'john' } })
+
+# You can use object to query by simple value
+Model.where.store(:tags).path(user: { name: 'john' })
+#=> select * from hstores where tags#>>'{\"user\",\"name\"}' = 'john'
+# or passing path parts as args one by one with value at the end
+Model.where.store(:tags).path(:user, :name, 'john')
+
+# Match by complex value (array or object)
+Model.where.store(:tags).path(:main, ['a', 'b'])
+#=> select * from hstores where tags#>'{\"main\"}' = '[\"a\",\"b\"]'
+```
+
+### Array
+
+Array stores support containment queries (just like Hstore and JSONB) and also `overlap` operator.
+
+**NOTE**. There are some other array operators ('ANY', 'ALL', querying by index - value) which I'm not going to implement – PRs are welcomed!
+
+Overlap:
+```ruby
+Model.where.store(:tags).overlap('a', 'b')
+#=> select * from hstores where tags && '{\"a\",\"b\"}'
+```
+
+### Negation
+
+Use `not` before operator to constuct negation or pass arguments to `not` to run key-value query.
+
+```ruby
+Model.where.store(:tags).not.overlap('a', 'b')
+#=> select * from hstores where not (tags && '{\"a\",\"b\"}')
+
+Hstore.where.store(:tags).not(a: 1)
+#=> select * from hstores where tags->'a' != '1'
+```
 
-ActiveRecord extension for querying hstore and jsonb.

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

@@ -26,7 +26,7 @@ module ActiveRecord
         when Array
           val.map { |v| stringify(v) }
         when Hash
-          Hash[val.map { |k, v| [k, stringify(v)] }]
+          Hash[val.map { |k, v| [stringify(k), stringify(v)] }]
         else
           val.to_s
         end

data/lib/pgrel/version.rb

@@ -1,3 +1,3 @@
-module Pgrel
-  VERSION = "0.1.0"
+module Pgrel # :nodoc:
+  VERSION = "0.1.1"
 end

data/spec/pgrel/hstore_spec.rb

@@ -24,6 +24,7 @@ describe Hstore do
     Hstore.create!(name: 'c', tags: { f: true, d: 'b' })
     Hstore.create!(name: 'd', tags: { f: false })
     Hstore.create!(name: 'e', tags: { a: 2, c: 'x', d: 'c', g: 'c' })
+    Hstore.create!(tags: { 1 => 2 })
   end
 
   context '#where' do
@@ -33,6 +34,10 @@ describe Hstore do
       expect(Hstore.where.store(:tags, f: false).first.name).to eq 'd'
     end
 
+    it 'integer keys' do
+      expect(Hstore.where.store(:tags, 1 => 2).size).to eq 1
+    end
+
     it 'arrays' do
       expect(Hstore.where.store(:tags, a: [1, 2, 3]).size).to eq 3
     end
@@ -115,11 +120,11 @@ describe Hstore do
     end
 
     it '#any' do
-      expect(Hstore.where.store(:tags).not.any('a', 'f').size).to eq 0
+      expect(Hstore.where.store(:tags).not.any('a', 'f').size).to eq 1
     end
 
     it '#keys' do
-      expect(Hstore.where.store(:tags).not.keys('a', 'f').size).to eq 4
+      expect(Hstore.where.store(:tags).not.keys('a', 'f').size).to eq 5
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgrel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord