grape-listing 1.1.3.2 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25983a60808ce493ed6c1ed4bd878f775f8d1774d59237b5ff7e67c4604093eb
-  data.tar.gz: c0a525c0d05080d2a6bb465790883d1909d0ca93fe6fbe9b003f2a572e42b2b2
+  metadata.gz: ebde4f181db7c89e1def2eeb1af0fe820da5f89b0921dc88080d0b793f3d01ac
+  data.tar.gz: 5f077bb264dcf16c617be8a22c78e0769a1270af387ee2f171b78be398a35baa
 SHA512:
-  metadata.gz: 760336dd3ddbd1eefb129d69f9667e278e8f3dff5818470b47d4ac5a20737493bf88a51f358e37151bccbaab8cde2f5dc6d13cc703b7e7fee204935f2ec13cec
-  data.tar.gz: d03755555bd12a587dd9bf4d5de76c16f644bb2acaa220ddff1de5877a705debb0254f962dbd65513f22a290e75596def586ceecd6f28bdf0fd6ab60c2e9008b
+  metadata.gz: 0cc783b3c30a87083033d825a7d80624af8d513c55989b6cd572a9dea1786caa72bc1306f50bf1a5f6ca6f136e9008b4c08a6b93713d4e5da58b12e06684500d
+  data.tar.gz: dde882747da769a523f0c31b4862327d8b959f667a14e5b151b92dca8de9b609204467c2b9bfbfc79e19b75a2b27b49243184ac434bb7ee858a496371b6c6c78

data/README.md

@@ -44,6 +44,8 @@ end
 
 `search: %w[...]` - список полей, по которым должна осуществляться фильтрация (поиск).
 
+`paginate: false` - отдавать результат без пагинации, сразу всей коллекцией (по умолчанию - с пагинацией)
+
 ## Параметры HTTP запроса
 
 Некоторые функции, такие, как поиск (фильтрация), сортировка и формирование эл. таблиц осуществляется путем обработки параметров HTTP запроса.

data/lib/grape/dsl.rb

@@ -2,21 +2,28 @@ module Grape
   module DSL
     module InsideRoute
 
-      def listing(model:, entity:, scopes: nil, search: nil)
-        opts = listing_opts(model, entity, scopes, search)
+      def listing(model:, entity:, scopes: nil, search: nil, paginate: true, caching: false)
+        # параметры запроса API
+        request_method = request.env['REQUEST_METHOD']
+        request_uri = request.env['REQUEST_URI']
+
+        # опции для сервиса
+        opts = listing_opts(model, entity, scopes, search, caching, request_method, request_uri)
 
         if params[:spreadsheet]
           listing_spreadsheet(**opts)
-        else
+        elsif paginate
           GrapeListingService.paginated(**opts)
+        else
+          GrapeListingService.listed(**opts)
         end
       end
 
       private
 
-      def listing_opts(model, entity, scopes, search)
+      def listing_opts(model, entity, scopes, search, caching, request_method, request_uri)
         # стандартные опции
-        opts = { model:, entity:, scopes:, search:, params:, current_user: }
+        opts = { model:, entity:, scopes:, search:, params:, current_user:, caching:, request_method:, request_uri: }
 
         # требуемый список полей (+стандартные) для фильтрации в Grape Entity
         if params[:columns]

data/lib/grape_listing_service.rb

@@ -1,4 +1,5 @@
 require 'listing_service/args_handling'
+require 'listing_service/listing'
 require 'listing_service/pagination'
 require 'listing_service/search'
 require 'listing_service/serialization'
@@ -8,6 +9,7 @@ require 'listing_service/spreadsheet'
 class GrapeListingService
 
   include GrapeListing::ArgsHandling
+  include GrapeListing::Listing
   include GrapeListing::Pagination
   include GrapeListing::Search
   include GrapeListing::Serialization
@@ -18,6 +20,10 @@ class GrapeListingService
     handle_args(**args)
   end
 
+  def self.listed(**args)
+    new(**args).listed
+  end
+
   def self.paginated(**args)
     new(**args).paginated
   end

data/lib/listing_service/args_handling.rb

@@ -7,6 +7,10 @@ module GrapeListing
       # обрабатываемая модель
       @model = args[:model]
 
+      # параметры адреса запроса API
+      @request_method = args[:request_method]
+      @request_uri = args[:request_uri]
+
       # параметры запроса и текущий пользователь
       @params = args[:params].stringify_keys
       @current_user = args[:current_user]
@@ -42,12 +46,15 @@ module GrapeListing
 
       # временная директория (для генерации файлов)
       @tempdir = args[:tempdir]
+
+      # кеширование результатов обработки Grape Entity
+      @caching = args[:caching]
     end
 
     def records_count
       # получение кол-ва записей из кеша
-      cache_key = "#{@model}_records_count"
-      cached = GrapeListing.cache.read(cache_key)
+      key = count_cache_key
+      cached = GrapeListing.cache.read(key)
       return cached if cached
 
       # получение кол-ва записей из запроса к БД
@@ -55,11 +62,19 @@ module GrapeListing
 
       # кеширование кол-ва записей при превышении порогового значения
       if count >= 1_000
-        GrapeListing.cache.write(cache_key, count, expires_in: 30.minutes)
+        GrapeListing.cache.write(key, count, expires_in: 30.minutes)
       end
 
       count
     end
 
+    def count_cache_key
+      # пример: "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/listing.rb

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

data/lib/listing_service/serialization.rb

@@ -23,20 +23,35 @@ module GrapeListing
     end
 
     def serialize_with_entity(records)
-      opts = { params: @params, current_user: @current_user }
+      @entity_opts = { params: @params, current_user: @current_user }
 
       # требуемый список полей (если был передан)
-      opts[:only] = @only_columns if @only_columns
+      @entity_opts[:only] = @only_columns if @only_columns
 
       # опция для идентификации формирования эл. таблицы
-      opts[:spreadsheet] = true if @params['spreadsheet']
-
-      records.map { |i| @grape_entity.represent(i, opts).as_json }
+      @entity_opts[:spreadsheet] = true if @params['spreadsheet']
+
+      # обработка результатов
+      records.map do |record|
+        if @caching
+          caching_entity_representation(record)
+        else
+          @grape_entity.represent(record, @entity_opts).as_json
+        end
+      end
     end
 
     def obtain_fields_values(record)
       @fields.map { |i| record.send(i) }
     end
 
+    def caching_entity_representation(record)
+      key = "#{@grape_entity}:#{record.id}"
+
+      GrapeListing.cache.fetch(key) 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.1.3.2
+  version: 1.1.5
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,6 +107,7 @@ files:
 - lib/grape_listing/configuration.rb
 - lib/grape_listing_service.rb
 - lib/listing_service/args_handling.rb
+- lib/listing_service/listing.rb
 - lib/listing_service/pagination.rb
 - lib/listing_service/search.rb
 - lib/listing_service/serialization.rb