ii_finder 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3ba37c83b4bc3c8015d95bf52544ea29e90928948c0f5926946e8cb0c49bb3
-  data.tar.gz: c785e88d9b5c78e1a1409cedd805a2944d526de46d6b4acb22272c8c97d732a8
+  metadata.gz: 5e3dc926cc0da901131f8a10b84ae7a31815606384e5b37ab3caad85ad87cee3
+  data.tar.gz: 9217854b0fe479c182404a1137e4c95f1777d8a674fbb3f3b81bc744a1476652
 SHA512:
-  metadata.gz: 67e33beb2d96672958062a58301da0ff1cc9bdb8855572c2e41fa41c685e08a7901d52e6c99df97fec2d986b8043cd59726bd1fbaf3d0c5790854d6720fc8c6d
-  data.tar.gz: 6b70c8f8620928ca1997e79f0178aaba61cd04abfedc5d2ff8e24b7296e9c4e0b7cfaa1be9c4bd05a42ee647e7a5d3c0a532a55e09e285fb362876a914c93470
+  metadata.gz: 45ee75341deca673d350dadc0bc1c0be3e24b9a473261f26f5861310fced6d3b2b9237aaf484dac82d08339bbeb1e6a7e5bde7ddcca77d2cd1599ec03b849083
+  data.tar.gz: ad252f7de5a14f901aa2278d7a9b69732a198778608c3bdfb816f73e46ec435d18721cac57901890d722e3780bc03bc19735fe4df703612392bf82352053a661

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.1.0
+
+* Add log subscriber.
+
 ## 1.0.0
 
 * First release.

data/README.md

@@ -187,6 +187,21 @@ User.finder_scope(name: 'NAME').to_sql
 #=> SELECT "users".* FROM "users" WHERE "users"."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 UsersFinder with {:id=>1} (Duration: 9.9ms, Allocations: 915)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome at https://github.com/kanety/ii_finder.

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

data/lib/ii_finder/base.rb

@@ -1,64 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'lookup'
+require_relative 'core'
 require_relative 'parameters'
 require_relative 'callbacks'
+require_relative 'instrumentation'
+require_relative 'lookup'
 
 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
   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/core.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Core
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :relation, :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] || {}
+      else
+        @relation = args[0]
+        @criteria = args[1]
+        @model = @relation.klass
+      end
+      @table = @model.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)
+        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_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.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_finder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -121,7 +121,10 @@ files:
 - lib/ii_finder/base.rb
 - lib/ii_finder/callbacks.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