jqr-stale_object_destroyer 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.0.1. Initial extraction.

data/Manifest

@@ -0,0 +1,7 @@
+CHANGELOG
+init.rb
+lib/stale_object_destroyer.rb
+Manifest
+Rakefile
+README.rdoc
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,58 @@
+= Stale Object Destroyer
+
+An easy way to handle stale object errors in Rails by retrying the entire request.
+
+If you're using optimistic locking your ActiveRecord models you've probably run across the ActiveRecord::StaleObjectError. It is raised when a race condition is detected.
+
+So how do you handle ActiveRecord::StaleObjectError? Rails documentation has this to say.
+
+  You're then responsible for dealing with the conflict by rescuing the 
+  exception and either rolling back, merging, or otherwise apply the business 
+  logic needed to resolve the conflict. 
+
+In most applications, you simply need to retry the thing that failed and make sure you don't use any stale values when trying again. That last bit can prove rather tricky with the numerous caching techniques employed in high performance Rails applications.
+
+Stale Object Destroyer provides an easy way for you to start the entire request over to ensure no stale objects will be operated on. It handles this entirely inside of Rails though, so no additional client requests will be made. 
+
+As far as your code knows, the user just retried the request a few times in hopes of success.
+
+As far as your user knows, your site did nothing out of the ordinary.
+
+== Examples
+
+Stale Object Destroyer works by handling StaleObjectErrors at a much higher level in the request cycle so you will need to let them pass through your exception notification code.
+
+  def rescue_action_in_public
+    request.reraise_stale_object_errors(exception)
+    
+    # normal exception stuff, hoptoad etc.
+  end
+  
+If needed, you can inspect the request object to determine how many times the current action has been attempted or to find out if this is the last attempt.
+
+  request.attempt         # => 3
+  request.last_attempt?   # => false
+
+A great use of request.attempt is to disable your caching library after a request has failed.
+
+  before_filter :cache_setup
+  def cache_setup
+    SomeCacheLibrary.enable = request.attempt == 1
+  end
+  
+
+== Install
+
+As a Rails plugin.
+
+  ./script/plugin install git://github.com/jqr/stale_object_destroyer.git
+
+Prefer gems? Add this to your environment.rb and run the following command.
+
+  config.gem 'jqr-stale_object_destroyer', :lib => 'stale_object_destroyer', :source => 'http://gems.github.com'
+
+  $ rake gems:install
+
+
+Homepage:: http://github.com/jqr/versionable/tree/master  
+License:: Copyright (c) 2008 Elijah Miller <mailto:elijah.miller@gmail.com> and Kristopher Chambers <mailto:kristopher.chambers@gmail.com, released under the MIT license.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'spec/rake/spectask'
+
+require 'echoe'
+Echoe.new 'stale_object_destroyer' do |p|
+  p.description     = "An easy way to handle stale object errors in Rails by retrying the entire request."
+  p.url             = "http://github.com/jqr/stale_object_destroyer"
+  p.author          = "Elijah Miller"
+  p.email           = "elijah.miller@gmail.com"
+  p.retain_gemspec  = true
+  p.need_tar_gz     = false
+  p.extra_deps      = [
+  ]
+end
+
+desc 'Default: run specs'
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :test => :spec

data/init.rb

@@ -0,0 +1 @@
+require 'stale_object_destroyer'

data/lib/stale_object_destroyer.rb

@@ -0,0 +1,33 @@
+class ActionController::CgiRequest
+  attr_accessor :attempt, :last_attempt
+  
+  def last_attempt?
+    last_attempt
+  end
+  
+  def reraise_stale_object_errors(exception)
+    if exception.is_a?(ActiveRecord::StaleObjectError) && !last_attempt?
+      raise exception
+    end
+  end
+end
+
+class ActionController::Base
+  class << self 
+    def process_with_destroyer(request, response)
+      max = 5
+      (1..max).each do |attempt|
+        begin
+          request.attempt = attempt
+          request.last_attempt = attempt == max
+          
+          return process_without_destroyer(request, response)
+        rescue ActiveRecord::StaleObjectError => err
+          logger.error "[StaleObjectDestroyer] #{err.message} on attempt #{attempt}"
+        end
+      end
+    end
+  
+   alias_method_chain :process, :destroyer
+ end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'stale_object_destroyer')
+

data/stale_object_destroyer.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stale_object_destroyer}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elijah Miller"]
+  s.date = %q{2009-02-11}
+  s.description = %q{An easy way to handle stale object errors in Rails by retrying the entire request.}
+  s.email = %q{elijah.miller@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/stale_object_destroyer.rb", "README.rdoc"]
+  s.files = ["CHANGELOG", "init.rb", "lib/stale_object_destroyer.rb", "Manifest", "Rakefile", "README.rdoc", "spec/spec_helper.rb", "stale_object_destroyer.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jqr/stale_object_destroyer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Stale_object_destroyer", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{stale_object_destroyer}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{An easy way to handle stale object errors in Rails by retrying the entire request.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: jqr-stale_object_destroyer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Elijah Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An easy way to handle stale object errors in Rails by retrying the entire request.
+email: elijah.miller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/stale_object_destroyer.rb
+- README.rdoc
+files: 
+- CHANGELOG
+- init.rb
+- lib/stale_object_destroyer.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/spec_helper.rb
+- stale_object_destroyer.gemspec
+has_rdoc: true
+homepage: http://github.com/jqr/stale_object_destroyer
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Stale_object_destroyer
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: stale_object_destroyer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An easy way to handle stale object errors in Rails by retrying the entire request.
+test_files: []
+