jsonb_accessor 1.0.0.beta.2 → 1.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6f16bfcb008ed0dabf95cb479829414652c0fb5
-  data.tar.gz: 9aec106f0ba84f640710bb8181da1d2d329e38ce
+  metadata.gz: daa3bf1bf3902f9507356358bb715623a66f622a
+  data.tar.gz: b6f917cb7dab2ad61077a23a2b94d8a65545b6f5
 SHA512:
-  metadata.gz: 6bac196bd2d23e96576d8893a320f4fc006860164ef5ca56fde49ee7591b603f3f1d876de857231c3e4a2e07ecdd9170567f9b74e17c1c97ea44a6c514cb81a5
-  data.tar.gz: 4670f4f4dda76182a874f9ffa3c279487a4b8aff250660575df49aab1a84b5dd0b11971142c76a8cc50dbccd935bdd814b18646838a100a9cef927bd487a5011
+  metadata.gz: 1d3f263eb28a0b7f2d0b1f813cc0a9d24b2b1fd0814eca2916ca474d150eb751287e064b82464f541224a53a4b6576bffc35012a56a4ea84bf240646e5c3a288
+  data.tar.gz: 5a41d9c6cd1b5d45b3d8f76b974493c668a28453575d0247fb896cc842edfcc898d4d3aedc6158c54e8786cdcb0b962c7bf7be942b169699951aa4695fb561c3

data/.rubocop.yml

@@ -23,9 +23,11 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Metrics/PerceivedComplexity:
+Security/YAMLLoad:
   Enabled: false
 Style/AlignParameters:
   Enabled: false

data/Appraisals

@@ -1,4 +1,4 @@
 appraise "activerecord-5.0.0" do
   gemspec
-  gem "activerecord", "5.0.0"
+  gem "activerecord", "~> 5.0.0"
 end

data/README.md

@@ -27,7 +27,7 @@ This README reflects the most recent 1.0 beta. Method names and interfaces may s
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem "jsonb_accessor", "1.0.0.beta.2"
+gem "jsonb_accessor", "1.0.0.beta.3"
 ```
 
 And then execute:
@@ -71,6 +71,8 @@ class Product < ActiveRecord::Base
 end
 ```
 
+A brief note about defaults: `default` works pretty much as you would expect in practice, but it actually becomes part of a defaults hash that is the `default` value for the jsonb column (in the above example it would be `:data`).
+
 You can also pass in a `store_key` option.
 
 ```ruby
@@ -103,12 +105,18 @@ class Product < ActiveRecord::Base
 end
 ```
 
-Jsonb Accessor will add a `scope` to `Product` called `data_where`.
+Jsonb Accessor will add a `scope` to `Product` called like the json column with `_where` suffix, in our case `data_where`.
 
 ```ruby
 Product.all.data_where(name: "Granite Towel", price: 17)
 ```
 
+Similarly, it will also add a `data_where_not` `scope` to `Product`.
+
+```ruby
+Product.all.data_where_not(name: "Plasma Fork")
+```
+
 For number fields you can query using `<` or `>`or use plain english if that's what you prefer.
 
 ```ruby
@@ -157,6 +165,15 @@ Product.all.jsonb_contains(:data, reviewed_at: 10.minutes.ago, p: 12) # Using th
 
 **Note:** Under the hood, `jsonb_contains` uses the [`@>` operator in Postgres](https://www.postgresql.org/docs/9.5/static/functions-json.html) so when you include an array query, the stored array and the array used for the query do not need to match exactly. For example, when queried with `[1, 2]`, records that have arrays of `[2, 1, 3]` will be returned.
 
+### `jsonb_excludes`
+
+Returns all records that exclude the given JSON paths. Pretty much the opposite of `jsonb_contains`. Note that this will automatically exclude all records that contain `null` in their jsonb column (the `data` column, in the example below).
+
+```ruby
+Product.all.jsonb_excludes(:data, title: "foo")
+Product.all.jsonb_excludes(:data, reviewed_at: 10.minutes.ago, p: 12) # Using the store key
+```
+
 ### `jsonb_number_where`
 
 Returns all records that match the given criteria.
@@ -178,6 +195,14 @@ It supports:
 
 and it is indifferent to strings/symbols.
 
+### `jsonb_number_where_not`
+
+Returns all records that do not match the given criteria. It's the opposite of `jsonb_number_where`. Note that this will automatically exclude all records that contain `null` in their jsonb column (the `data` column, in the example below).
+
+```ruby
+Product.all.jsonb_number_where_not(:data, :price_in_cents, :greater_than, 300)
+```
+
 ### `jsonb_time_where`
 
 Returns all records that match the given criteria.
@@ -188,6 +213,14 @@ Product.all.jsonb_time_where(:data, :reviewed_at, :before, 2.days.ago)
 
 It supports `before` and `after` and is indifferent to strings/symbols.
 
+### `jsonb_time_where_not`
+
+Returns all records that match the given criteria. The opposite of `jsonb_time_where`. Note that this will automatically exclude all records that contain `null` in their jsonb column (the `data` column, in the example below).
+
+```ruby
+Product.all.jsonb_time_where_not(:data, :reviewed_at, :before, 2.days.ago)
+```
+
 ## Single-Table Inheritance
 
 One of the big issues with `ActiveRecord` single-table inheritance (STI)

data/db/migrate/20150407031737_set_up_testing_db.rb

@@ -1,4 +1,4 @@
-class SetUpTestingDb < ActiveRecord::Migration
+class SetUpTestingDb < ActiveRecord::Migration[5.0]
   def change
     create_table :products do |t|
       t.jsonb :options

data/gemfiles/activerecord_5.0.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "pg"
-gem "activerecord", "5.0.0"
+gem "activerecord", "~> 5.0.0"
 
 gemspec :path => "../"

data/gemfiles/activerecord_5.0.0.gemfile.lock

@@ -1,33 +1,33 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.2)
-      activerecord (>= 5.0.0)
+    jsonb_accessor (1.0.0.beta.3)
+      activerecord (>= 5.0)
       pg (>= 0.18.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.0.0)
-      actionview (= 5.0.0)
-      activesupport (= 5.0.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.0)
-      activesupport (= 5.0.0)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activemodel (5.0.0)
-      activesupport (= 5.0.0)
-    activerecord (5.0.0)
-      activemodel (= 5.0.0)
-      activesupport (= 5.0.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
       arel (~> 7.0)
-    activesupport (5.0.0)
+    activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -39,48 +39,48 @@ GEM
     arel (7.1.4)
     ast (2.3.0)
     awesome_print (1.7.0)
-    builder (3.2.2)
+    builder (3.2.3)
     coderay (1.1.1)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.5)
     database_cleaner (1.5.3)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     erubis (2.7.0)
-    i18n (0.7.0)
+    i18n (0.8.1)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     method_source (0.8.2)
     mini_portile2 (2.1.0)
-    minitest (5.9.1)
-    nokogiri (1.6.8.1)
+    minitest (5.10.1)
+    nokogiri (1.7.0.1)
       mini_portile2 (~> 2.1.0)
-    parser (2.3.1.4)
+    parser (2.4.0.0)
       ast (~> 2.2)
-    pg (0.19.0)
+    pg (0.20.0)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-doc (0.9.0)
+    pry-doc (0.10.0)
       pry (~> 0.9)
-      yard (~> 0.8)
+      yard (~> 0.9)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails-dom-testing (2.0.1)
+    rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.0)
-      actionpack (= 5.0.0)
-      activesupport (= 5.0.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rainbow (2.1.0)
+    rainbow (2.2.1)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -95,8 +95,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.44.1)
-      parser (>= 2.3.1.1, < 3.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
@@ -109,18 +109,18 @@ GEM
       activerecord (>= 4.2.7, < 5.1.0)
       railties (>= 4.2.7, < 5.1.0)
       rake (~> 10.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
+    thor (0.19.4)
+    thread_safe (0.3.6)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.1.1)
-    yard (0.9.5)
+    unicode-display_width (1.1.3)
+    yard (0.9.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 5.0.0)
+  activerecord (~> 5.0.0)
   appraisal
   awesome_print
   bundler (~> 1.9)
@@ -137,4 +137,4 @@ DEPENDENCIES
   standalone_migrations
 
 BUNDLED WITH
-   1.13.6
+   1.14.6

data/jsonb_accessor.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths         = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 5.0.0"
+  spec.add_dependency "activerecord", ">= 5.0"
   spec.add_dependency "pg", ">= 0.18.1"
 
   spec.add_development_dependency "appraisal"

data/lib/jsonb_accessor/macro.rb

@@ -3,16 +3,50 @@ module JsonbAccessor
   module Macro
     module ClassMethods
       def jsonb_accessor(jsonb_attribute, field_types)
-        field_names = field_types.keys
         names_and_store_keys = field_types.each_with_object({}) do |(name, type), mapping|
           _type, options = Array(type)
           mapping[name.to_s] = (options.try(:delete, :store_key) || name).to_s
         end
+
         # Defines virtual attributes for each jsonb field.
         field_types.each do |name, type|
           attribute name, *type
         end
 
+        store_key_mapping_method_name = "jsonb_store_key_mapping_for_#{jsonb_attribute}"
+        # Defines methods on the model class
+        class_methods = Module.new do
+          # Allows us to get a mapping of field names to store keys scoped to the column
+          define_method(store_key_mapping_method_name) do
+            superclass_mapping = superclass.try(store_key_mapping_method_name) || {}
+            superclass_mapping.merge(names_and_store_keys)
+          end
+        end
+        # We extend with class methods here so we can use the results of methods it defines to define more useful methods later
+        extend class_methods
+
+        # Get field names to default values mapping
+        names_and_defaults = field_types.each_with_object({}) do |(name, type), mapping|
+          _type, options = Array(type)
+          field_default = options.try(:delete, :default)
+          mapping[name.to_s] = field_default if field_default
+        end
+
+        # Get store keys to default values mapping
+        store_keys_and_defaults = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(names_and_defaults, public_send(store_key_mapping_method_name))
+
+        # Define jsonb_defaults_mapping_for_<jsonb_attribute>
+        defaults_mapping_method_name = "jsonb_defaults_mapping_for_#{jsonb_attribute}"
+        class_methods.instance_eval do
+          define_method(defaults_mapping_method_name) do
+            superclass_mapping = superclass.try(defaults_mapping_method_name) || {}
+            superclass_mapping.merge(store_keys_and_defaults)
+          end
+        end
+
+        all_defaults_mapping = public_send(defaults_mapping_method_name)
+        attribute jsonb_attribute, :jsonb, default: all_defaults_mapping if all_defaults_mapping.present?
+
         # Setters are in a module to allow users to override them and still be able to use `super`.
         setters = Module.new do
           # Overrides the setter created by `attribute` above to make sure the jsonb attribute is kept in sync.
@@ -25,16 +59,17 @@ module JsonbAccessor
           end
 
           # Overrides the jsonb attribute setter to make sure the jsonb fields are kept in sync.
-          define_method("#{jsonb_attribute}=") do |value|
-            indifferent_value = value.try(:with_indifferent_access) || {}
-            value_with_store_keys = names_and_store_keys.each_with_object({}) do |(name, store_key), new_value|
-              new_value[store_key] = indifferent_value[name]
-            end
+          define_method("#{jsonb_attribute}=") do |given_value|
+            value = given_value || {}
+            names_to_store_keys = self.class.public_send(store_key_mapping_method_name)
 
-            super(value_with_store_keys)
+            empty_store_key_attributes = names_to_store_keys.values.each_with_object({}) { |name, defaults| defaults[name] = nil }
+            empty_named_attributes = names_to_store_keys.keys.each_with_object({}) { |name, defaults| defaults[name] = nil }
 
-            new_attributes = field_names.each_with_object({}) { |name, defaults| defaults[name] = nil }.merge(value || {})
-            new_attributes.each { |name, new_value| write_attribute(name, new_value) }
+            store_key_attributes = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(value, names_to_store_keys)
+            write_attribute(jsonb_attribute, empty_store_key_attributes.merge(store_key_attributes))
+
+            empty_named_attributes.merge(value).each { |name, attribute_value| write_attribute(name, attribute_value) }
           end
         end
         include setters
@@ -51,12 +86,15 @@ module JsonbAccessor
 
         # <jsonb_attribute>_where scope
         scope("#{jsonb_attribute}_where", lambda do |attributes|
-          store_key_attributes = attributes.each_with_object({}) do |(name, value), new_attributes|
-            store_key = names_and_store_keys[name.to_s]
-            new_attributes[store_key] = value
-          end
+          store_key_attributes = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
           jsonb_where(jsonb_attribute, store_key_attributes)
         end)
+
+        # <jsonb_attribute>_where_not scope
+        scope("#{jsonb_attribute}_where_not", lambda do |attributes|
+          store_key_attributes = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
+          jsonb_where_not(jsonb_attribute, store_key_attributes)
+        end)
       end
     end
   end

data/lib/jsonb_accessor/query_builder.rb

@@ -41,21 +41,56 @@ module JsonbAccessor
 
   module QueryBuilder
     extend ActiveSupport::Concern
+    InvalidColumnName = Class.new(StandardError)
+
+    def self.validate_column_name!(query, column_name)
+      if query.model.columns.none? { |column| column.name == column_name.to_s }
+        raise InvalidColumnName, "a column named `#{column_name}` does not exist on the `#{query.model.table_name}` table"
+      end
+    end
+
+    def self.convert_keys_to_store_keys(attributes, store_key_mapping)
+      attributes.each_with_object({}) do |(name, value), new_attributes|
+        store_key = store_key_mapping[name.to_s]
+        new_attributes[store_key] = value
+      end
+    end
 
     included do
