ii_finder 1.1.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e833c71166437a7e1f0881641850c3b2bc6f36f9c7827a2e18d0c63ba9d3e4b
-  data.tar.gz: 6f653a027ee5947a6c7bbcd0ce3f76999513f334b79ebd5a8b12dc907961ea2f
+  metadata.gz: e9c42e9402b1850eb69b928c7ea83e978e3ccbe3b3356eb4e5b1d24edf9424ce
+  data.tar.gz: d22e81c3f0c1bd32b9637d8722b5c6007ae5bf2c27c9b880c2c3b90e88f23363
 SHA512:
-  metadata.gz: 1b861518b33b016ccc5795cd04c6c1677a159efd43eeb023bb00ae068b00cb2ca2820c0bf35c58b136cf6ee8392995b87b4a4d5e6e8bbfc5e09f1ab7e16a422c
-  data.tar.gz: 443dc16e940192156b4af6af1747d9f81166455870ed50215a361c61b9e0535b6ae60e14a0824ae989be6cb141e844235cec5cfbb2b210e4923694b9e792cd73
+  metadata.gz: d5d8a31523c9cfa994a683c51723bbb62a1ca09891f1653ccc7f4af8a0b4a28a6927983886c504b86bfbb22e331f50e103f5378b5931e60e4111c49219e8670e
+  data.tar.gz: 1c0770784cc663a8bcba3c99b1d0af1439d29c23b8b5a885f7cc34a5c06136972879a9ce8d48d619ca4b6de80639f76c4eb4d51749597a619032f4d1324b54ed

data/.github/workflows/ci.yml

@@ -4,21 +4,29 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
-        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0']
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61', 'rails70']
         exclude:
           - ruby: 2.3
             gemfile: rails60
           - ruby: 2.3
             gemfile: rails61
+          - ruby: 2.3
+            gemfile: rails70
           - ruby: 2.4
             gemfile: rails60
           - ruby: 2.4
             gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails70
+          - ruby: 2.5
+            gemfile: rails70
+          - ruby: 2.6
+            gemfile: rails70
           - ruby: 3.0
             gemfile: rails50
           - ruby: 3.0

data/CHANGELOG.md

@@ -1,8 +1,28 @@
 # CHANGELOG
 
+## 2.1.0
+
+* Add traversal config.
+* Add callbacks for `call_all`.
+* Add calling instrumentation.
+* Clear class cache when reloaded.
+* Bump coactive version to 0.2.
+
+## 2.0.1
+
+* Return relation after callbacks called.
+
+## 2.0.0
+
+* Replace chain feature with coactive.
+
+## 1.2.0
+
+* Add chain feature.
+
 ## 1.1.2
 
-Try fetch prior to calling instance method.
+* Try fetch prior to calling instance method.
 
 ## 1.1.1
 

data/README.md

@@ -24,14 +24,14 @@ Then execute:
 Prepare model:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 ```
 
 Prepare finder:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -43,15 +43,15 @@ end
 Use finder as follows:
 
 ```ruby
-UsersFinder.call(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+ItemsFinder.call(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 You can also specify relation as first argument:
 
 ```ruby
-UsersFinder.call(User.where(id: [1, 2, 3]), name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."id" IN (1, 2, 3) AND "users"."name" = 'NAME'
+ItemsFinder.call(Item.where(id: [1, 2, 3]), name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."id" IN (1, 2, 3) AND "items"."name" = 'NAME'
 ```
 
 ### Finder
@@ -61,7 +61,7 @@ Finder method will not be called when the value of parameter is blank.
 If you want to receive such value, set `allow_blank` as follows:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name, allow_blank: true
 
   def name(value)
@@ -69,14 +69,14 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: '').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = ''
+ItemsFinder.call(name: '').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = ''
 ```
 
 Finder has following attributes:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -87,10 +87,10 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: 'NAME')
-#=> relation: #<User::ActiveRecord_Relation:
+ItemsFinder.call(name: 'NAME')
+#=> relation: #<Item::ActiveRecord_Relation:
 #   criteria: {:name=>'NAME'}
-#   model: User
+#   model: Item
 #   table: #<Arel::Table ...>
 ```
 
@@ -102,7 +102,7 @@ IIFinder.configure do |config|
   config.merge_relation = false
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -110,8 +110,8 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+ItemsFinder.call(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 #### Callbacks
@@ -125,7 +125,7 @@ Following callbacks are available.
 For example:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   after_call :default_order
 
   def default_order
@@ -133,14 +133,45 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call.to_sql
-#=> SELECT "users".* FROM "users" ORDER BY "users"."id" DESC
+ItemsFinder.call.to_sql
+#=> SELECT "items".* FROM "items" ORDER BY "items"."id" DESC
 ```
 
 Note that finder does not handle the return value of callback.
 When you want to update `@relation` in the callback,
 reassign `@relation` or use methods like `where!` or `order!`.
 
+#### Coactors
+
+You can chain multiple finders by using `coact`. For example:
+
+```ruby
+class NameFinder < IIFinder::Base
+  parameters :name
+
+  def name(value)
+    @relation.where(name: value)
+  end
+end
+
+class AgeFinder < IIFinder::Base
+  parameters :age
+
+  def age(value)
+    @relation.where(age: value)
+  end
+end
+
+class ItemsFinder < IIFinder::Base
+  coact NameFinder, AgeFinder
+end
+
+ItemsFinder.call(Item.all, name: 'name', age: 10).to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'name' AND "items"."age" = 10
+```
+
+See [coactive](https://github.com/kanety/coactive) for more `coact` examples:
+
 ### Lookup for model
 
 Finder lookups related model by its class name when the first argument of `call` is not relation.
@@ -148,30 +179,30 @@ So the name of finder class should be composed of the name of model class.
 For example:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
 end
 
-IIFinder::Base.lookup(UsersFinder)
-#=> User
+IIFinder::Base.lookup(ItemsFinder)
+#=> Item
 ```
 
 Note that superclass of finder is also looked up until related model is found.
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
 end
 
-class InheritedUsersFinder < UsersFinder
+class InheritedItemsFinder < ItemsFinder
 end
 
-IIFinder::Base.lookup(InheritedUsersFinder)
-#=> User
+IIFinder::Base.lookup(InheritedItemsFinder)
+#=> Item
 ```
 
 ### Scope for model
@@ -179,12 +210,12 @@ IIFinder::Base.lookup(InheritedUsersFinder)
 In case you want to call finder from model, include `IIFinder::Scope` into model as follows:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
   include IIFinder::Scope
 end
 
-User.finder_scope(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+Item.finder_scope(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 ### Logging
@@ -199,7 +230,9 @@ IIFinder::LogSubscriber.attach_to :ii_finder
 This subscriber will write logs in debug mode as the following example:
 
 ```
-Called UsersFinder with {:id=>1} (Duration: 9.9ms, Allocations: 915)
+Calling ItemsFinder with {:id=>1}
+...
+Called ItemsFinder (Duration: 9.9ms, Allocations: 915)
 ```
 
 ## Contributing

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/ii_finder.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "coactive", ">= 0.2"
 
   spec.add_development_dependency "rails", ">= 5.0"
   spec.add_development_dependency "sqlite3"

data/lib/ii_finder/base.rb

@@ -5,6 +5,9 @@ require_relative 'parameters'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'lookup'
+require_relative 'context'
+require_relative 'contextualizer'
+require_relative 'coactors'
 
 module IIFinder
   class Base
@@ -13,5 +16,7 @@ module IIFinder
     include Callbacks
     include Instrumentation
     include Lookup
+    include Contextualizer
+    include Coactors
   end
 end

data/lib/ii_finder/callbacks.rb

@@ -6,9 +6,16 @@ module IIFinder
     include ActiveSupport::Callbacks
 
     included do
+      define_callbacks :all
       define_callbacks :call
     end
 
+    def call_all
+      run_callbacks :all do
+        super
+      end
+    end
+
     def call
       run_callbacks :call do
         super
@@ -16,6 +23,18 @@ module IIFinder
     end
 
     class_methods do
+      def before_all(*args, &block)
+        set_callback(:all, :before, *args, &block)
+      end
+
+      def after_all(*args, &block)
+        set_callback(:all, :after, *args, &block)
+      end
+
+      def around_all(*args, &block)
+        set_callback(:all, :around, *args, &block)
+      end
+
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)
       end

data/lib/ii_finder/coactors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Coactors
+    extend ActiveSupport::Concern
+
+    included do
+      include Coactive::Base
+
+      configure_coactive do |config|
+        config.load_paths = ['app/finders']
+        config.class_suffix = 'Finder'
+        config.use_cache = true
+        config.lookup_superclass_until = ['ActiveRecord::Base', 'ActiveModel::Base']
+      end
+
+      class << self
+        alias_method :chain, :coact
+      end
+    end
+  end
+end

data/lib/ii_finder/config.rb

@@ -6,7 +6,8 @@ module IIFinder
 
     self.data = {
       lookup_cache: true,
-      merge_relation: true
+      merge_relation: true,
+      traversal: :postorder,
     }
 
     data.keys.each do |key|

data/lib/ii_finder/context.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module IIFinder
+  class Context < Coactive::Context
+    def to_s
+      "#<#{self.class} model=#{@_data[:model]} criteria=#{@_data[:criteria].to_s.truncate(300)}>"
+    end
+  end
+end

data/lib/ii_finder/contextualizer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Contextualizer
+    extend ActiveSupport::Concern
+    include Coactive::Contextualizer
+
+    def call
+      contextualize do
+        super
+      end
+    end
+  end
+end

data/lib/ii_finder/core.rb

@@ -3,34 +3,49 @@
 module IIFinder
   module Core
     extend ActiveSupport::Concern
+    include Coactive::Initializer
 
     included do
-      attr_reader :relation, :criteria, :model, :table
+      self.context_class = IIFinder::Context
+      context :relation, output: true
+      context :criteria, :model, :table
     end
 
     def initialize(*args)
-      if args.size == 0 || args.size == 1
-        @model = self.class.lookup
-        raise IIFinder::Error.new("could not find model for #{self.class}") unless @model
-        @relation = @model.all
-        @criteria = args[0] || {}
+      if args[0].is_a?(self.class.context_class)
+        super(args[0])
       else
-        @relation = args[0]
-        @criteria = args[1]
-        @model = @relation.klass
+        relation, criteria = Core.resolve_args(self, *args)
+        model = relation.klass
+        table = model.arel_table if model.respond_to?(:arel_table)
+        super(relation: relation, criteria: criteria, model: model, table: table)
+      end
+    end
+
+    def call_all
+      planned = case IIFinder.config.traversal
+        when :preorder
+          [self] + coactors
+        when :postorder
+          coactors + [self]
+        when :inorder
+          planned = coactors.in_groups(2, false)
+          planned[0] + [self] + planned[1]
+        end
+
+      planned.each do |finder|
+        relation = finder == self ? call : finder.call(@context)
+        @context.relation = @context.relation.merge(relation) if relation.respond_to?(:merge)
       end
-      @table = @model.arel_table if @model.respond_to?(:arel_table)
     end
 
     def call
       self.class._parameters.each do |param|
         value = fetch_criteria(param.name)
         if value.present? || param.allow_blank?
-          call_method(param.name, value)
+          merge_relation!(send(param.name, value))
         end
       end
-
-      @relation
     end
 
     def fetch_criteria(name)
@@ -41,17 +56,28 @@ module IIFinder
       end
     end
 
-    def call_method(name, value)
-      result = send(name, value)
-
-      if result.respond_to?(:merge) && Config.merge_relation
-        @relation = @relation.merge(result)
+    def merge_relation!(relation)
+      if relation.respond_to?(:merge) && Config.merge_relation
+        @relation = @relation.merge(relation)
       end
     end
 
     class_methods do
       def call(*args)
-        new(*args).call
+        finder = new(*args).tap(&:call_all)
+        finder.context.relation
+      end
+    end
+
+    class << self
+      def resolve_args(finder, *args)
+        if args.size == 0 || args.size == 1
+          model = finder.class.lookup
+          raise IIFinder::Error.new("could not find model for #{finder.class}") unless model
+          return model.all,  args[0] || {}
+        else
+          return args[0], args[1]
+        end
       end
     end
   end

data/lib/ii_finder/instrumentation.rb

@@ -4,6 +4,11 @@ module IIFinder
   module Instrumentation
     extend ActiveSupport::Concern
 
+    def call_all
+      ActiveSupport::Notifications.instrument 'calling.ii_finder', finder: self
+      super
+    end
+
     def call
       ActiveSupport::Notifications.instrument 'call.ii_finder', finder: self do
         super

data/lib/ii_finder/log_subscriber.rb

@@ -2,13 +2,22 @@
 
 module IIFinder
   class LogSubscriber < ActiveSupport::LogSubscriber
+    def calling(event)
+      debug do
+        finder = event.payload[:finder]
+        "Calling #{finder.class} with #{finder.context}"
+      end
+    end
+
     def call(event)
       debug do
         finder = event.payload[:finder]
-        "Called #{finder.class} with #{finder.criteria} (#{additional_log(event)})"
+        "Called #{finder.class} (#{additional_log(event)})"
       end
     end
 
+    private
+
     def additional_log(event)
       additions = ["Duration: %.1fms" % event.duration]
       additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)

data/lib/ii_finder/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module IIFinder
+  class Railtie < Rails::Railtie
+    ActiveSupport::Reloader.to_prepare do
+      IIFinder::Lookup.cache.clear
+    end
+  end
+end

data/lib/ii_finder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIFinder
-  VERSION = '1.1.2'
+  VERSION = '2.1.0'
 end

data/lib/ii_finder.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'coactive'
 
 require 'ii_finder/version'
 require 'ii_finder/config'
@@ -6,6 +7,7 @@ require 'ii_finder/errors'
 require 'ii_finder/base'
 require 'ii_finder/scope'
 require 'ii_finder/log_subscriber'
+require 'ii_finder/railtie' if defined?(Rails)
 
 module IIFinder
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_finder
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coactive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -116,11 +130,15 @@ files:
 - gemfiles/rails52.gemfile
 - gemfiles/rails60.gemfile
 - gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - ii_finder.gemspec
 - lib/ii_finder.rb
 - lib/ii_finder/base.rb
 - lib/ii_finder/callbacks.rb
+- lib/ii_finder/coactors.rb
 - lib/ii_finder/config.rb
+- lib/ii_finder/context.rb
+- lib/ii_finder/contextualizer.rb
 - lib/ii_finder/core.rb
 - lib/ii_finder/errors.rb
 - lib/ii_finder/instrumentation.rb
@@ -128,6 +146,7 @@ files:
 - lib/ii_finder/lookup.rb
 - lib/ii_finder/parameter.rb
 - lib/ii_finder/parameters.rb
+- lib/ii_finder/railtie.rb
 - lib/ii_finder/scope.rb
 - lib/ii_finder/version.rb
 homepage: https://github.com/kanety/ii_finder