Merge pull request #1109 from senid231/936-custom-sorting

Fixes #936 add ability to define custom sorting

Author: lgebhardt

lib/jsonapi/active_relation_resource_finder.rb

@@ -387,28 +387,38 @@ def apply_pagination(records, paginator, order_options)
         records
       end
 
-      def apply_sort(records, order_options, _context = {})
+      def apply_sort(records, order_options, context = {})
         if order_options.any?
           order_options.each_pair do |field, direction|
-            if field.to_s.include?(".")
-              *model_names, column_name = field.split(".")
-
-              associations = _lookup_association_chain([records.model.to_s, *model_names])
-              joins_query = _build_joins([records.model, *associations])
-
-              order_by_query = "#{_join_table_name(associations.last)}.#{column_name} #{direction}"
-              records = records.joins(joins_query).order(order_by_query)
-            else
-              field = _attribute_delegated_name(field)
-              records = records.order(field => direction)
-            end
+            records = apply_single_sort(records, field, direction, context)
           end
         end
 
         records
       end
 
-      def apply_basic_sort(records, order_options, context = {})
+      def apply_single_sort(records, field, direction, context = {})
+        strategy = _allowed_sort.fetch(field.to_sym, {})[:apply]
+
+        if strategy
+          call_method_or_proc(strategy, records, direction, context)
+        else
+          if field.to_s.include?(".")
+            *model_names, column_name = field.split(".")
+
+            associations = _lookup_association_chain([records.model.to_s, *model_names])
+            joins_query = _build_joins([records.model, *associations])
+
+            order_by_query = "#{_join_table_name(associations.last)}.#{column_name} #{direction}"
+            records.joins(joins_query).order(order_by_query)
+          else
+            field = _attribute_delegated_name(field)
+            records.order(field => direction)
+          end
+        end
+      end
+
+      def apply_basic_sort(records, order_options, _context = {})
         if order_options.any?
           order_options.each_pair do |field, direction|
             records = records.order("#{field} #{direction}")
@@ -476,11 +486,7 @@ def apply_filter(records, filter, value, options = {})
         strategy = _allowed_filters.fetch(filter.to_sym, Hash.new)[:apply]
 
         if strategy
-          if strategy.is_a?(Symbol) || strategy.is_a?(String)
-            send(strategy, records, value, options)
-          else
-            strategy.call(records, value, options)
-          end
+          call_method_or_proc(strategy, records, value, options)
         else
           filter = _attribute_delegated_name(filter)
           table_alias = options[:table_alias]

lib/jsonapi/resource.rb

@@ -416,6 +416,8 @@ def inherited(subclass)
 
         subclass._allowed_filters = (_allowed_filters || Set.new).dup
 
+        subclass._allowed_sort = _allowed_sort.dup
+
         type = subclass.name.demodulize.sub(/Resource$/, '').underscore
         subclass._type = type.pluralize.to_sym
 
@@ -537,7 +539,7 @@ def model_name_for_type(key_type)
       end
 
       attr_accessor :_attributes, :_relationships, :_type, :_model_hints
-      attr_writer :_allowed_filters, :_paginator
+      attr_writer :_allowed_filters, :_paginator, :_allowed_sort
 
       def create(context)
         new(create_model, context)
@@ -583,6 +585,10 @@ def attribute(attribute_name, options = {})
         define_method "#{attr}=" do |value|
           @model.public_send("#{options[:delegate] ? options[:delegate].to_sym : attr}=", value)
         end unless method_defined?("#{attr}=")
+
+        if options.fetch(:sortable, true) && !_has_sort?(attr)
+          sort attr
+        end
       end
 
       def attribute_to_model_field(attribute)
@@ -669,6 +675,15 @@ def filter(attr, *args)
         @_allowed_filters[attr.to_sym] = args.extract_options!
       end
 
+      def sort(sorting, options = {})
+        self._allowed_sort[sorting.to_sym] = options
+      end
+
+      def sorts(*args)
+        options = args.extract_options!
+        _allowed_sort.merge!(args.inject({}) { |h, sorting| h[sorting.to_sym] = options.dup; h })
+      end
+
       def primary_key(key)
         @_primary_key = key.to_sym
       end
@@ -689,7 +704,7 @@ def creatable_fields(_context = nil)
 
       # Override in your resource to filter the sortable keys
       def sortable_fields(_context = nil)
-        _attributes.keys
+        _allowed_sort.keys
       end
 
       def sortable_field?(key, context = nil)
@@ -759,11 +774,7 @@ def verify_filter(filter, raw, context = nil)
         strategy = _allowed_filters.fetch(filter, Hash.new)[:verify]
 
         if strategy
-          if strategy.is_a?(Symbol) || strategy.is_a?(String)
-            values = send(strategy, filter_values, context)
-          else
-            values = strategy.call(filter_values, context)
-          end
+          values = call_method_or_proc(strategy, filter_values, context)
           [filter, values]
         else
           if is_filter_relationship?(filter)
@@ -774,6 +785,14 @@ def verify_filter(filter, raw, context = nil)
         end
       end
 
+      def call_method_or_proc(strategy, *args)
+        if strategy.is_a?(Symbol) || strategy.is_a?(String)
+          send(strategy, *args)
+        else
+          strategy.call(*args)
+        end
+      end
+
       def key_type(key_type)
         @_resource_key_type = key_type
       end
@@ -890,6 +909,10 @@ def _allowed_filters
         defined?(@_allowed_filters) ? @_allowed_filters : { id: {} }
       end
 
+      def _allowed_sort
+        @_allowed_sort ||= {}
+      end
+
       def _paginator
         @_paginator ||= JSONAPI.configuration.default_paginator
       end
@@ -963,6 +986,10 @@ def _allowed_filter?(filter)
         !_allowed_filters[filter].nil?
       end
 
+      def _has_sort?(sorting)
+        !_allowed_sort[sorting.to_sym].nil?
+      end
+
       def module_path
         if name == 'JSONAPI::Resource'
           ''

test/controllers/controller_test.rb

@@ -3971,4 +3971,37 @@ def test_fetch_indicators_sort_by_widgets_name
     assert_equal indicator_2.id.to_s, json_response['data'].first['id']
     assert_equal 2, json_response['data'].size
   end
+
+end
+
+class RobotsControllerTest < ActionController::TestCase
+
+  def teardown
+    Robot.delete_all
+  end
+
+  def test_fetch_robots_with_sort_by_name
+    Robot.create! name: 'John', version: 1
+    Robot.create! name: 'jane', version: 1
+    assert_cacheable_get :index, params: {sort: 'name'}
+    assert_response :success
+    assert_equal 'John', json_response['data'].first['attributes']['name']
+  end
+
+  def test_fetch_robots_with_sort_by_lower_name
+    Robot.create! name: 'John', version: 1
+    Robot.create! name: 'jane', version: 1
+    assert_cacheable_get :index, params: {sort: 'lower_name'}
+    assert_response :success
+    assert_equal 'jane', json_response['data'].first['attributes']['name']
+  end
+
+  def test_fetch_robots_with_sort_by_version
+    Robot.create! name: 'John', version: 1
+    Robot.create! name: 'jane', version: 2
+    assert_cacheable_get :index, params: {sort: 'version'}
+    assert_response 400
+    assert_equal 'version is not a valid sort criteria for robots', json_response['errors'].first['detail']
+  end
+
 end

test/fixtures/active_record.rb

@@ -350,6 +350,12 @@
     t.integer :indicator_id, null: false
     t.timestamps null: false
   end
+
+  create_table :robots, force: true do |t|
+    t.string :name
+    t.integer :version
+    t.timestamps null: false
+  end
 end
 
 ### MODELS
@@ -725,6 +731,9 @@ class Widget < ActiveRecord::Base
   belongs_to :indicator
 end
 
+class Robot < ActiveRecord::Base
+end
+
 ### CONTROLLERS
 class AuthorsController < JSONAPI::ResourceControllerMetal
 end
@@ -1021,6 +1030,9 @@ class WidgetsController < JSONAPI::ResourceController
 class IndicatorsController < JSONAPI::ResourceController
 end
 
+class RobotsController < JSONAPI::ResourceController
+end
+
 ### RESOURCES
 class BaseResource < JSONAPI::Resource
   abstract
@@ -2186,6 +2198,15 @@ class WorkerResource < JSONAPI::Resource
   attribute :name
 end
 
+class RobotResource < ::JSONAPI::Resource
+  attribute :name
+  attribute :version, sortable: false
+
+  sort :lower_name, apply: ->(records, direction, _context) do
+    records.order("LOWER(robots.name) #{direction}")
+  end
+end
+
 ### PORO Data - don't do this in a production app
 $breed_data = BreedData.new
 $breed_data.add(Breed.new(0, 'persian'))

test/test_helper.rb

@@ -400,6 +400,7 @@ class CatResource < JSONAPI::Resource
   jsonapi_resources :workers, only: [:show]
   jsonapi_resources :widgets, only: [:index]
   jsonapi_resources :indicators, only: [:index]
+  jsonapi_resources :robots, only: [:index]
 
   mount MyEngine::Engine => "/boomshaka", as: :my_engine
   mount ApiV2Engine::Engine => "/api_v2", as: :api_v2_engine