grape-listing 1.2.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba00678e6ce8506dd80ac31e49dda56058cbb7ad385f2264018e18e9d9279632
-  data.tar.gz: a622910e11b063da43d43edcde6a76d40e66affeb53b3ce490ef0900d6012c54
+  metadata.gz: 91c1e4c2304b5a8918099f9d66fe17adb0867d70dc3e31c4e1d8ddd4f4763bb2
+  data.tar.gz: 43c297e7791da7cc815f893f1ed8e920047799f35633f4facf174911874c6c88
 SHA512:
-  metadata.gz: e2acc4de1f0cfd8406ffd4aa237df70b3058fba8a3d30ce0397aa4b617d6280a9a780c91f77c5d0f3e852f41bbf87b0875ef8582796ab1916d4f65eda4134d86
-  data.tar.gz: ccb7b6dfe1251b06760f39a7de49da40aed8ab31960d481536ec7b7cd59df32b5d21b173a7bb374a8247295c33a286e31e093090c9e1a8049b81dabfa090b155
+  metadata.gz: 38e71d0a6b5b79d13923c4e1950fd6fe9d51732eb57fcf7efe87546a473b93be40994f131beeadd7db0d24ed5b77612997676e472e0e993ccac4d0056f7891a3
+  data.tar.gz: b24ea490f428720e199ffb8029bcfc96abd0f13d471dbc68c8125fe6455b14f19be3d17a7040f7b2cf488199040961586f55ffc258b6a0d57b7469c9b03a643c

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'] }[0]
     end
 
   end

data/lib/listing_service/spreadsheet.rb

@@ -3,6 +3,13 @@ require 'fast_excel'
 module GrapeListing
   module Spreadsheet
 
+    EXCLUDED_COLUMNS = %i[
+      created_at
+      updated_at
+      deleted_at
+      global_id
+    ].freeze
+
     def spreadsheet
       # поиск и фильтрация
       search
@@ -68,7 +75,7 @@ module GrapeListing
 
     def grape_entity_columns
       @grape_entity.root_exposures.map do |exposure|
-        unless exposure.key == :deleted_at
+        if EXCLUDED_COLUMNS.exclude?(exposure.key)
           exposure.key
         end
       end.compact

metadata

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