dirty_callbacks 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+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,37 @@
+= Dirty Callbacks
+
+Dirty callbacks is an active record plugin that adds some callbacks for tracking changes to fields.
+
+Currently, it adds two types of callbacks:
+  
+  before_field_changes_on_update & after_field_changed_on_update
+
+This allows you to hook a callback in to the save cycle that only gets called if a particular field is changed in the save.
+
+This is especially useful in conjunction with my {observational}[http://github.com/giraffesoft/observational] plugin.
+
+== Installation
+
+sudo gem install giraffesoft-dirty_callbacks
+
+== Usage
+
+To get dirty callbacks, you need to include the module in the model you want to use it in.
+
+Then, just declare the callbacks as normal:
+
+  class User < ActiveRecord::BAse
+    include DirtyCallbacks
+
+    before_email_changes_on_update :do_stuff
+
+    protected
+    def do_stuff
+      puts email_was
+      puts email
+    end
+  end
+
+== Copyright
+
+Copyright (c) 2009 James Golick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dirty_callbacks"
+    gem.summary = %Q{TODO}
+    gem.email = "james@giraffesoft.ca"
+    gem.homepage = "http://github.com/giraffesoft/dirty_callbacks"
+    gem.authors = ["James Golick"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dirty_callbacks #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/dirty_callbacks.rb

@@ -0,0 +1,19 @@
+module DirtyCallbacks
+  def self.included(klass)
+    klass.class_eval do
+      columns.each do |f|
+        f = f.name
+        define_callbacks :"before_#{f}_changes_on_update", :"after_#{f}_changed_on_update"
+
+        before_update do |o|
+          o.send :callback, :"before_#{f}_changes_on_update" if o.send :"#{f}_changed?"
+        end
+
+        after_update do |o|
+          o.send :callback, :"after_#{f}_changed_on_update" if o.send :"#{f}_changed?"
+        end
+      end
+    end
+  end
+end
+

data/spec/dirty_callbacks_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DirtyCallbacks" do
+  describe "callback before a changed field is saved - on update" do
+    before do
+      @user = User.create
+      User.send :before_email_changes_on_update, :do_stuff
+    end
+
+    it "should fire in the before_save_on_update callback if the field has chnaged" do
+      @user.email = "whatever"
+      @user.expects(:do_stuff)
+      @user.send :callback, :before_update
+    end
+
+    it "should not fire in the before_save_on_update callback if the field hasn't chnaged" do
+      @user.expects(:do_stuff).never
+      @user.send :callback, :before_update
+    end
+  end
+
+  describe "callback after a changed field is saved - on update" do
+    before do
+      @user = User.create
+      User.send :after_email_changed_on_update, :do_stuff
+    end
+
+    it "should fire in the after_update callback if the field has chnaged" do
+      @user.email = "whatever"
+      @user.expects(:do_stuff)
+      @user.send :callback, :after_update
+    end
+
+    it "should not fire in the after_update callback if the field hasn't chnaged" do
+      @user.expects(:do_stuff).never
+      @user.send :callback, :after_update
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'spec'
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_record'
+require 'dirty_callbacks'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string  :email,    :default => ''
+  end
+end
+
+class User < ActiveRecord::Base
+  include DirtyCallbacks
+end
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: dirty_callbacks
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/dirty_callbacks.rb
+- spec/dirty_callbacks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/giraffesoft/dirty_callbacks
+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.1
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- spec/dirty_callbacks_spec.rb
+- spec/spec_helper.rb