paginated 1.0.3 → 1.0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e2b8888c610c376b97da4c118067cf4d6d1ac8d63e02fc11971638b9ad0595
-  data.tar.gz: a5fc2020f8d9a3adf16816e0d03d2e2419ed3128d806d23a5ce3d20a6831e442
+  metadata.gz: 60256c0f7c8df7e2fd347f31b5b713b6a878aa4554017a2aa074e05ffc9b5900
+  data.tar.gz: 3daaacf9ba025b0ce2b47d0990aa72b29e45037dde4c8461fb913bc21aa28f94
 SHA512:
-  metadata.gz: a3aa8e4b873a0498720d727d3517cb9576eb1b97a96884cdf2c8336b92f56a0016db99e1d6c3c49875bede9fc73dbd91d902180b05253e7079d9970504f9b01a
-  data.tar.gz: 7ad52eb2f7a3b3c3356781d7703f156f14ef4cec04d00dc14e825e0c6dd4ef10b868b9325b18ab2405d740d0ddc2d70072f09d4e91cc12f398548344ed66ce02
+  metadata.gz: d3a615e433b61937db50ccacea1c96857b263e7cf680cfe29c9e0feb4f678cd988a2ac34cfb24dc693884f525406262dd7bfbe60e0859ee8e6e93ae50b23f24a
+  data.tar.gz: 3ffafc39efb627cdfbf2bbff6f9c273421694fcc8abe6984260453cca1893ed8a65cd190740fcec7fcba0d459b4af1a0a2f7eb4374273e651f9ce4c9cb580215

data/README.md

@@ -20,7 +20,7 @@ bundle
 
 Использование с помощью вызова метода `.collection` и передачи в него необходимых опций:
 ```
-Paginated.new.collection()
+Paginated.collection()
 ```
 
 Опции (с примерами):
