jsonb_accessor 1.0.0.beta.5 → 1.0.0.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a66f5adf90e5c66c0cacb04698102c37fbd69b27
-  data.tar.gz: dcee9f04338256069b16e0078bbd21ee34264b7a
+  metadata.gz: bd5842d35872b7e0a4aae6cf87b7a58b32dc7c23
+  data.tar.gz: 74587e5629b53a1e34416e966527a59087a522d7
 SHA512:
-  metadata.gz: eb1b146937ec6624866dc4f8594d25889eb9fd7a92de1610242048e6c5488050b0be7cbe8e9f2f887a07ed45eeb97308071c3889023eb2a3074f8e01928c91a6
-  data.tar.gz: f8d8fad1f5adea8b6d71b8512991a838f4a8dde52c4b9ca83b03facfab2d00f946d3a2a9e402c18d0f3f44bc2de53fa624e57e2531e2fe1b095c2766561c2ed6
+  metadata.gz: 9fdafe03f73b4e9b002f592b2eccac07dee6db7e236285cbc4a7ddb7394f96a74e441d25f32397e1fe210631444d06fcdea25b416cd2849623a6db1ad8974787
+  data.tar.gz: 311f65d600e4e52ed56f1eb8412628821ff453266beebeb4045c665209c437690000beaa69d30f32c9439566f99df79e2d91b86eeae045099f365df653e8fb70

data/.ruby-version

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

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 rvm:
   - 2.2.5
-  - 2.3.1
+  - 2.3.3
+  - 2.4.1
 addons:
   postgresql: '9.4'
 before_install:

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"
 end

data/README.md

@@ -29,7 +29,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.0.0.beta.6"
 ```
 
 And then execute:
@@ -141,6 +141,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 +172,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.

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.0.0.gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.5)
+    jsonb_accessor (1.0.0.beta.6)
       activerecord (>= 5.0)
+      activesupport (>= 5.0)
       pg (>= 0.18.1)
 
 GEM
@@ -32,7 +33,7 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    appraisal (2.1.0)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
@@ -42,7 +43,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
-    database_cleaner (1.5.3)
+    database_cleaner (1.6.0)
     diff-lcs (1.3)
     erubis (2.7.0)
     i18n (0.8.1)
@@ -51,7 +52,7 @@ GEM
     method_source (0.8.2)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
-    nokogiri (1.7.0.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
     parser (2.4.0.0)
       ast (~> 2.2)
@@ -66,7 +67,7 @@ GEM
       yard (~> 0.9)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
-    rack (2.0.1)
+    rack (2.0.2)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails-dom-testing (2.0.2)
@@ -83,19 +84,19 @@ GEM
     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)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     rubocop (0.48.1)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
@@ -103,12 +104,10 @@ GEM
       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)
+    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)
@@ -122,20 +121,19 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (~> 5.0.0)
-  appraisal
+  appraisal (~> 2.2.0)
   awesome_print
   bundler (~> 1.9)
-  database_cleaner (~> 1.5.3)
+  database_cleaner (~> 1.6.0)
   jsonb_accessor!
   pg
   pry
   pry-doc
   pry-nav
   rake (~> 10.0)
-  rspec (~> 3.2)
+  rspec (~> 3.6.0)
   rubocop (~> 0.48.1)
-  shoulda-matchers
-  standalone_migrations
+  standalone_migrations (~> 5.2.0)
 
 BUNDLED WITH
    1.14.6

data/gemfiles/activerecord_5.1.0.gemfile

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

data/gemfiles/activerecord_5.1.0.gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.5)
+    jsonb_accessor (1.0.0.beta.6)
       activerecord (>= 5.0)
+      activesupport (>= 5.0)
       pg (>= 0.18.1)
 
 GEM
@@ -42,7 +43,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
-    database_cleaner (1.5.3)
+    database_cleaner (1.6.0)
     diff-lcs (1.3)
     erubi (1.6.0)
     i18n (0.8.1)
@@ -83,19 +84,19 @@ GEM
     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)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     rubocop (0.48.1)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
@@ -103,8 +104,6 @@ GEM
       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)
@@ -122,20 +121,19 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord (~> 5.1.0)
-  appraisal
+  appraisal (~> 2.2.0)
   awesome_print
   bundler (~> 1.9)
-  database_cleaner (~> 1.5.3)
+  database_cleaner (~> 1.6.0)
   jsonb_accessor!
   pg
   pry
   pry-doc
   pry-nav
   rake (~> 10.0)
-  rspec (~> 3.2)
+  rspec (~> 3.6.0)
   rubocop (~> 0.48.1)
-  shoulda-matchers
-  standalone_migrations
+  standalone_migrations (~> 5.2.0)
 
 BUNDLED WITH
    1.14.6

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 "appraisal", "~> 2.2.0"
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "database_cleaner", "~> 1.5.3"
+  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 "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/macro.rb

@@ -100,9 +100,16 @@ module JsonbAccessor
         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

@@ -40,6 +40,40 @@ module JsonbAccessor
       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
@@ -47,6 +81,7 @@ module JsonbAccessor
     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 }
@@ -114,7 +149,7 @@ module JsonbAccessor
         query = all
         contains_attributes = {}
 
-        attributes.each do |name, value|
+        JsonbAccessor::CONVERT_RANGES.call(attributes).each do |name, value|
           case value
           when IS_NUMBER_QUERY_ARGUMENTS
             value.each { |operator, query_value| query = query.jsonb_number_where(column_name, name, operator, query_value) }
@@ -133,6 +168,10 @@ module JsonbAccessor
         excludes_attributes = {}
 
         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"
+          end
+
           case value
           when IS_NUMBER_QUERY_ARGUMENTS
             value.each { |operator, query_value| query = query.jsonb_number_where_not(column_name, name, operator, query_value) }

data/lib/jsonb_accessor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonbAccessor
-  VERSION = "1.0.0.beta.5"
+  VERSION = "1.0.0.beta.6"
 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.0.0.beta.6
 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: 2017-05-09 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,16 +58,16 @@ 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
@@ -74,14 +88,14 @@ dependencies:
     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
@@ -158,14 +172,14 @@ dependencies:
     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
@@ -263,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 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.