retryable_record 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd3a3c47c9c5b116e53ab13546b73a141c5c6248
+  data.tar.gz: 1e4f1d3b5dd0ff89a5cda4f4389ee46fb05f2dff
+SHA512:
+  metadata.gz: a5d6b2ab96bb4f6eda6f901aec0f294d29a69d366fe960b356478ea2d937b4d331ff7f86a13b62d6f46b2cebf61d1b019d48211d8ca263f56539cb87b5cdea17
+  data.tar.gz: 6c74189f910b32da855c101a9405cd5fd27ebda3f2005cf788b54a5c36690ce908ee23968b4d9eac5a5fcd8b699fbd7dfde01c119cdd3d570439439b0dfc32d3

data/LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2010 Peter Suschlik
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.rdoc

@@ -46,6 +46,29 @@ You can use +retryable_record+ in 3 different ways:
     user.save!
   end
 
+== Option +attempts+
+
+There is also an option +attempts+ to limit the number of retries.
+If no attempts option is specified, it's assumed to be possibly infinte attempts until 
+an ActiveRecord::StaleObjectError is not raised. The +attempts+ option works in all three forms.
+
+Here is the Module inclusion example with an attempts option used.
+
+  require 'retryable_record'
+
+  class User < ActiveRecord::Base
+    include RetryableRecord
+  end
+
+  user = User.first
+
+  user.retryable(:attempts => 5) do
+    user.username = "foo"
+    user.save!
+  end
+
+After 5 attempts, this will just re-raise the ActiveRecord::StaleObjectError anyway.
+
 == Optimistic locking (lock_version column)
 
 ActiveRecord migration needs to support optimistic locking. See http://api.rubyonrails.org/classes/ActiveRecord/Locking/Optimistic.html
@@ -69,9 +92,14 @@ Inspired by
 * http://github.com/nfedyashev/retryable
 * http://vision-media.ca/resources/ruby/better-ruby-retryable-method (broken)
 
+=== Contributors
+
+Thanks to all contributions from awesome people[https://github.com/neopoly/retryable_record/contributors]!
+
 == TODO
 
-* Better example in README
+* Improve README example
+* Add Changelog!
 * Intergration test with ActiveRecord
 
 == Note on Patches/Pull Requests

data/lib/retryable_record.rb

@@ -16,6 +16,19 @@ require 'active_record/base'
 #     user.save!
 #   end
 #
+# == Example using attempts
+#
+#   class User < ActiveRecord::Base
+#     include RetryableRecord
+#   end
+#
+#   user = User.first
+#
+#   user.retryable(:attempts => 2) do
+#     user.username = "foo"
+#     user.save!
+#   end
+#
 module RetryableRecord
   # Retryable operations on an ActiveRecord +record+.
   #
@@ -26,16 +39,23 @@ module RetryableRecord
   #     user.save!
   #   end
   #
-  def retry(record)
-    yield
-  rescue ActiveRecord::StaleObjectError
-    record.reload
-    retry
+  def retry(record, opts = {})
+    attempts = opts[:attempts]
+    begin
+      yield
+    rescue ActiveRecord::StaleObjectError
+      unless attempts.nil?
+        raise unless attempts > 0
+        attempts -= 1
+      end
+      record.reload
+      retry
+    end
   end
   module_function :retry
 
   # Retries operations on an ActiveRecord.
-  def retryable(&block)
-    RetryableRecord.retry(self, &block)
+  def retryable(opts = {}, &block)
+    RetryableRecord.retry(self, opts, &block)
   end
 end

data/lib/retryable_record/import.rb

@@ -12,8 +12,17 @@ module Kernel
   #     user.save!
   #   end
   #
+  # == Example using attempts
+  #
+  #   require 'retryable_record/import'
+  #
+  #   RetryableRecord(user, :attempts => 3) do
+  #     user.username = "foo"
+  #     user.save!
+  #   end
+  #
   # See RetryableRecord#retry
-  def RetryableRecord(record, &block)
-    RetryableRecord.retry(record, &block)
+  def RetryableRecord(record, opts = {}, &block)
+    RetryableRecord.retry(record, opts, &block)
   end
 end

data/lib/retryable_record/version.rb

@@ -1,3 +1,3 @@
 module RetryableRecord
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/retryable_record.gemspec

@@ -14,10 +14,11 @@ Gem::Specification.new do |gem|
   gem.name          = "retryable_record"
   gem.require_paths = ["lib"]
   gem.version       = RetryableRecord::VERSION
+  gem.license       = 'MIT'
 
   gem.add_runtime_dependency 'activerecord', '>= 3'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rdoc'
-  gem.add_development_dependency 'minitest', '~> 3.2.0'
+  gem.add_development_dependency 'minitest', '~> 5.0.4'
 end

data/test/helper.rb

@@ -1,40 +1,27 @@
 require 'rubygems'
 
-require 'minitest/unit'
 require 'minitest/autorun'
 
 require 'retryable_record'
 
-class Spec < MiniTest::Spec
-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
+require 'support/fake_record'
+
+class Spec < Minitest::Spec
+  # Assert internal counter of the fake +record+.
+  #
+  # The following counters must be provided:
+  # * +:reloads+
+  # * +:saves+
+  #
+  # == Example
+  #
+  #   assert_record :reloads => 2, :saves => 1
+  #
+  def assert_record(counter={})
+    raise ":reloads missing" unless counter.key?(:reloads)
+    raise ":saves missing" unless counter.key?(:saves)
+
+    assert_equal counter[:reloads], record.count_reloads, "unexpected record reloads"
+    assert_equal counter[:saves], record.count_saves, "unexpected record saves"
   end
 end

data/test/retryable_record_import_test.rb

@@ -15,9 +15,23 @@ class RetryableRecordImportTest < Spec
 
     let(:retries) { 0 }
 
-    it "saves and does not retry" do
-      assert_equal 0, record.counter[:reload]
-      assert_equal 1, record.counter[:save]
+    it "saves and does not retry/reload" do
+      assert_record :reloads => 0, :saves => 1
+    end
+  end
+
+  describe :RetryableRecord_with_attempts do
+    let(:retries) { 2 }
+
+    it "retries `attempts` times, before re-raising" do
+      assert_raises ActiveRecord::StaleObjectError do
+        RetryableRecord(record, :attempts => 1) do
+          record.concurrent_modification!
+          record.save!
+        end
+      end
+
+      assert_record :reloads => 1, :saves => 0
     end
   end
 end

data/test/retryable_record_test.rb

@@ -16,8 +16,7 @@ class RetryableRecordTest < Spec
       let(:retries) { 0 }
 
       it "saves and does not retry" do
-        assert_equal 0, record.counter[:reload]
-        assert_equal 1, record.counter[:save]
+        assert_record :reloads => 0, :saves => 1
       end
     end
 
@@ -25,8 +24,7 @@ class RetryableRecordTest < Spec
       let(:retries) { 5 }
 
       it "saves and reloads 5 times" do
-        assert_equal 5, record.counter[:reload]
-        assert_equal 1, record.counter[:save]
+        assert_record :reloads => 5, :saves => 1
       end
     end
 
@@ -37,8 +35,7 @@ class RetryableRecordTest < Spec
         end
       end
 
-      assert_equal 0, record.counter[:reload]
-      assert_equal 1, record.counter[:save]
+      assert_record :reloads => 0, :saves => 1
     end
   end
 
@@ -53,8 +50,22 @@ class RetryableRecordTest < Spec
     let(:retries) { 0 }
 
     it "saves and does not retry" do
-      assert_equal 0, record.counter[:reload]
-      assert_equal 1, record.counter[:save]
+      assert_record :reloads => 0, :saves => 1
+    end
+  end
+
+  describe :retryable_with_attempts do
+    let(:retries) { 2 }
+
+    it "retries `attempts` times, before re-raising" do
+      assert_raises ActiveRecord::StaleObjectError do
+        record.retryable(:attempts => 1) do
+          record.concurrent_modification!
+          record.save!
+        end
+      end
+
+      assert_record :reloads => 1, :saves => 0
     end
   end
 end

data/test/support/fake_record.rb

@@ -0,0 +1,40 @@
+class FakeRecord
+  include RetryableRecord
+
+  def initialize(retries_left = 0)
+    @counter = Hash.new(0)
+    @counter[:retries_left] = retries_left
+  end
+
+  def reload
+    counter[:reloads] += 1
+    self
+  end
+
+  def save!
+    counter[:saves] += 1
+  end
+
+  def count_saves
+    counter[:saves]
+  end
+
+  def count_reloads
+    counter[:reloads]
+  end
+
+  def concurrent_modification!
+    if retries_left?
+      counter[:retries_left] -= 1
+      raise ActiveRecord::StaleObjectError.new self, :save
+    end
+  end
+
+  private
+
+  attr_reader :counter
+
+  def retries_left?
+    counter[:retries_left] > 0
+  end
+end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: retryable_record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-06-13 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
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 5.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 5.0.4
 description: Retries an operation on an ActiveRecord until no StaleObjectError is
   being raised.
 email:
@@ -99,38 +90,34 @@ files:
 - test/helper.rb
 - test/retryable_record_import_test.rb
 - test/retryable_record_test.rb
+- test/support/fake_record.rb
 homepage: https://github.com/neopoly/retryable_record
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -864916261665633026
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -864916261665633026
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Retries an operation on an ActiveRecord until no StaleObjectError is being
   raised.
 test_files:
 - test/helper.rb
 - test/retryable_record_import_test.rb
 - test/retryable_record_test.rb
+- test/support/fake_record.rb