ii_finder 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3ba37c83b4bc3c8015d95bf52544ea29e90928948c0f5926946e8cb0c49bb3
-  data.tar.gz: c785e88d9b5c78e1a1409cedd805a2944d526de46d6b4acb22272c8c97d732a8
+  metadata.gz: 2fbbf6a8d97c83f3d098f3b13d93039491698409623d0137e0b170c83dedd58d
+  data.tar.gz: 9619799961e2416db17aca506f6ef596acd621b3fc1339aa82679b779d3f79e8
 SHA512:
-  metadata.gz: 67e33beb2d96672958062a58301da0ff1cc9bdb8855572c2e41fa41c685e08a7901d52e6c99df97fec2d986b8043cd59726bd1fbaf3d0c5790854d6720fc8c6d
-  data.tar.gz: 6b70c8f8620928ca1997e79f0178aaba61cd04abfedc5d2ff8e24b7296e9c4e0b7cfaa1be9c4bd05a42ee647e7a5d3c0a532a55e09e285fb362876a914c93470
+  metadata.gz: 577f3b00606d238e20a9d24075a92b9b5cdc10f170637e4e6bf6dc58db3bd04bf5de13a75da050af0b7a421d1dfe6bc91b4020188f38051394c39b81133b2fa0
+  data.tar.gz: abd2108a7892aa866ffc8d6a86545b61df42ce7b0c10af079e4272f5194e74be5f3c7146ed3ed671a96ea5eb6240edeabe77da8e51ab675b2a05427212bb2adf

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## 1.2.0
+
+* Add chain feature.
+
+## 1.1.2
+
+* Try fetch prior to calling instance method.
+
+## 1.1.1
+
+* Check arel_table existence for model.
+* Make mergeability check more flexible.
+
+## 1.1.0
+
+* Add log subscriber.
+
 ## 1.0.0
 
 * First release.

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,59 @@ 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!`.
 
+#### Chain
+
+You can chain multiple finders by using `chain`. 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
+  chain 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
+```
+
+You can also use method or block to find finder class dynamically:
+
+```ruby
+class ItemFinder < IIFinder::Base
+  chain -> { NameFinder }
+end
+
+class ItemFinder < IIFinder::Base
+  chain :chain_finder
+
+  def chain_finder
+    NameFinder
+  end
+end
+```
+
 ### Lookup for model
 
 Finder lookups related model by its class name when the first argument of `call` is not relation.
@@ -148,30 +193,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 +224,27 @@ 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
+
+Finder supports instrumentation hook supplied by `ActiveSupport::Notifications`.
+You can enable log subscriber as follows:
+
+```ruby
+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)
 ```
 
 ## Contributing

data/lib/ii_finder/base.rb

@@ -1,64 +1,19 @@
 # frozen_string_literal: true
 
-require_relative 'lookup'
+require_relative 'core'
 require_relative 'parameters'
 require_relative 'callbacks'
+require_relative 'instrumentation'
+require_relative 'lookup'
+require_relative 'chain'
 
 module IIFinder
   class Base
+    include Core
     include Parameters
     include Callbacks
+    include Instrumentation
     include Lookup
-
-    attr_reader :relation, :criteria, :model, :table
-
-    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] || {}
-      else
-        @relation = args[0]
-        @criteria = args[1]
-        @model = @relation.klass
-      end
-      @table = @model.arel_table
-    end
-
-    def call
-      run_callbacks :call do
-        self.class._parameters.each do |param|
-          value = fetch_criteria(param.name)
-          if value.present? || param.allow_blank?
-            call_method(param.name, value)
-          end
-        end
-      end
-
-      @relation
-    end
-
-    def fetch_criteria(name)
-      if @criteria.respond_to?(name)
-        @criteria.send(name)
-      elsif @criteria.respond_to?(:fetch)
-        @criteria.fetch(name, nil)
-      end
-    end
-
-    def call_method(name, value)
-      result = send(name, value)
-
-      if Config.merge_relation && result.is_a?(ActiveRecord::Relation)
-        @relation = @relation.merge(result)
-      end
-    end
-
-    class << self 
-      def call(*args)
-        new(*args).call
-      end
-    end
+    include Chain
   end
 end

data/lib/ii_finder/callbacks.rb

@@ -9,6 +9,12 @@ module IIFinder
       define_callbacks :call
     end
 
+    def call
+      run_callbacks :call do
+        super
+      end
+    end
+
     class_methods do
       def before_call(*args, &block)
         set_callback(:call, :before, *args, &block)

data/lib/ii_finder/chain.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Chain
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_chains
+      self._chains = []
+    end
+
+    def call
+      lookup.each do |finder|
+        merge_relation!(finder.call(*@_args))
+      end
+      super
+    end
+
+    def lookup
+      self.class._chains.map do |finder|
+        if finder.is_a?(Symbol) && respond_to?(finder, true)
+          send(finder)
+        elsif finder.is_a?(Proc)
+          instance_exec(&finder)
+        else
+          finder
+        end
+      end.flatten.compact
+    end
+
+    class_methods do
+      def chain(*finders, &block)
+        self._chains = _chains + finders
+        self._chains << block if block
+      end
+    end
+  end
+end

data/lib/ii_finder/core.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :relation, :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] || {}
+      else
+        @relation = args[0]
+        @criteria = args[1]
+        @model = @relation.klass
+      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?
+          merge_relation!(send(param.name, value))
+        end
+      end
+
+      @relation
+    end
+
+    def fetch_criteria(name)
+      if @criteria.respond_to?(:fetch)
+        @criteria.fetch(name, nil)
+      elsif @criteria.respond_to?(name)
+        @criteria.send(name)
+      end
+    end
+
+    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
+      end
+    end
+  end
+end

data/lib/ii_finder/instrumentation.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Instrumentation
+    extend ActiveSupport::Concern
+
+    def call
+      ActiveSupport::Notifications.instrument 'call.ii_finder', finder: self do
+        super
+      end
+    end
+  end
+end

data/lib/ii_finder/log_subscriber.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module IIFinder
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def call(event)
+      debug do
+        finder = event.payload[:finder]
+        "Called #{finder.class} with #{finder.criteria} (#{additional_log(event)})"
+      end
+    end
+
+    def additional_log(event)
+      additions = ["Duration: %.1fms" % event.duration]
+      additions << "Allocations: %d" % event.allocations if event.respond_to?(:allocations)
+      additions.join(', ')
+    end
+  end
+end

data/lib/ii_finder/lookup.rb

@@ -19,13 +19,13 @@ module IIFinder
     end
 
     class << self
-      class_attribute :_cache
-      self._cache = {}
+      class_attribute :cache
+      self.cache = {}
 
       def call(klass)
         return if terminate?(klass)
 
-        cache(klass) do
+        with_cache(klass) do
           if klass.name && (resolved = resolve(klass))
             resolved
           elsif klass.superclass
@@ -36,9 +36,9 @@ module IIFinder
 
       private
 
-      def cache(klass)
+      def with_cache(klass)
         if Config.lookup_cache
-          self._cache[klass] ||= yield
+          self.cache[klass] ||= yield
         else
           yield
         end

data/lib/ii_finder/version.rb

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

data/lib/ii_finder.rb

@@ -5,6 +5,7 @@ require 'ii_finder/config'
 require 'ii_finder/errors'
 require 'ii_finder/base'
 require 'ii_finder/scope'
+require 'ii_finder/log_subscriber'
 
 module IIFinder
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_finder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,8 +120,12 @@ files:
 - lib/ii_finder.rb
 - lib/ii_finder/base.rb
 - lib/ii_finder/callbacks.rb
+- lib/ii_finder/chain.rb
 - lib/ii_finder/config.rb
+- lib/ii_finder/core.rb
 - lib/ii_finder/errors.rb
+- lib/ii_finder/instrumentation.rb
+- lib/ii_finder/log_subscriber.rb
 - lib/ii_finder/lookup.rb
 - lib/ii_finder/parameter.rb
 - lib/ii_finder/parameters.rb