retryable_record 0.0.1 → 0.1.1

data/.gitignore

@@ -1,4 +1,5 @@
 coverage
+Gemfile.lock
 pkg
 doc
 .yardoc

data/.rvmrc

@@ -0,0 +1 @@
+rvm @retryable_record --create

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - ree
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in retryable_record.gemspec
+gemspec

data/README.rdoc

@@ -2,9 +2,11 @@
 
 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]
+Gem[https://rubygems.org/gems/retryable_record] |
+Source[http://github.com/neopoly/retryable_record] |
+RDoc[http://rdoc.info/projects/neopoly/retryable_record] |
+{<img src="https://secure.travis-ci.org/neopoly/retryable_record.png?branch=master" alt="Build Status" />}[http://travis-ci.org/neopoly/retryable_record]
+
 
 == Usage
 
@@ -21,6 +23,13 @@ Metrics[http://getcaliper.com/caliper/project?repo=http%3A%2F%2Fgemcutter.org%2F
     user.save!
   end
 
+== Credits
+
+Inspired by
+* http://vision-media.ca/resources/ruby/better-ruby-retryable-method
+* http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/
+* http://github.com/carlo/retryable
+
 == TODO
 
 * Better example in README
@@ -35,7 +44,3 @@ Metrics[http://getcaliper.com/caliper/project?repo=http%3A%2F%2Fgemcutter.org%2F
 * 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

@@ -1,27 +1,10 @@
-require 'rubygems'
-require 'rake'
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
-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
+desc 'Default: run unit tests.'
+task :default => :test
 
+# Test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -29,28 +12,12 @@ Rake::TestTask.new(:test) do |test|
   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
+# RDoc
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'retryable_record'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/retryable_record/version.rb

@@ -0,0 +1,3 @@
+module RetryableRecord
+  VERSION = "0.1.1"
+end

data/retryable_record.gemspec

@@ -1,60 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/retryable_record/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{retryable_record}
-  s.version = "0.0.1"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Suschlik"]
+  gem.email         = ["ps@neopoly.de"]
+  gem.description   = %q{Retries an operation on an ActiveRecord until no StaleObjectError is being raised.}
+  gem.summary       = %q{Retries an operation on an ActiveRecord until no StaleObjectError is being raised.}
+  gem.homepage      = "https://github.com/neopoly/retryable_record"
 
-  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"
-  ]
+  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.name          = "retryable_record"
+  gem.require_paths = ["lib"]
+  gem.version       = RetryableRecord::VERSION
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  gem.add_runtime_dependency 'activerecord', '>= 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
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest', '~> 3.2.0'
 end
-

data/test/helper.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+
+require 'minitest/unit'
+require 'minitest/autorun'
+
+require 'retryable_record'
+
+class Spec < MiniTest::Spec
+  class << self
+    alias :context :describe
+    alias :test :it
+    alias :setup :before
+    alias :teardown :after
+  end
+end
+
+class FakeRecord
+  include RetryableRecord
+
+  attr_accessor :counter
+
+  def initialize(retries_left = 0)
+    @counter = Hash.new(0)
+    @counter[:retries_left] = retries_left
+  end
+
+  def reload
+    @counter[:reload] += 1
+    self
+  end
+
+  def save!
+    @counter[:save] += 1
+  end
+
+  def retries_left?
+    @counter[:retries_left] > 0
+  end
+
+  def concurrent_modification!
+    if retries_left?
+      @counter[:retries_left] -= 1
+      raise ActiveRecord::StaleObjectError.new self, :save
+    end
+  end
+end

data/test/retryable_record_test.rb

@@ -1,47 +1,44 @@
-require 'teststrap'
+require 'helper'
+
+class RetryableRecordTest < Spec
+  let(:retries) { 0 }
+  let(:record) { FakeRecord.new(retries) }
 
-context "FakeRecord" do
   setup do
-    FakeRecord.new
+    record.retryable do
+      record.concurrent_modification!
+      record.save!
+    end
   end
 
-  asserts("that block return value") do
-    topic.retryable { :return_value }
-  end.equals(:return_value)
+  context :retryable do
+    context "without retry" do
+      let(:retries) { 0 }
 
-  asserts("that other errors") do
-    topic.retryable do
-      raise "other error"
+      test "saves and does not retry" do
+        assert_equal 0, record.counter[:reload]
+        assert_equal 1, record.counter[:save]
+      end
     end
-  end.raises(RuntimeError, "other error")
 
-  context "saves without retries" do
-    hookup do
-      topic.retryable do
-        topic.save
+    context "with retry once" do
+      let(:retries) { 5 }
+
+      test "saves and reloads 5 times" do
+        assert_equal 5, record.counter[:reload]
+        assert_equal 1, record.counter[: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
+    test "does not rescue other errors" do
+      assert_raises RuntimeError do
+        record.retryable do
+          raise "foo"
         end
       end
-    end
 
-    asserts("save counter") { topic.counter[:save] }.equals(1)
-    asserts("reload counter") { topic.counter[:reload] }.equals(1)
+      assert_equal 0, record.counter[:reload]
+      assert_equal 1, record.counter[:save]
+    end
   end
 end

metadata

@@ -1,96 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: retryable_record
-version: !ruby/object:Gem::Version 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
 platform: ruby
-authors: 
+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
+date: 2012-07-02 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
   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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Retries an operation on an ActiveRecord until no StaleObjectError is
+  being raised.
+email:
+- ps@neopoly.de
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
 - .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/retryable_record.rb
+- lib/retryable_record/version.rb
 - retryable_record.gemspec
 - test.watchr
+- test/helper.rb
 - test/retryable_record_test.rb
-- test/teststrap.rb
-has_rdoc: true
-homepage: http://github.com/splattael/retryable_record
+homepage: https://github.com/neopoly/retryable_record
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+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: 
+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.3.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
-test_files: 
+summary: Retries an operation on an ActiveRecord until no StaleObjectError is being
+  raised.
+test_files:
+- test/helper.rb
 - test/retryable_record_test.rb
-- test/teststrap.rb

data/test/teststrap.rb

@@ -1,31 +0,0 @@
-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