tiny_filter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf60cc543019e4d02a3c8ffda90cd0e27d224feefdd0517f1b359c9e598b7f2
-  data.tar.gz: fc7bceb2b9ec9265d4535fcacbf65c207e2df6b689b3d3117a839ccffdba6524
+  metadata.gz: 33ab33afed080553844b220a53dd8f63f88d303b9b06f751de4f1985f11ca745
+  data.tar.gz: 1f62c70732e0cc8a529b851babcd5c3f0ef455626db4faf633a28d8ad79624ef
 SHA512:
-  metadata.gz: f1537075c3b79a1e3ab09080f7d9e68edb43e22dd97881782000d67d677cfdd543c118e445425f0bf729d2680ec8b8d35db8fb064d911f36b6727388ebcde957
-  data.tar.gz: 3b49cb06eca991359f8bf91500fb9f0ff20fcb36f503a25bd7011b239b9258411178844906e8ae424e4e7ab16720875c0c0f430161fb82f6640b35b4704c7146
+  metadata.gz: f3bc9efb9ada2976656c97b849adb4df37428218976f6d5bcc31be2907e8e2158fb7270e9ef89cccb4854a98fd2533fa86e7ea3b503fcefc255264ea48c14f69
+  data.tar.gz: 685a3e02de2e4a45d72ee394f961e567202860791b5fba770b6c4519246d611e20e760cd742c9bd850bd6abe98c632f5f776113cd71537c83c947e7802efcb7e

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [Unreleased]
+## [0.3.0] - 2023-11-06
+
+- No runtime dependencies!
+- Sequel integration
 
 ## [0.2.1] - 2023-10-20
 

data/README.md

@@ -5,7 +5,7 @@
 [![Github Actions CI](https://github.com/lassoid/tiny_filter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/lassoid/tiny_filter/actions/workflows/ci.yml)
 
 TinyFilter is created to provide a simple object-oriented abstraction layer for filtering collections.
-It is mainly purposed for ActiveRecord collections, but you can also use it with any enumerable.
+It is mainly purposed for ActiveRecord/Sequel models, but you can also use it with any enumerable.
 
 ```ruby
 Post.where(title: "Wow!").filter_by(from: 2.days.ago, to: 1.day.ago).order(:created_at)
@@ -83,11 +83,12 @@ Thus if the initial scope for filtering is an ActiveRecord collection,
 it is a bad practice for filter to return not an ActiveRecord collection.
 Otherwise you can face errors depending on the provided options order.
 
-## ActiveRecord integration
+## ORM integration
 
-### Helper
+### ActiveRecord
 
-TinyFilter provides a simple concern, that adds just one method `filter_by`, that can be used in ActiveRecord method chaining.
+TinyFilter provides a simple concern, that adds just one method `filter_by`,
+that can be used in ActiveRecord method chaining.
 
 Just include `TinyFilter::Concern` in your model and that's all!
 
@@ -104,12 +105,30 @@ Post.where(title: "something interesting").filter_by(from: 2.days.ago, to: 1.day
 Post.filter_by(from: 1.year.ago)
 ```
 
+### Sequel
+
+The previously mentioned filter concern can also be used in Sequel models.
+
+```ruby
+class Artist < Sequel::Model
+  include TinyFilter::Concern
+end
+```
+
+Querying examples:
+
+```ruby
+Artist.where(name: "Kirill").filter_by(from: 2.days.ago, to: 1.day.ago).order(:name).all
+Artist.filter_by(from: 1.year.ago).all
+```
+
 ### Naming convention
 
 By default a filter class and a model are mapped by a _model name_ with a _suffix_ `Filter`.
 For example, the model `My::Class` by default will use the `My::ClassFilter` as a filter class.
 
-You can customize this behavior by implementing a `filter_class` class method with an appropriate class as a return value.
+You can customize this behavior by implementing a `filter_class` class method
+with an appropriate class as a return value.
 
 ```ruby
 class My::Class < ApplicationRecord
@@ -123,7 +142,7 @@ end
 
 ## Using with Plain objects
 
-You can use filters with non-ActiveRecord collections like so:
+You can use filters with Plain Old Ruby collections like so:
 
 ```ruby
 options    # filter options, for example: `{ from: 2.days.ago, to: 1.day.ago }`

data/lib/tiny_filter/concern.rb

@@ -2,13 +2,20 @@
 
 module TinyFilter
   module Concern
-    extend ActiveSupport::Concern
-
-    included do
-      if defined?(ActiveRecord::Base) && self <= ActiveRecord::Base
-        scope :filter_by, ->(args = {}) { TinyFilter::FilterFinder.find(self).filter(self, args) }
-      else
-        raise Error, "unable to include TinyFilter::Concern in #{self} that is not an ActiveRecord::Base descendant"
+    class << self
+      def included(other)
+        if defined?(ActiveRecord::Base) && other <= ActiveRecord::Base
+          other.scope :filter_by, ->(args = {}) { TinyFilter::FilterFinder.find(self).filter(self, args) }
+        elsif defined?(Sequel::Model) && other <= Sequel::Model
+          other.dataset_module do
+            def filter_by(args = {})
+              TinyFilter::FilterFinder.find(self).filter(self, args)
+            end
+          end
+        else
+          raise Error, "unable to include TinyFilter::Concern in #{other} " \
+            "that is not an ActiveRecord::Base or Sequel::Model descendant"
+        end
       end
     end
   end

data/lib/tiny_filter/filter_finder.rb

@@ -15,10 +15,18 @@ module TinyFilter
         if object.respond_to?(:filter_class)
           object.filter_class
         elsif object.respond_to?(:model_name)
-          "#{object.model_name}#{SUFFIX}".constantize
+          Object.const_get("#{object.model_name}#{SUFFIX}")
+        elsif object.respond_to?(:model)
+          if object.model.respond_to?(:filter_class)
+            object.model.filter_class
+          else
+            Object.const_get("#{object.model}#{SUFFIX}")
+          end
         else
-          raise Error, "unable to find appropriate filter class for #{object}"
+          Object.const_get("#{object}#{SUFFIX}")
         end
+      rescue NameError
+        raise Error, "unable to find appropriate filter class for #{object}"
       end
     end
   end

data/lib/tiny_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinyFilter
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/tiny_filter.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Kirill Usanov", "LassoID"]
   spec.email = "kirill@lassoid.ru"
 
-  spec.summary = "Tiny filtering for Rails."
-  spec.description = "Simple filtering for ActiveRecord and enumerables."
+  spec.summary = "Tiny filtering for ActiveRecord, Sequel and enumerables."
+  spec.description = "Simple filtering for ActiveRecord, Sequel and enumerables."
   spec.homepage = "https://github.com/lassoid/tiny_filter"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Dependencies
-  spec.add_dependency "activesupport", ">= 6.0"
   spec.add_development_dependency "activerecord", ">= 6.0"
   spec.add_development_dependency "railties", ">= 6.0"
   spec.add_development_dependency "rake"
@@ -41,5 +40,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rake"
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "rubocop-shopify"
+  spec.add_development_dependency "sequel"
   spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_filter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Usanov
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple filtering for ActiveRecord and enumerables.
+description: Simple filtering for ActiveRecord, Sequel and enumerables.
 email: kirill@lassoid.ru
 executables: []
 extensions: []
@@ -231,5 +231,5 @@ requirements: []
 rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
-summary: Tiny filtering for Rails.
+summary: Tiny filtering for ActiveRecord, Sequel and enumerables.
 test_files: []