model_observer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cefc88cdbb1e00c4b1550cb9f45edcc6b0fd078
-  data.tar.gz: a0798211619936ad40912908f92ba157423c0695
+  metadata.gz: 1b2f28ed4ce8f3ca08a0174cffe2efa8f204cc8f
+  data.tar.gz: b7645d137b2c89cf2c62bc402f29d927f53edc95
 SHA512:
-  metadata.gz: 96c0cf861d126fb6be493c7ee17cc4dc9090775187cb7d49c01bbd34ff77a310b8a81b6038b3af8453b78075ad66685c4a6c4994b6df25d53f6fa99d3e69a6f0
-  data.tar.gz: 3182a0ed8c4cb77aadddeaafb5a971eb2e22f6a39123c6439ea083446de315dee9f5ae44e967e06af73880d63e53a01b8f4888ad63e8add7c3dc54d06312f3da
+  metadata.gz: 0971e467136f4ca7d050f78f52b27abe59462a34cf56c347a869ba6d8a99c2c9449ea9daad424ed16f74d244af35bede5fbb6f9fc0bf003ac7d2929fb60c121e
+  data.tar.gz: b0ad80b30466713bd869148efaf71cf039856ccee8e0384f6303647fec5ff9c405e20f2917e87e077010611f50b28d56ab23299ff247ff1f6ef9a2e57a336e67

data/README.md

@@ -16,18 +16,18 @@ and bundle
 
     bundle
 
-## Query Log
+## Configuration
 
-The time include instantiate models will be logged after each sql log like this:
+Initialize ModelObserver at `config/environments/development.rb` with the following code:
 
-    Author Load (0.5ms)  SELECT `authors`.* FROM `authors` WHERE `authors`.`id` = 1 LIMIT 1
-    Author Instantiate (1.5ms)  SELECT `authors`.* FROM `authors` WHERE `authors`.`id` = 1 LIMIT 1
-
-1.5ms == 0.5ms(DB query) + 1.0ms(model instantiation)
+    config.after_initialize do
+      ModelObserver.summary = true
+      ModelObserver.instantiation_log = true
+    end
 
 ## Summary Log
 
-The summary of each request will be added to the end like this:
+The summary of each request will be appended to the end like this:
 
     ===== Model Observer Start =====
     Author: 1 sum(10.6ms) avg(10.6ms)
@@ -42,3 +42,14 @@ The summary of each request will be added to the end like this:
       id(507): 3
       id(536): 3
     ===== Model Observer End =======
+
+`id(319): 3` means the models with same class(Book) and same id(319) have been instantiated three times.
+
+## Instantiation Log
+
+The duration include query and instantiate models will be logged after each sql log like this:
+
+    Author Load (0.5ms)  SELECT `authors`.* FROM `authors` WHERE `authors`.`id` = 1 LIMIT 1
+    Author Instantiate (1.5ms)  SELECT `authors`.* FROM `authors` WHERE `authors`.`id` = 1 LIMIT 1
+
+1.5ms == 0.5ms(DB query) + 1.0ms(model instantiation)

data/lib/model_observer.rb

@@ -9,20 +9,43 @@ module ModelObserver
   autoload :Analyser, 'model_observer/analyser'
   autoload :Rack, 'model_observer/rack'
 
-  if active_record?
-    if active_record4?
-      autoload :ActiveRecord, 'model_observer/active_record4'
-      ModelObserver::ActiveRecord.enable
-    elsif active_record3?
-      autoload :ActiveRecord, 'model_observer/active_record3'
-      ModelObserver::ActiveRecord.enable
-    else
-      raise "Current version of active_record is not supported."
-    end
-    require 'model_observer/log_subscriber'
-  end
+  attr_writer :summary, :instantiation_log
 
   class << self
+    def summary?
+      @summary
+    end
+
+    def instantiation_log?
+      @instantiation_log
+    end
+
+    def summary=(bool)
+      @summary = bool
+      if summary?
+        if active_record?
+          if active_record4?
+            autoload :ActiveRecord, 'model_observer/active_record4'
+            ModelObserver::ActiveRecord.enable
+          elsif active_record3?
+            autoload :ActiveRecord, 'model_observer/active_record3'
+            ModelObserver::ActiveRecord.enable
+          else
+            raise "Current version of active_record is not supported."
+          end
+        end
+      end
+    end
+
+    def instantiation_log=(bool)
+      @instantiation_log = bool
+      if instantiation_log?
+        if active_record?
+          require 'model_observer/log_subscriber'
+        end
+      end
+    end
+
     def start_request
     end
 

data/lib/model_observer/active_record3.rb

@@ -1,27 +1,22 @@
 module ModelObserver
   module ActiveRecord
-    def self.enable
-      require 'active_record'
-
-      ::ActiveRecord::Inheritance::ClassMethods.class_eval do
-        alias_method :origin_instantiate, :instantiate
-
-        def instantiate(record)
-          started_at = Time.now
-          instance = origin_instantiate(record)
-          ModelObserver::Collector.add_metric(ModelObserver::Metric.new(instance, started_at, Time.now))
-          instance
-        end
+    class << self
+      def enable
+        require 'active_record'
+        require 'model_observer/querying'
+        overwrite_instantiate
       end
 
