jsonb_accessor 1.0.0.beta.3 → 1.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daa3bf1bf3902f9507356358bb715623a66f622a
-  data.tar.gz: b6f917cb7dab2ad61077a23a2b94d8a65545b6f5
+  metadata.gz: 9342c69dc4817b5f014149d149fd8fb92ad650ff
+  data.tar.gz: d3b5f27e415c190f63b9275cc28c648fc2510023
 SHA512:
-  metadata.gz: 1d3f263eb28a0b7f2d0b1f813cc0a9d24b2b1fd0814eca2916ca474d150eb751287e064b82464f541224a53a4b6576bffc35012a56a4ea84bf240646e5c3a288
-  data.tar.gz: 5a41d9c6cd1b5d45b3d8f76b974493c668a28453575d0247fb896cc842edfcc898d4d3aedc6158c54e8786cdcb0b962c7bf7be942b169699951aa4695fb561c3
+  metadata.gz: 2b2e8d7ffbc17b5b8455c8e95f686a1ad24a2f3cbd7f6166d7bcf2300922316221248617dd021fb0d3f59db45f5b9bb4ff912540c4876f0b3a92484d688fc29a
+  data.tar.gz: 6e1453d01c791b69cf5ec9c0f525819bc8eed173fdbb4f914c8e190f7a5f6b7ae0ad8e966707a023299d69f2e33df1cb0af74b3ef7374053127cbe8c430a14dd

data/README.md

@@ -1,6 +1,8 @@
 # JSONb Accessor
 
-Created by [<img src="https://raw.githubusercontent.com/devmynd/jsonb_accessor/master/devmynd-logo.png" alt="DevMynd Logo" />](https://www.devmynd.com/) [![Gem Version](https://badge.fury.io/rb/jsonb_accessor.svg)](http://badge.fury.io/rb/jsonb_accessor) [![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" />
+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/)
+
+[![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" />
 
 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.
 
@@ -27,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.3"
+gem "jsonb_accessor", "1.0.0.beta.4"
 ```
 
 And then execute:
@@ -71,7 +73,7 @@ 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`).
+The `default` option works pretty much as you would expect in practice; if no values are set for the attributes, a hash of the specified default values is saved to the jsonb column.
 
 You can also pass in a `store_key` option.
 
@@ -154,6 +156,14 @@ Product.all.data_where(reviewed_at: { before: Time.current }, price: { greater_t
 ```
 This scope makes use of the `jsonb_contains`, `jsonb_number_where`, and `jsonb_time_where` `scope`s.
 
+### `jsonb_where_not`
+
+Just the opposite of `jsonb_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_where_not(:data, reviewed_at: { before: Time.current }, p: { greater_than: 5 })
+```
+
 ### `jsonb_contains`
 
 Returns all records that contain the given JSON paths.

data/gemfiles/activerecord_5.0.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    jsonb_accessor (1.0.0.beta.3)
+    jsonb_accessor (1.0.0.beta.4)
       activerecord (>= 5.0)
       pg (>= 0.18.1)
 

data/lib/jsonb_accessor/macro.rb

@@ -29,7 +29,7 @@ module JsonbAccessor
         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
+          mapping[name.to_s] = field_default unless field_default.nil?
         end
 
         # Get store keys to default values mapping

data/lib/jsonb_accessor/query_builder.rb

@@ -39,9 +39,13 @@ module JsonbAccessor
       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 }
@@ -49,6 +53,20 @@ module JsonbAccessor
       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]
@@ -126,6 +144,13 @@ module JsonbAccessor
 
         excludes_attributes.empty? ? query : query.jsonb_excludes(column_name, excludes_attributes)
       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}")
+      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.3"
+  VERSION = "1.0.0.beta.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.3
+  version: 1.0.0.beta.4
 platform: ruby
 authors:
 - Michael Crismali
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord