jsonb_accessor 1.0.0.beta.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a66f5adf90e5c66c0cacb04698102c37fbd69b27
-  data.tar.gz: dcee9f04338256069b16e0078bbd21ee34264b7a
+  metadata.gz: 80ed7aa0b3f529122a97b2a00b4f81011ef18014
+  data.tar.gz: 407d572cea056870ce66d7b92c89d1b3e15bdb2d
 SHA512:
-  metadata.gz: eb1b146937ec6624866dc4f8594d25889eb9fd7a92de1610242048e6c5488050b0be7cbe8e9f2f887a07ed45eeb97308071c3889023eb2a3074f8e01928c91a6
-  data.tar.gz: f8d8fad1f5adea8b6d71b8512991a838f4a8dde52c4b9ca83b03facfab2d00f946d3a2a9e402c18d0f3f44bc2de53fa624e57e2531e2fe1b095c2766561c2ed6
+  metadata.gz: be4ffe5fc2318edc84b98ffee5296d30d2a9d03817540c4622f04875d0a41c19022c19c0c998357f6730cad37103ce79c43b46c5aa08a46dce8078b77f03752d
+  data.tar.gz: c02e7189b7354d5d112aa9414e9cb4e5329d57b97b75b4d07a7e64da1abab04c63a0419509335fd557728eb48df1183d2a2d00c9c84ed7216ac4461205ec1c4d

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 gemfiles/.bundle
+gemfiles/*.gemfile.lock

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - db/**/*
     - gemfiles/**/*
     - vendor/**/*
-Lint/SpaceBeforeFirstArg:
+Style/SpaceBeforeFirstArg:
   Enabled: false
 Lint/UnusedBlockArgument:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.1

data/.travis.yml

@@ -1,16 +1,19 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
 addons:
-  postgresql: '9.4'
+  postgresql: "9.4"
 before_install:
   - gem update --system
   - gem --version
-  - gem install bundler
+  - gem install bundler:2.1.4
 before_script:
   - bundle exec rake db:create
   - bundle exec rake db:migrate
+install: bundle _2.1.4_ install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
 cache: bundler
 gemfile:
   - gemfiles/activerecord_5.0.0.gemfile

data/Appraisals

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 appraise "activerecord-5.0.0" do
-  gemspec
   gem "activerecord", "~> 5.0.0"
 end
 
 appraise "activerecord-5.1.0" do
-  gemspec
-  gem "activerecord", "~> 5.1.0"
+  gem "activerecord", "~> 5.1.3"
 end

data/README.md

@@ -1,17 +1,13 @@
 # JSONb Accessor
 
-Created by &nbsp;&nbsp;&nbsp; [<img src="https://raw.githubusercontent.com/devmynd/jsonb_accessor/master/devmynd-logo.png" alt="DevMynd Logo" />](https://www.devmynd.com/)
+Created by &nbsp;&nbsp;&nbsp; [<img src="https://raw.githubusercontent.com/madeintandem/jsonb_accessor/master/tandem-logo.png" alt="Tandem Logo" />](https://www.madeintandem.com/)
 
-[![Gem Version](https://badge.fury.io/rb/jsonb_accessor.svg)](http://badge.fury.io/rb/jsonb_accessor) &nbsp;&nbsp;&nbsp;[![Build Status](https://travis-ci.org/devmynd/jsonb_accessor.svg)](https://travis-ci.org/devmynd/jsonb_accessor) <img src="https://raw.githubusercontent.com/devmynd/jsonb_accessor/master/json-bee.png" alt="JSONb Accessor Logo" align="right" />
+[![Gem Version](https://badge.fury.io/rb/jsonb_accessor.svg)](http://badge.fury.io/rb/jsonb_accessor) &nbsp;&nbsp;&nbsp;[![Build Status](https://travis-ci.org/madeintandem/jsonb_accessor.svg)](https://travis-ci.org/madeintandem/jsonb_accessor) <img src="https://raw.githubusercontent.com/madeintandem/jsonb_accessor/master/json-bee.png" alt="JSONb Accessor Logo" align="right" />
 
-Adds typed `jsonb` backed fields as first class citizens to your `ActiveRecord` models. This gem is similar in spirit to [HstoreAccessor](https://github.com/devmynd/hstore_accessor), but the `jsonb` column in PostgreSQL has a few distinct advantages, mostly around nested documents and support for collections.
+Adds typed `jsonb` backed fields as first class citizens to your `ActiveRecord` models. This gem is similar in spirit to [HstoreAccessor](https://github.com/madeintandem/hstore_accessor), but the `jsonb` column in PostgreSQL has a few distinct advantages, mostly around nested documents and support for collections.
 
 It also adds generic scopes for querying `jsonb` columns.
 
-## 1.0 Beta
-
-This README reflects the most recent 1.0 beta. Method names and interfaces may still change.
-
 ## Table of Contents
 
 * [Installation](#installation)
@@ -29,7 +25,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.5"
+gem "jsonb_accessor", "~> 1"
 ```
 
 And then execute:
@@ -141,6 +137,14 @@ For time related fields you can query using `before` and `after`.
 Product.all.data_where(reviewed_at: { before: Time.current.beginning_of_week, after: 4.weeks.ago })
 ```
 
+If you want to search for records within a certain time, date, or number range, just pass in the range (Note: this is just shorthand for the above mentioned `before`/`after`/`less_than`/`less_than_or_equal_to`/`greater_than_or_equal_to`/etc options).
+
+```ruby
+Product.all.data_where(price: 10..20)
+Product.all.data_where(price: 10...20)
+Product.all.data_where(reviewed_at: Time.current..3.days.from_now)
+```
+
 This scope is a convenient wrapper around the `jsonb_where` `scope` that saves you from having to convert the given keys to the store keys and from specifying the column.
 
 ### `jsonb_where`
@@ -164,6 +168,27 @@ Just the opposite of `jsonb_where`. Note that this will automatically exclude al
 Product.all.jsonb_where_not(:data, reviewed_at: { before: Time.current }, p: { greater_than: 5 })
 ```
 
+### `<jsonb_attribute>_order`
+
+Orders your query according to values in the Jsonb Accessor fields similar to ActiveRecord's `order`.
+
+```ruby
+Product.all.data_order(:price)
+Product.all.data_order(:price, :reviewed_at)
+Product.all.data_order(:price, reviewed_at: :desc)
+```
+
+It will convert your given keys into store keys if necessary.
+
+### `jsonb_order`
+
+Allows you to order by a Jsonb Accessor field.
+
+```ruby
+Product.all.jsonb_order(:data, :price, :asc)
+Product.all.jsonb_order(:data, :price, :desc)
+```
+
 ### `jsonb_contains`
 
 Returns all records that contain the given JSON paths.
@@ -284,7 +309,7 @@ From here any attributes specific to any sub-class can be stored in the
 individual fields in an `jsonb` column.
 
 This approach was originally conceived by Joe Hirn in [this blog
-post](http://www.devmynd.com/blog/2013-3-single-table-inheritance-hstore-lovely-combination).
+post](https://madeintandem.com/blog/2013-3-single-table-inheritance-hstore-lovely-combination/).
 
 ## Validations
 
@@ -309,7 +334,7 @@ Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-1. [Fork it](https://github.com/devmynd/jsonb_accessor/fork)
+1. [Fork it](https://github.com/madeintandem/jsonb_accessor/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Add tests and changes (run the tests with `rake`)
 4. Commit your changes (`git commit -am 'Add some feature'`)

data/gemfiles/activerecord_5.0.0.gemfile

@@ -6,4 +6,3 @@ gem "pg"
 gem "activerecord", "~> 5.0.0"
 
 gemspec path: "../"
-gemspec path: "../"

data/gemfiles/activerecord_5.1.0.gemfile

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

data/jsonb_accessor.gemspec

@@ -23,18 +23,18 @@ Gem::Specification.new do |spec|
   spec.require_paths         = ["lib"]
 
   spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 5.0"
   spec.add_dependency "pg", ">= 0.18.1"
 
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "database_cleaner", "~> 1.5.3"
+  spec.add_development_dependency "appraisal", "~> 2.2.0"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "database_cleaner", "~> 1.6.0"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
   spec.add_development_dependency "rubocop", "~> 0.48.1"
-  spec.add_development_dependency "shoulda-matchers"
-  spec.add_development_dependency "standalone_migrations"
+  spec.add_development_dependency "standalone_migrations", "~> 5.2.0"
 end

data/lib/jsonb_accessor.rb

@@ -6,6 +6,7 @@ require "active_record/connection_adapters/postgresql_adapter"
 
 require "jsonb_accessor/version"
 require "jsonb_accessor/macro"
+require "jsonb_accessor/query_helper"
 require "jsonb_accessor/query_builder"
 
 module JsonbAccessor

data/lib/jsonb_accessor/macro.rb

@@ -11,7 +11,11 @@ module JsonbAccessor
 
         # Defines virtual attributes for each jsonb field.
         field_types.each do |name, type|
-          attribute name, *type
+          next attribute name, type unless type.is_a?(Array)
+          next attribute name, *type unless type.last.is_a?(Hash)
+
+          *args, keyword_args = type
+          attribute name, *args, **keyword_args
         end
 
         store_key_mapping_method_name = "jsonb_store_key_mapping_for_#{jsonb_attribute}"
@@ -34,7 +38,7 @@ module JsonbAccessor
         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))
+        store_keys_and_defaults = ::JsonbAccessor::QueryHelper.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}"
@@ -46,7 +50,14 @@ module JsonbAccessor
         end
 
         all_defaults_mapping = public_send(defaults_mapping_method_name)
-        attribute jsonb_attribute, :jsonb, default: all_defaults_mapping if all_defaults_mapping.present?
+        # Fields may have procs as default value. This means `all_defaults_mapping` may contain procs as values. To make this work
+        # with the attributes API, we need to wrap `all_defaults_mapping` with a proc itself, making sure it returns a plain hash
+        # each time it is evaluated.
+        all_defaults_mapping_proc =
+          if all_defaults_mapping.present?
+            -> { all_defaults_mapping.map { |key, value| [key, value.respond_to?(:call) ? value.call : value] }.to_h }
+          end
+        attribute jsonb_attribute, :jsonb, default: all_defaults_mapping_proc if all_defaults_mapping_proc.present?
 
         # Setters are in a module to allow users to override them and still be able to use `super`.
         setters = Module.new do
@@ -67,7 +78,7 @@ module JsonbAccessor
             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 }
 
-            store_key_attributes = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(value, names_to_store_keys)
+            store_key_attributes = ::JsonbAccessor::QueryHelper.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) }
@@ -81,28 +92,37 @@ module JsonbAccessor
             jsonb_values = public_send(jsonb_attribute) || {}
             jsonb_values.each do |store_key, value|
               name = names_and_store_keys.key(store_key)
-              write_attribute(name, value) if name
+              next unless name
+
+              write_attribute(name, value)
+              clear_attribute_change(name) if persisted?
             end
-            clear_changes_information if persisted?
           end
         end
 
         # <jsonb_attribute>_where scope
         scope("#{jsonb_attribute}_where", lambda do |attributes|
-          store_key_attributes = ::JsonbAccessor::QueryBuilder.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
+          store_key_attributes = ::JsonbAccessor::QueryHelper.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))
+          store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
           jsonb_where_not(jsonb_attribute, store_key_attributes)
         end)
 
         # <jsonb_attribute>_order scope
-        scope("#{jsonb_attribute}_order", lambda do |attribute, direction = nil|
-          key = all.model.public_send(store_key_mapping_method_name)[attribute.to_s]
-          jsonb_order(jsonb_attribute, key, direction || :asc)
+        scope("#{jsonb_attribute}_order", lambda do |*args|
+          ordering_options = args.extract_options!
+          order_by_defaults = args.each_with_object({}) { |attribute, config| config[attribute] = :asc }
+          store_key_mapping = all.model.public_send(store_key_mapping_method_name)
+
+          order_by_defaults.merge(ordering_options).reduce(all) do |query, (name, direction)|
+            key = store_key_mapping[name.to_s]
+            order_query = jsonb_order(jsonb_attribute, key, direction)
+            query.merge(order_query)
+          end
         end)
       end
     end

data/lib/jsonb_accessor/query_builder.rb

@@ -1,112 +1,41 @@
 # frozen_string_literal: true
 
 module JsonbAccessor
-  GREATER_THAN = ">"
-  GREATER_THAN_OR_EQUAL_TO = ">="
-  LESS_THAN = "<"
-  LESS_THAN_OR_EQUAL_TO = "<="
-
-  NUMBER_OPERATORS_MAP = {
-    GREATER_THAN => GREATER_THAN,
-    "greater_than" => GREATER_THAN,
-    "gt" => GREATER_THAN,
-    GREATER_THAN_OR_EQUAL_TO => GREATER_THAN_OR_EQUAL_TO,
-    "greater_than_or_equal_to" => GREATER_THAN_OR_EQUAL_TO,
-    "gte" => GREATER_THAN_OR_EQUAL_TO,
-    LESS_THAN => LESS_THAN,
-    "less_than" => LESS_THAN,
-    "lt" => LESS_THAN,
-    LESS_THAN_OR_EQUAL_TO => LESS_THAN_OR_EQUAL_TO,
-    "less_than_or_equal_to" => LESS_THAN_OR_EQUAL_TO,
-    "lte" => LESS_THAN_OR_EQUAL_TO
-  }.freeze
-
-  NUMBER_OPERATORS = NUMBER_OPERATORS_MAP.keys.freeze
-
-  TIME_OPERATORS_MAP = {
-    "after" => GREATER_THAN,
-    "before" => LESS_THAN
-  }.freeze
-
-  TIME_OPERATORS = TIME_OPERATORS_MAP.keys.freeze
-
-  IS_NUMBER_QUERY_ARGUMENTS = lambda do |arg|
-    arg.is_a?(Hash) &&
-      arg.keys.map(&:to_s).all? { |key| JsonbAccessor::NUMBER_OPERATORS.include?(key) }
-  end
-
-  IS_TIME_QUERY_ARGUMENTS = lambda do |arg|
-    arg.is_a?(Hash) &&
-      arg.keys.map(&:to_s).all? { |key| JsonbAccessor::TIME_OPERATORS.include?(key) }
-  end
-
-  ORDER_DIRECTIONS = [:asc, :desc, "asc", "desc"].freeze
-
   module QueryBuilder
     extend ActiveSupport::Concern
-    InvalidColumnName = Class.new(StandardError)
-    InvalidFieldName = Class.new(StandardError)
-    InvalidDirection = 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.validate_field_name!(query, column_name, field_name)
-      store_keys = query.model.public_send("jsonb_store_key_mapping_for_#{column_name}").values
-      if store_keys.exclude?(field_name.to_s)
-        valid_field_names = store_keys.map { |key| "`#{key}`" }.join(", ")
-        raise InvalidFieldName, "`#{field_name}` is not a valid field name, valid field names include: #{valid_field_names}"
-      end
-    end
-
-    def self.validate_direction!(option)
-      if ORDER_DIRECTIONS.exclude?(option)
-        raise InvalidDirection, "`#{option}` is not a valid direction for ordering, only `asc` and `desc` are accepted"
-      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, lambda do |column_name, attributes|
-        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
+        JsonbAccessor::QueryHelper.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)
+        JsonbAccessor::QueryHelper.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)
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::QueryHelper::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)
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::QueryHelper::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)
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::QueryHelper::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)
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        operator = JsonbAccessor::QueryHelper::TIME_OPERATORS_MAP.fetch(given_operator.to_s)
         where.not("(#{table_name}.#{column_name} ->> ?)::timestamp #{operator} ?", field_name, value)
       end)
 
@@ -114,11 +43,10 @@ module JsonbAccessor
         query = all
         contains_attributes = {}
 
-        attributes.each do |name, value|
-          case value
-          when IS_NUMBER_QUERY_ARGUMENTS
+        JsonbAccessor::QueryHelper.convert_ranges(attributes).each do |name, value|
+          if JsonbAccessor::QueryHelper.number_query_arguments?(value)
             value.each { |operator, query_value| query = query.jsonb_number_where(column_name, name, operator, query_value) }
-          when IS_TIME_QUERY_ARGUMENTS
+          elsif JsonbAccessor::QueryHelper.time_query_arguments?(value)
             value.each { |operator, query_value| query = query.jsonb_time_where(column_name, name, operator, query_value) }
           else
             contains_attributes[name] = value
@@ -133,10 +61,13 @@ module JsonbAccessor
         excludes_attributes = {}
 
         attributes.each do |name, value|
-          case value
-          when IS_NUMBER_QUERY_ARGUMENTS
+          if value.is_a?(Range)
+            raise JsonbAccessor::QueryHelper::NotSupported, "`jsonb_where_not` scope does not accept ranges as arguments. Given `#{value}` for `#{name}` field"
+          end
+
+          if JsonbAccessor::QueryHelper.number_query_arguments?(value)
             value.each { |operator, query_value| query = query.jsonb_number_where_not(column_name, name, operator, query_value) }
-          when IS_TIME_QUERY_ARGUMENTS
+          elsif JsonbAccessor::QueryHelper.time_query_arguments?(value)
             value.each { |operator, query_value| query = query.jsonb_time_where_not(column_name, name, operator, query_value) }
           else
             excludes_attributes[name] = value
@@ -147,10 +78,10 @@ module JsonbAccessor
       end)
 
       scope(:jsonb_order, lambda do |column_name, field_name, direction|
-        JsonbAccessor::QueryBuilder.validate_column_name!(all, column_name)
-        JsonbAccessor::QueryBuilder.validate_field_name!(all, column_name, field_name)
-        JsonbAccessor::QueryBuilder.validate_direction!(direction)
-        order("(#{table_name}.#{column_name} -> '#{field_name}') #{direction}")
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        JsonbAccessor::QueryHelper.validate_field_name!(all, column_name, field_name)
+        JsonbAccessor::QueryHelper.validate_direction!(direction)
+        order(Arel.sql("(#{table_name}.#{column_name} -> '#{field_name}') #{direction}"))
       end)
     end
   end

data/lib/jsonb_accessor/query_helper.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module JsonbAccessor
+  module QueryHelper
+    # Errors
+    InvalidColumnName = Class.new(StandardError)
+    InvalidFieldName = Class.new(StandardError)
+    InvalidDirection = Class.new(StandardError)
+    NotSupported = Class.new(StandardError)
+
+    # Constants
+    GREATER_THAN = ">"
+    GREATER_THAN_OR_EQUAL_TO = ">="
+    LESS_THAN = "<"
+    LESS_THAN_OR_EQUAL_TO = "<="
+
+    NUMBER_OPERATORS_MAP = {
+      GREATER_THAN => GREATER_THAN,
+      "greater_than" => GREATER_THAN,
+      "gt" => GREATER_THAN,
+      GREATER_THAN_OR_EQUAL_TO => GREATER_THAN_OR_EQUAL_TO,
+      "greater_than_or_equal_to" => GREATER_THAN_OR_EQUAL_TO,
+      "gte" => GREATER_THAN_OR_EQUAL_TO,
+      LESS_THAN => LESS_THAN,
+      "less_than" => LESS_THAN,
+      "lt" => LESS_THAN,
+      LESS_THAN_OR_EQUAL_TO => LESS_THAN_OR_EQUAL_TO,
+      "less_than_or_equal_to" => LESS_THAN_OR_EQUAL_TO,
+      "lte" => LESS_THAN_OR_EQUAL_TO
+    }.freeze
+
+    NUMBER_OPERATORS = NUMBER_OPERATORS_MAP.keys.freeze
+
+    TIME_OPERATORS_MAP = {
+      "after" => GREATER_THAN,
+      "before" => LESS_THAN
+    }.freeze
+
+    TIME_OPERATORS = TIME_OPERATORS_MAP.keys.freeze
+
+    ORDER_DIRECTIONS = [:asc, :desc, "asc", "desc"].freeze
+
+    class << self
+      def 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 validate_field_name!(query, column_name, field_name)
+        store_keys = query.model.public_send("jsonb_store_key_mapping_for_#{column_name}").values
+        if store_keys.exclude?(field_name.to_s)
+          valid_field_names = store_keys.map { |key| "`#{key}`" }.join(", ")
+          raise InvalidFieldName, "`#{field_name}` is not a valid field name, valid field names include: #{valid_field_names}"
+        end
+      end
+
+      def validate_direction!(option)
+        if ORDER_DIRECTIONS.exclude?(option)
+          raise InvalidDirection, "`#{option}` is not a valid direction for ordering, only `asc` and `desc` are accepted"
+        end
+      end
+
+      def 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
+
+      def number_query_arguments?(arg)
+        arg.is_a?(Hash) && arg.keys.map(&:to_s).all? { |key| NUMBER_OPERATORS.include?(key) }
+      end
+
+      def time_query_arguments?(arg)
+        arg.is_a?(Hash) && arg.keys.map(&:to_s).all? { |key| TIME_OPERATORS.include?(key) }
+      end
+
+      def convert_number_ranges(attributes)
+        attributes.each_with_object({}) do |(name, value), new_attributes|
+          is_range = value.is_a?(Range)
+
+          new_attributes[name] = if is_range && value.first.is_a?(Numeric) && value.exclude_end?
+                                   { greater_than_or_equal_to: value.first, less_than: value.end }
+                                 elsif is_range && value.first.is_a?(Numeric)
+                                   { greater_than_or_equal_to: value.first, less_than_or_equal_to: value.end }
+                                 else
+                                   value
+                                 end
+        end
+      end
+
+      def convert_time_ranges(attributes)
+        attributes.each_with_object({}) do |(name, value), new_attributes|
+          is_range = value.is_a?(Range)
+
+          if is_range && (value.first.is_a?(Time) || value.first.is_a?(Date))
+            start_time = value.first
+            end_time = value.end
+            new_attributes[name] = { before: end_time, after: start_time }
+          else
+            new_attributes[name] = value
+          end
+        end
+      end
+
+      def convert_ranges(attributes)
+        %i[convert_number_ranges convert_time_ranges].reduce(attributes) do |new_attributes, converter_method|
+          public_send(converter_method, new_attributes)
+        end
+      end
+    end
+  end
+end

data/lib/jsonb_accessor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonbAccessor
-  VERSION = "1.0.0.beta.5"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Crismali
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-03 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -44,44 +58,44 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -142,30 +156,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -180,34 +194,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.48.1
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  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: standalone_migrations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
 description: Adds typed jsonb backed fields to your ActiveRecord models.
 email:
 - michael@crismali.com
@@ -235,13 +235,12 @@ files:
 - db/migrate/20150407031737_set_up_testing_db.rb
 - db/schema.rb
 - gemfiles/activerecord_5.0.0.gemfile
-- gemfiles/activerecord_5.0.0.gemfile.lock
 - gemfiles/activerecord_5.1.0.gemfile
-- gemfiles/activerecord_5.1.0.gemfile.lock
 - jsonb_accessor.gemspec
 - lib/jsonb_accessor.rb
 - lib/jsonb_accessor/macro.rb
 - lib/jsonb_accessor/query_builder.rb
+- lib/jsonb_accessor/query_helper.rb
 - lib/jsonb_accessor/version.rb
 homepage: https://github.com/devmynd/jsonb_accessor
 licenses:
@@ -258,12 +257,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Adds typed jsonb backed fields to your ActiveRecord models.

data/gemfiles/activerecord_5.0.0.gemfile.lock

@@ -1,141 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    jsonb_accessor (1.0.0.beta.5)
-      activerecord (>= 5.0)
-      pg (>= 0.18.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    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.2)
-      activesupport (= 5.0.2)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 2.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.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    appraisal (2.1.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (7.1.4)
-    ast (2.3.0)
-    awesome_print (1.7.0)
-    builder (3.2.3)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
-    database_cleaner (1.5.3)
-    diff-lcs (1.3)
-    erubis (2.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.10.1)
-    nokogiri (1.7.0.1)
-      mini_portile2 (~> 2.1.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    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.10.0)
-      pry (~> 0.9)
-      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.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.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.2.2)
-      rake
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.48.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    shoulda-matchers (3.1.1)
-      activesupport (>= 4.0.0)
-    slop (3.6.0)
-    standalone_migrations (5.0.0)
-      activerecord (>= 4.2.7, < 5.1.0)
-      railties (>= 4.2.7, < 5.1.0)
-      rake (~> 10.0)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.2.1)
-    yard (0.9.8)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 5.0.0)
-  appraisal
-  awesome_print
-  bundler (~> 1.9)
-  database_cleaner (~> 1.5.3)
-  jsonb_accessor!
-  pg
-  pry
-  pry-doc
-  pry-nav
-  rake (~> 10.0)
-  rspec (~> 3.2)
-  rubocop (~> 0.48.1)
-  shoulda-matchers
-  standalone_migrations
-
-BUNDLED WITH
-   1.14.6

