grape-listing 1.1.8 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47ec8a91643cdf3b1ab90b6f2f6f3ede8ee0c0ab069b9f79b9b5c3bca7339d7
-  data.tar.gz: 0d69408736e14c1839167cb33ec0ee8e6b335046f5989b041668c6497c0d205a
+  metadata.gz: 216dc8cc1fddbb989a7b093569bb9acf2c085b52a74d3a0bdfffed84ad2a48c8
+  data.tar.gz: 9a8a054586ff87f8c00cabfdab4002282eb1dc1b0bea57bdd876ed5e39f4abe5
 SHA512:
-  metadata.gz: 541f2e90aa6ec5f9c6778259da1d58037ece13a5e7238765ac0641c9aac2ac7eaa8bb2c60fb9f44a4b04854220f4bdaed32ed569f8a2b5a82a6669a67df154ea
-  data.tar.gz: 18599c3bfbedf62aa12d653b8cb052d67d5646998a1cf9a02c15bbc91b21332878a832b004809e4dc53ce2301463613792fcd17abad857cd3b60e95e71b7e90c
+  metadata.gz: 906c4e171bea8562f8a77e6b50eb2c742e39452ce10d81067a3cf4649e15294229eea1d4e587c724f3782c2337e3293095241d621c71a88e0d0707d1839a39bb
+  data.tar.gz: eace61cdf1afa188cf656c89b5fce3eeaf56d54ccd0be4ec008b43d9cf5216e2f1e26e6055ccc60767ff07551776854a5d721a954293d8fb40f3cc7bc3918381

data/README.md

@@ -26,8 +26,7 @@ bundle
 ```ruby
 get 'users' do
   listing model: User,
-          entity: UserEntity,
-          search: %w[email name|ilike role|custom.for_role]
+          entity: UserEntity
 end
 
 ```
@@ -52,7 +51,24 @@ end
 
 ### Поиск
 
-Для поиска по полям необходимо передать их в запросе в виде `?field=value`. Для поиска по нескольким полям, параметры должны быть перечислены через `&`, например: `?field_1=value&field_2=value`.
+Для возможности поиска необходимо передать названия полей, по которым может осуществляться поиск, в виде массива в опции `search`.
+
+Для осуществления фильтрации необходимо передать параметры в запросе в виде `?field=value`. Для поиска по нескольким полям, параметры должны быть перечислены через `&`, например: `?field_1=value&field_2=value`.
+
+В общем случае, названия полей соответствуют названиями параметров (например поле `name` и параметр `name`).
+
+Пример использования с осуществлением поиска по полю `name` с полным совпадением:
+
+```ruby
+get 'users' do
+  listing model: User,
+          entity: UserEntity,
+          search: %w[name]
+end
+```
+```
+GET http://localhost:3000/api/users?name=Ivan
+```
 
 ### Сортировка
 

data/lib/listing_service/args_handling.rb

@@ -58,7 +58,7 @@ module GrapeListing
       return cached if cached
 
       # получение кол-ва записей из запроса к БД
-      count = @model.merge(@scopes).count(:id)
+      count = @model.merge(@scopes).distinct.count(:id)
 
       # кеширование кол-ва записей при превышении порогового значения
       if count >= 1_000
@@ -69,6 +69,13 @@ module GrapeListing
     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}"
 

data/lib/listing_service/search.rb

@@ -19,8 +19,8 @@ module GrapeListing
           # название скоупа из модели, который нужно применить
           scope_name = operator.split('.')[1]
           # применение скоупа
-          @objects = list.send(scope_name, value)
-          @objects_count = @objects.count
+          @objects = list.send(scope_name, value).distinct
+          @objects_count = @objects.distinct.count
           next
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-listing
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.10
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack