retryable_record 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+pkg
+doc
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Peter Suschlik
+
+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,41 @@
+= retryable_record
+
+Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
+
+Source[http://github.com/splattael/retryable_record] |
+RDoc[http://rdoc.info/projects/splattael/retryable_record] |
+Metrics[http://getcaliper.com/caliper/project?repo=http%3A%2F%2Fgemcutter.org%2Fgems%2Fretryable_record]
+
+== Usage
+
+  require 'retryable_record'
+
+  class User < ActiveRecord::Base
+    include RetryableRecord
+  end
+
+  user = User.first
+
+  user.retryable do
+    user.username = "foo"
+    user.save!
+  end
+
+== TODO
+
+* Better example in README
+* Intergration test with ActiveRecord
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Peter Suschlik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "retryable_record"
+    gem.summary = %Q{Retries an operation on an ActiveRecord until no StaleObjectError is being raised.}
+# TODO    gem.description = %Q{}
+    gem.email = "peter@suschlik.de"
+    gem.homepage = "http://github.com/splattael/retryable_record"
+    gem.authors = ["Peter Suschlik"]
+
+    gem.add_development_dependency "riot", ">= 0.10.11"
+    gem.add_development_dependency "riot_notifier"
+    gem.add_development_dependency "yard"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

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

data/lib/retryable_record.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require 'active_record/base'
+
+# Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
+#
+# @example
+#
+#   class User < ActiveRecord::Base
+#     include RetryableRecord
+#   end
+#
+#   user = User.first
+#
+#   user.retryable do
+#     user.username = "foo"
+#     user.save!
+#   end
+#
+# @yield Operation that should be retried on failure ActiveRecord::StaleObjectError.
+module RetryableRecord
+  def retryable(&block)
+    yield
+  rescue ActiveRecord::StaleObjectError
+    reload
+    retry
+  end
+end

data/retryable_record.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{retryable_record}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Suschlik"]
+  s.date = %q{2010-02-11}
+  s.email = %q{peter@suschlik.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/retryable_record.rb",
+     "retryable_record.gemspec",
+     "test.watchr",
+     "test/retryable_record_test.rb",
+     "test/teststrap.rb"
+  ]
+  s.homepage = %q{http://github.com/splattael/retryable_record}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Retries an operation on an ActiveRecord until no StaleObjectError is being raised.}
+  s.test_files = [
+    "test/retryable_record_test.rb",
+     "test/teststrap.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<riot>, [">= 0.10.11"])
+      s.add_development_dependency(%q<riot_notifier>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<riot>, [">= 0.10.11"])
+      s.add_dependency(%q<riot_notifier>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0.10.11"])
+    s.add_dependency(%q<riot_notifier>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test.watchr

@@ -0,0 +1,15 @@
+#!/usr/bin/env watchr
+ 
+begin
+  require File.join(ENV["HOME"], ".watchr.test.rb")
+rescue LoadError
+  warn "Unable to load #{File.join(ENV["HOME"], ".watchr.test.rb")}"
+  warn "You might try this: http://gist.github.com/raw/273574/8804dff44b104e9b8706826dc8882ed985b4fd13/.watchr.test.rb"
+  exit
+end
+ 
+run_tests
+ 
+watch('test/.*_test\.rb')   { |md| run md[0] }
+watch('lib/(.*)\.rb')       { |md| run "test/#{underscore(md[1])}_test.rb" }
+watch('test/teststrap.rb')  { run_tests }

data/test/retryable_record_test.rb

@@ -0,0 +1,47 @@
+require 'teststrap'
+
+context "FakeRecord" do
+  setup do
+    FakeRecord.new
+  end
+
+  asserts("that block return value") do
+    topic.retryable { :return_value }
+  end.equals(:return_value)
+
+  asserts("that other errors") do
+    topic.retryable do
+      raise "other error"
+    end
+  end.raises(RuntimeError, "other error")
+
+  context "saves without retries" do
+    hookup do
+      topic.retryable do
+        topic.save
+      end
+    end
+
+    asserts("save counter") { topic.counter[:save] }.equals(1)
+    asserts("reload counter") { topic.counter[:reload] }.equals(0)
+  end
+
+  context "saves with 1 retry" do
+    hookup do
+      topic.retryable do
+        i = 0
+        topic.retryable do
+          if i == 0
+            i += 1
+            topic.concurrent_modification!
+          end
+
+          topic.save
+        end
+      end
+    end
+
+    asserts("save counter") { topic.counter[:save] }.equals(1)
+    asserts("reload counter") { topic.counter[:reload] }.equals(1)
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'riot'
+require 'riot_notifier'
+
+require 'retryable_record'
+
+Riot.reporter = RiotNotifier
+
+class FakeRecord
+  include RetryableRecord
+
+  attr_accessor :counter
+
+  def initialize
+    @counter = Hash.new(0)
+  end
+
+  def reload
+    @counter[:reload] += 1
+    self
+  end
+
+  def save
+    @counter[:save] += 1
+    true
+  end
+
+  def concurrent_modification!
+    raise ActiveRecord::StaleObjectError
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: retryable_record
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: riot_notifier
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: peter@suschlik.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/retryable_record.rb
+- retryable_record.gemspec
+- test.watchr
+- test/retryable_record_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/splattael/retryable_record
+licenses: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
+test_files: 
+- test/retryable_record_test.rb
+- test/teststrap.rb