ii_finder 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af875699d606b3d6b00fc1dba12000c1eea5767d029b5bd125b10f7ef3cdabd
-  data.tar.gz: e865e05b213f6e69522d3d9df5b96b2d2bffed9cfe62dd15e9e3ad0e964677bb
+  metadata.gz: e9c42e9402b1850eb69b928c7ea83e978e3ccbe3b3356eb4e5b1d24edf9424ce
+  data.tar.gz: d22e81c3f0c1bd32b9637d8722b5c6007ae5bf2c27c9b880c2c3b90e88f23363
 SHA512:
-  metadata.gz: 89f8b24b33d997bf4f530673cf7066390864fbf3d4dbe56bd871edef522664febf803f4c06cd906a6792837dbb08336973c9f8538b2ca9c626f591d9939dee0c
-  data.tar.gz: 8d65c22603983ed0cbd3c7dccdcc349f8f8466be5bf76be8241e45c7181db63c6d36bed2eb5431323da5ad74a4935e12b6cceaad79f615e0660a4aab4f955d38
+  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,5 +1,13 @@
 # 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.

data/README.md

@@ -230,7 +230,9 @@ IIFinder::LogSubscriber.attach_to :ii_finder
 This subscriber will write logs in debug mode as the following example:
 
 ```
-Called ItemsFinder 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,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
-  spec.add_dependency "coactive", ">= 0.1"
+  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,8 @@ require_relative 'parameters'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'lookup'
+require_relative 'context'
+require_relative 'contextualizer'
 require_relative 'coactors'
 
 module IIFinder
@@ -14,6 +16,7 @@ module IIFinder
     include Callbacks
     include Instrumentation
     include Lookup
+    include Contextualizer
     include Coactors
   end
 end

data/lib/ii_finder/callbacks.rb

@@ -6,18 +6,35 @@ 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
       end
-
-      @relation
     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

@@ -18,12 +18,5 @@ module IIFinder
         alias_method :chain, :coact
       end
     end
-
-    def call
-      coactors.each do |finder|
-        merge_relation!(finder.call(*@_args))
-      end
-      super
-    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,24 +3,40 @@
 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)
-      @_args = 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
@@ -30,8 +46,6 @@ module IIFinder
           merge_relation!(send(param.name, value))
         end
       end
-
-      @relation
     end
 
     def fetch_criteria(name)
@@ -50,7 +64,20 @@ module IIFinder
 
     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 = '2.0.1'
+  VERSION = '2.1.0'
 end

data/lib/ii_finder.rb

@@ -7,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: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -130,12 +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
@@ -143,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