abstract_finder 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a7e235ebd8fd73ee68168acc1a73d22209d32b7279d1b1b2301f60ad95bdcf
-  data.tar.gz: effe24917541a0e2f74ef5f8ba5f3033796e4fda372ca7def0508e5851e4035f
+  metadata.gz: 49fae0a173ce18d04cc4abf88445dcec29cd0452062ac82674a40eae90460a7c
+  data.tar.gz: 6ae4d1c35a546fb0b2bf77e6b82576bdb472aeffa44df6d94ffee98f207452d8
 SHA512:
-  metadata.gz: c0f2e8cf4e7a50bf30abfc088d8c8f748451db1722ab62a3c15fa32c02a430e2b61282d5f24ebdbd0f16cc8f8e49b2807a2191f10b12c66cf7085e93c6bbfb8c
-  data.tar.gz: 0b765daf8f62b5364ace03cfac75dd4554388cfb29bf31365a65c7593103da718b2a0e042a0d6d6ada3346d19c227a39e1e1a7292bdc02e837c2577f430a4d82
+  metadata.gz: aa089b58c7a7107cea5ba6b13eb222e7392f9ff71778285b574d51e8d7af4cf1d7d14b685738b6e88ee6a7779c089f98059a94817b5b10bcdd33c6c3629c0893
+  data.tar.gz: 79bd1f89970b20b24408b6396ccc199048d79700c8395723901857d37757e7efbb3bd44de674270472d62da4cd120e35d506cb54187c03ee0a6d636a3154aad4

data/README.md

@@ -0,0 +1,28 @@
+## AbstractFinder
+
+### API wrapper for search, pagination, filter.
+
+General idea to pass a 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], # to fight N+1
+    params             # permitted params for pagination, filtering, ordering and search
+  )
+
+  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/base_finder.rb

@@ -31,14 +31,21 @@ class BaseFinder
   def total
     return 0 if @collection.blank?
 
-    @total ||= @collection.count
+    @total ||= @collection.size
+  end
+
+  def next_page?
+    (@total - (page.next * per_page)).positive?
+  rescue StandardError
+    false
   end
 
   def meta
     {
       page: page,
       per_page: per_page,
-      total: @total
+      total: @total,
+      next_page: next_page?
     }
   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.5
 platform: ruby
 authors:
 - Aleksei Ivanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-01-12 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