jsonapi.rb 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33681c6b51c54e27169bfef6b0d9185e1fb80b95
-  data.tar.gz: 4fabb406e5d206e9c42896c6e58a5e77372a68a7
+  metadata.gz: 84c4daefc4822fcbaf912d9bbf500fa8db752bc2
+  data.tar.gz: 3a338f497562d61ee01ccdb889fa309ccc2ebbdf
 SHA512:
-  metadata.gz: ae9a1760b380ef3ff3ebb6b050cdb29b7e59e1032ad21d61f26bb97a357b873590f9fa12fca544cd7074ee04fab2d6ea40b86d7eccaa5832bd6ad334eacbe212
-  data.tar.gz: d55f34067318a8fb16a841cf742b5e9180c306ca54e48f7f69461db45ad1d0df621f93c41d36727d644e38262973e420aad2253a132dee22295dd4a43ac0c4b0
+  metadata.gz: 0da896b2305034b5f448b440db0b93ec67155fdfc707c535328c045c679686b113de9511dd5d9761cf1cced8230776ab47ed85914258440a5b7d76e15e203254
+  data.tar.gz: 8f49760c1227c2017b74106fd3b47b64382aa46892114b54ba4db525fabe384ce6fd49ebe87bfdee69afbdec0aa0263ae39b249b0ceed78b2c2643f5fdde8088

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    jsonapi.rb (1.2.1)
+    jsonapi.rb (1.3.0)
       fast_jsonapi (~> 1.5)
       rack
       ransack

data/README.md

@@ -195,6 +195,18 @@ $ curl -X GET \
   &sort=-model_attr,relationship_attr
 ```
 
+#### Sorting using expressions
+
+You can use basic aggregations like `min`, `max`, `avg`, `sum` and `count`
+when sorting. This is an optional feature since SQL aggregations require
+grouping. To enable expressions along with filters, use the option flags:
+
+```ruby
+options = { sort_with_expressions: true }
+jsonapi_filter(User.all, allowed_fields, options) do |filtered|
+  render jsonapi: result.group('id').to_a
+end
+```
 
 ### Pagination
 

data/lib/jsonapi/filtering.rb

@@ -1,8 +1,21 @@
 require 'ransack/predicate'
+require_relative 'patches'
 
 # Filtering and sorting support
 module JSONAPI
   module Filtering
+    # Parses and returns the attribute and the predicate of a ransack field
+    #
+    # @param requested_field [String] the field to parse
+    # @return [Array] with the fields and the predicate
+    def self.extract_attributes_and_predicate(requested_field)
+      field_name = requested_field.to_s.dup
+      predicate = Ransack::Predicate.detect_and_strip_from_string!(field_name)
+      predicate = Ransack::Predicate.named(predicate)
+
+      [field_name.split(/_and_|_or_/), predicate]
+    end
+
     private
 
     # Applies filtering and sorting to a set of resources if requested
@@ -13,10 +26,12 @@ module JSONAPI
     # Ex.: `GET /resource?filter[region_matches_any]=Lisb%&sort=-created_at,id`
     #
     # @param allowed_fields [Array] a list of allowed fields to be filtered
+    # @param options [Hash] extra flags to enable/disable features
     # @return [ActiveRecord::Base] a collection of resources
-    def jsonapi_filter(resources, allowed_fields)
+    def jsonapi_filter(resources, allowed_fields, options = {})
+      allowed_fields = allowed_fields.map(&:to_s)
       extracted_params = jsonapi_filter_params(allowed_fields)
-      extracted_params[:sorts] = jsonapi_sort_params(allowed_fields)
+      extracted_params[:sorts] = jsonapi_sort_params(allowed_fields, options)
       resources = resources.ransack(extracted_params)
       block_given? ? yield(resources) : resources
     end
@@ -34,11 +49,8 @@ module JSONAPI
       allowed_fields = allowed_fields.map(&:to_s)
 
       requested.each_pair do |requested_field, to_filter|
-        field_name = requested_field.dup
-        predicate = Ransack::Predicate.detect_and_strip_from_string!(field_name)
-        predicate = Ransack::Predicate.named(predicate)
-
-        field_names = field_name.split(/_and_|_or_/)
+        field_names, predicate = JSONAPI::Filtering
+          .extract_attributes_and_predicate(requested_field)
 
         if to_filter.is_a?(String) && to_filter.include?(',')
           to_filter = to_filter.split(',')
@@ -52,24 +64,34 @@ module JSONAPI
       filtered
     end
 
-    # Extracts and whitelists allowed fields to be sorted
+    # Extracts and whitelists allowed fields (or expressions) to be sorted
     #
     # @param allowed_fields [Array] a list of allowed fields to be sorted
+    # @param options [Hash] extra options to enable/disable features
     # @return [Hash] to be passed to [ActiveRecord::Base#order]
-    def jsonapi_sort_params(allowed_fields)
+    def jsonapi_sort_params(allowed_fields, options = {})
+      filtered = []
       requested = params[:sort].to_s.split(',')
-      requested.map! do |requested_field|
-        desc = requested_field.to_s.start_with?('-')
-        [
-          desc ? requested_field[1..-1] : requested_field,
-          desc ? 'desc' : 'asc'
-        ]
-      end
 
-      # Convert to strings instead of hashes to allow joined table columns.
-      requested.to_h.slice(*allowed_fields.map(&:to_s)).map do |field, dir|
-        [field, dir].join(' ')
+      requested.each do |requested_field|
+        if requested_field.to_s.start_with?('-')
+          dir = 'desc'
+          requested_field = requested_field[1..-1]
+        else
+          dir = 'asc'
+        end
+
+        field_names, predicate = JSONAPI::Filtering
+          .extract_attributes_and_predicate(requested_field)
+
+        next unless (field_names - allowed_fields).empty?
+        next if !options[:sort_with_expressions] && predicate
+
+        # Convert to strings instead of hashes to allow joined table columns.
+        filtered << [requested_field, dir].join(' ')
       end
+
+      filtered
     end
   end
 end

data/lib/jsonapi/patches.rb

@@ -0,0 +1,69 @@
+require 'ransack'
+
+Ransack.configure do |config|
+  # Raise errors if a query contains an unknown predicate or attribute.
+  # Default is true (do not raise error on unknown conditions).
+  config.ignore_unknown_conditions = true
+
+  # Enable expressions
+  # See: https://www.rubydoc.info/github/rails/rails/Arel/Expressions
+  config.add_predicate(
+    'count', arel_predicate: 'count',
+    validator: ->(_) { true }, compounds: false
+  )
+  config.add_predicate(
+    'count_distinct', arel_predicate: 'count',
+    validator: ->(_) { true }, formatter: ->(_) { true }, compounds: false
+  )
+  config.add_predicate(
+    'sum', arel_predicate: 'sum',
+    validator: ->(v) { true }, compounds: false
+  )
+  config.add_predicate(
+    'avg', arel_predicate: 'average',
+    validator: ->(v) { true }, compounds: false
+  )
+  config.add_predicate(
+    'min', arel_predicate: 'minimum',
+    validator: ->(v) { true }, compounds: false
+  )
+  config.add_predicate(
+    'max', arel_predicate: 'maximum',
+    validator: ->(v) { true }, compounds: false
+  )
+end
+
+
+Ransack::Visitor.class_eval do
+  alias_method :original_visit_Ransack_Nodes_Sort, :visit_Ransack_Nodes_Sort
+
+  private
+
+  # Original method assumes sorting is done only by attributes
+  def visit_Ransack_Nodes_Sort(node)
+    # Try the default sorting visitor method...
+    binded = original_visit_Ransack_Nodes_Sort(node)
+    valid = (binded.valid? if binded.respond_to?(:valid?)) || true
+    return binded if binded.present? && valid
+
+    # Fallback to support the expressions...
+    binded = Ransack::Nodes::Condition.extract(node.context, node.name, nil)
+    valid = (binded.valid? if binded.respond_to?(:valid?)) || true
+    binded.arel_predicate if binded.present? && valid
+  end
+end
+
+Ransack::Nodes::Condition.class_eval do
+  alias_method :original_format_predicate, :format_predicate
+
+  private
+
+  # Original method doesn't respect the arity of expressions
+  # See: lib/ransack/adapters/active_record/ransack/nodes/condition.rb#L30-L42
+  def format_predicate(attribute)
+    original_format_predicate(attribute)
+  rescue ArgumentError
+    arel_pred = arel_predicate_for_attribute(attribute)
+    attribute.attr.public_send(arel_pred)
+  end
+end

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Stas Suscov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_jsonapi
@@ -217,6 +217,7 @@ files:
 - lib/jsonapi/fetching.rb
 - lib/jsonapi/filtering.rb
 - lib/jsonapi/pagination.rb
+- lib/jsonapi/patches.rb
 - lib/jsonapi/rails.rb
 - lib/jsonapi/version.rb
 homepage: https://github.com/stas/jsonapi.rb