paginated 1.0.4.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f9695ec19cbd557cbd15ec981e775e3572371a428e0a6b0ae2abc6803e4201
-  data.tar.gz: 2f59100f090ccac1c1696d925273f65a2e55de67f5a68cad6f3911700c31f8a0
+  metadata.gz: dc1e1341ee42864eac2a4ddfa5850bd346ebbdaa0af08f923b8cf817ae7007c1
+  data.tar.gz: e4229ce09bf53d673968e6b3a6f0fc3ec126c2fadbf8d4ce643c398abe304e0a
 SHA512:
-  metadata.gz: 5b0d8b686bbf1ace12b48c1aa7059f6f55b82a2281aa36454eccadefb2814b04977071911f2b11482a79c678537bed0c40ccd18e23f3736e0331cda9b1cd13d4
-  data.tar.gz: d6e047296b4a80fbdbe756b1f39e64c8ff505a5993d4cc4be713dc0b2b01d39a6ed97851678306f962b7cf06a66b29592a069b377289c2737de54d5f7136f6ef
+  metadata.gz: e893cbdf13ca2f5dca56230526d7f64241cb1508ec85b71ffd080db80331bf92fb0cb676e5dcca7965f45a2c443fbc91d38e10f58e044e689cfd5b5ba6e5933a
+  data.tar.gz: 0fa820a572cef4fa26014b72d5ec25c906532e0b979c313d0c1498020b7eb9bea105619a57db43b46e3949730328d4022552798de0bd0e27e6bb7ce168201b0c

data/README.md

@@ -33,8 +33,6 @@ Paginated.collection()
 
 `params:` - передаваемые параметры для фильтрации записей.
 
-`order: :name` - название поля, по которому должна осуществляться сортировка.
-
 `search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
 
 Например:
@@ -51,7 +49,20 @@ Paginated.collection(
     name|ilike
     role|custom.for_role
   ],
-  params:,
-  order: :name,
+  params:
 )
 ```
+
+## Параметры HTTP запроса
+
+Поиск и сортировка осуществляется путем обработки параметров HTTP запроса.
+
+Для поиска по полям необходимо передать их в запросе в виде `?field=value`. Для поиска по нескольким полям, параметры должны быть перечислены через `&`, например: `?field_1=value&field_2=value`.
+
+Для сортировки выдачи необходимо передать в параметрах запроса:
+
+- `sort_by` - название поля, по которому должна осуществляться сортировка.
+
+- `sort_order` направление, по которому должна осуществляться сортировка (`asc/desc`).
+
+По умолчанию сортировка осуществляется по `id` записей в направлении `DESC`.

data/lib/paginated/serialization.rb

@@ -5,7 +5,7 @@ module Serialization
   private
 
   def serialize
-    # коллекция записей / сущность для применения аггрегирования
+    # коллекция записей ActiveRecord для применения аггрегирования
     list = @objects || @model.unscoped.merge(@scopes)
 
     # применение сортировки и пагинации к коллекции записей
@@ -31,39 +31,12 @@ module Serialization
   end
 
   def serialize_with_entity
-    @objects = @objects.map { |i| @grape_entity.represent(i, current_user: @current_user).as_json }
-  end
-
-  def sort_proc
-    # сортировка не задана явно, не передан параметр
-    # или значение переданного параметра не совпадает с ожидаемым
-    if @sort.blank? || @sort.map { |i| i.split('|')[0] }.exclude?(@params[:sort])
-      field = @order
-      return proc { order("#{field} DESC") }
-    end
-
-    @sort.each do |sort_option|
-      sort, field = sort_option.split('|')
+    opts = { current_user: @current_user }
 
-      # пропускаем, если поле для сортировки не совпадает с переданным параметром
-      next if @params[:sort] != sort
+    # требуемый список колонок (если был передан)
+    opts[:only] = @only_columns if @only_columns
 
-      # если поле для сортировки совпадает с ключом переданного параметра
-      field = sort if field.blank?
-
-      sort_order = "#{@params[:sort_order]} NULLS LAST"
-
-      order_proc =
-        if field.split('.').count > 1
-          # сортировка по связанной таблице
-          relation, column = field.split('.')
-          proc { eager_load(relation).order("#{relation.tableize}.#{column} #{sort_order}") }
-        else
-          proc { order("#{field} #{sort_order}") }
-        end
-
-      return order_proc
-    end
+    @objects = @objects.map { |i| @grape_entity.represent(i, opts).as_json }
   end
 
   def obtain_fields_values(record)

data/lib/paginated/sorting.rb

@@ -0,0 +1,12 @@
+module Sorting
+
+  extend ActiveSupport::Concern
+
+  private
+
+  def sort_proc
+    query = Arel.sql("#{@sort_by} #{@sort_order} NULLS LAST")
+    proc { order(query) }
+  end
+
+end

data/lib/paginated.rb

@@ -1,10 +1,12 @@
 require 'paginated/search'
 require 'paginated/serialization'
+require 'paginated/sorting'
 
 class Paginated
 
   include Search
   include Serialization
+  include Sorting
 
   def initialize(**args)
     # обработка переданных аргументов
@@ -27,6 +29,8 @@ class Paginated
     { count: @objects_count, objects: @objects }
   end
 
+  private
+
   def handle_args(**args)
     # обрабатываемая Rails модель
     @model = args[:model]
@@ -50,9 +54,12 @@ class Paginated
     @offset = @params['offset'].to_i
     @limit = @params['limit'] || 20
 
+    # требуемый список полей на списке
+    @only_columns = args[:only_columns]
+
     # сортировка
-    @order = args[:order] || :id
-    @sort = args[:sort]
+    @sort_by = @params['sort_by'] || :id
+    @sort_order = @params['sort_order'] || :desc
 
     # подсчет кол-ва записей
     @objects_count = records_count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paginated
 version: !ruby/object:Gem::Version
-  version: 1.0.4.2
+  version: 1.0.6
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -62,6 +62,7 @@ files:
 - lib/paginated.rb
 - lib/paginated/search.rb
 - lib/paginated/serialization.rb
+- lib/paginated/sorting.rb
 homepage:
 licenses:
 - MIT
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Пагинация для Rails-приложений