fear-of-callbacks 0.0.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jamie van Dyke
+
+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.rdoc

@@ -0,0 +1,42 @@
+= fear-of-callbacks
+
+Got a legacy app that has some spaghetti ActiveRecord callbacks?  Install this gem, and your log will fruitfully fill with juicy logging of the callback calls.
+
+== Install
+
+Add this to your Rails environment file, I recommend only development.rb
+
+    config.gem 'fear-of-callbacks'
+
+== Output
+
+Currently your log will fill with lines like the following.  Notice the preceeding equal signs, these allow you to grep for just these calls.  Example:
+
+    $ tail -f log/development.log | grep "=="
+    
+    == Callback => ListItem - after_initialize
+    == Callback => ListItem - before_validation
+    == Callback => ListItem - before_validation_on_create
+    == Callback => ListItem - validate
+    == Callback => ListItem - validate_on_create
+    == Callback => ListItem - after_validation
+    == Callback => ListItem - after_validation_on_create
+    == Callback => ListItem - before_save
+    == Callback => ListItem - before_create
+    == Callback => ListItem - after_create
+    == Callback => ListItem - after_save
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.  Although currently the tests aren't much to write home about.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jamie van Dyke. See LICENSE for details.

data/lib/fear-of-callbacks.rb

@@ -0,0 +1 @@
+require 'fear-of/callbacks'

data/lib/fear-of/callbacks.rb

@@ -0,0 +1,15 @@
+module FearOf
+  module Callbacks
+    
+    def self.included(base)
+      base.send :alias_method_chain, :run_callbacks, :logging
+    end
+    
+    def run_callbacks_with_logging(kind, options = {}, &block)
+      ActiveRecord::Base.logger.debug "== Callback => #{self.class} - #{kind}"
+      run_callbacks_without_logging(kind, options = {}, &block)
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, FearOf::Callbacks

data/test/callbacks_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class CallbacksTest < Test::Unit::TestCase
+  context "an active record class" do
+    setup do
+      @cheese = Cheese.new
+      @cheese.save
+    end
+
+    should "have included the FearOf::Callback module" do
+      assert @cheese.class.included_modules.include? FearOf::Callbacks
+      assert @cheese.respond_to? :run_callbacks_with_logging
+    end
+    
+    before_should "output to the default log when a callback has been called" do
+      ActiveRecord::Base.logger.expects(:screw_you).with("== CALLBACK before_save on nothing")
+    end
+    
+    should_change("the cheese count", :by => 1) { Cheese.count }
+  end
+end

data/test/models.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Base.establish_connection :adapter  => 'sqlite3', :database => File.join(File.dirname(__FILE__), 'test.db')
+ 
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :cheeses, :force => true do |t|
+      t.string :name
+    end
+  end
+end
+ 
+CreateSchema.suppress_messages { CreateSchema.migrate(:up) }
+ 
+class Cheese < ActiveRecord::Base
+  before_save :smell
+  
+  def smell
+    # Man, I whiff of feet, I'm obviously a damn good cheese!
+    # Oh, and I should output somethig to the log because of the callback logger
+    puts "SMELL!"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'activerecord'
+require 'models'
+require 'mocha'
+require 'test/unit'
+require 'shoulda'
+begin require 'redgreen'; rescue LoadError; end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fear-of-callbacks'
+
+class Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: fear-of-callbacks
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Jamie van Dyke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: " ActiveRecord has lots of callbacks like before_save, this gem logs all of the used ones to your log "
+email: jamie@fearoffish.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/fear-of-callbacks.rb
+- lib/fear-of/callbacks.rb
+- test/callbacks_test.rb
+- test/models.rb
+- test/test_helper.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/fearoffish/fear-of-callbacks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Activate logging of all your used ActiveRecord callback hooks
+test_files: 
+- test/callbacks_test.rb
+- test/models.rb
+- test/test_helper.rb