grape-listing 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7ada8749162c0e09f2a0dad2712dbd31e3296d302266449e4c5edd7cea9b1d6
-  data.tar.gz: 51afe0e601ad9e8f5d22d4c0d07031078cc9b6d1161cfd092a15dfb18265cd8b
+  metadata.gz: fc9d85fa238526c44cf07b472bd9976773d5bfe9cb04bdc97ecc81672df569cf
+  data.tar.gz: fe05929e906cb16edb27e6987eb16d0d7b12ab824f9de49154b4bb1b84294fcf
 SHA512:
-  metadata.gz: ff72f5cf03c2394347d8745e8c68429d85f793ce64f29eddc7d808f6b75fb81c4a4cb6d12bf5af8f707a999e2fe90d5269b4b310ebd6794819d65d0bfbeb7fe0
-  data.tar.gz: 98e6cec6b17f9efa1fcbd1890a3d376539d2662240e6dfddb107ae729a96b1f8e2aea569f2adb183fb52639945159a3dcc7b0b24ce7e5ada098d055c2d1b1066
+  metadata.gz: 8bf8698b3d478e54fbd02091a24a7d3a838c3a9fd30b79edb1b9941a92a722ef86a43850035f7c6e4ccd89384f4576160ae7fb09c8c665f0b706ba6f157cdf74
+  data.tar.gz: e45bdb89068782fae208e8b6ec250fdf528b44cd7fffbd151247346eaf473a7c4206318a10a59ac3ce7f1e04280feca4e75580de945ee3e0bb1c8a553067d442

data/README.md

@@ -1,5 +1,5 @@
 # Grape Listing
