birth_control 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3904cd8ccfa1d3999f2ff5611bce9e262a09f6b2
+  data.tar.gz: a1c6f5c1995106164acee1dd712aed0747ac1f66
+SHA512:
+  metadata.gz: 0d97df7b6818906dc7c538f703190ab7bfd82b12f026d4bd09f15895b1e13f2a386e365ad6b1f12cf7ee691570164e8564b2d12b0312dfc6f359239c46039d76
+  data.tar.gz: 19803e430038e1ab9fc303ad3669bc820de8bb948d1170bb3dcfee498b19b143f64f4ee8c28089de068a3a28086206bed6bc6cfa7954691b2aca898fe832517f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+birth_control

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 2.0.0
+
+script: "bundle exec rspec"
+
+notifications:
+  disabled: false
+  recipients:
+    - xijo@gmx.de

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (c) 2013 Johannes Opper
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,62 @@
+# BirthControl
+
+Count active record instantiations and report them to the log.
+
+[![Build Status](https://secure.travis-ci.org/xijo/birth_control.png)](http://travis-ci.org/xijo/birth_control)
+
+[![Coderwall Endorse](http://api.coderwall.com/xijo/endorsecount.png)](http://coderwall.com/xijo)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'birth_control', groups: [:development]
+
+And then execute:
+
+    $ bundle
+
+After bundling you'll need to enable the logging by putting this line into your development environment:
+
+    BirthControl.enable = true
+
+## Usage
+
+Two new reports will be logged into your rails log:
+
+1. The class instantiation report - count all active record objects by class and in total
+2. Duplication report - reveals where active record objects were loaded more than once
+
+### Example reports:
+
+This example show the result of a project detail page. You can see, that there were 5 project instantiations but always the same project. The first two may be necassary, but the later 3 could have been avoided.
+
+    *** [BirthControl] Class instantiation overview ***
+        5 Projects
+       20 ProjectPictures
+        2 Users
+        1 Countries
+        3 BlogPosts
+       30 Total
+
+    *** [BirthControl] Duplicate instantiation detected ***
+
+    Project(42) - 5 times
+      1. app/controllers/projects_controller.rb:27:in `load_project_for_caching'
+      2. app/controllers/projects_controller.rb:13:in `show'
+      3. app/views/projects/_blog_post.html.slim:3:in `...'
+      4. app/views/projects/_blog_post.html.slim:3:in `...'
+      5. app/views/projects/_blog_post.html.slim:3:in `...'
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Changelog
+
+**0.0.1** (*2013-11-16*)
+* Initial import, basic reports

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/birth_control.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'birth_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "birth_control"
+  spec.version       = BirthControl::VERSION
+  spec.authors       = ["Johannes Opper"]
+  spec.email         = ["xijo@gmx.de"]
+  spec.description   = %q{Count active record instantiations and report them to the log}
+  spec.summary       = %q{Count active record instantiations and report them to the log}
+  spec.homepage      = "http://github.com/xijo/birth_control"
+  spec.license       = "WTFPL"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'terminal-table'
+  spec.add_dependency 'actionpack'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/birth_control.rb

@@ -0,0 +1,21 @@
+require 'active_support'
+require 'terminal-table'
+require 'singleton'
+
+module BirthControl
+  def self.enable=(enable)
+    @enabled = enable
+  end
+
+  def self.enabled?
+    !!@enabled
+  end
+end
+
+require 'birth_control/extensions/active_record'
+require 'birth_control/extensions/controller'
+require 'birth_control/counter'
+require 'birth_control/railtie' if defined?(Rails)
+require 'birth_control/report'
+require 'birth_control/version'
+

data/lib/birth_control/counter.rb

@@ -0,0 +1,22 @@
+module BirthControl
+  class Counter
+    include Singleton
+
+    attr_accessor :results
+
+    def initialize
+      reset
+    end
+
+    def count(klass, id, caller = [])
+      @results[klass] ||= {}
+      @results[klass][id] ||= []
+      @results[klass][id] << caller
+      @results
+    end
+
+    def reset
+      @results = {}
+    end
+  end
+end

data/lib/birth_control/extensions/active_record.rb

@@ -0,0 +1,15 @@
+module BirthControl
+  module Extensions
+    module ActiveRecord
+      extend ActiveSupport::Concern
+
+      included do
+        after_initialize :count_class_instantiation
+      end
+
+      def count_class_instantiation
+        BirthControl::Counter.instance.count(self.class.name, id, caller)
+      end
+    end
+  end
+end

data/lib/birth_control/extensions/controller.rb

@@ -0,0 +1,20 @@
+module BirthControl
+  module Extensions
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :reset_birth_control
+        after_filter  :birth_control_report
+      end
+
+      def reset_birth_control
+        BirthControl::Counter.instance.reset
+      end
+
+      def birth_control_report
+        Rails.logger.warn BirthControl::Report.new(BirthControl::Counter.instance.results)
+      end
+    end
+  end
+end

data/lib/birth_control/railtie.rb

@@ -0,0 +1,10 @@
+module BirthControl
+  class Railtie < Rails::Railtie
+    initializer 'birth_control.initialize_extensions' do
+      if BirthControl.enabled?
+        ActiveRecord::Base.send     :include, BirthControl::Extensions::ActiveRecord
+        ActionController::Base.send :include, BirthControl::Extensions::Controller
+      end
+    end
+  end
+end

data/lib/birth_control/report.rb

@@ -0,0 +1,59 @@
+module BirthControl
+  class Report
+    def initialize(results)
+      @results = results
+    end
+
+    def count_class_and_id(klass, id)
+      @results[klass][id].size
+    end
+
+    def count_class(klass)
+      @results[klass].inject(0) { |c, (id, _)| c + count_class_and_id(klass, id) }
+    end
+
+    def count
+      @results.inject(0) { |c, (klass, _)| c + count_class(klass) }
+    end
+
+    def duplication_report
+      lines = []
+
+      @results.each do |klass, entries|
+        entries.each do |id, callers|
+          if callers.size > 1
+            lines << "\n#{klass}(#{id}) - #{callers.size} times"
+            callers.each_with_index do |caller, index|
+              occurence = caller.detect { |call| call.match(/app\//) }
+              occurence.sub!(/(.*)\/app\//, 'app/')
+              lines << "  #{index+1}. #{occurence}"
+            end
+          end
+        end
+      end
+      if lines.size > 0
+        lines.unshift "*** [BirthControl] Duplicate instantiation detected ***"
+        lines.join("\n") + "\n"
+      end
+    end
+
+    def class_instantiation_report
+      lines = ["*** [BirthControl] Class instantiation overview ***"]
+      @results.each do |klass, _|
+        count = "%5s" % count_class(klass)
+        lines << "#{count} #{klass.pluralize}"
+      end
+      lines << "#{"%5s" % count} Total"
+      lines.join("\n") + "\n"
+    end
+
+    def to_s
+      lines = [
+        '[BirthControl]',
+        class_instantiation_report,
+        duplication_report
+      ]
+      lines.join "\n"
+    end
+  end
+end

data/lib/birth_control/version.rb

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

data/spec/lib/birth_control/counter_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe BirthControl::Counter do
+
+  let(:counter) { BirthControl::Counter.instance }
+  after         { counter.reset }
+
+  it 'behaves as singleton' do
+    counter.should eq BirthControl::Counter.instance
+  end
+
+  describe '#reset' do
+    it 'removes all existing results' do
+      counter.results = :something
+      counter.reset
+      counter.results.should eq({})
+    end
+  end
+
+  describe '#count' do
+    it 'groups results by class' do
+      counter.count('Foo', 1)
+      counter.count('Bar', 1)
+      counter.results.should have(2).keys
+    end
+
+    it 'counts different ids per class' do
+      counter.count 'Foo', 1
+      counter.count 'Foo', 2
+      counter.results['Foo'].should have(2).keys
+    end
+
+    it 'groups multiple occurencies of the same id' do
+      counter.count('Foo', 1)
+      counter.count('Foo', 1)
+      counter.results['Foo'][1].should have(2).entries
+    end
+  end
+
+end

data/spec/lib/birth_control/report_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe BirthControl::Report do
+  let(:results) do
+    {
+      'Project' => {
+        1 => [['somewhere/app/models/project.rb:123'], ['somewhere/lib/project_counter.rb:1']],
+        2 => [['somewhere/app/models/project.rb:123']]
+      },
+      'User' => {
+        1 => [['somewhere/app/controllers/sessions_controller.rb:1']],
+      }
+    }
+  end
+  let(:report) { BirthControl::Report.new(results) }
+
+  it '#count returns total of all counted objects' do
+    report.count_class_and_id('Project', 1).should eq 2
+    report.count_class('Project').should eq 3
+    report.count.should eq 4
+  end
+
+end

data/spec/lib/birth_control_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe BirthControl do
+
+  it '#enable= works as intended' do
+    BirthControl.enable = false
+    BirthControl.should_not be_enabled
+    BirthControl.enable = true
+    BirthControl.should be_enabled
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+
+SimpleCov.adapters.define 'gem' do
+  add_filter '/spec/'
+  add_group 'Libraries', '/lib/'
+end
+SimpleCov.start 'gem'
+
+require 'birth_control'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: birth_control
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Johannes Opper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Count active record instantiations and report them to the log
+email:
+- xijo@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- birth_control.gemspec
+- lib/birth_control.rb
+- lib/birth_control/counter.rb
+- lib/birth_control/extensions/active_record.rb
+- lib/birth_control/extensions/controller.rb
+- lib/birth_control/railtie.rb
+- lib/birth_control/report.rb
+- lib/birth_control/version.rb
+- spec/lib/birth_control/counter_spec.rb
+- spec/lib/birth_control/report_spec.rb
+- spec/lib/birth_control_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/xijo/birth_control
+licenses:
+- WTFPL
+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.3
+signing_key: 
+specification_version: 4
+summary: Count active record instantiations and report them to the log
+test_files:
+- spec/lib/birth_control/counter_spec.rb
+- spec/lib/birth_control/report_spec.rb
+- spec/lib/birth_control_spec.rb
+- spec/spec_helper.rb