@@ -40,7 +40,7 @@ Paginated.new.collection()
 Например:
 
 ```
-Paginated.new.collection(
+Paginated.collection(
   model: 'User',
   fields: %i[
     email

data/lib/paginated/search.rb

@@ -5,9 +5,9 @@ module Search
   private
 
   def search
-    @attrs[:search]&.each do |field|
+    @search_fields&.each do |field|
       # коллекция записей для дальнейшей фильтрации
-      entity = @objects || @model.unscoped.merge(@scopes)
+      list = @objects || @model.unscoped.merge(@scopes)
 
       # оператор и значение для поиска
       operator, value = search_operands(field)
@@ -20,7 +20,7 @@ module Search
         # название скоупа из модели, который нужно применить
         scope_name = operator.split('.')[1]
         # применение скоупа
-        @objects = entity.send(scope_name, value)
+        @objects = list.send(scope_name, value)
         @objects_count = @objects.count
         next
       end
@@ -32,16 +32,16 @@ module Search
 
       if field.include?('.')
         # нужно приджойнить таблицу
-        join_association, field = field.split('.')
-        table = join_association.tableize
-        entity = entity.joins(join_association.to_sym)
+        join_assoc, field = field.split('.')
+        table = join_assoc.tableize
+        list = list.joins(join_assoc.to_sym)
       else
         table = @model.table_name
         field = field.split('|')[0]
       end
 
       query = where_query(table, field, operator, value)
-      @objects = entity.where(query)
+      @objects = list.where(query)
       @objects_count = @objects.count
     end
   end
@@ -52,10 +52,10 @@ module Search
     # WHERE query operator
     operator = field.split('|').size > 1 ? field.split('|').last : '='
 
-    # check for ILIKE operator
+    # условие для поиска ILIKE
     value = "%#{value}%" if operator == 'ilike' && value.present?
 
-    # check if multi-filter search enabled
+    # проверка мульти-поиска по параметру с массивом
     if operator == 'multi' && !value.blank?
       operator = 'IN'
       value = "(#{value.join(', ')})"
@@ -63,13 +63,13 @@ module Search
 
     # проверка диапазона (MIN/MAX)
     if %w[min max].include?(operator)
-      range_field = field.split('.').last.split(':')[0].try { |p| p.split('|')[0] }
+      range_field = field.split('.').last.split(':')[0].try { |i| i.split('|')[0] }
       value = @params["#{range_field}_#{operator}"]
       operator = operator == 'min' ? '>=' : '<='
     end
 
     # check array operator
-    if operator == 'array' && !value.blank?
+    if operator == 'array' && value.present?
       operator = '='
       value = "{#{value}}"
     end
@@ -78,24 +78,14 @@ module Search
   end
 
   def default_param_value(field)
-    key =
-      if field.include?('|')
-        # название ключа-поля без оператора (напр. ilike)
-        field.split('|')[0]
-      else
-        field
-      end
+    # название ключа-поля без оператора (напр. ilike)
+    key = field.split('|')[0]
 
     @params[key]
   end
 
   def where_query(table, field, operator, value)
-    if field.include?('_at')
-      # фильтрация по дате/времени
-      "EXTRACT(epoch FROM #{field}) #{operator} #{value}"
-    else
-      "#{table}.#{field} #{operator} #{value}"
-    end
+    "#{table}.#{field} #{operator} #{value}"
   end
 
   def quotations_formatting(string)

data/lib/paginated/serialization.rb

@@ -6,20 +6,15 @@ module Serialization
 
   def serialize
     # коллекция записей / сущность для применения аггрегирования
-    entity = @objects || @model.unscoped.merge(@scopes)
+    list = @objects || @model.unscoped.merge(@scopes)
 
-    # применение сортировки и пагинации (если необходимо) к коллекции записей
-    @objects =
-      if @paginate
-        entity.offset(@offset).merge(sort_proc).limit(@limit)
-      else
-        entity.merge(sort_proc)
-      end
+    # применение сортировки и пагинации к коллекции записей
+    @objects = list.offset(@offset).merge(sort_proc).limit(@limit)
 
     # сериализация с помощью переданных полей или сериалайзера
     if @fields
       serialize_with_fields
-    elsif @attrs[:entity]
+    elsif @grape_entity
       serialize_with_entity
     end
   end
@@ -36,8 +31,7 @@ module Serialization
   end
 
   def serialize_with_entity
-    entity = @attrs[:entity].constantize
-    @objects = @objects.map { |i| entity.represent(i, current_user: @current_user).as_json }
+    @objects = @objects.map { |i| @grape_entity.represent(i, current_user: @current_user).as_json }
   end
 
   def sort_proc
@@ -72,8 +66,8 @@ module Serialization
     end
   end
 
-  def obtain_fields_values(object)
-    @fields.map { |f| object.send(f) }
+  def obtain_fields_values(record)
+    @fields.map { |i| record.send(i) }
   end
 
 end

data/lib/paginated.rb

@@ -6,21 +6,16 @@ class Paginated
   include Search
   include Serialization
 
-  def collection(**attrs)
-    @attrs = attrs
-    @params = attrs[:serialization_scope].params.stringify_keys
-    @current_user = attrs[:serialization_scope].current_user
-    @fields = attrs[:fields]
-    @scopes = attrs[:scopes] || {}
-    @offset = @params['offset'].to_i
-    @limit = @params['limit'] || 20
-    @order = attrs[:order] || :id
-    @sort = attrs[:sort]
-    @model = attrs[:model].constantize
-    @root = @params.key?('root') ? @params['root'] : false
-    @paginate = @params.key?('paginate') ? @params['paginate'].to_s == 'true' : true
-    @objects_count = records_count(attrs[:model])
+  def initialize(**args)
+    # обработка переданных аргументов
+    handle_args(**args)
+  end
+
+  def self.collection(**args)
+    new(**args).collection
+  end
 
+  def collection
     if @objects_count > 0
       search
       serialize
@@ -28,32 +23,56 @@ class Paginated
       @objects = []
     end
 
-    if @root
-      # записи в корне
-      @objects
-    else
-      # результат с пагинацией
-      { count: @objects_count, objects: @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
+
+    # сортировка
+    @order = args[:order] || :id
+    @sort = args[:sort]
+
+    # подсчет кол-ва записей
+    @objects_count = records_count
+  end
 
-  def records_count(model_name)
+  def records_count
     # получение кол-ва записей из кеша
-    cache_key = "#{model_name}_records_count"
-    cached_value = Rails.cache.read(cache_key)
-    return cached_value if cached_value
+    cache_key = "#{@model}_records_count"
+    cached = Rails.cache.read(cache_key)
+    return cached if cached
 
     # получение кол-ва записей из запроса к БД
-    db_value = @model.merge(@scopes).count(:id)
+    count = @model.merge(@scopes).count(:id)
 
     # кеширование кол-ва записей при превышении порогового значения
-    if db_value >= 1_000
-      Rails.cache.write(cache_key, db_value, expires_in: 30.minutes)
+    if count >= 1_000
+      Rails.cache.write(cache_key, count, expires_in: 30.minutes)
     end
 
-    db_value
+    count
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paginated
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4.1
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Пагинация для Rails-приложений