grape-listing 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 753ca42cbbc590322ae50cc4deb2319abbf1ed42971f3465d47fd437ae59426b
-  data.tar.gz: 8340c60d43bfaf42cd28507f78797802a2a02d59c5520ff538b20f5f2573a8d7
+  metadata.gz: ce3fabc3535ed2bcff72cf023731eb2735b5125172952eaed585e76b51d1829d
+  data.tar.gz: edf8e6afdcaf150eb451852184063eeeaceab550690cd5e96602fdd345ed8c57
 SHA512:
-  metadata.gz: 61b65a31634ecd111fa68f0769c80fc2668e9d80b8f61e262fc4f989e499232af1bdeacfe1c6abc711b81bf92f43c9c2630242b8c3229395c68c7a8b40e3c7f1
-  data.tar.gz: e102f06d75c44ddc18b657cefe265f0d9fc6c9cff86640352be57079c1af8032a14bed7c3481e3418fe1e439af48b0ee549bd57bfa4ab43e2dee2bea67532e3f
+  metadata.gz: cc56a44b5ff3259e37519142891cb9a332e3833c0c88bf9a37b3aec5ea31d7c6077cb6c7dd664d8407a288d77d7dc992898b58f3117536eabe5159638204c592
+  data.tar.gz: 73b3df84fbcc94f86bbc41c5323aa1bf8ce5ddbb00890199d560bf3d00fd1fda704a57d9dce71fcebaf84b07b094a6495b6fe5090899009bfeaf30f3151c8733

data/README.md

@@ -33,17 +33,19 @@ end
 
 Опции (с примерами):
 
-`model: User` - модель, записи которой нужно обработать.
+`model: User` - модель, записи которой нужно обработать
 
-`entity: UserEntity` - класс Grape Entity, который обработает каждую запись (передается вместо `fields`).
+`preload: [:posts]` - связи, которые нужно подгрузить для eager load
+
+`entity: UserEntity` - класс Grape Entity, который обработает каждую запись (передается вместо `fields`)
 
 `scopes: proc {...}` - блок кода для применения
 
-`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `entity`).
+`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `entity`)
 
-`search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
+`search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск)
 
-`sortable: %w[...]` - список полей, по которым может осуществляться сортировка.
+`sortable: %w[...]` - список полей, по которым может осуществляться сортировка
 
 `paginate: false` - отдавать результат без пагинации, сразу всей коллекцией (по умолчанию - с пагинацией)
 

data/lib/grape/dsl.rb

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

data/lib/listing_service/args_handling.rb

@@ -7,6 +7,9 @@ module GrapeListing
       # обрабатываемая модель
       @model = args[:model]
 
+      # список связей, необходимых для подгрузки eager load
+      @preload = args[:preload] || []
+
       # параметры адреса запроса API
       @request_method = args[:request_method]
       @request_uri = args[:request_uri]

data/lib/listing_service/listing.rb

@@ -17,7 +17,7 @@ module GrapeListing
 
     def list
       # коллекция записей ActiveRecord для применения аггрегирования
-      list = @objects || @model.merge(@scopes)
+      list = @objects || @model.preload(@preload).merge(@scopes)
 
       # применение сортировки к коллекции записей
       @objects = list.merge(sort_proc)

data/lib/listing_service/pagination.rb

@@ -17,7 +17,7 @@ module GrapeListing
 
     def paginate
       # коллекция записей ActiveRecord для применения аггрегирования
-      list = @objects || @model.merge(@scopes)
+      list = @objects || @model.preload(@preload).merge(@scopes)
 
       # применение сортировки и пагинации к коллекции записей
       @objects = list.offset(@offset).merge(sort_proc).limit(@limit)

data/lib/listing_service/search.rb

@@ -6,7 +6,7 @@ module GrapeListing
     def search
       @search_fields&.each do |field|
         # коллекция записей для дальнейшей фильтрации
-        list = @objects || @model.merge(@scopes)
+        list = @objects || @model.preload(@preload).merge(@scopes)
 
         # оператор и значение для поиска
         operator, value = search_operands(field)

data/lib/listing_service/sorting.rb

@@ -5,7 +5,7 @@ module GrapeListing
 
     def sort_proc
       # проверка необходимости нестандартной сортировки
-      unless custom_sorting_field
+      if !@sortable.is_a?(Array) || @sortable.empty? || custom_sorting_field.blank?
         return proc { order('id DESC NULLS LAST') }
       end
 
@@ -22,7 +22,7 @@ module GrapeListing
 
     # поиск поля для индивидуальной сортировки среди допустимых
     def custom_sorting_field
-      @custom_sorting_field ||= @sortable&.select { |i| i.split('|')[0] == @params['sort_by'] }&.first
+      @custom_sorting_field ||= @sortable.select { |i| i.split('|')[0] == @params['sort_by'] }.first
     end
 
   end

data/lib/listing_service/spreadsheet.rb

@@ -15,7 +15,7 @@ module GrapeListing
       search
 
       # коллекция записей ActiveRecord для формирования эл. таблицы
-      records = @objects || @model.merge(@scopes)
+      records = @objects || @model.preload(@preload).merge(@scopes)
 
       # ограничение записей
       records = records.order(:id).offset(@offset).limit(@limit)

metadata

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