tiny_filter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52eb68e11715585163330d5f814e72744ad26114320d87dd9dd1cb80326bf3a7
-  data.tar.gz: c57812b379ade0d6dcdd4f262c6cd1e00773c15f9e1d6292594eff133eef4556
+  metadata.gz: b25430ea35a61c7a2ce2bc81b38596990385179c11b4b2797c441df5e1813725
+  data.tar.gz: ec073eef8a8faf00b171e9ba92fa356a76fa3947b76f314cab3e6997855a618c
 SHA512:
-  metadata.gz: 757d3bc888fc7658bb1c72ce82871be05f4dcf90d50eb48b9cf610267f11f2a44b12e6844b84d074593f19de61462e4daf44cb1e43452ce55117562bebebd5e4
-  data.tar.gz: 59f7ae5777c94a9b01c7f51848ae9e3ee3b365643e44702e836ccd42c3a77d5fc93f21eecd47aefac9a327dee8d644d3f39476c6e114ce1fa1779fbcc9245174
+  metadata.gz: '0905513bd90fe26f0bc2ead908f73688e3dbe69da16d4864f5e7d64a3be6b0aa1e3f159b270498bb7e8f3c1faced5ac9707a318034c433e3bdc2746e7d9742ba'
+  data.tar.gz: 98498c4a965f6b7262418e7a952a6b164ef6baa08c869503b971a3461486cb0c6580cf62be73aaff98282d0c4ad3a087203751554fcd92b668ca2f63d2d64e11

data/.rubocop.yml

@@ -17,9 +17,6 @@ Layout/EmptyLinesAroundAccessModifier:
 Layout/IndentationConsistency:
   EnforcedStyle: normal
 
-Layout/EmptyLinesAroundClassBody:
-  EnforcedStyle: empty_lines_special
-
 Style/SymbolArray:
   EnforcedStyle: percent
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-12-17
+
+- Filters inheritance
+
+## [0.1.1] - 2022-12-12
+
+- Fixed generators
+
 ## [0.1.0] - 2022-12-05
 
 - Initial release

data/README.md

@@ -1,5 +1,9 @@
 # TinyFilter
 
+[![Gem Version](https://badge.fury.io/rb/tiny_filter.svg)](https://rubygems.org/gems/tiny_filter)
+[![Gem downloads count](https://img.shields.io/gem/dt/tiny_filter)](https://rubygems.org/gems/tiny_filter)
+[![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.
 
@@ -40,11 +44,11 @@ Each filter is defined by calling `filters` method inside class body.
 
 `filters` accepts two arguments:
 - `key` - a filter name, used as identifier;
-- `block` - a block or proc/lambda with filter logic, that returns filtered collection and itself accepts two arguments:
+- `block` - a block with filter logic, that returns filtered collection and itself accepts two arguments:
   - `scope` - a collection that should be filtered;
   - `value` - a value for filtering.
 
-When you perform filtering, provided keys indicate filters `key`s and provided `value`s are passed to corresponding filters `block`s.
+When you perform filtering, provided key indicate filter `key` and provided value is passed to `value` param in corresponding filter `block`.
 `scope`s receive collections in a pipeline manner:
 _first_ executed filter receives _original collection_,
 _second and further_ receive the _return collection_ of the previous filter.
@@ -58,7 +62,7 @@ class UserFilter < ApplicationFilter
 end
 
 UserFilter.filter(User, name: "John", surname: "Doe")
-# It performs like this inside:
+# Which is equivalent to:
 # User.where(first_name: "John").where(last_name: "Doe")
 ```
 
@@ -68,14 +72,14 @@ It guarantees that scope behaves the same way as in other filters in this class.
 ```ruby
 filters(:title) { |scope, value| scope.where("title ILIKE ?", value) }
 
-# bad - scope is meant to be ActiveRecord collection, but the return value is an array.
+# bad - scope is an ActiveRecord collection, but the return value is an array.
 filters(:from) { |scope, value| scope.select { |e| e.created_at >= value } }
 
 # good - scope and return value are both ActiveRecord collections.
 filters(:from) { |scope, value| scope.where("created_at >= ?", value) }
 ```
 
-So, if the initial scope for filtering is ActiveRecord collection,
+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.
 
@@ -117,7 +121,7 @@ class My::Class < ApplicationRecord
 end
 ```
 
-### Using with Plain objects
+## Using with Plain objects
 
 You can use filters with non-ActiveRecord collections like so:
 

data/lib/{tiny_filter/generators → generators}/tiny_filter/filter/filter_generator.rb

@@ -11,7 +11,7 @@ module TinyFilter
 
       def create_filter
         template_file = File.join("app/filters", class_path, filter_file_name)
-        template "filter.rb.erb", template_file
+        template "filter.rb.tt", template_file
       end
 
       private
@@ -19,7 +19,6 @@ module TinyFilter
       def filter_file_name
         "#{file_name}_filter.rb"
       end
-
     end
   end
 end

data/lib/{tiny_filter/generators → generators}/tiny_filter/install/install_generator.rb

@@ -8,9 +8,8 @@ module TinyFilter
       desc "This generator creates an application filter"
 
       def copy_application_filter
-        template "application_filter.rb", "app/filters/application_filter.rb"
+        template "application_filter.rb.tt", "app/filters/application_filter.rb"
       end
-
     end
   end
 end

data/lib/tiny_filter/base.rb

@@ -3,12 +3,14 @@
 module TinyFilter
   class Base
     class << self
+      def inherited(subclass)
+        super
+        dup_filters = __filters__.dup
+        subclass.__filters__ = dup_filters.each { |key, value| dup_filters[key] = value.dup }
+      end
 
       def filters(key, &block)
-        key = key.to_sym
-        raise AlreadyDefinedError, "filter :#{key} defined more than once in #{self}" if __filters__.key?(key)
-
-        __filters__[key] = block
+        __filters__[key.to_sym] = block
       end
 
       def filter(base_scope, args = {})
@@ -20,13 +22,13 @@ module TinyFilter
         end
       end
 
-      private
+      protected
+
+      attr_writer :__filters__
 
       def __filters__
         @__filters__ ||= {}
       end
-
     end
-
   end
 end

data/lib/tiny_filter/filter_finder.rb

@@ -5,7 +5,6 @@ module TinyFilter
     SUFFIX = "Filter"
 
     class << self
-
       def find(object)
         filter_class(object)
       end
@@ -21,8 +20,6 @@ module TinyFilter
           raise Error, "unable to find appropriate filter class for #{object}"
         end
       end
-
     end
-
   end
 end

data/lib/tiny_filter/version.rb

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

data/lib/tiny_filter.rb

@@ -11,5 +11,4 @@ require "tiny_filter/concern"
 module TinyFilter
   class Error < StandardError; end
   class NotDefinedError < Error; end
-  class AlreadyDefinedError < Error; end
 end

data/tiny_filter.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["kirill.usanov.dev@gmail.com"]
 
   spec.summary = "Tiny filtering for Rails."
-  spec.description = "Simple filtering for your Rails models and enumerables."
+  spec.description = "Simple filtering for ActiveRecord and enumerables."
   spec.homepage = "https://github.com/lassoid/tiny_filter"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kirill Usanov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-11 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -197,7 +197,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple filtering for your Rails models and enumerables.
+description: Simple filtering for ActiveRecord and enumerables.
 email:
 - kirill.usanov.dev@gmail.com
 executables: []
@@ -212,16 +212,16 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/generators/tiny_filter/filter/USAGE
+- lib/generators/tiny_filter/filter/filter_generator.rb
+- lib/generators/tiny_filter/filter/templates/filter.rb.tt
+- lib/generators/tiny_filter/install/USAGE
+- lib/generators/tiny_filter/install/install_generator.rb
+- lib/generators/tiny_filter/install/templates/application_filter.rb.tt
 - lib/tiny_filter.rb
 - lib/tiny_filter/base.rb
 - lib/tiny_filter/concern.rb
 - lib/tiny_filter/filter_finder.rb
-- lib/tiny_filter/generators/tiny_filter/filter/USAGE
-- lib/tiny_filter/generators/tiny_filter/filter/filter_generator.rb
-- lib/tiny_filter/generators/tiny_filter/filter/templates/filter.rb.erb
-- lib/tiny_filter/generators/tiny_filter/install/USAGE
-- lib/tiny_filter/generators/tiny_filter/install/install_generator.rb
-- lib/tiny_filter/generators/tiny_filter/install/templates/application_filter.rb
 - lib/tiny_filter/version.rb
 - sig/tiny_filter.rbs
 - tiny_filter.gemspec
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Tiny filtering for Rails.