cat_tree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4a536bc23956e61a60529f845b14fcef498f05a
+  data.tar.gz: fb7863349ba46fd6bc5c716821f2dede4a944cfd
+SHA512:
+  metadata.gz: dffce9f4cc59207c5250e6665264c8a43012ebefa8fdbd0ca77658e169f2c98e2d55478e5f1d2578c31e23a2a0aed5e20777b4e21badd5b1e55ca09bad8e45a6
+  data.tar.gz: 67e5e948910397d2b1eee3b088cffd0749b2b6b1a269b77c1a8e17bd2b73bf8ab756c47d19e08612526a056f8f37f983eb8b8a69a7cd99dcebcd23630fddf191

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+bundle
+gemfiles/*.lock

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails3" do
+  gem "activerecord", "~> 3.2.0"
+end
+
+appraise "rails40" do
+  gem "activerecord", "~> 4.0.0"
+end
+
+appraise "rails41" do
+  gem "activerecord", "~> 4.1.0"
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cat_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tsukasa OISHI
+
+MIT License
+
+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,74 @@
+# CatTree
+
+CatTree monitors ActiveRecord objects in development environment the number of objects and the number of same objects.
+It helps you decrease waste of memory and increase application performance.
+
+![CatTree](http://s3-ap-northeast-1.amazonaws.com/kaeruspoon/images/110/large.JPG?1328342672)
+
+
+## Usage
+
+You can be used by simply installing.
+CatTree notifies the result analyzing ActiveRecord objects. Look at the Rails log when Rails action finished.
+
+```
+Started GET "/top" for xxx.xxx.xxx.xxx at yyyy
+Processing by TopController#index as HTML
+  Parameters: {}
+  ....
+
+[CatTree]
+  ActiveRecord::Base:     102
+  Same objects:
+    User(id:12):  2
+      /Users/tsukasa/dev/kaeruspoon/app/controllers/top_controller.rb:5:in `index'
+
+      /Users/tsukasa/dev/kaeruspoon/app/controllers/top_controller.rb:6:in `index'
+
+Completed 200 OK in 1121.8ms (Views: 899.0ms | ActiveRecord: 222.8ms)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cat_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cat_tree
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cat_tree/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Test
+
+I'm glad that you would do test!
+To run the test suite, you need mysql installed.
+How to setup your test environment.
+
+
+```bash
+bundle install --path bundle
+GEM_HOME=bundle/ruby/(your ruby version) gem install bundler --pre
+bundle exec appraisal install
+```
+
+This command run the spec suite for all rails versions supported.
+
+```base
+bundle exec appraisal rake spec
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cat_tree.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cat_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cat_tree"
+  spec.version       = CatTree::VERSION
+  spec.authors       = ["Tsukasa OISHI"]
+  spec.email         = ["tsukasa.oishi@gmail.com"]
+  spec.summary       = %q{CatTree monitors ActiveRecord objects in development environment}
+  spec.description   = %q{CatTree monitors ActiveRecord objects in development environment}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 3.2.0', '< 4.2'
+  spec.add_dependency 'activesupport', '>= 3.2.0', '< 4.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 2.14'
+  spec.add_development_dependency 'appraisal', '~> 1.0'
+  spec.add_development_dependency 'mysql2'
+end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/cat_tree/initializer.rb

@@ -0,0 +1,38 @@
+module CatTree
+  module Initializer
+    module ClassMethods
+      @@cat_tree_observer = {}
+
+      def add_cat_tree_observer(observer)
+        @@cat_tree_observer[Thread.current.object_id] = observer
+      end
+
+      def remove_cat_tree_observer
+        @@cat_tree_observer[Thread.current.object_id] = nil
+      end
+
+      def cat_tree_notice(object)
+        if cat_tree_observer = @@cat_tree_observer[Thread.current.object_id]
+          cat_tree_observer.notice(object)
+        end
+      end
+    end
+
+    module ArBase
+      def self.included(base)
+        base.after_initialize :cat_tree_notice
+        base.extend CatTree::Initializer::ClassMethods
+      end
+
+      private
+
+      def cat_tree_notice
+        self.class.cat_tree_notice(self)
+      end
+    end
+
+    def self.extend_active_record
+      ActiveRecord::Base.__send__(:include, Initializer::ArBase)
+    end
+  end
+end

data/lib/cat_tree/logger.rb

@@ -0,0 +1,12 @@
+module CatTree
+  class Logger
+    class << self
+      attr_writer :logger
+
+      def warn(message)
+        return unless @logger
+        @logger.warn message
+      end
+    end
+  end
+end

data/lib/cat_tree/observer.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+require 'cat_tree/logger'
+
+module CatTree
+  class Observer
+    def self.check(&block)
+      self.new.check(&block)
+    end
+
+    def initialize
+      @ar_base = {}
+    end
+
+    def notice(object)
+      return if object.new_record?
+      key = "#{object.class.name}(id:#{object.id})"
+      @ar_base[key] ||= {:count => 0, :callers => []}
+      @ar_base[key][:count] += 1
+      if defined?(Rails)
+        root_path = Rails.root.to_s
+        root_path += "/" unless root_path.last == "/"
+        cal = caller.select{|c| c =~ %r!#{root_path}(app|lib)/!}
+        @ar_base[key][:callers] << cal unless cal.empty?
+      else
+        @ar_base[key][:callers] << caller
+      end
+    end
+
+    def ar_base_count
+      @ar_base.values.inject(0){|t,v| t + v[:count]}
+    end
+
+    def same_ar_base_objects
+      Hash[*(@ar_base.select{|k,v| v[:count] > 1}.flatten)]
+    end
+
+    def check
+      ActiveRecord::Base.add_cat_tree_observer(self)
+      yield
+    ensure
+      ActiveRecord::Base.remove_cat_tree_observer
+      output_message
+    end
+
+    private
+
+    def output_message
+      return if @ar_base.empty?
+
+      msg = ["", "[CatTree]"]
+      msg << "  ActiveRecord::Base:\t#{ar_base_count}"
+
+      unless (same_objects = same_ar_base_objects).empty?
+        msg << "  Same objects:"
+        same_objects.keys.sort_by{|k| same_objects[k][:count]}.reverse.each do |key|
+          msg << "    #{key}:\t#{same_objects[key][:count]}"
+          same_objects[key][:callers].each do |cal|
+            cal.each{|c| msg << "      #{c}"}
+            msg << ""
+          end
+        end
+      end
+      msg << ""
+
+      Logger.warn msg.join("\n")
+    end
+  end
+end

data/lib/cat_tree/rack.rb

@@ -0,0 +1,15 @@
+require 'cat_tree/observer'
+
+module CatTree
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Observer.check do
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/cat_tree/railtie.rb

@@ -0,0 +1,17 @@
+require "cat_tree/rack"
+require "cat_tree/initializer"
+require "cat_tree/logger"
+require 'rails'
+
+module CatTree
+  class Railtie < Rails::Railtie
+    initializer "cat_tree.configure_rails_initialization" do |app|
+      app.config.app_middleware.use  CatTree::Rack
+      CatTree::Logger.logger = Rails.logger
+
+      ActiveSupport.on_load(:active_record) do
+        Initializer.extend_active_record
+      end
+    end
+  end
+end

data/lib/cat_tree/version.rb

@@ -0,0 +1,3 @@
+module CatTree
+  VERSION = "0.0.1"
+end

data/lib/cat_tree.rb

@@ -0,0 +1,5 @@
+require "cat_tree/version"
+require "cat_tree/initializer"
+require "cat_tree/observer"
+require "cat_tree/rack"
+require "cat_tree/railtie" if defined?(Rails)

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+ENV["RAILS_ENV"]="test"
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'logger'
+require 'cat_tree'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'mysql2',
+  :encoding => 'utf8',
+  :reconnect => false,
+  :database => 'cat_tree_test',
+  :username => 'root',
+  :pool =>  5,
+  :timeout => 5000
+)
+
+module TruncateTable
+  def truncate
+    connection.execute("TRUNCATE TABLE #{table_name}")
+  end
+end
+
+class User < ActiveRecord::Base
+  extend TruncateTable
+  has_many :articles
+end
+
+class Article < ActiveRecord::Base
+  extend TruncateTable
+  belongs_to :user
+end
+
+CatTree::Initializer.extend_active_record

data/spec/unit/observer_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe CatTree::Observer do
+  before do
+    User.truncate
+    Article.truncate
+
+    u = User.create(:name => "cat_tree")
+    u.articles.create(:title => "title1")
+    u.articles.create(:title => "title2")
+    u2 = User.create(:name => "cat_tree2")
+    u2.articles.create(:title => "title3")
+    @number_of_object = rand(10) + 1
+  end
+
+  context "#check" do
+    it "count to find AR::Base object" do
+      observer = CatTree::Observer.new
+      observer.check do
+        @number_of_object.times { User.where(:name => "cat_tree").first }
+      end
+
+      expect(observer.ar_base_count).to eq(@number_of_object)
+    end
+
+    it "count to find AR::Base object with association" do
+      observer = CatTree::Observer.new
+      observer.check do
+        @number_of_object.times { User.includes(:articles).where(:name => "cat_tree").first }
+      end
+
+      expect(observer.ar_base_count).to eq(@number_of_object * 3)
+    end
+
+    it "count same AR:Base object" do
+      @number_of_object += 1
+      observer = CatTree::Observer.new
+      observer.check do
+        User.new
+        User.create(:name => "dummy")
+        @number_of_object.times do
+          User.includes(:articles).where(:name => "cat_tree").first
+        end
+      end
+
+      result = observer.same_ar_base_objects
+      expect(result.size).to eq(3)
+      result.each do |key, value|
+        expect(["User(id:1)", "Article(id:1)", "Article(id:2)"]).to include(key)
+        expect(value[:count]).to eq(@number_of_object)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: cat_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tsukasa OISHI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: CatTree monitors ActiveRecord objects in development environment
+email:
+- tsukasa.oishi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cat_tree.gemspec
+- gemfiles/rails3.gemfile
+- gemfiles/rails40.gemfile
+- gemfiles/rails41.gemfile
+- lib/cat_tree.rb
+- lib/cat_tree/initializer.rb
+- lib/cat_tree/logger.rb
+- lib/cat_tree/observer.rb
+- lib/cat_tree/rack.rb
+- lib/cat_tree/railtie.rb
+- lib/cat_tree/version.rb
+- spec/cat_tree_test.sqlite3
+- spec/spec_helper.rb
+- spec/unit/observer_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: CatTree monitors ActiveRecord objects in development environment
+test_files:
+- spec/cat_tree_test.sqlite3
+- spec/spec_helper.rb
+- spec/unit/observer_spec.rb