jsonb_accessor 1.0.0.beta.6 → 1.0.0.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd5842d35872b7e0a4aae6cf87b7a58b32dc7c23
-  data.tar.gz: 74587e5629b53a1e34416e966527a59087a522d7
+  metadata.gz: 9443b5a6ade6928899a6d286c8302a95bab56c9c
+  data.tar.gz: 5168b13af14c34bfd05652f9dab3099ef0b555bd
 SHA512:
-  metadata.gz: 9fdafe03f73b4e9b002f592b2eccac07dee6db7e236285cbc4a7ddb7394f96a74e441d25f32397e1fe210631444d06fcdea25b416cd2849623a6db1ad8974787
-  data.tar.gz: 311f65d600e4e52ed56f1eb8412628821ff453266beebeb4045c665209c437690000beaa69d30f32c9439566f99df79e2d91b86eeae045099f365df653e8fb70
+  metadata.gz: 3d0dfee7666cf5d0390faa6205813152f3c1ef013ff26864d64959cb5eaf9bb099784677d870f04176ff30b089b0c247b21361688b71d34c6c0808caa4fddbd8
+  data.tar.gz: 887584f334980e0c03866f443090db22c1d9dcd3ffc360c2733a7d133388aed25ed3f73438ba33a9cba35a71468b959fb9fc6e8ded1cb4fe7bf81e1479cf11af

data/gemfiles/activerecord_5.0.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.6)
+    jsonb_accessor (1.0.0.beta.7)
       activerecord (>= 5.0)
       activesupport (>= 5.0)
       pg (>= 0.18.1)
@@ -123,7 +123,7 @@ DEPENDENCIES
   activerecord (~> 5.0.0)
   appraisal (~> 2.2.0)
   awesome_print
-  bundler (~> 1.9)
+  bundler (~> 1.15.0)
   database_cleaner (~> 1.6.0)
   jsonb_accessor!
   pg
@@ -136,4 +136,4 @@ DEPENDENCIES
   standalone_migrations (~> 5.2.0)
 
 BUNDLED WITH
-   1.14.6
+   1.15.3

data/gemfiles/activerecord_5.1.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.6)
+    jsonb_accessor (1.0.0.beta.7)
       activerecord (>= 5.0)
       activesupport (>= 5.0)
       pg (>= 0.18.1)
@@ -123,7 +123,7 @@ DEPENDENCIES
   activerecord (~> 5.1.0)
   appraisal (~> 2.2.0)
   awesome_print
-  bundler (~> 1.9)
+  bundler (~> 1.15.0)
   database_cleaner (~> 1.6.0)
   jsonb_accessor!
   pg
@@ -136,4 +136,4 @@ DEPENDENCIES
   standalone_migrations (~> 5.2.0)
 
 BUNDLED WITH
-   1.14.6
+   1.15.3

data/jsonb_accessor.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pg", ">= 0.18.1"
 
   spec.add_development_dependency "appraisal", "~> 2.2.0"
-  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "bundler", "~> 1.15.0"
   spec.add_development_dependency "database_cleaner", "~> 1.6.0"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "pry"

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

@@ -34,7 +34,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 +46,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 +74,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) }
@@ -89,13 +96,13 @@ module JsonbAccessor
 
         # <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)
 

data/lib/jsonb_accessor/query_builder.rb

@@ -1,147 +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
-
-  CONVERT_NUMBER_RANGES = lambda do |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
-
-  CONVERT_TIME_RANGES = lambda do |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
-
-  CONVERT_RANGES = lambda do |attributes|
-    [CONVERT_NUMBER_RANGES, CONVERT_TIME_RANGES].reduce(attributes) do |new_attributes, converter|
-      converter.call(new_attributes)
-    end
-  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)
-    NotSupported = 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)
 
@@ -149,11 +43,10 @@ module JsonbAccessor
         query = all
         contains_attributes = {}
 
-        JsonbAccessor::CONVERT_RANGES.call(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
@@ -169,13 +62,12 @@ module JsonbAccessor
 
         attributes.each do |name, value|
           if value.is_a?(Range)
-            raise NotSupported, "`jsonb_where_not` scope does not accept ranges as arguments. Given `#{value}` for `#{name}` field"
+            raise JsonbAccessor::QueryHelper::NotSupported, "`jsonb_where_not` scope does not accept ranges as arguments. Given `#{value}` for `#{name}` field"
           end
 
-          case value
-          when IS_NUMBER_QUERY_ARGUMENTS
+          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
@@ -186,9 +78,9 @@ 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)
+        JsonbAccessor::QueryHelper.validate_column_name!(all, column_name)
+        JsonbAccessor::QueryHelper.validate_field_name!(all, column_name, field_name)
+        JsonbAccessor::QueryHelper.validate_direction!(direction)
         order("(#{table_name}.#{column_name} -> '#{field_name}') #{direction}")
       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.6"
+  VERSION = "1.0.0.beta.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.6
+  version: 1.0.0.beta.7
 platform: ruby
 authors:
 - Michael Crismali
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +242,7 @@ files:
 - 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: