ar_transaction_changes 0.0.1

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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shopify Inc.
+
+MIT License
+
+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,46 @@
+# ArTransactionChanges
+
+Store transaction changes for active record objects so that they
+are available in an after_commit callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar_transaction_changes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar_transaction_changes
+
+## Usage
+
+Just include ArTransactionChanges and transaction_changed_attributes
+will store the original values for all the changed attributes
+throughout the transaction.
+
+```ruby
+class User < ActiveRecord::Base
+  include ArTransactionChanges
+
+  after_commit :print_transaction_changes
+
+  def print_transaction_changes
+    transaction_changed_attributes.each do |name, old_value|
+      puts "attribute #{name}: #{old_value.inspect} -> #{send(name).inspect}"
+    end
+  end
+end
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+task :default => 'test'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '.' << 'lib' << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end

data/ar_transaction_changes.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ar_transaction_changes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ar_transaction_changes"
+  gem.version       = ArTransactionChanges::VERSION
+  gem.authors       = ["Dylan Smith"]
+  gem.email         = ["Dylan.Smith@shopify.com"]
+  gem.description   = %q{Solves the problem of trying to get all the changes to an object during a transaction in an after_commit callbacks.}
+  gem.summary       = %q{Store transaction changes for active record objects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("activerecord", [">= 3.0.0"])
+
+  gem.add_development_dependency("mysql2")
+end

data/lib/ar_transaction_changes.rb

@@ -0,0 +1,37 @@
+require "ar_transaction_changes/version"
+
+module ArTransactionChanges
+  def create(*)
+    super.tap do |status|
+      store_transaction_changed_attributes if status != false
+    end
+  end
+
+  def update(*)
+    super.tap do |status|
+      store_transaction_changed_attributes if status != false
+    end
+  end
+
+  def committed!(*)
+    super
+  ensure
+    @transaction_changed_attributes = nil
+  end
+
+  def rolledback!(*)
+    super
+  ensure
+    @transaction_changed_attributes = nil
+  end
+
+  def transaction_changed_attributes
+    changed_attributes.merge(@transaction_changed_attributes || {})
+  end
+
+  private
+
+  def store_transaction_changed_attributes
+    @transaction_changed_attributes = transaction_changed_attributes
+  end
+end

data/lib/ar_transaction_changes/version.rb

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

data/test/database.yml.default

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql2
+  database: ar_transaction_changes_test
+  host: 127.0.0.1
+  encoding: utf8
+  username: root
+  password:

data/test/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+  include ArTransactionChanges
+
+  attr_accessor :stored_transaction_changes
+
+  after_commit :store_transaction_changes_for_tests
+
+  def store_transaction_changes_for_tests
+    @stored_transaction_changes = transaction_changed_attributes.reduce({}) do |changes, (attr_name, value)|
+      changes[attr_name] = [value, send(attr_name)]
+      changes
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+ENV["RAILS_ENV"] = "test"
+require 'pathname'
+require 'yaml'
+require 'active_record'
+require 'ar_transaction_changes'
+require 'minitest/autorun'
+
+test_dir = Pathname.new(File.dirname(__FILE__))
+config_filename = test_dir.join("database.yml").exist? ? "database.yml" : "database.yml.default"
+database_yml = YAML.load(test_dir.join(config_filename).read)
+ActiveRecord::Base.configurations = database_yml
+ActiveRecord::Base.establish_connection "test"
+
+ActiveRecord::Base.connection.tap do |db|
+  db.drop_table(:users) if db.table_exists?(:users)
+  db.create_table(:users) do |t|
+    t.string :name
+    t.string :occupation
+  end
+end
+
+Dir[test_dir.join("models/*.rb")].each{ |file| require file }

data/test/transaction_changes_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class TransactionChangesTest < MiniTest::Unit::TestCase
+  def setup
+    @user = User.new(:name => "Dylan", :occupation => "Developer")
+    @user.save!
+    @user.stored_transaction_changes = nil
+  end
+
+  def teardown
+    User.delete_all
+  end
+
+  def test_transaction_changes_for_create
+    user = User.new(:name => "Dylan")
+    user.save!
+    assert_equal [nil, "Dylan"], user.stored_transaction_changes["name"]
+  end
+
+  def test_transaction_changes_for_update
+    @user.name = "Dillon"
+    @user.save!
+    assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
+  end
+
+  def test_transaction_changes_for_double_save
+    @user.transaction do
+      @user.name = "Dillon"
+      @user.save!
+
+      @user.occupation = "Tester"
+      @user.save!
+    end
+    assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
+    assert_equal ["Developer", "Tester"], @user.stored_transaction_changes["occupation"]
+  end
+
+  def test_transaction_changes_for_rollback
+    @user.transaction do
+      @user.name = "Dillon"
+      @user.save!
+      raise ActiveRecord::Rollback
+    end
+    assert_equal nil, @user.stored_transaction_changes
+  end
+
+  def test_transaction_changes_after_reload_saved
+    @user.transaction do
+      @user.name = "Dillon"
+      @user.save!
+
+      @user.reload
+    end
+    assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
+  end
+
+  def test_transaction_changes_after_reload_unsaved
+    @user.transaction do
+      @user.name = "Dillon"
+      @user.save!
+
+      @user.name = "Andrew"
+      assert_equal "Dylan", @user.transaction_changed_attributes["name"]
+      @user.reload
+    end
+    assert_equal ["Dylan", "Dillon"], @user.stored_transaction_changes["name"]
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ar_transaction_changes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dylan Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solves the problem of trying to get all the changes to an object during
+  a transaction in an after_commit callbacks.
+email:
+- Dylan.Smith@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_transaction_changes.gemspec
+- lib/ar_transaction_changes.rb
+- lib/ar_transaction_changes/version.rb
+- test/database.yml.default
+- test/models/user.rb
+- test/test_helper.rb
+- test/transaction_changes_test.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Store transaction changes for active record objects
+test_files:
+- test/database.yml.default
+- test/models/user.rb
+- test/test_helper.rb
+- test/transaction_changes_test.rb