association_callbacks 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.bundle
+.rbenv-version
+pkg/*
+spec/test.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    association_callbacks (0.0.1)
+      activerecord (~> 3.2.0)
+      activesupport (~> 3.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.2)
+      activesupport (= 3.2.2)
+      builder (~> 3.0.0)
+    activerecord (3.2.2)
+      activemodel (= 3.2.2)
+      activesupport (= 3.2.2)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.6)
+    multi_json (1.2.0)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    railties (3.2.2)
+      actionpack (= 3.2.2)
+      activesupport (= 3.2.2)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+    tzinfo (0.3.32)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  association_callbacks!
+  rspec (~> 2.9.0)
+  rspec-rails (~> 2.9.0)
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Alexis Toulotte
+
+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.mdown

@@ -0,0 +1,93 @@
+# AssociationCallbacks
+
+Provides a way to define [callbacks](http://api.rubyonrails.org/classes/ActiveModel/Callbacks.html)
+of one [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html)
+model into an associated one.
+
+## Example
+
+First, two simple `Article` and `Comment` models:
+
+    class Article < ActiveRecord::Base
+      has_many :comments
+    end
+    
+    class Comment < ActiveRecord::Base
+      belongs_to :article
+    end
+
+Then, you often need to denormalize `Comment` stuff into `Post` or vice versa.
+Here is the standard way to denormalize `last_comment_at` on posts:
+
+    class Comment < ActiveRecord::Base
+      belongs_to :article
+      
+      after_create :update_post_last_comment_at
+      after_destroy :update_post_last_comment_at
+      
+      def update_post_last_comment_at
+        post.update_attributes!(:last_comment_at => post.comments.order('created_at').last.try(:created_at))
+      end
+    end
+
+But, there is a problem here: we define `Post` denormalization callbacks into
+`Comment` model. IMHO, this is the wrong place. `Post` denormalization
+**should** be in `Post` model in order to have less relationship between
+models.
+
+Here is how to do it with `association_callabacks`:
+
+    class Post < ActiveRecord::Base
+      has_many :comments
+    
+      after_create :update_last_comment_at, :source => :comments
+      after_destroy :update_last_comment_at, :source => :comments
+      
+      def update_last_comment_at
+        update_attributes!(:last_comment_at => comments.order('created_at').last.try(:created_at))
+      end
+    end
+
+You just have to specify `:source` option to your callbacks, and that's all!
+Note that `:source` option must be an existing association name.
+
+Note that association callbacks methods can take associated record as
+argument, above code can be:
+
+    class Post < ActiveRecord::Base
+      has_many :comments
+      
+      after_create :update_last_comment_at
+      
+      def update_last_comment_at(comment)
+        update_attributes!(:last_comment_at => comment.created_at)
+      end
+    end
+
+Association callbacks can also be defined as block:
+
+    class Post < ActiveRecord::Base
+      has_many :comments
+      
+      after_destroy :source => :comments do |post|
+        post.decrement!(:comments_count)
+      end
+    end
+
+Another solution is to use [ActiveModel Observers](http://api.rubyonrails.org/classes/ActiveModel/Observer.html),
+but for a better project comprehension, I really prefer placing denormalization
+directly into model. Observers are more designed for emails notifications,
+cache sweepers, etc.
+
+## Installation
+
+Just add this into your `Gemfile`:
+
+    gem 'association_callabacks'
+
+Then, just run `bundle install`.
+
+## Executing test suite
+
+This project is fully tested with [Rspec 2](http://github.com/rspec/rspec).
+Just run `bundle exec rake` (after a `bundle install`).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: runs specs.'
+task :default => :spec
+
+desc 'Run all specs in spec directory.'
+RSpec::Core::RakeTask.new(:spec)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/association_callbacks.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = 'association_callbacks'
+  s.version = File.read(File.expand_path(File.dirname(__FILE__) + '/VERSION')).strip
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Alexis Toulotte'
+  s.email = 'al@alweb.org'
+  s.homepage = 'https://github.com/alexistoulotte/association_callbacks'
+  s.summary = 'Callbacks for ActiveRecord associations'
+  s.description = 'Provides a way to define callbacks of one ActiveRecord model into an associated one'
+
+  s.rubyforge_project = 'association_callbacks'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '~> 3.2.0'
+  s.add_dependency 'activesupport', '~> 3.2.0'
+
+  s.add_development_dependency 'rspec', '~> 2.9.0'
+  s.add_development_dependency 'rspec-rails', '~> 2.9.0'
+  s.add_development_dependency 'sqlite3-ruby'
+end

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/association_callbacks')

data/lib/association_callbacks/active_record.rb

@@ -0,0 +1,89 @@
+module AssociationCallbacks
+
+  module ActiveRecord
+
+    CALLBACKS = %w(
+      after_commit
+      after_create
+      after_destroy
+      after_save
+      after_update
+      after_validation
+      before_create
+      before_destroy
+      before_save
+      before_update
+      before_validation
+    ).freeze
+
+    extend ActiveSupport::Concern
+
+    included do |base|
+      CALLBACKS.each do |callback|
+        base.class_eval <<-EOS
+          class << self
+
+            def #{callback}_with_association(*args, &block)
+              if args.last.is_a?(Hash) && args.last.key?(:source)
+                options = args.extract_options!
+                define_callback_with_association(:#{callback}, args, options, &block)
+              else
+                #{callback}_without_association(*args, &block)
+              end
+            end
+            alias_method_chain :#{callback}, :association
+
+          end
+        EOS
+      end
+    end
+
+    module ClassMethods
+
+      private
+
+      def define_callback_with_association(callback, methods, options = {}, &block)
+        relation_name = options.delete(:source).try(:to_sym)
+        relation = reflect_on_association(relation_name) || raise(ArgumentError.new("No such association: #{name}.#{relation_name}"))
+        inverse_relation_name = relation.inverse_of.try(:name).presence || raise(ArgumentError.new("You must specify :inverse_of on #{name}.#{relation_name} to use association callbacks"))
+        relation.klass.send(callback, options) do |record|
+          invoke_callback_with_association(record, record.send(inverse_relation_name), methods, &block)
+        end
+      end
+
+    end
+
+    private
+
+    def invoke_callback_block_with_association(record, inverse_record, &block)
+      yield(inverse_record, record) if block_given?
+    end
+
+    def invoke_callback_methods_with_association(record, inverse_record, methods)
+      methods.each do |method|
+        if inverse_record.method(method).arity == 1
+          inverse_record.send(method, record)
+        else
+          inverse_record.send(method)
+        end
+      end
+    end
+
+    def invoke_callback_with_association(record, assocation, methods, &block)
+      return if assocation.nil?
+      if assocation.respond_to?(:find_each)
+        assocation.find_each do |inverse_record|
+          invoke_callback_methods_with_association(record, inverse_record, methods)
+          invoke_callback_block_with_association(record, inverse_record, &block)
+        end
+      elsif assocation.is_a?(::ActiveRecord::Base)
+        invoke_callback_methods_with_association(record, assocation, methods)
+        invoke_callback_block_with_association(record, assocation, &block)
+      else
+        raise "Assocation can't be used by callbacks: #{association.inspect}"
+      end
+    end
+
+  end
+
+end

data/lib/association_callbacks.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+require 'active_support/concern'
+
+module AssociationCallbacks
+
+  class << self
+
+    def version
+      @@version ||= File.read(File.expand_path(File.dirname(__FILE__) + '/../VERSION')).strip.freeze
+    end
+
+  end
+
+end
+
+lib_path = File.expand_path(File.dirname(__FILE__) + '/association_callbacks')
+
+require "#{lib_path}/active_record"
+
+ActiveRecord::Base.send(:include, AssociationCallbacks::ActiveRecord)

data/spec/association_callbacks/active_record_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe AssociationCallbacks::ActiveRecord do
+
+  context 'with has_many relation' do
+
+    it 'invokes callback defines as method' do
+      post = Post.create!
+      expect {
+        Comment.create!(:post_id => post.id)
+      }.to change { post.reload.comments_count }.by(1)
+    end
+
+    it 'invokes callback defines as method (with one argument)' do
+      post = Post.create!
+      expect {
+        Comment.create!(:post => post, :created_at => 2.years.ago)
+      }.to change { post.reload.last_comment_at }.from(nil)
+      post.last_comment_at.to_i.should be_within(5).of(2.years.ago.to_i)
+    end
+
+    it 'invokes callback defines as block' do
+      post = Post.create!
+      comment = Comment.create!(:post => post)
+      expect {
+        comment.destroy
+      }.to change { post.reload.comments_count }.by(-1)
+    end
+
+    it 'invokes regular callbacks' do
+      post = Post.new(:body => 'this is body', :title => 'foo')
+      expect {
+        post.save!
+      }.to change { post.texts }.from(nil).to('foo,this,is,body')
+    end
+
+  end
+
+  context 'with belongs_to relation' do
+
+    it 'invokes callback defines as method' do
+      post = Post.create!
+      comment = post.comments.create!
+      expect {
+        post.update_attributes!(:title => 'foo')
+      }.to change { comment.reload.post_updated_at }
+      comment.post_updated_at.to_i.should be_within(5).of(Time.now.to_i)
+    end
+
+    it 'invokes callback defines as method (with one argument)' do
+      post = Post.create!(:title => 'foo')
+      comment = post.comments.create!
+      expect {
+        post.update_attributes!(:title => 'bar')
+      }.to change { comment.reload.post.title }.from('foo').to('bar')
+    end
+
+    it 'invokes callback defines as block' do
+      post = Post.create!
+      comment = Comment.create!(:post_id => post.id)
+      expect {
+        post.destroy
+      }.to change { comment.reload.orphan_from_id }.from(nil).to(post.id)
+    end
+
+    it 'invokes regular callbacks' do
+      post = Post.create!(:title => 'foo')
+      comment = Comment.new(:post => post)
+      expect {
+        comment.save!
+      }.to change { comment.post_title }.from(nil).to('foo')
+    end
+
+  end
+
+end

data/spec/association_callbacks_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe AssociationCallbacks do
+
+  describe '.version' do
+
+    it 'is a string' do
+      AssociationCallbacks.version.should be_a(String)
+    end
+
+    it 'is with correct format' do
+      AssociationCallbacks.version.should match(/^\d+\.\d+(\.\d+)?$/)
+    end
+
+    it 'is freezed' do
+      expect {
+        AssociationCallbacks.version.gsub!('.', '#')
+      }.to raise_error(/can't modify frozen string/i)
+    end
+
+  end
+
+end

data/spec/mocks/comment.rb

@@ -0,0 +1,26 @@
+class Comment < ActiveRecord::Base
+
+  belongs_to :post, :inverse_of => :comments
+
+  after_save :update_post_updated_at, :source => :post
+  before_create :set_post_title
+  before_save :update_post_title, :source => :post
+  after_destroy :source => :post do |comment, post|
+    comment.update_attributes!(:orphan_from_id => post.id)
+  end
+
+  private
+
+  def set_post_title
+    self.post_title = post.title
+  end
+
+  def update_post_title(post)
+    update_attributes!(:post_title => post.title) if post.title_changed?
+  end
+
+  def update_post_updated_at
+    update_attributes!(:post_updated_at => post.updated_at)
+  end
+
+end

data/spec/mocks/post.rb

@@ -0,0 +1,23 @@
+class Post < ActiveRecord::Base
+
+  has_many :comments, :inverse_of => :post
+
+  after_create :increment_comments_count, :update_last_comment_at, :source => :comments
+  after_destroy :source => :comments do |post|
+    post.decrement!(:comments_count)
+  end
+  before_save do |post|
+    post.texts = "#{post.title} #{post.body}".strip.split(/\s+/).join(',')
+  end
+
+  private
+
+  def increment_comments_count
+    increment!(:comments_count)
+  end
+
+  def update_last_comment_at(comment)
+    update_attributes!(:last_comment_at => comment.created_at)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.dirname(__FILE__) + '/../lib/association_callbacks'
+
+# Support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Mocks
+ActiveSupport::Dependencies.autoload_paths << "#{File.dirname(__FILE__)}/mocks"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Comment.delete_all
+    Post.delete_all
+  end
+end

data/spec/support/bootsrap/database.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => "#{File.dirname(__FILE__)}/../../test.sqlite3", :timeout => 5000)
+
+ActiveRecord::Base.connection.create_table(:comments, :force => true) do |t|
+  t.integer :orphan_from_id
+  t.datetime :post_updated_at
+  t.integer :post_id
+  t.string :post_title
+  t.timestamps
+end
+ActiveRecord::Base.connection.create_table(:posts, :force => true) do |t|
+  t.text :body
+  t.integer :comments_count, :default => 0
+  t.datetime :last_comment_at
+  t.text :texts
+  t.string :title
+  t.timestamps
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: association_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexis Toulotte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70294690344260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70294690344260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70294690343080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70294690343080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70294690341960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70294690341960
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70294690340660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70294690340660
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &70294690339420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70294690339420
+description: Provides a way to define callbacks of one ActiveRecord model into an
+  associated one
+email: al@alweb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.mdown
+- Rakefile
+- VERSION
+- association_callbacks.gemspec
+- init.rb
+- lib/association_callbacks.rb
+- lib/association_callbacks/active_record.rb
+- spec/association_callbacks/active_record_spec.rb
+- spec/association_callbacks_spec.rb
+- spec/mocks/comment.rb
+- spec/mocks/post.rb
+- spec/spec_helper.rb
+- spec/support/bootsrap/database.rb
+homepage: https://github.com/alexistoulotte/association_callbacks
+licenses: []
+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: -2681495212806614534
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2681495212806614534
+requirements: []
+rubyforge_project: association_callbacks
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Callbacks for ActiveRecord associations
+test_files:
+- spec/association_callbacks/active_record_spec.rb
+- spec/association_callbacks_spec.rb
+- spec/mocks/comment.rb
+- spec/mocks/post.rb
+- spec/spec_helper.rb
+- spec/support/bootsrap/database.rb