activerecord-after-transaction 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1e3edc231e68ba16701de6e1e278e48da20622c
+  data.tar.gz: e963ec2be9923994eed49b14e1fc4adb7c27f764
+SHA512:
+  metadata.gz: a59648ccafe1fcd5397957aa11a8db00dc85eb0cb843f6c98cb6ffa9a9ac69a2d314b19ce0dd5213d9a2cc5e9baa9dde5606d523117e50a6567aca3b777530d6
+  data.tar.gz: c0dae729f4d14bfc08d9ca7c44e5e3e8db98889648ee91375961809474a0604ee032e0539fdf180e1f89422775ed5b2d151d5f19327ab964a4a21b525bb7a4ed

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/log/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+## Misc
+Gemfile.lock
+gemfiles/*.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+env:
+  -
+  - ACTIVE_RECORD_VERSION=3.2.0
+  - ACTIVE_RECORD_VERSION=4.0.0
+  - ACTIVE_RECORD_VERSION=4.1.0
+  - ACTIVE_RECORD_VERSION=4.2.0.beta4
+
+script: "bundle exec rake spec"
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', "~> #{ENV['ACTION_RECORD_VERSION']}" if ENV['ACTION_RECORD_VERSION'].to_s != ''
+
+gem "sqlite3"
+gem 'database_cleaner'
+gem "codeclimate-test-reporter", require: nil
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daisuke Taniwaki
+
+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,90 @@
+# activerecord-after-transaction
+
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Build Status][build-image]][build-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Code Climate][gpa-image]][gpa-link]
+
+Execute a proc after transaction.
+
+You basically don't need this gem if you use `after_commit`. However, let's say you have `state_machine` gem and want to do something after transition, the gem doesn't provide a way to do it. In this case, you might have written the following code.
+
+```ruby
+def after_commit(record)
+  if record.previous_changes[:state] == ['draft', 'published']
+    UserMailer.notify_publish(record).deliver
+  elsif record.previous_changes[:state] == ['draft', 'deleted']
+    UserMailer.notify_delete(record).deliver
+  end 
+end 
+```
+
+It spoils the readability of `state_machine`. You definitely want to write the following instead.
+
+```ruby
+after_transition from: :draft, to: :published do
+  UserMailer.notify_publish(record).deliver
+end
+after_transition from: :draft, to: :deleted do
+  UserMailer.notify_publish(record).deliver
+end
+```
+
+That's why I made this gem. :)
+
+## Installation
+
+Add the activerecord-after-transaction gem to your Gemfile.
+
+```ruby
+gem "activerecord-after-transaction"
+```
+
+And run `bundle install`.
+
+## Usage
+
+```ruby
+class Foo < ActiveRecord::Base
+  after_transition from: :draft, to: :published do
+    after_transaction do
+      UserMailer.notify_publish(record).deliver
+    end
+  end
+  after_transition from: :draft, to: :deleted do
+    after_transaction do
+      UserMailer.notify_publish(record).deliver
+    end
+  end
+end
+```
+
+Then, the proc will be executed after the transaction. If it's not in the transaction, it will be executed immediately.
+
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.
+
+
+
+[gem-image]:   https://badge.fury.io/rb/activerecord-after-transaction.svg
+[gem-link]:    http://badge.fury.io/rb/activerecord-after-transaction
+[build-image]: https://secure.travis-ci.org/dtaniwaki/activerecord-after-transaction.png
+[build-link]:  http://travis-ci.org/dtaniwaki/activerecord-after-transaction
+[deps-image]:  https://gemnasium.com/dtaniwaki/activerecord-after-transaction.svg
+[deps-link]:   https://gemnasium.com/dtaniwaki/activerecord-after-transaction
+[cov-image]:   https://codeclimate.com/github/dtaniwaki/activerecord-after-transaction/badges/coverage.svg
+[cov-link]:    https://codeclimate.com/github/dtaniwaki/activerecord-after-transaction
+[gpa-image]:   https://codeclimate.com/github/dtaniwaki/activerecord-after-transaction.png
+[gpa-link]:    https://codeclimate.com/github/dtaniwaki/activerecord-after-transaction
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/VERSION

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

data/activerecord-after-transaction.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |gem|
+  gem.name        = "activerecord-after-transaction"
+  gem.version     = ::File.read(::File.expand_path('../VERSION', __FILE__)).to_s.strip
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Daisuke Taniwaki"]
+  gem.email       = ["daisuketaniwaki@gmail.com"]
+  gem.homepage    = "https://github.com/dtaniwaki/activerecord-after-transaction"
+  gem.summary     = "Exec Proc After Transaction"
+  gem.description = "Exec Proc After Transaction"
+  gem.license     = "MIT"
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "activerecord", ">= 3.2"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/activerecord-after-transaction.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+require 'activerecord_after_transaction/version'
+require 'activerecord_after_transaction/methods'
+
+ActiveSupport.on_load :active_record do
+  include ActiveRecord::AfterTransaction::Methods
+end

data/lib/activerecord-after-transaction/methods.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+
+module ActiveRecord::AfterTransaction
+  module Methods
+    def self.included(klass)
+      klass.class_eval do
+        after_commit :execute_after_transaction
+        after_rollback :clear_after_transaction
+      end
+    end
+
+    def after_transaction(&block)
+      return block.call unless self.class.connection.open_transactions
+      @after_transaction_queue ||= []
+      @after_transaction_queue.push block
+      logger && logger.debug("Push #{block}")
+    end
+
+    def execute_after_transaction
+      logger && logger.debug("Execute the queue")
+      @after_transaction_queue.each do |block|
+        logger && logger.debug("Execute #{block}")
+        block.call
+      end
+      clear_after_transaction
+    end
+
+    def clear_after_transaction
+      logger && logger.debug("Clear the queue")
+      @after_transaction_queue.clear
+    end
+  end
+end

data/lib/activerecord-after-transaction/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecord::AfterTransaction
+  VERSION = ::File.read(::File.expand_path('../../../../VERSION', __FILE__)).to_s.strip
+end

data/spec/after_transaction/methods_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'activerecord-after-transaction/methods'
+
+describe ActiveRecord::AfterTransaction::Methods do
+  let(:klass) do
+    create_tmp_model foo: :integer do
+      include ActiveRecord::AfterTransaction::Methods
+    end
+  end
+  subject { klass.new }
+
+  describe 'in a transaction' do
+    it 'executes the proc after transaction' do
+      step = 1
+      klass.transaction do
+        subject.after_transaction do
+          step = 2
+        end
+        subject.save!
+        step = 3
+      end
+      expect(step).to eq 2
+    end
+    it 'clears executed procs' do
+      step = 1
+      klass.transaction do
+        subject.after_transaction do
+          step += 1
+        end
+        subject.save!
+        subject.save!
+      end
+      expect(step).to eq 2
+    end
+    it 'does not execute the proc after rollback' do
+      step = 1
+      klass.transaction do
+        subject.after_transaction do
+          step = 2
+        end
+        subject.save!
+        raise ActiveRecord::Rollback
+      end
+      expect(step).to eq 1
+    end
+  end
+  describe 'not in a transaction' do
+    it 'executes the proc immediately' do
+      step = 1
+
+      subject.after_transaction do
+        step = 2
+      end
+      expect(step).to eq 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+#require 'database_cleaner'
+require 'active_record'
+require 'simplecov'
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+# require 'coveralls'
+# Coveralls.wear!
+
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+RSpec.configure do |c|
+  # c.before :suite do
+  #   ActiveRecord::Migration.verbose = false
+  #   DatabaseCleaner.clean_with :truncation
+  # end
+  # c.before :example do
+  #   DatabaseCleaner.strategy = :truncation
+  #   DatabaseCleaner.start
+  # end
+  # c.after :example do
+  #   DatabaseCleaner.clean
+  # end
+end
+

data/spec/support/tmp_model.rb

@@ -0,0 +1,26 @@
+def create_tmp_model(_columns = {}, &_block)
+  time = Time.now.to_f.to_s.gsub('.', '_')
+  _model_name = "TmpClass#{time}"
+  _table_name = "tmp_class#{time}s"
+  # if ActiveRecord::Base.connection.table_exists? _table_name
+  #   ActiveRecord::Migration.drop_table _table_name
+  # end
+  begin
+    Object.send :remove_const, _model_name
+  rescue NameError
+  end
+
+  ActiveRecord::Migration.create_table _table_name do |t|
+    _columns.each do |name, type|
+      t.column name, type
+    end
+  end
+  Object.class_eval <<-EOS
+    class #{_model_name} < ActiveRecord::Base
+      self.table_name = '#{_table_name}'
+    end
+  EOS
+  klass = Object.const_get _model_name
+  klass.class_exec(&_block) unless _block.nil?
+  klass
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-after-transaction
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daisuke Taniwaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Exec Proc After Transaction
+email:
+- daisuketaniwaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- activerecord-after-transaction.gemspec
+- lib/activerecord-after-transaction.rb
+- lib/activerecord-after-transaction/methods.rb
+- lib/activerecord-after-transaction/version.rb
+- spec/after_transaction/methods_spec.rb
+- spec/spec_helper.rb
+- spec/support/tmp_model.rb
+homepage: https://github.com/dtaniwaki/activerecord-after-transaction
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Exec Proc After Transaction
+test_files:
+- spec/after_transaction/methods_spec.rb
+- spec/spec_helper.rb
+- spec/support/tmp_model.rb