paginated 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae94c2ae8e872f233996072ec628db19b885a8538cafcf7ff3b75a2af99b933
-  data.tar.gz: 2fd627408f5ad65ae5da8e72fd9b393db0e8cdaf7f2d1b073f02135ce37ea474
+  metadata.gz: 8b38840cf61263ac1ee6c8a3a239db1bd1e4e6d852e9ce25919286f2a35b6767
+  data.tar.gz: 7160149eb3a72516e113827d8c0ac756322f61160d2b95480f55b91e824daae9
 SHA512:
-  metadata.gz: f73355fbbeda03857a8948618625392f69749f4bb968d9c4248662c31703db94cadb3a115013419d24b9fce418edf6db4db8c91dcbd6de855fae22a77a473ce0
-  data.tar.gz: 1297773a18228ed479111c7cc84fad0a500cfd4af7c87d456e9abe5cc825bdd161716b31b5ffa8ec53c352e0a2b81c8bd94e959c15e552f8ac733a346991e702
+  metadata.gz: e8a1f43f03ea4e249ff01d03964a9c7d4b9eab658683d3a570b1698800a2bc83edb329faff24ea284552bfbb3190e6d1884b1d5be17fa2956699c845965c5414
+  data.tar.gz: 2ea45ab22ed18d3d807e2a150c3da237bdc3de2bdc48033a0250acb7593a864a0178ef80e43774de63fa7ae016747757305b033d155fd7fc948c078adc24a547

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

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

data/lib/paginated/serialization.rb

@@ -4,76 +4,72 @@ module Serialization
 
   private
 
-  def serialize
-    # коллекция записей / сущность для применения аггрегирования
-    entity = @objects || @model.unscoped.merge(@scopes)
-
-    # применение сортировки и пагинации (если необходимо) к коллекции записей
-    @objects =
-      if @paginate
-        entity.offset(@offset).merge(sort_proc).limit(@limit)
-      else
-        entity.merge(sort_proc)
+  class_methods do
+    def serialize
+      # коллекция записей / сущность для применения аггрегирования
+      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
-
-    # сериализация с помощью переданных полей или сериалайзера
-    if @fields
-      serialize_with_fields
-    elsif @attrs[:entity]
-      serialize_with_entity
     end
-  end
-
-  def serialize_with_fields
-    # добавление ID в список полей по умолчанию
-    @fields.push(:id)
 
-    # список массивов значений
-    @objects = @objects.map { |i| obtain_fields_values(i) }
+    def serialize_with_fields
+      # добавление ID в список полей по умолчанию
+      @fields.push(:id)
 
-    # трансформация массивов значений в объекты (ключ-значение)
-    @objects = @objects.map { |i| @fields.zip(i).to_h }
-  end
+      # список массивов значений
+      @objects = @objects.map { |i| obtain_fields_values(i) }
 
-  def serialize_with_entity
-    entity = @attrs[:entity].constantize
-    @objects = @objects.map { |i| entity.represent(i, current_user: @current_user).as_json }
-  end
+      # трансформация массивов значений в объекты (ключ-значение)
+      @objects = @objects.map { |i| @fields.zip(i).to_h }
+    end
 
-  def sort_proc
-    # сортировка не задана явно, не передан параметр
-    # или значение переданного параметра не совпадает с ожидаемым
-    if @sort.blank? || @sort.map { |i| i.split('|')[0] }.exclude?(@params[:sort])
-      field = @order
-      return proc { order("#{field} DESC") }
+    def serialize_with_entity
+      @objects = @objects.map { |i| @grape_entity.represent(i, current_user: @current_user).as_json }
     end
 
-    @sort.each do |sort_option|
-      sort, field = sort_option.split('|')
+    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('|')
 
-      # пропускаем, если поле для сортировки не совпадает с переданным параметром
-      next if @params[:sort] != sort
+        # пропускаем, если поле для сортировки не совпадает с переданным параметром
+        next if @params[:sort] != sort
 
-      # если поле для сортировки совпадает с ключом переданного параметра
-      field = sort if field.blank?
+        # если поле для сортировки совпадает с ключом переданного параметра
+        field = sort if field.blank?
 
-      sort_order = "#{@params[:sort_order]} NULLS LAST"
+        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
+        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
+        return order_proc
+      end
     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
 
 end

data/lib/paginated.rb

@@ -6,20 +6,12 @@ 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 self.collection(**args)
+    # обработка переданных аргументов
+    handle_args(**args)
+
+    # подсчет кол-ва записей
+    @objects_count = records_count
 
     if @objects_count > 0
       search
@@ -28,32 +20,53 @@ class Paginated
       @objects = []
     end
 
-    if @root
-      # записи в корне
-      @objects
-    else
-      # результат с пагинацией
-      { count: @objects_count, objects: @objects }
-    end
+    # результат с пагинацией
+    { count: @objects_count, objects: @objects }
   end
 
-  private
+  def self.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]
+  end
 
-  def records_count(model_name)
+  def self.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.unscoped.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.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-16 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-приложений