paginated 1.0.4 → 1.0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b38840cf61263ac1ee6c8a3a239db1bd1e4e6d852e9ce25919286f2a35b6767
-  data.tar.gz: 7160149eb3a72516e113827d8c0ac756322f61160d2b95480f55b91e824daae9
+  metadata.gz: 49f9695ec19cbd557cbd15ec981e775e3572371a428e0a6b0ae2abc6803e4201
+  data.tar.gz: 2f59100f090ccac1c1696d925273f65a2e55de67f5a68cad6f3911700c31f8a0
 SHA512:
-  metadata.gz: e8a1f43f03ea4e249ff01d03964a9c7d4b9eab658683d3a570b1698800a2bc83edb329faff24ea284552bfbb3190e6d1884b1d5be17fa2956699c845965c5414
-  data.tar.gz: 2ea45ab22ed18d3d807e2a150c3da237bdc3de2bdc48033a0250acb7593a864a0178ef80e43774de63fa7ae016747757305b033d155fd7fc948c078adc24a547
+  metadata.gz: 5b0d8b686bbf1ace12b48c1aa7059f6f55b82a2281aa36454eccadefb2814b04977071911f2b11482a79c678537bed0c40ccd18e23f3736e0331cda9b1cd13d4
+  data.tar.gz: d6e047296b4a80fbdbe756b1f39e64c8ff505a5993d4cc4be713dc0b2b01d39a6ed97851678306f962b7cf06a66b29592a069b377289c2737de54d5f7136f6ef

data/README.md

@@ -49,7 +49,7 @@ Paginated.collection(
   search: %w[
     email
     name|ilike
-    role|custom_search.for_role
+    role|custom.for_role
   ],
   params:,
   order: :name,

data/lib/paginated/search.rb

@@ -4,98 +4,96 @@ module Search
 
   private
 
-  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)
+  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') && value.present?
+        # название скоупа из модели, который нужно применить
+        scope_name = operator.split('.')[1]
+        # применение скоупа
+        @objects = list.send(scope_name, value)
         @objects_count = @objects.count
+        next
       end
-    end
 
-    def search_operands(field)
-      value = default_param_value(field)
+      # форматирование кавычек
+      if operator != 'IN' && !@model.defined_enums.key?(field)
+        value = quotations_formatting(value)
+      end
 
-      # WHERE query operator
-      operator = field.split('|').size > 1 ? field.split('|').last : '='
+      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
 
-      # условие для поиска ILIKE
-      value = "%#{value}%" if operator == 'ilike' && value.present?
+      query = where_query(table, field, operator, value)
+      @objects = list.where(query)
+      @objects_count = @objects.count
+    end
+  end
 
-      # проверка мульти-поиска по параметру с массивом
-      if operator == 'multi' && !value.blank?
-        operator = 'IN'
-        value = "(#{value.join(', ')})"
-      end
+  def search_operands(field)
+    value = default_param_value(field)
 
-      # проверка диапазона (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
+    # WHERE query operator
+    operator = field.split('|').size > 1 ? field.split('|').last : '='
 
-      # check array operator
-      if operator == 'array' && value.present?
-        operator = '='
-        value = "{#{value}}"
-      end
+    # условие для поиска ILIKE
+    value = "%#{value}%" if operator == 'ilike' && value.present?
 
-      [operator, value]
+    # проверка мульти-поиска по параметру с массивом
+    if operator == 'multi' && !value.blank?
+      operator = 'IN'
+      value = "(#{value.join(', ')})"
     end
 
-    def default_param_value(field)
-      # название ключа-поля без оператора (напр. ilike)
-      key = field.split('|')[0]
-
-      @params[key]
+    # проверка диапазона (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
 
-    def where_query(table, field, operator, value)
-      "#{table}.#{field} #{operator} #{value}"
+    # check array operator
+    if operator == 'array' && value.present?
+      operator = '='
+      value = "{#{value}}"
     end
 
-    def quotations_formatting(string)
-      # удаление одинарных кавычек (напр. внутри строки)
-      value = string.to_s.gsub(/'/, '')
+    [operator, value]
+  end
 
-      # добавление одинарных кавычек вокруг строки
-      "'#{value}'"
-    end
+  def default_param_value(field)
+    # название ключа-поля без оператора (напр. ilike)
+    key = field.split('|')[0]
+
+    @params[key]
+  end
+
+  def where_query(table, field, operator, value)
+    "#{table}.#{field} #{operator} #{value}"
+  end
+
+  def quotations_formatting(string)
+    # удаление одинарных кавычек (напр. внутри строки)
+    value = string.to_s.gsub(/'/, '')
+
+    # добавление одинарных кавычек вокруг строки
+    "'#{value}'"
   end
 
 end

data/lib/paginated/serialization.rb

@@ -4,72 +4,70 @@ module Serialization
 
   private
 
-  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
+  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
+  end
 
-    def serialize_with_fields
-      # добавление ID в список полей по умолчанию
-      @fields.push(:id)
+  def serialize_with_fields
+    # добавление ID в список полей по умолчанию
+    @fields.push(:id)
 
-      # список массивов значений
-      @objects = @objects.map { |i| obtain_fields_values(i) }
+    # список массивов значений
+    @objects = @objects.map { |i| obtain_fields_values(i) }
 
-      # трансформация массивов значений в объекты (ключ-значение)
-      @objects = @objects.map { |i| @fields.zip(i).to_h }
-    end
+    # трансформация массивов значений в объекты (ключ-значение)
+    @objects = @objects.map { |i| @fields.zip(i).to_h }
+  end
 
-    def serialize_with_entity
-      @objects = @objects.map { |i| @grape_entity.represent(i, current_user: @current_user).as_json }
-    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
+  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('|')
+    @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
-      end
+      return order_proc
     end
+  end
 
-    def obtain_fields_values(record)
-      @fields.map { |i| record.send(i) }
-    end
+  def obtain_fields_values(record)
+    @fields.map { |i| record.send(i) }
   end
 
 end

data/lib/paginated.rb

@@ -6,13 +6,16 @@ class Paginated
   include Search
   include Serialization
 
-  def self.collection(**args)
+  def initialize(**args)
     # обработка переданных аргументов
     handle_args(**args)
+  end
 
-    # подсчет кол-ва записей
-    @objects_count = records_count
+  def self.collection(**args)
+    new(**args).collection
+  end
 
+  def collection
     if @objects_count > 0
       search
       serialize
@@ -24,7 +27,7 @@ class Paginated
     { count: @objects_count, objects: @objects }
   end
 
-  def self.handle_args(**args)
+  def handle_args(**args)
     # обрабатываемая Rails модель
     @model = args[:model]
 
@@ -50,9 +53,12 @@ class Paginated
     # сортировка
     @order = args[:order] || :id
     @sort = args[:sort]
+
+    # подсчет кол-ва записей
+    @objects_count = records_count
   end
 
-  def self.records_count
+  def records_count
     # получение кол-ва записей из кеша
     cache_key = "#{@model}_records_count"
     cached = Rails.cache.read(cache_key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paginated
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.4.2
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-07 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails