abstract_finder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a7e235ebd8fd73ee68168acc1a73d22209d32b7279d1b1b2301f60ad95bdcf
-  data.tar.gz: effe24917541a0e2f74ef5f8ba5f3033796e4fda372ca7def0508e5851e4035f
+  metadata.gz: c2cd512d02c9a41dc385d4ff126bcdce014ebbe4f0c1b130849f3d682b83ad9c
+  data.tar.gz: f95a7ebdcb012e83b0883da86542a5852210c705397da6febae389711666294c
 SHA512:
-  metadata.gz: c0f2e8cf4e7a50bf30abfc088d8c8f748451db1722ab62a3c15fa32c02a430e2b61282d5f24ebdbd0f16cc8f8e49b2807a2191f10b12c66cf7085e93c6bbfb8c
-  data.tar.gz: 0b765daf8f62b5364ace03cfac75dd4554388cfb29bf31365a65c7593103da718b2a0e042a0d6d6ada3346d19c227a39e1e1a7292bdc02e837c2577f430a4d82
+  metadata.gz: 44b11a1234976fdfc7860118950380fa6221b23b908d0dc3c3fd4155db743e9147038045a9e1ed8fb95cf2242753068ae955a0a2f066349c754213fd844d4d6e
+  data.tar.gz: fbc1a578b810be1fd9d512c725a8749ed7796789b7e9408f5c5d47d994bd5a1c2d53977c30d2f2eda5990ad0b0290991eda75878aac13f9e4742cef187e8502d

data/README.md

@@ -0,0 +1,28 @@
+## AbstractFinder
+
+### API wrapper for search, pagination, filter.
+
+General idea to pass query, relations to avoid N+1 and permitted params to paginate, filter and sort AbstractFinder collection.
+
+
+``` ruby
+class RecordsContrroller < Api::BaseController
+  def index
+  finder = AbstractFinder.call(
+    Record.latest, # scope, method or class
+    %w[rating status],
+    params
+  )
+
+  render json: RecordSerializer.new(
+    finder.collection,
+    { meta: finder.meta, params: permitted_params }
+  ).serializable_hash
+
+  private
+
+  def params
+    params.require(:record).permit(:page, :per_page, :search_by, :q, :order_by)
+  end
+end
+```

data/lib/abstract_finder.rb

@@ -43,7 +43,7 @@ class AbstractFinder < BaseFinder
 
   # define #search_by method in query model and use this finder
   def query
-    @collection = model.includes(associations).search_by(@filters[:q]) if model.respond_to? :search_by
+    @collection = @collection.includes(associations).search_by(@filters[:q]) if @collection.respond_to? :search_by
   end
 
   def filter; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aleksei Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Abstract finder for rails api with gueries, sort, filter and pagination