grape-listing 1.2.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c908d060e847beb9d2919d16e2d631168c97181c0522e008ac6cf2ea9b9957
-  data.tar.gz: c06c939b8ae46d8b900b3e652488b281c5858ea8abc6b7b6265e2c40000ce0a8
+  metadata.gz: 753ca42cbbc590322ae50cc4deb2319abbf1ed42971f3465d47fd437ae59426b
+  data.tar.gz: 8340c60d43bfaf42cd28507f78797802a2a02d59c5520ff538b20f5f2573a8d7
 SHA512:
-  metadata.gz: f43ec4d90177802e01106f55b0e589a663c2f1013c176154f17a9bc5ef57fb57566b915ffc63c2c65aa324c154a8cad8d21c0da740d29811a32cd76a72d76e14
-  data.tar.gz: 82c8fd75f4eb8405a1706e03c3ce28cb8ae4456787b910aad3b423d4a705002c74165212adb11edf2d83344be92a7c6cbda37e1346f081e9db607931ba80b045
+  metadata.gz: 61b65a31634ecd111fa68f0769c80fc2668e9d80b8f61e262fc4f989e499232af1bdeacfe1c6abc711b81bf92f43c9c2630242b8c3229395c68c7a8b40e3c7f1
+  data.tar.gz: e102f06d75c44ddc18b657cefe265f0d9fc6c9cff86640352be57079c1af8032a14bed7c3481e3418fe1e439af48b0ee549bd57bfa4ab43e2dee2bea67532e3f

data/README.md

@@ -43,6 +43,8 @@ end
 
 `search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
 
+`sortable: %w[...]` - список полей, по которым может осуществляться сортировка.
+
 `paginate: false` - отдавать результат без пагинации, сразу всей коллекцией (по умолчанию - с пагинацией)
 
 ## Параметры HTTP запроса

data/lib/grape/dsl.rb

@@ -4,13 +4,13 @@ module Grape
   module DSL
     module InsideRoute
 
-      def listing(model:, entity:, scopes: nil, search: nil, paginate: true, caching: false)
+      def listing(model:, entity:, scopes: nil, search: nil, sortable: nil, paginate: true, caching: false)
         # параметры запроса API
         request_method = request.env['REQUEST_METHOD']
         request_uri = request.env['REQUEST_URI']
 
         # опции для сервиса
-        opts = listing_opts(model, entity, scopes, search, caching, request_method, request_uri)
+        opts = listing_opts(model, entity, scopes, search, sortable, caching, request_method, request_uri)
 
         if params[:spreadsheet]
           listing_spreadsheet(**opts)
@@ -23,9 +23,20 @@ module Grape
 
       private
 
-      def listing_opts(model, entity, scopes, search, caching, request_method, request_uri)
+      def listing_opts(model, entity, scopes, search, sortable, caching, request_method, request_uri)
         # стандартные опции
-        opts = { model:, entity:, scopes:, search:, params:, current_user:, caching:, request_method:, request_uri: }
+        opts = {
+          model:,
+          entity:,
+          scopes:,
+          search:,
+          sortable:,
+          params:,
+          current_user:,
+          caching:,
+          request_method:,
+          request_uri:
+        }
 
         # требуемый список полей (+стандартные) для фильтрации в Grape Entity
         if params[:columns]

data/lib/listing_service/args_handling.rb

@@ -38,8 +38,7 @@ module GrapeListing
       @only_columns = args[:only_columns]
 
       # сортировка
-      @sort_by = @params['sort_by'] || :id
-      @sort_order = @params['sort_order'] || :desc
+      @sortable = args[:sortable]
 
       # подсчет кол-ва записей
       @objects_count = records_count

data/lib/listing_service/sorting.rb

@@ -4,8 +4,25 @@ module GrapeListing
     private
 
     def sort_proc
-      query = Arel.sql("#{@sort_by} #{@sort_order} NULLS LAST")
-      proc { order(query) }
+      # проверка необходимости нестандартной сортировки
+      unless custom_sorting_field
+        return proc { order('id DESC NULLS LAST') }
+      end
+
+      sort_order = @params['sort_order'] || 'DESC'
+      sorting_scope = custom_sorting_field.split('|')[1]
+
+      if sorting_scope
+        proc { send(sorting_scope, sort_order) }
+      else
+        query = Arel.sql("#{custom_sorting_field} #{sort_order} NULLS LAST")
+        proc { order(query) }
+      end
+    end
+
+    # поиск поля для индивидуальной сортировки среди допустимых
+    def custom_sorting_field
+      @custom_sorting_field ||= @sortable&.select { |i| i.split('|')[0] == @params['sort_by'] }&.first
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-listing
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack