grape-listing 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba8617bffac0ab4e4a01be9a04405601e47b623856460fac204877fc26317f7
-  data.tar.gz: aeca947deec2736192248fef996310e5848acd3575e176c9d708c5b6623d8799
+  metadata.gz: 79497f0f3b194664ec9c8c5bbea0640dc346b60d6b2c9b84e6a7fbbb644da707
+  data.tar.gz: fc81cf3328415dc9f5a82df4ffb6fc505d1b364f7b706888f9c135d6600c4b1e
 SHA512:
-  metadata.gz: c4cf61f5dde0b861f2cbeb372c324a02eaf9a1b71dcb6ff573f48b427abf0a10c0e232dc1851414094d0e103ee4000950d6f1a8c97553b0e9c62d01d6ee3a972
-  data.tar.gz: cb98c65e16c43a058c1c513e223e6ff15b2a3b2a13acd538a29aba2167f232ebb363847123509efb54227ecf3abe8451bb43b6f7e34b808f676c5b7f83ca2c4d
+  metadata.gz: cdeb53c3deea041c1898c1ec43af53f5ef6d3732621022cc7152263ac66cfd96113569cd5f651d26ba11d7d6cab8fde2ba6760d5f677a9c707f7e37d1099d11e
+  data.tar.gz: 90b469c13b6c9141f9ea97d30ba79c4c76efa5b291b66c6b5a6afd276d2fbdd5b8937d70ea43521f26a0fbebe13430e69f09f918750baf4c755f7eba2d3116c8

data/lib/grape/dsl.rb

@@ -4,13 +4,13 @@ module Grape
   module DSL
     module InsideRoute
 
-      def listing(model:, entity:, scopes: nil, search: nil, sortable: nil, paginate: true, caching: false, preload: nil)
+      def listing(model:, entity:, scopes: nil, search: nil, sortable: nil, paginate: true, cache: nil, preload: nil)
         # параметры запроса API
         request_method = request.env['REQUEST_METHOD']
         request_uri = request.env['REQUEST_URI']
 
         # опции для сервиса
-        opts = listing_opts(model, entity, scopes, search, sortable, caching, request_method, request_uri, preload)
+        opts = listing_opts(model, entity, scopes, search, sortable, cache, request_method, request_uri, preload)
 
         if params[:spreadsheet]
           listing_spreadsheet(**opts)
@@ -23,7 +23,7 @@ module Grape
 
       private
 
-      def listing_opts(model, entity, scopes, search, sortable, caching, request_method, request_uri, preload)
+      def listing_opts(model, entity, scopes, search, sortable, cache, request_method, request_uri, preload)
         # стандартные опции
         opts = {
           model:,
@@ -34,7 +34,7 @@ module Grape
           sortable:,
           params:,
           current_user:,
-          caching:,
+          cache:,
           request_method:,
           request_uri:
         }

data/lib/grape_listing/version.rb

@@ -0,0 +1,3 @@
+module GrapeListing
+  VERSION = '1.4.0'.freeze
+end

data/lib/listing_service/args_handling.rb

@@ -43,46 +43,11 @@ module GrapeListing
       # сортировка
       @sortable = args[:sortable]
 
-      # подсчет кол-ва записей
-      @objects_count = records_count
-
       # временная директория (для генерации файлов)
       @tempdir = args[:tempdir]
 
       # кеширование результатов обработки Grape Entity
-      @caching = args[:caching]
-    end
-
-    def records_count
-      # получение кол-ва записей из кеша
-      key = count_cache_key
-      cached = GrapeListing.cache.read(key)
-      return cached if cached
-
-      # получение кол-ва записей из запроса к БД
-      count = @model.merge(@scopes).distinct.count(:id)
-
-      # кеширование кол-ва записей при превышении порогового значения
-      if count >= 1_000
-        GrapeListing.cache.write(key, count, expires_in: 30.minutes)
-      end
-
-      count
-    end
-
-    def count_cache_key
-      # необходимо убрать параметры offset и page из uri
-      uri_path, params = @request_uri.split('?')
-      if params
-        params = Rack::Utils.parse_query(params).except('offset', 'page')
-        @request_uri = params.present? ? "#{uri_path}?#{Rack::Utils.build_query(params)}" : uri_path
-      end
-
-      # пример: "GET api/v1/users?active=true"
-      body = "#{@request_method} #{@request_uri}"
-
-      enc = Digest::MD5.hexdigest(body)
-      "listing_cached_count_#{enc}"
+      @cache = args[:cache]
     end
 
   end

data/lib/listing_service/listing.rb

@@ -2,12 +2,11 @@ module GrapeListing
   module Listing
 
     def listed
-      if @objects_count > 0
-        search
-        list
-      else
-        @objects = []
-      end
+      # применение фильтрации
+      search
+
+      # обработка записей
+      handle_objects_list
 
       # результат
       @objects
@@ -15,15 +14,15 @@ module GrapeListing
 
     private
 
-    def list
+    def handle_objects_list
       # коллекция записей ActiveRecord для применения аггрегирования
       list = @objects || @model.preload(@preload).merge(@scopes)
 
       # применение сортировки к коллекции записей
       @objects = list.merge(sort_proc)
 
-      # сериализация с помощью переданных полей или сериалайзера
-      @objects = serialize(@objects)
+      # сериализация
+      @objects = represent(@objects)
     end
 
   end

data/lib/listing_service/pagination.rb

@@ -2,12 +2,11 @@ module GrapeListing
   module Pagination
 
     def paginated
-      if @objects_count > 0
-        search
-        paginate
-      else
-        @objects = []
-      end
+      # применение фильтрации
+      search
+
+      # обработка записей
+      handle_paginated_list
 
       # результат с пагинацией
       { count: @objects_count, objects: @objects }
@@ -15,16 +14,52 @@ module GrapeListing
 
     private
 
-    def paginate
+    def handle_paginated_list
       # коллекция записей ActiveRecord для применения аггрегирования
       list = @objects || @model.preload(@preload).merge(@scopes)
 
+      # подсчет кол-ва записей
+      @objects_count = records_count(list)
+
       # применение сортировки и пагинации к коллекции записей
       @objects = list.offset(@offset).merge(sort_proc).limit(@limit)
 
-      # сериализация с помощью переданных полей или сериалайзера
-      @objects = serialize(@objects)
+      # сериализация
+      @objects = represent(@objects)
     end
 
+    def records_count(list)
+      # получение кол-ва записей из кеша
+      key = count_cache_key
+      cached = GrapeListing.cache.read(key)
+      return cached if cached
+
+      # получение кол-ва записей из запроса к БД
+      count = list.distinct.count(:id)
+
+      # кеширование кол-ва записей при превышении порогового значения
+      if count >= 1_000
+        GrapeListing.cache.write(key, count, expires_in: 30.minutes)
+      end
+
+      count
+    end
+
+    def count_cache_key
+      # необходимо убрать параметры offset и page из uri
+      uri_path, params = @request_uri.split('?')
+      if params
+        params = Rack::Utils.parse_query(params).except('offset', 'page')
+        @request_uri = params.present? ? "#{uri_path}?#{Rack::Utils.build_query(params)}" : uri_path
+      end
+
+      # пример: "GET api/v1/users?active=true"
+      body = "#{@request_method} #{@request_uri}"
+
+      enc = Digest::MD5.hexdigest(body)
+      "listing_cached_count_#{enc}"
+    end
+
+
   end
 end

data/lib/listing_service/search.rb

@@ -41,10 +41,6 @@ module GrapeListing
         query = where_query(table, field, operator, value)
         @objects = list.where(query)
       end
-    
-      if @objects
-        @objects_count = @objects.distinct.count
-      end
     end
 
     def search_operands(field)

data/lib/listing_service/serialization.rb

@@ -3,6 +3,14 @@ module GrapeListing
 
     private
 
+    def represent(records)
+      if @cache.present?
+        cache { serialize(records) }
+      else
+        serialize(records)
+      end
+    end
+
     def serialize(records)
       if @fields
         serialize_with_fields(records)
@@ -11,6 +19,17 @@ module GrapeListing
       end
     end
 
+    def cache
+      # параметры кеширования
+      key = @cache[:key] || @model.table_name
+      opts = @cache.slice(:expires_in)
+
+      # непосредственное кеширование
+      GrapeListing.cache.fetch(key, opts) do
+        yield
+      end
+    end
+
     def serialize_with_fields(records)
       # добавление ID в список полей по умолчанию
       @fields.push(:id)
@@ -33,11 +52,7 @@ module GrapeListing
 
       # обработка результатов
       records.map do |record|
-        if @caching
-          caching_entity_representation(record)
-        else
-          @grape_entity.represent(record, @entity_opts).as_json
-        end
+        @grape_entity.represent(record, @entity_opts).as_json
       end
     end
 
@@ -45,21 +60,5 @@ module GrapeListing
       @fields.map { |i| record.send(i) }
     end
 
-    def caching_entity_representation(record)
-      key = "#{@grape_entity}:#{record.id}"
-
-      # опции кеширования
-      opts =
-        if @caching.is_a?(ActiveSupport::Duration)
-          { expires_in: @caching }
-        else
-          {}
-        end
-
-      GrapeListing.cache.fetch(key, opts) do
-        @grape_entity.represent(record, @entity_opts).as_json
-      end
-    end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-listing
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -91,6 +91,7 @@ files:
 - lib/grape/dsl.rb
 - lib/grape_listing.rb
 - lib/grape_listing/configuration.rb
+- lib/grape_listing/version.rb
 - lib/grape_listing_service.rb
 - lib/listing_service/args_handling.rb
 - lib/listing_service/listing.rb
@@ -101,7 +102,7 @@ files:
 - lib/listing_service/spreadsheet.rb
 homepage:
 licenses:
-- MIT
+- Copyright
 metadata:
   rubygems_mfa_required: 'true'
 post_install_message: