paginated 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22aa1b0f64b6566bb94bfb250518c8e18a668c1ca3e16b73ebbc7ab7e1cd74fc
-  data.tar.gz: e40ee2dc208873e2ea18b9798dbae255b6a536dbf279cae50c9a33e3eaa3e1c0
+  metadata.gz: cc3ad78511419953d52e6f0f45794b7ff5b11730cb5556dbecc64f9785d8a195
+  data.tar.gz: 136abe2c808ba73b848c8ecf68b8033d573c9c3dd87e351fab13be3fd16a6659
 SHA512:
-  metadata.gz: 3454f5ddc9bbb5e7a419fdf7617ae0ba69bcd927c5e648227301c919f67ddf347f31ea14b1a49f4f2189c03b5e3fe0f56cc7eb8a3ec347aaa4a893b16a6f8a44
-  data.tar.gz: 51de563f73d7225a37aea2ca3d59b6ac9dcfc8d67774fbf0acaacb7a0a4d37d87b35044963941aac2225a3b7d70a8a427a2b4a7eaea43c42ca40e04ffd31b7ab
+  metadata.gz: 6764684cb5a12b29b6ebd146bc7a5e8e77705b2d237c4dd60c553db1aa4461e5f9332fc56d30679bf97c3daf51e3f817a5bd60ea5a9c2523c5ae40cab112f656
+  data.tar.gz: 6074be3b096999fe2379345aa17e6d69441af45ae471d453c32be5125e1d98b5eb6c7c3033324d8500e32680e6e66817dc303779c4e0ab23504efceb09de5ea3

data/README.md

@@ -18,27 +18,22 @@ bundle
 
 ## Использование
 
-Использование с помощью вызова метода `.collection` и передачи в него необходимых опций:
-```
-Paginated.collection()
-```
+Использование с помощью вызова метода-хелпера `paginated` и передачи в него необходимых опций.
 
 Опции (с примерами):
 
 `model: 'User'` - название модели, записи которой нужно обработать.
 
-`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `serializer`).
-
 `entity: 'UserEntity'` - название класса Grape Entity, который обработает каждую запись (передается вместо `fields`).
 
-`params:` - передаваемые параметры для фильтрации записей.
+`fields: %i[...]` - список полей, которые должны присутствовать в списке записей (передается вместо `serializer`).
 
 `search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
 
 Например:
 
 ```
-Paginated.collection(
+paginated(
   model: 'User',
   fields: %i[
     email
@@ -48,8 +43,7 @@ Paginated.collection(
     email
     name|ilike
     role|custom.for_role
-  ],
-  params:
+  ]
 )
 ```
 

data/lib/grape_extensions/dsl.rb

@@ -0,0 +1,63 @@
+module Grape
+  module DSL
+    module InsideRoute
+
+      def paginated(model:, entity:, scopes: nil, search: nil)
+        opts = pagination_opts(model, entity, scopes, search)
+
+        if params[:spreadsheet]
+          paginated_spreadsheet(**opts)
+        else
+          paginated_collection(**opts)
+        end
+      end
+
+      private
+
+      def pagination_opts(model, entity, scopes, search)
+        # стандартные опции
+        opts = { model:, entity:, scopes:, search:, params:, current_user: }
+
+        # требуемый список полей (+стандартные)
+        if params[:columns]
+          opts[:only_columns] = params[:columns] + %w[id deleted_at]
+        end
+
+        # требуемый список полей эл. таблицы
+        if params[:spreadsheet]
+          opts[:spreadsheet_columns] = JSON.parse(params[:spreadsheet])
+        end
+
+        opts
+      end
+
+      def paginated_spreadsheet(opts)
+        Dir.mktmpdir do |tempdir|
+          file_path = Paginated.spreadsheet **opts.merge(tempdir:)
+
+          spreadsheet_file_headers File.basename(file_path)
+          File.open(file_path).read
+        end
+      end
+
+      def spreadsheet_file_headers(filename)    
+        header['Content-Type'] =
+          case File.extname(filename)
+          when '.csv'
+            'application/csv'
+          when '.xlsx'
+            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+          end
+
+        header['Access-Control-Expose-Headers'] = 'Content-Disposition'
+        header['Content-Disposition'] = "attachment; filename=#{Addressable::URI.escape(filename)}"
+        env['api.format'] = :binary
+      end
+
+      def paginated_collection(opts)
+        Paginated.collection(**opts)
+      end
+
+    end
+  end
+end

data/lib/paginated/args_andling.rb

@@ -0,0 +1,63 @@
+module ArgsHandling
+
+  extend ActiveSupport::Concern
+
+  private
+
+  def handle_args(**args)
+    # обрабатываемая Rails модель
+    @model = args[:model]
+
+    # параметры запроса и текущий пользователь
+    @params = args[:params].stringify_keys
+    @current_user = args[:current_user]
+
+    # поля, по которым возможен поиск
+    @search_fields = args[:search]
+
+    # сериализация - через Grape Entity или список полей
+    @grape_entity = args[:entity]
+    @fields = args[:fields]
+
+    # Rails scopes для применения
+    @scopes = args[:scopes] || {}
+
+    # offset / limit
+    @offset = @params['offset'].to_i
+    @limit = @params['limit'] || 20
+
+    # требуемый список полей для коллекции
+    @only_columns = args[:only_columns]
+
+    # список полей для эл. таблицы
+    @spreadsheet_columns = args[:spreadsheet_columns]
+
+    # сортировка
+    @sort_by = @params['sort_by'] || :id
+    @sort_order = @params['sort_order'] || :desc
+
+    # подсчет кол-ва записей
+    @objects_count = records_count
+
+    # временная директория (для генерации файлов)
+    @tempdir = args[:tempdir]
+  end
+
+  def records_count
+    # получение кол-ва записей из кеша
+    cache_key = "#{@model}_records_count"
+    cached = Rails.cache.read(cache_key)
+    return cached if cached
+
+    # получение кол-ва записей из запроса к БД
+    count = @model.merge(@scopes).count(:id)
+
+    # кеширование кол-ва записей при превышении порогового значения
+    if count >= 1_000
+      Rails.cache.write(cache_key, count, expires_in: 30.minutes)
+    end
+
+    count
+  end
+
+end

data/lib/paginated/{serialization.rb → collection.rb}

@@ -1,7 +1,19 @@
-module Serialization
+module Collection
 
   extend ActiveSupport::Concern
 
+  def collection
+    if @objects_count > 0
+      search
+      serialize
+    else
+      @objects = []
+    end
+
+    # результат с пагинацией
+    { count: @objects_count, objects: @objects }
+  end
+
   private
 
   def serialize
@@ -31,7 +43,12 @@ module Serialization
   end
 
   def serialize_with_entity
-    @objects = @objects.map { |i| @grape_entity.represent(i, current_user: @current_user).as_json }
+    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)

data/lib/paginated/spreadsheet.rb

@@ -0,0 +1,53 @@
+require 'fast_excel'
+
+module Spreadsheet
+
+  extend ActiveSupport::Concern
+
+  def spreadsheet
+    search if @objects_count > 0
+
+    # коллекция записей ActiveRecord для формирования эл. таблицы
+    records = @objects || @model.unscoped.merge(@scopes)
+
+    # формирования файла эл. таблицы
+    generate_spreadsheet(records)
+  end
+
+  private
+
+  def generate_spreadsheet(records)
+    filepath = "#{@tempdir}/#{Time.now.strftime('%Y%m%d_%H%M%S')}.xlsx"
+
+    # создание таблицы и ее конфигурация
+    workbook = FastExcel.open(filepath, constant_memory: true)
+    workbook.default_format.set(
+      font_size: 0,
+      font_family: 'Arial'
+    )
+
+    # стили
+    bold = workbook.bold_format
+
+    # лист
+    worksheet = workbook.add_worksheet('Основной')
+    worksheet.auto_width = true
+
+    # заголовки
+    worksheet.append_row(@spreadsheet_columns.values, bold)
+
+    # содержимое
+    columns = @spreadsheet_columns.keys
+    records.each do |record|
+      values = columns.map { |col| record.send(col) }
+      worksheet.append_row(values)
+    end
+
+    # закрытие/сохранение файла
+    workbook.close
+
+    # путь до файла для дальнейшей обработки
+    filepath
+  end
+
+end

data/lib/paginated.rb

@@ -1,15 +1,20 @@
+require 'paginated/args_andling'
+require 'paginated/collection'
 require 'paginated/search'
-require 'paginated/serialization'
 require 'paginated/sorting'
+require 'paginated/spreadsheet'
+
+require 'grape_extensions/dsl'
 
 class Paginated
 
+  include ArgsHandling
+  include Collection
   include Search
-  include Serialization
   include Sorting
+  include Spreadsheet
 
   def initialize(**args)
-    # обработка переданных аргументов
     handle_args(**args)
   end
 
@@ -17,66 +22,8 @@ class Paginated
     new(**args).collection
   end
 
-  def collection
-    if @objects_count > 0
-      search
-      serialize
-    else
-      @objects = []
-    end
-
-    # результат с пагинацией
-    { count: @objects_count, objects: @objects }
-  end
-
-  private
-
-  def handle_args(**args)
-    # обрабатываемая Rails модель
-    @model = args[:model]
-
-    # параметры запроса и текущий пользователь
-    serialization_scope = args[:serialization_scope]
-    @params = serialization_scope.params.stringify_keys
-    @current_user = serialization_scope.current_user
-
-    # поля, по которым возможен поиск
-    @search_fields = args[:search]
-
-    # сериализация - через Grape Entity или список полей
-    @grape_entity = args[:entity]
-    @fields = args[:fields]
-
-    # Rails scopes для применения
-    @scopes = args[:scopes] || {}
-
-    # offset / limit
-    @offset = @params['offset'].to_i
-    @limit = @params['limit'] || 20
-
-    # сортировка
-    @sort_by = @params['sort_by'] || :id
-    @sort_order = @params['sort_order'] || :desc
-
-    # подсчет кол-ва записей
-    @objects_count = records_count
-  end
-
-  def records_count
-    # получение кол-ва записей из кеша
-    cache_key = "#{@model}_records_count"
-    cached = Rails.cache.read(cache_key)
-    return cached if cached
-
-    # получение кол-ва записей из запроса к БД
-    count = @model.merge(@scopes).count(:id)
-
-    # кеширование кол-ва записей при превышении порогового значения
-    if count >= 1_000
-      Rails.cache.write(cache_key, count, expires_in: 30.minutes)
-    end
-
-    count
+  def self.spreadsheet(**args)
+    new(**args).spreadsheet
   end
 
 end

metadata

@@ -1,68 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: paginated
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
+        version: 2.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: grape
+  name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
+        version: 1.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: grape-entity
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-description: Простая пагинация записей и поиск для Rails-приложений
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: fast_excel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Простая пагинация записей, поиск и формирование эл. таблиц для API на
+  базе Grape
 email: babin359@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/grape_extensions/dsl.rb
 - lib/paginated.rb
+- lib/paginated/args_andling.rb
+- lib/paginated/collection.rb
 - lib/paginated/search.rb
-- lib/paginated/serialization.rb
 - lib/paginated/sorting.rb
+- lib/paginated/spreadsheet.rb
 homepage:
 licenses:
 - MIT
@@ -85,5 +103,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
-summary: Пагинация для Rails-приложений
+summary: Пагинация для API на базе Grape
 test_files: []