paginated 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc3ad78511419953d52e6f0f45794b7ff5b11730cb5556dbecc64f9785d8a195
-  data.tar.gz: 136abe2c808ba73b848c8ecf68b8033d573c9c3dd87e351fab13be3fd16a6659
+  metadata.gz: 198ac3104064417c27a8177a6000b4344999b26715857a79b05c67f112f8a6b3
+  data.tar.gz: 4e8b69b3de828f3a3295a7bfb638dd0c851ecb4e20f7d36d0cea406f1a7def46
 SHA512:
-  metadata.gz: 6764684cb5a12b29b6ebd146bc7a5e8e77705b2d237c4dd60c553db1aa4461e5f9332fc56d30679bf97c3daf51e3f817a5bd60ea5a9c2523c5ae40cab112f656
-  data.tar.gz: 6074be3b096999fe2379345aa17e6d69441af45ae471d453c32be5125e1d98b5eb6c7c3033324d8500e32680e6e66817dc303779c4e0ab23504efceb09de5ea3
+  metadata.gz: 51c867ec559e36bbadda8cf1f1d5658e840878a5a8d6d1670926e373457502e247698489a99841ce2f74637f6f25cd15b520bb00216cf98077d8f4a0b2b99c9f
+  data.tar.gz: 0a18ebb83509c2c3be91f6ce1d793548f954b9b692db560239d40a118340cf6908d8704ba8dc89c8244313f9e67ce37d6ef4458c22bd0ff596ab7d63ac3a40d0

data/README.md

@@ -20,32 +20,42 @@ bundle
 
 Использование с помощью вызова метода-хелпера `paginated` и передачи в него необходимых опций.
 
+
+Например:
+
+```
+paginated model: User,
+          entity: UserEntity,
+          search: %w[email name|ilike role|custom.for_role]
+```
+
 Опции (с примерами):
 
-`model: 'User'` - название модели, записи которой нужно обработать.
+`model: User` - модель, записи которой нужно обработать.
 
-`entity: 'UserEntity'` - название класса Grape Entity, который обработает каждую запись (передается вместо `fields`).
+`entity: UserEntity` - класс Grape Entity, который обработает каждую запись (передается вместо `fields`).
 
-`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `serializer`).
+`scopes: proc {...}` - блок кода для применения
+
+`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `entity`).
 
 `search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
 
-Например:
+`spreadsheet: '[...]'` - список полей/колонок для формирования эл. таблицы, JSON в виде строки. Пример:
 
 ```
-paginated(
-  model: 'User',
-  fields: %i[
-    email
-    name
-  ],
-  search: %w[
-    email
-    name|ilike
-    role|custom.for_role
-  ]
-)
+[
+  {
+    "column": "id",
+    "title": "ID"
+  },
+  {
+    "column": "name",
+    "title": "Название"
+  }
+]
 ```
+При передаче `speadsheet` происходит формирование эл. таблицы в виде XLSX файла.
 
 ## Параметры HTTP запроса
 

data/lib/grape_extensions/dsl.rb

@@ -24,6 +24,13 @@ module Grape
         end
 
         # требуемый список полей эл. таблицы
+        # формат:
+        # [
+        #   {
+        #     "column": "id",
+        #     "title": "ID"
+        #   }
+        # ]
         if params[:spreadsheet]
           opts[:spreadsheet_columns] = JSON.parse(params[:spreadsheet])
         end

data/lib/paginated/spreadsheet.rb

@@ -34,12 +34,12 @@ module Spreadsheet
     worksheet.auto_width = true
 
     # заголовки
-    worksheet.append_row(@spreadsheet_columns.values, bold)
+    worksheet.append_row(spreadsheet_titles, bold)
 
     # содержимое
-    columns = @spreadsheet_columns.keys
+    cols = spreadsheet_columns
     records.each do |record|
-      values = columns.map { |col| record.send(col) }
+      values = cols.map { |col| record.send(col) }
       worksheet.append_row(values)
     end
 
@@ -50,4 +50,12 @@ module Spreadsheet
     filepath
   end
 
+  def spreadsheet_titles
+    @spreadsheet_columns.map { |i| i['title'] }
+  end
+
+  def spreadsheet_columns
+    @spreadsheet_columns.map { |i| i['column'] }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paginated
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Павел Бабин
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="