activerecord-callback_notification 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+gem "activesupport", ">= 3.1.0"
+gem "activerecord", ">= 3.1.0"
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+end
+group :test do
+  gem 'debugger'
+  gem "sqlite3"
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.4)
+      activesupport (= 3.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.4)
+      activemodel (= 3.1.4)
+      activesupport (= 3.1.4)
+      arel (~> 2.2.3)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.4)
+      multi_json (~> 1.0)
+    arel (2.2.3)
+    builder (3.0.0)
+    coderay (1.0.6)
+    columnize (0.3.6)
+    debugger (1.1.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1)
+      debugger-ruby_core_source (~> 1.1)
+    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.2)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    method_source (0.7.1)
+    multi_json (1.3.2)
+    pry (0.9.9.3)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (2.4.4)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.1.0)
+  activesupport (>= 3.1.0)
+  bundler (~> 1.1.0)
+  debugger
+  jeweler (~> 1.8.3)
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joshua Szmajda
+
+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,44 @@
+# activerecord-callback_notification
+
+This gem extends ActiveRecord to send an
+ActiveSupport::Notification for each normal ActiveRecord callback.
+
+## Usage
+
+    ActiveRecord::Base.notify_callbacks!
+
+will setup notifications on all ActiveRecord models. You can also use
+this in a single-model context, like:
+
+    class Foo < ActiveRecord::Base
+      notify_callbacks!
+    end
+
+Elsewhere you can subscribe to callbacks via
+
+    ActiveSupport::Notifications.subscribe(/^callback:/) do |*data|
+      # data is an array like
+      # [ callback name, start timestamp, end timestamp, some id, information hash ]
+      interesting_bit = data.last
+      interesting_bit[:object] == your_active_record_object
+      interesting_bit[:callback] == :the_callback # like :after_save or whatever
+    end
+
+This is primarily useful in a lazy/omniscient "observer-ish" context. You probably don't
+want to use this system to monitor specific models.
+
+## Contributing to activerecord-callback_notification
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Optoro, Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activerecord-callback_notification"
+  gem.homepage = "http://github.com/optoro/activerecord-callback_notification"
+  gem.license = "MIT"
+  gem.summary = %Q{Instruments all activerecord objects with notifications around callbacks}
+  gem.description = %Q{Instruments all activerecord objects with notifications around callbacks}
+  gem.email = "josh@optoro.com"
+  gem.authors = ["Joshua Szmajda"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord-callback_notification #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/activerecord-callback_notification.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord-callback_notification"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Szmajda"]
+  s.date = "2012-04-25"
+  s.description = "Instruments all activerecord objects with notifications around callbacks"
+  s.email = "josh@optoro.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "activerecord-callback_notification.gemspec",
+    "lib/activerecord-callback_notification.rb",
+    "spec/activerecord-callback_notification_spec.rb",
+    "spec/spec_helper.rb",
+    "test.db"
+  ]
+  s.homepage = "http://github.com/optoro/activerecord-callback_notification"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Instruments all activerecord objects with notifications around callbacks"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.1.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.1.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.1.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.1.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/activerecord-callback_notification.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+require 'active_record/base'
+require 'active_record/callbacks'
+
+module ActiveRecord
+  module CallbackNotifications
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def notify_callbacks!
+        ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+          next if callback.to_s =~ /^around_/
+          next unless respond_to?(callback)
+          callback_meth = :"_instrument_notifications_for_#{callback}"
+          next if respond_to?(callback_meth)
+          define_method callback_meth do |&block|
+            ActiveSupport::Notifications.instrument("callback:#{callback}",
+                                                    :object => self,
+                                                    :callback => callback
+                                                   )
+            true
+          end
+          send(callback, callback_meth)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include,  ActiveRecord::CallbackNotifications)

data/spec/activerecord-callback_notification_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class CreateStuff < ActiveRecord::Migration
+  def self.up
+    create_table "foos" do |t|
+      t.string "name"
+    end
+    create_table "bars" do |t|
+      t.string "x"
+    end
+  end
+end
+
+class Foo < ActiveRecord::Base; end
+class Bar < ActiveRecord::Base; end
+
+describe "ActiverecordCallbackNotification" do
+  before :all do
+    ActiveRecord::Base.notify_callbacks!
+    db = 'test.db'
+    File.unlink db if File.exists? db
+    ActiveRecord::Base.establish_connection(
+      :adapter => 'sqlite3',
+      :database => db
+    )
+
+    CreateStuff.up
+  end
+  before :all do
+    @notifications = []
+    ActiveSupport::Notifications.subscribe(/^callback:/) do |*data|
+      @notifications << data
+      true
+    end
+  end
+  before :each do
+    # clear array without messsing with pointer
+    @notifications.size.times {@notifications.shift}
+  end
+
+  it "allows the model to save" do
+    f = Foo.new(:name => "1")
+    f.save!
+  end
+
+  it "works for create" do
+    f = Foo.new(:name => "1")
+    f.save!
+    ac = @notifications.detect{|e| e[0] == 'callback:after_create'}
+    ac.should_not be_nil
+    ac.last[:object].should == f
+    ac.last[:callback].should == :after_create
+  end
+
+  it "works for another model" do
+    f = Bar.new(:x => "1")
+    f.save!
+    ac = @notifications.detect{|e| e[0] == 'callback:after_create'}
+    ac.should_not be_nil
+    ac.last[:object].should == f
+    ac.last[:callback].should == :after_create
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'activerecord-callback_notification'
+require 'pry'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-callback_notification
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Szmajda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &18676660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *18676660
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &18675620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *18675620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18674960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *18674960
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &18674080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *18674080
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &18673220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *18673220
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &18672420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *18672420
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &18671420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18671420
+description: Instruments all activerecord objects with notifications around callbacks
+email: josh@optoro.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- activerecord-callback_notification.gemspec
+- lib/activerecord-callback_notification.rb
+- spec/activerecord-callback_notification_spec.rb
+- spec/spec_helper.rb
+- test.db
+homepage: http://github.com/optoro/activerecord-callback_notification
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2541234766714767702
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Instruments all activerecord objects with notifications around callbacks
+test_files: []