-      ::ActiveRecord::Querying.class_eval do
-        alias_method :origin_find_by_sql, :find_by_sql
+      def overwrite_instantiate
+        ::ActiveRecord::Inheritance::ClassMethods.class_eval do
+          alias_method :origin_instantiate, :instantiate
 
-        def find_by_sql(sql, binds = [])
-          ::ActiveSupport::Notifications.instrumenter.instrument(
-            "instantiate.model_observer",
-            :sql   => connection.to_sql(sanitize_sql(sql), binds),
-            :name  => "#{name} Instantiate") { origin_find_by_sql(sql, binds) }
+          def instantiate(record)
+            started_at = Time.now
+            instance = origin_instantiate(record)
+            ModelObserver::Collector.add_metric(ModelObserver::Metric.new(instance, started_at, Time.now))
+            instance
+          end
         end
       end
     end

data/lib/model_observer/active_record4.rb

@@ -1,27 +1,22 @@
 module ModelObserver
   module ActiveRecord
-    def self.enable
-      require 'active_record'
-
-      ::ActiveRecord::Persistence::ClassMethods.class_eval do
-        alias_method :origin_instantiate, :instantiate
-
-        def instantiate(record, column_types = {})
-          started_at = Time.now
-          instance = origin_instantiate(record, column_types)
-          ModelObserver::Collector.add_metric(ModelObserver::Metric.new(instance, started_at, Time.now))
-          instance
-        end
+    class << self
+      def enable
+        require 'active_record'
+        require 'model_observer/querying'
+        overwrite_instantiate
       end
 
-      ::ActiveRecord::Querying.class_eval do
-        alias_method :origin_find_by_sql, :find_by_sql
+      def overwrite_instantiate
+        ::ActiveRecord::Persistence::ClassMethods.class_eval do
+          alias_method :origin_instantiate, :instantiate
 
-        def find_by_sql(sql, binds = [])
-          ::ActiveSupport::Notifications.instrumenter.instrument(
-            "instantiate.model_observer",
-            :sql   => connection.to_sql(sanitize_sql(sql), binds),
-            :name  => "#{name} Instantiate") { origin_find_by_sql(sql, binds) }
+          def instantiate(record, column_types = {})
+            started_at = Time.now
+            instance = origin_instantiate(record, column_types)
+            ModelObserver::Collector.add_metric(ModelObserver::Metric.new(instance, started_at, Time.now))
+            instance
+          end
         end
       end
     end

data/lib/model_observer/analyser.rb

@@ -6,13 +6,21 @@ module ModelObserver
         Collector.metrics_hash.each do |key, value|
           sum_duration = value.map(&:duration).sum
           average_duration = sum_duration / value.count
-          text << "#{key}: #{value.count} sum(#{sum_duration.round(1)}ms) avg(#{average_duration.round(1)}ms)\n"
+          text << "#{key}: #{value.count} #{sum_text(sum_duration)} #{average_text(average_duration)}\n"
           text << analyse_single_class(value)
         end
         text.sub!(/\n$/, '')
         text
       end
 
+      def sum_text(sum_duration)
+        "sum(#{sum_duration.round(1)}ms)"
+      end
+
+      def average_text(average_duration)
+        "avg(#{average_duration.round(1)}ms)"
+      end
+
       def analyse_single_class(metrics)
         return if metrics.empty?
         primary_key = metrics.first.model_class.primary_key

data/lib/model_observer/metric.rb

@@ -4,7 +4,7 @@ module ModelObserver
 
     def initialize(model, started_at, ended_at)
       @model_class = model.class
-      @model_id = model.__send__(model.class.primary_key)
+      @model_id = model.__send__(model.class.primary_key) if model.class.primary_key
       @started_at = started_at
       @ended_at = ended_at
     end

data/lib/model_observer/querying.rb

@@ -1,14 +1,10 @@
-module ModelObserver
-  module Querying
-    ::ActiveRecord::Querying.class_eval do
-      alias_method :origin_find_by_sql, :find_by_sql
+::ActiveRecord::Querying.class_eval do
+  alias_method :origin_find_by_sql, :find_by_sql
 
-      def find_by_sql(sql, binds = [])
-        ::ActiveSupport::Notifications.instrumenter.instrument(
-          "instantiate.active_record",
-          :sql   => sql,
-          :name  => "#{name} Load") { origin_find_by_sql }
-      end
-    end
+  def find_by_sql(sql, binds = [])
+    ActiveSupport::Notifications.instrumenter.instrument(
+      "instantiate.model_observer",
+      :sql   => connection.to_sql(sanitize_sql(sql), binds),
+      :name  => "#{name} Instantiate") { origin_find_by_sql(sql, binds) }
   end
 end

data/lib/model_observer/version.rb

@@ -1,3 +1,3 @@
 module ModelObserver
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_observer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Weihu Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Help to find out duplicated model object creations.