-      scope(:jsonb_contains,
-        -> (column_name, attributes) { where("#{table_name}.#{column_name} @> (?)::jsonb", attributes.to_json) })
+      scope(:jsonb_contains, lambda do |column_name, attributes|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
+        where("#{table_name}.#{column_name} @> (?)::jsonb", attributes.to_json)
+      end)
+
+      scope(:jsonb_excludes, lambda do |column_name, attributes|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
+        where.not("#{table_name}.#{column_name} @> (?)::jsonb", attributes.to_json)
+      end)
 
       scope(:jsonb_number_where, lambda do |column_name, field_name, given_operator, value|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
         operator = JsonbAccessor::NUMBER_OPERATORS_MAP.fetch(given_operator.to_s)
         where("(#{table_name}.#{column_name} ->> ?)::float #{operator} ?", field_name, value)
       end)
 
+      scope(:jsonb_number_where_not, lambda do |column_name, field_name, given_operator, value|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::NUMBER_OPERATORS_MAP.fetch(given_operator.to_s)
+        where.not("(#{table_name}.#{column_name} ->> ?)::float #{operator} ?", field_name, value)
+      end)
+
       scope(:jsonb_time_where, lambda do |column_name, field_name, given_operator, value|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
         operator = JsonbAccessor::TIME_OPERATORS_MAP.fetch(given_operator.to_s)
         where("(#{table_name}.#{column_name} ->> ?)::timestamp #{operator} ?", field_name, value)
       end)
 
+      scope(:jsonb_time_where_not, lambda do |column_name, field_name, given_operator, value|
+        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::TIME_OPERATORS_MAP.fetch(given_operator.to_s)
+        where.not("(#{table_name}.#{column_name} ->> ?)::timestamp #{operator} ?", field_name, value)
+      end)
+
       scope(:jsonb_where, lambda do |column_name, attributes|
         query = all
         contains_attributes = {}
@@ -73,6 +108,24 @@ module JsonbAccessor
 
         query.jsonb_contains(column_name, contains_attributes)
       end)
+
+      scope(:jsonb_where_not, lambda do |column_name, attributes|
+        query = all
+        excludes_attributes = {}
+
+        attributes.each do |name, value|
+          case value
+          when IS_NUMBER_QUERY_ARGUMENTS
+            value.each { |operator, query_value| query = query.jsonb_number_where_not(column_name, name, operator, query_value) }
+          when IS_TIME_QUERY_ARGUMENTS
+            value.each { |operator, query_value| query = query.jsonb_time_where_not(column_name, name, operator, query_value) }
+          else
+            excludes_attributes[name] = value
+          end
+        end
+
+        excludes_attributes.empty? ? query : query.jsonb_excludes(column_name, excludes_attributes)
+      end)
     end
   end
 end

data/lib/jsonb_accessor/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module JsonbAccessor
-  VERSION = "1.0.0.beta.2"
+  VERSION = "1.0.0.beta.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.2
+  version: 1.0.0.beta.3
 platform: ruby
 authors:
 - Michael Crismali
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-10 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement