tiny_filter 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70649a100b15254ca35dc3949cbbd549f87a34e41f85d87d600c42fc8d3401f0
-  data.tar.gz: af5850f2ee780906e08c24f67510224543ef46e873c342faeaa05a56e8f3c08f
+  metadata.gz: 5cf60cc543019e4d02a3c8ffda90cd0e27d224feefdd0517f1b359c9e598b7f2
+  data.tar.gz: fc7bceb2b9ec9265d4535fcacbf65c207e2df6b689b3d3117a839ccffdba6524
 SHA512:
-  metadata.gz: d2bab5a83fb731582136d1fd219906dc0a1a44ac0a3dd83c24d0317fc5cc66f3303cca654944aae0ab23d680dbc6c1af23ccc8afd19fdd97173fc374398a3f61
-  data.tar.gz: bfc8bc3fcf4ea121c403e61c27bf9ffa516d7f94401b38cd4d7edc0f2ee3b14b42229500bd9c0da0b0c05ca79e08f61e9f31f52afa471688eb1b29bb3160c5f4
+  metadata.gz: f1537075c3b79a1e3ab09080f7d9e68edb43e22dd97881782000d67d677cfdd543c118e445425f0bf729d2680ec8b8d35db8fb064d911f36b6727388ebcde957
+  data.tar.gz: 3b49cb06eca991359f8bf91500fb9f0ff20fcb36f503a25bd7011b239b9258411178844906e8ae424e4e7ab16720875c0c0f430161fb82f6640b35b4704c7146

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-rails
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-factory_bot
 
 inherit_gem:
   rubocop-shopify: rubocop.yml
@@ -17,9 +18,6 @@ Layout/EmptyLinesAroundAccessModifier:
 Layout/IndentationConsistency:
   EnforcedStyle: normal
 
-Layout/EmptyLinesAroundClassBody:
-  EnforcedStyle: empty_lines_special
-
 Style/SymbolArray:
   EnforcedStyle: percent
 

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.1] - 2023-10-20
+
+- Do not fix max dependencies versions
+- Improved generators
+
+## [0.2.0] - 2022-12-17
+
+- Filters inheritance
+
 ## [0.1.1] - 2022-12-12
 
 - Fixed generators

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kirill.usanov.dev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kirill@lassoid.ru. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/README.md

@@ -1,6 +1,8 @@
 # TinyFilter
 
-[![Gem Version](https://badge.fury.io/rb/tiny_filter.svg)](https://badge.fury.io/rb/tiny_filter)
+[![Gem Version](https://img.shields.io/gem/v/tiny_filter?color=blue&label=version)](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.
@@ -42,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.
@@ -60,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")
 ```
 
@@ -70,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.
 
@@ -119,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:
 
@@ -132,11 +134,12 @@ MyFilter.filter(collection, options)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`/`rspec` to run the tests.
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests.
+You can also run `bin/rubocop` to lint the source code
+and `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+To install this gem onto your local machine, run `bin/rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bin/rake release`,
 which will create a git tag for the version, push git commits and the created tag,
 and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,12 +1,3 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/lib/generators/tiny_filter/filter/filter_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators"
+
 module TinyFilter
   module Generators
     class FilterGenerator < ::Rails::Generators::NamedBase
@@ -11,7 +13,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 +21,6 @@ module TinyFilter
       def filter_file_name
         "#{file_name}_filter.rb"
       end
-
     end
   end
 end

data/lib/generators/tiny_filter/install/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Generates application filter - base class for all your filters.
+    Generates an application filter - a base class for all your filters.
 
 Examples:
     `bin/rails generate tiny_filter:install`

data/lib/generators/tiny_filter/install/install_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/generators"
+
 module TinyFilter
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
@@ -8,9 +10,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.1"
+  VERSION = "0.2.1"
 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

@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.name = "tiny_filter"
   spec.version = TinyFilter::VERSION
   spec.authors = ["Kirill Usanov", "LassoID"]
-  spec.email = ["kirill.usanov.dev@gmail.com"]
+  spec.email = "kirill@lassoid.ru"
 
   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"
@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Dependencies
-  spec.add_dependency "activesupport", ">= 6.0", "< 7.1"
-  spec.add_development_dependency "activerecord", ">= 6.0", "< 7.1"
-  spec.add_development_dependency "railties", ">= 6.0", "< 7.1"
+  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"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 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: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,9 +18,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,9 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -38,9 +32,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -48,9 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -58,9 +46,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -68,9 +53,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -197,9 +179,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple filtering for your Rails models and enumerables.
-email:
-- kirill.usanov.dev@gmail.com
+description: Simple filtering for ActiveRecord and enumerables.
+email: kirill@lassoid.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -214,10 +195,10 @@ files:
 - Rakefile
 - lib/generators/tiny_filter/filter/USAGE
 - lib/generators/tiny_filter/filter/filter_generator.rb
-- lib/generators/tiny_filter/filter/templates/filter.rb.erb
+- 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
+- lib/generators/tiny_filter/install/templates/application_filter.rb.tt
 - lib/tiny_filter.rb
 - lib/tiny_filter/base.rb
 - lib/tiny_filter/concern.rb
@@ -247,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Tiny filtering for Rails.