data/gemfiles/activerecord_5.1.0.gemfile.lock

@@ -1,141 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    jsonb_accessor (1.0.0.beta.5)
-      activerecord (>= 5.0)
-      pg (>= 0.18.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.1.0)
-      actionview (= 5.1.0)
-      activesupport (= 5.1.0)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.0)
-      activesupport (= 5.1.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.1.0)
-      activesupport (= 5.1.0)
-    activerecord (5.1.0)
-      activemodel (= 5.1.0)
-      activesupport (= 5.1.0)
-      arel (~> 8.0)
-    activesupport (5.1.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (8.0.0)
-    ast (2.3.0)
-    awesome_print (1.7.0)
-    builder (3.2.3)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
-    database_cleaner (1.5.3)
-    diff-lcs (1.3)
-    erubi (1.6.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.10.1)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    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.10.0)
-      pry (~> 0.9)
-      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.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.0)
-      actionpack (= 5.1.0)
-      activesupport (= 5.1.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rainbow (2.2.2)
-      rake
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.48.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    shoulda-matchers (3.1.1)
-      activesupport (>= 4.0.0)
-    slop (3.6.0)
-    standalone_migrations (5.2.1)
-      activerecord (>= 4.2.7, < 5.2.0)
-      railties (>= 4.2.7, < 5.2.0)
-      rake (~> 10.0)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.2.1)
-    yard (0.9.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 5.1.0)
-  appraisal
-  awesome_print
-  bundler (~> 1.9)
-  database_cleaner (~> 1.5.3)
-  jsonb_accessor!
-  pg
-  pry
-  pry-doc
-  pry-nav
-  rake (~> 10.0)
-  rspec (~> 3.2)
-  rubocop (~> 0.48.1)
-  shoulda-matchers
-  standalone_migrations
-
-BUNDLED WITH
-   1.14.6