abstract_finder 0.0.1

checksums.yaml

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Mr Ivanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/abstract_finder/base_finder.rb

@@ -0,0 +1,66 @@
+# Class Base finder
+class BaseFinder
+  DEFAULT_PER_PAGE = 10
+
+  attr_reader :collection
+
+  def self.call(*args)
+    instance = new(*args)
+    instance.call
+    instance
+  end
+
+  def initialize(filters)
+    @filters = filters
+  end
+
+  def call
+    load_collection
+
+    self
+  end
+
+  def page
+    filter_by(:page)&.to_i || 1
+  end
+
+  def per_page
+    filter_by(:per_page)&.to_i || DEFAULT_PER_PAGE
+  end
+
+  def total
+    return 0 if @collection.blank?
+
+    @total ||= @collection.count
+  end
+
+  def meta
+    {
+      page: page,
+      per_page: per_page,
+      total: @total
+    }
+  end
+
+  protected
+
+  def load_collection
+    @collection = nil
+  end
+
+  # Internal: check if filter by param specified
+  #   param_name - name of filters param
+  #
+  # Returns Boolean
+  def filtered_by?(param_name)
+    filter_by(param_name).present?
+  end
+
+  # Internal: filter value for parameter
+  #   param_name - name of filters param
+  #
+  # Returns String
+  def filter_by(param_name)
+    @filters[param_name]
+  end
+end

data/lib/abstract_finder.rb

@@ -0,0 +1,54 @@
+require_relative 'abstract_finder/base_finder'
+
+# AbstractFinder
+class AbstractFinder < BaseFinder
+  attr_reader :model, :associations
+
+  SORT = %w[asc desc].freeze
+
+  def self.call(model, associations = [], args = [])
+    new(model, associations, args).call
+  end
+
+  def initialize(model, associations, args) # rubocop:disable Lint/MissingSuper
+    @model = model
+    @associations = associations
+    @filters = args
+  end
+
+  def call
+    load_collection
+
+    self
+  end
+
+  protected
+
+  def load_collection
+    base_collection
+    query if @filters[:q].present? && @collection.respond_to?(:search_by)
+    order if @filters[:order].present?
+    filter if @filters[:filter_by].present? && @collection.respond_to?(:filter_by)
+    total
+    finalize_collection
+  end
+
+  def base_collection
+    @collection = model.all.includes(associations)
+  end
+
+  def finalize_collection
+    @collection = @collection.page(page).per(per_page)
+  end
+
+  # 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
+  end
+
+  def filter; end
+
+  def order
+    @collection = @collection.order(created_at: @filters[:order])
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: abstract_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleksei Ivanov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to simplify AR queries, it executes query and includes relations.
+email: alx.ekb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/abstract_finder.rb
+- lib/abstract_finder/base_finder.rb
+homepage: https://github.com/alxekb/abstract_finder
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Abstract finder for rails api with gueries, sort, filter and pagination
+test_files: []