retryable_record 0.1.1 → 0.2.0

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - ree
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode

data/README.rdoc

@@ -2,14 +2,37 @@
 
 Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
 
+{<img src="https://secure.travis-ci.org/neopoly/retryable_record.png?branch=master" alt="Build Status" />}[http://travis-ci.org/neopoly/retryable_record] {<img src="https://badge.fury.io/rb/retryable_record.png" alt="Gem Version" />}[http://badge.fury.io/rb/retryable_record] {<img src="https://codeclimate.com/github/neopoly/retryable_record.png" />}[https://codeclimate.com/github/neopoly/retryable_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]
+Documentation[http://rdoc.info/github/neopoly/retryable_record/master/frames]
 
 
 == Usage
 
+You can use +retryable_record+ in 3 different ways:
+
+=== Module function
+
+  require 'retryable_record'
+
+  RetryableRecord.retry(user) do
+    user.username = "foo"
+    user.save!
+  end
+
+=== Kernel import
+
+  require 'retryable_record/import'
+
+  RetryableRecord(user) do
+    user.username = "foo"
+    user.save!
+  end
+
+=== Module inclusion
+
   require 'retryable_record'
 
   class User < ActiveRecord::Base
@@ -23,12 +46,28 @@ RDoc[http://rdoc.info/projects/neopoly/retryable_record] |
     user.save!
   end
 
+== Optimistic locking (lock_version column)
+
+ActiveRecord migration needs to support optimistic locking. See http://api.rubyonrails.org/classes/ActiveRecord/Locking/Optimistic.html
+
+  class CreateUsers < ActiveRecord::Migration
+    def change
+      create_table :users do |t|
+        t.string :name
+        t.integer :lock_version
+
+        t.timestamps
+      end
+    end
+  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
+* http://github.com/nfedyashev/retryable
+* http://vision-media.ca/resources/ruby/better-ruby-retryable-method (broken)
 
 == TODO
 

data/lib/retryable_record/import.rb

@@ -0,0 +1,19 @@
+require 'retryable_record'
+
+module Kernel
+  # Retryable operations on an ActiveRecord +record+.
+  #
+  # == Example
+  #
+  #   require 'retryable_record/import'
+  #
+  #   RetryableRecord(user) do
+  #     user.username = "foo"
+  #     user.save!
+  #   end
+  #
+  # See RetryableRecord#retry
+  def RetryableRecord(record, &block)
+    RetryableRecord.retry(record, &block)
+  end
+end

data/lib/retryable_record/version.rb

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

data/lib/retryable_record.rb

@@ -3,7 +3,7 @@ require 'active_record/base'
 
 # Retries an operation on an ActiveRecord until no StaleObjectError is being raised.
 #
-# @example
+# == Example
 #
 #   class User < ActiveRecord::Base
 #     include RetryableRecord
@@ -16,12 +16,26 @@ require 'active_record/base'
 #     user.save!
 #   end
 #
-# @yield Operation that should be retried on failure ActiveRecord::StaleObjectError.
 module RetryableRecord
-  def retryable(&block)
+  # Retryable operations on an ActiveRecord +record+.
+  #
+  # == Example
+  #
+  #   RetryableRecord.retry(user) do
+  #     user.username = "foo"
+  #     user.save!
+  #   end
+  #
+  def retry(record)
     yield
   rescue ActiveRecord::StaleObjectError
-    reload
+    record.reload
     retry
   end
+  module_function :retry
+
+  # Retries operations on an ActiveRecord.
+  def retryable(&block)
+    RetryableRecord.retry(self, &block)
+  end
 end

data/retryable_record.gemspec

@@ -18,5 +18,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'activerecord', '>= 3'
 
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
   gem.add_development_dependency 'minitest', '~> 3.2.0'
 end

data/test/helper.rb

@@ -6,12 +6,6 @@ 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

data/test/retryable_record_import_test.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require 'retryable_record/import'
+
+class RetryableRecordImportTest < Spec
+  let(:retries) { 0 }
+  let(:record) { FakeRecord.new(retries) }
+
+  describe :RetryableRecord do
+    before do
+      RetryableRecord(record) do
+        record.concurrent_modification!
+        record.save!
+      end
+    end
+
+    let(:retries) { 0 }
+
+    it "saves and does not retry" do
+      assert_equal 0, record.counter[:reload]
+      assert_equal 1, record.counter[:save]
+    end
+  end
+end

data/test/retryable_record_test.rb

@@ -4,33 +4,33 @@ class RetryableRecordTest < Spec
   let(:retries) { 0 }
   let(:record) { FakeRecord.new(retries) }
 
-  setup do
-    record.retryable do
-      record.concurrent_modification!
-      record.save!
+  describe :retry do
+    before do
+      RetryableRecord.retry(record) do
+        record.concurrent_modification!
+        record.save!
+      end
     end
-  end
 
-  context :retryable do
-    context "without retry" do
+    describe "without retry" do
       let(:retries) { 0 }
 
-      test "saves and does not retry" do
+      it "saves and does not retry" do
         assert_equal 0, record.counter[:reload]
         assert_equal 1, record.counter[:save]
       end
     end
 
-    context "with retry once" do
+    describe "with retry once" do
       let(:retries) { 5 }
 
-      test "saves and reloads 5 times" do
+      it "saves and reloads 5 times" do
         assert_equal 5, record.counter[:reload]
         assert_equal 1, record.counter[:save]
       end
     end
 
-    test "does not rescue other errors" do
+    it "does not rescue other errors" do
       assert_raises RuntimeError do
         record.retryable do
           raise "foo"
@@ -41,4 +41,20 @@ class RetryableRecordTest < Spec
       assert_equal 1, record.counter[:save]
     end
   end
+
+  describe :retryable do
+    before do
+      record.retryable do
+        record.concurrent_modification!
+        record.save!
+      end
+    end
+
+    let(:retries) { 0 }
+
+    it "saves and does not retry" do
+      assert_equal 0, record.counter[:reload]
+      assert_equal 1, record.counter[:save]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retryable_record
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !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
@@ -77,10 +93,11 @@ files:
 - Rakefile
 - VERSION
 - lib/retryable_record.rb
+- lib/retryable_record/import.rb
 - lib/retryable_record/version.rb
 - retryable_record.gemspec
-- test.watchr
 - test/helper.rb
+- test/retryable_record_import_test.rb
 - test/retryable_record_test.rb
 homepage: https://github.com/neopoly/retryable_record
 licenses: []
@@ -94,19 +111,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !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.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 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

data/test.watchr

@@ -1,15 +0,0 @@
-#!/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 }