model_observer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec8feeb3833a59b988c7d230d4495e688bb23daa
+  data.tar.gz: 7a5ea18696fc7397111ab8047a00a0c6931d80a3
+SHA512:
+  metadata.gz: c52ca71ef43463cedee183431c8c1e9cfb577c25869934cf4c66bca74628be653ba05bdb9e8a98e85ecec7a89f538fc0329b2a48f377979f9f20321f06f36555
+  data.tar.gz: e33777e428926ea72981bac2dfe9f97b81fe27a66f8953af896422c60fa19c9ceb17c63bc213f45ba63d9d0c87a87b76fc26b86ad1c22ad49fbde74c9e8491f0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Weihu Chen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# ModelObserver
+
+A rails plugin to count the model object creations between each request, and help to find out the duplication.
+
+[![Build Status](https://travis-ci.org/cctiger36/model_observer.png?branch=master)](https://travis-ci.org/cctiger36/model_observer) [![Code Climate](https://codeclimate.com/github/cctiger36/model_observer.png)](https://codeclimate.com/github/cctiger36/model_observer)
+
+## Installation
+
+Add to your Gemfile
+
+    group :development do
+      gem 'model_observer'
+    end
+
+and bundle
+
+    bundle
+
+## Log
+
+The ModelObserver log will look like:
+
+    ===== Model Observer Start =====
+    Author: 1 sum(10ms) avg(10ms)
+    Book: 36 sum(13ms) avg(0ms)
+      id(20): 2
+      id(50): 9
+      id(61): 4
+      id(68): 2
+      id(111): 2
+      id(123): 3
+      id(124): 3
+    ===== Model Observer End =====

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/lib/model_observer/active_record.rb

@@ -0,0 +1,17 @@
+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
+      end
+    end
+  end
+end

data/lib/model_observer/analyser.rb

@@ -0,0 +1,33 @@
+module ModelObserver
+  class Analyser
+    class << self
+      def result
+        text = ""
+        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}ms) avg(#{average_duration}ms)\n"
+          text << analyse_single_class(value)
+        end
+        text.sub!(/\n$/, '')
+        text
+      end
+
+      def analyse_single_class(metrics)
+        return if metrics.empty?
+        primary_key = metrics.first.model_class.primary_key
+        hash = {}
+        metrics.each do |m|
+          hash[m.model_id] ||= 0
+          hash[m.model_id] += 1
+        end
+        hash
+        text = ""
+        hash.sort_by{|key, value| key}.each do |key, value|
+          text << "  #{primary_key}(#{key}): #{value}\n" if value > 1
+        end
+        text
+      end
+    end
+  end
+end

data/lib/model_observer/collector.rb

@@ -0,0 +1,26 @@
+module ModelObserver
+  class Collector
+    class << self
+      def metrics
+        @@metrics ||= []
+      end
+
+      def add_metric(metric)
+        metrics << metric
+      end
+
+      def clear
+        @@metrics = nil
+      end
+
+      def metrics_hash
+        hash = {}
+        metrics.each do |m|
+          hash[m.model_class.name] ||= []
+          hash[m.model_class.name] << m
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/model_observer/dependency.rb

@@ -0,0 +1,12 @@
+module ModelObserver
+  module Dependency
+    def active_record?
+      @active_record ||= begin
+        require 'active_record'
+        true
+      rescue LoadError
+        false
+      end
+    end
+  end
+end

data/lib/model_observer/metric.rb

@@ -0,0 +1,16 @@
+module ModelObserver
+  class Metric
+    attr_accessor :model_class, :model_id, :started_at, :ended_at
+
+    def initialize(model, started_at, ended_at)
+      @model_class = model.class
+      @model_id = model.__send__(model.class.primary_key)
+      @started_at = started_at
+      @ended_at = ended_at
+    end
+
+    def duration
+      ((ended_at.to_f - started_at.to_f) * 1000).to_i
+    end
+  end
+end

data/lib/model_observer/rack.rb

@@ -0,0 +1,15 @@
+module ModelObserver
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      ModelObserver.start_request
+      response = @app.call(env)
+      ModelObserver.write_to_rails_log
+      ModelObserver.end_request
+      response
+    end
+  end
+end

data/lib/model_observer/railtie.rb

@@ -0,0 +1,7 @@
+module ModelObserver
+  class Railtie < Rails::Railtie
+    initializer "model_observer.configure_rails_initialization" do |app|
+      app.middleware.use ModelObserver::Rack
+    end
+  end
+end

data/lib/model_observer/version.rb

@@ -0,0 +1,3 @@
+module ModelObserver
+  VERSION = "0.1.0"
+end

data/lib/model_observer.rb

@@ -0,0 +1,31 @@
+require 'model_observer/dependency'
+require 'model_observer/railtie'
+
+module ModelObserver
+  extend Dependency
+
+  autoload :Metric, 'model_observer/metric'
+  autoload :Collector, 'model_observer/collector'
+  autoload :Analyser, 'model_observer/analyser'
+  autoload :Rack, 'model_observer/rack'
+
+  if active_record?
+    autoload :ActiveRecord, 'model_observer/active_record'
+    ModelObserver::ActiveRecord.enable
+  end
+
+  class << self
+    def start_request
+    end
+
+    def end_request
+      Collector.clear
+    end
+
+    def write_to_rails_log
+      Rails.logger.warn "===== Model Observer Start ====="
+      Rails.logger.warn Analyser.result
+      Rails.logger.warn "===== Model Observer End ====="
+    end
+  end
+end

data/lib/tasks/model_observer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :model_observer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: model_observer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Weihu Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails plugin to count the model object creations between each request,
+  and help to find out the duplication.
+email:
+- cctiger36@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/model_observer/active_record.rb
+- lib/model_observer/analyser.rb
+- lib/model_observer/collector.rb
+- lib/model_observer/dependency.rb
+- lib/model_observer/metric.rb
+- lib/model_observer/rack.rb
+- lib/model_observer/railtie.rb
+- lib/model_observer/version.rb
+- lib/model_observer.rb
+- lib/tasks/model_observer_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/cctiger36/model_observer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Help to find out duplicated model object creations.
+test_files: []