-[![Gem Version](https://badge.fury.io/rb/paginated.svg)](https://badge.fury.io/rb/paginated)
+[![Gem Version](https://badge.fury.io/rb/grape-listing.svg)](https://badge.fury.io/rb/grape-listing)
 
 Гем для пагинации и фильтрации записей с возможностью формирования электронных таблиц (XLSX) на базе Grape.
 

data/lib/grape/dsl.rb

@@ -19,8 +19,8 @@ module Grape
         opts = { model:, entity:, scopes:, search:, params:, current_user: }
 
         # требуемый список полей (+стандартные) для фильтрации в Grape Entity
-        if params[:columns] && !params[:spreadsheet]
-          opts[:only_columns] = params[:columns] + %w[id deleted_at]
+        if params[:columns]
+          opts[:only_columns] = params[:spreadsheet] ? params[:columns] : params[:columns] + ['deleted_at']
         end
 
         opts

data/lib/grape_listing_service.rb

@@ -1,14 +1,16 @@
 require 'listing_service/args_handling'
-require 'listing_service/collection'
+require 'listing_service/pagination'
 require 'listing_service/search'
+require 'listing_service/serialization'
 require 'listing_service/sorting'
 require 'listing_service/spreadsheet'
 
 class GrapeListingService
 
   include GrapeListing::ArgsHandling
-  include GrapeListing::Collection
+  include GrapeListing::Pagination
   include GrapeListing::Search
+  include GrapeListing::Serialization
   include GrapeListing::Sorting
   include GrapeListing::Spreadsheet
 

data/lib/listing_service/pagination.rb

@@ -0,0 +1,30 @@
+module GrapeListing
+  module Pagination
+
+    def paginated
+      if @objects_count > 0
+        search
+        paginate
+      else
+        @objects = []
+      end
+
+      # результат с пагинацией
+      { count: @objects_count, objects: @objects }
+    end
+
+    private
+
+    def paginate
+      # коллекция записей ActiveRecord для применения аггрегирования
+      list = @objects || @model.unscoped.merge(@scopes)
+
+      # применение сортировки и пагинации к коллекции записей
+      @objects = list.offset(@offset).merge(sort_proc).limit(@limit)
+
+      # сериализация с помощью переданных полей или сериалайзера
+      @objects = serialize(@objects)
+    end
+
+  end
+end

data/lib/listing_service/serialization.rb

@@ -0,0 +1,42 @@
+module GrapeListing
+  module Serialization
+
+    private
+
+    def serialize(records)
+      if @fields
+        serialize_with_fields(records)
+      elsif @grape_entity
+        serialize_with_entity(records)
+      end
+    end
+
+    def serialize_with_fields(records)
+      # добавление ID в список полей по умолчанию
+      @fields.push(:id)
+
+      # список массивов значений
+      records = records.map { |i| obtain_fields_values(i) }
+
+      # трансформация массивов значений в объекты (ключ-значение)
+      records.map { |i| @fields.zip(i).to_h }
+    end
+
+    def serialize_with_entity(records)
+      opts = { current_user: @current_user }
+
+      # требуемый список полей (если был передан)
+      opts[:only] = @only_columns if @only_columns
+
+      # опция для идентификации формирования эл. таблицы
+      opts[:spreadsheet] = true if @params['spreadsheet']
+
+      records.map { |i| @grape_entity.represent(i, opts).as_json }
+    end
+
+    def obtain_fields_values(record)
+      @fields.map { |i| record.send(i) }
+    end
+
+  end
+end

data/lib/listing_service/spreadsheet.rb

@@ -4,6 +4,8 @@ module GrapeListing
   module Spreadsheet
 
     def spreadsheet
+      @spreadsheet_cols = @params['columns'].map(&:to_sym)
+
       # поиск и фильтрация
       search
 
@@ -13,13 +15,16 @@ module GrapeListing
       # ограничение записей
       records = records.order(:id).offset(@offset).limit(@limit)
 
+      # сериализация записей и превращение в объекты
+      objects = serialize(records)
+
       # формирования файла эл. таблицы
-      generate_spreadsheet(records)
+      generate_spreadsheet(objects)
     end
 
     private
 
-    def generate_spreadsheet(records)
+    def generate_spreadsheet(objects)
       filepath = "#{@tempdir}/#{Time.now.strftime('%Y%m%d_%H%M%S')}.xlsx"
 
       # создание таблицы и ее конфигурация
@@ -40,9 +45,8 @@ module GrapeListing
       worksheet.append_row(spreadsheet_titles, bold)
 
       # содержимое
-      cols = spreadsheet_columns
-      records.each do |record|
-        values = cols.map { |col| record.send_chain(col) }
+      objects.each do |object|
+        values = object.slice(*@spreadsheet_cols).values
         worksheet.append_row(values)
       end
 
@@ -54,23 +58,30 @@ module GrapeListing
     end
 
     def spreadsheet_titles
-      model_cols = @model.columns.to_h { |i| [i.name, i] }
+      values = []
+      entity_doc = @grape_entity.documentation
+      model_cols = @model.columns.to_h { |i| [i.name.to_sym, i] }
 
-      @params['columns'].map do |column|
+      @spreadsheet_cols.each do |column|
+        # поиск описания среди комментариев к таблице БД
         db_col = model_cols[column]
-
-        db_col.comment || column
+        if db_col&.comment&.present?
+          values << db_col.comment
+          next
+        end
+
+        # поиск описания среди комментариев к полям Grape Entity
+        doc = entity_doc[column]
+        if doc && doc[:desc]
+          values << doc[:desc]
+          next
+        end
+
+        # ничего из вышеперечисленного не найдено, заголовок - название самой колонки
+        values << column.upcase
       end
-    end
 
-    def spreadsheet_columns
-      entity_doc = @grape_entity.documentation
-
-      @params['columns'].map do |column|
-        doc = entity_doc[column.to_sym]
-
-        doc && doc[:sheet_method] ? doc[:sheet_method].split('.') : column
-      end
+      values
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-listing
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_excel
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-description: Простая пагинация, поиск и формирование эл. таблиц для API на базе Grape
+description: Фильтрация, пагинация и формирование эл. таблиц на базе Grape
 email: babin359@gmail.com
 executables: []
 extensions: []
@@ -80,8 +80,9 @@ files:
 - lib/grape_listing/configuration.rb
 - lib/grape_listing_service.rb
 - lib/listing_service/args_handling.rb
-- lib/listing_service/collection.rb
+- lib/listing_service/pagination.rb
 - lib/listing_service/search.rb
+- lib/listing_service/serialization.rb
 - lib/listing_service/sorting.rb
 - lib/listing_service/spreadsheet.rb
 homepage:

data/lib/listing_service/collection.rb

@@ -1,58 +0,0 @@
-module GrapeListing
-  module Collection
-
-    def paginated
-      if @objects_count > 0
-        search
-        serialize
-      else
-        @objects = []
-      end
-
-      # результат с пагинацией
-      { count: @objects_count, objects: @objects }
-    end
-
-    private
-
-    def serialize
-      # коллекция записей ActiveRecord для применения аггрегирования
-      list = @objects || @model.unscoped.merge(@scopes)
-
-      # применение сортировки и пагинации к коллекции записей
-      @objects = list.offset(@offset).merge(sort_proc).limit(@limit)
-
-      # сериализация с помощью переданных полей или сериалайзера
-      if @fields
-        serialize_with_fields
-      elsif @grape_entity
-        serialize_with_entity
-      end
-    end
-
-    def serialize_with_fields
-      # добавление ID в список полей по умолчанию
-      @fields.push(:id)
-
-      # список массивов значений
-      @objects = @objects.map { |i| obtain_fields_values(i) }
-
-      # трансформация массивов значений в объекты (ключ-значение)
-      @objects = @objects.map { |i| @fields.zip(i).to_h }
-    end
-
-    def serialize_with_entity
-      opts = { current_user: @current_user }
-
-      # требуемый список полей (если был передан)
-      opts[:only] = @only_columns if @only_columns
-
-      @objects = @objects.map { |i| @grape_entity.represent(i, opts).as_json }
-    end
-
-    def obtain_fields_values(record)
-      @fields.map { |i| record.send(i) }
-    end
-
-  end
-end