repeater 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Roman Parashchenko
+
+MIT License
+
+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.md

@@ -0,0 +1,46 @@
+# Repeater
+
+Flexible Ruby code re-execution
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'repeater'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install repeater
+
+## Usage
+
+### The possible options
+   ```
+   [tries]       count of tries (by default 1)
+   [timeout]     timeout (by default 0)
+   [sleep]       waiting for some sleep in seconds after each attempt (by default 0)
+   [on]          what kind of exceptions it is required to catch (by default generic Exception class)
+   [matching]    matching some error text by regular expression (by default any text /.*/)
+   [logger]      custom logger, for instance Log4R (by default STDOUT)
+   [trace]       should we output handled errors? (by default false)
+   [silent]      should we generate exception after finishing? (by default false)
+   ```
+
+### Examples
+
+ ```ruby
+ retryable { raise "Some fake error" }
+ rp(tries: 10, silent: true) { raise "Some fake error" }
+ ```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/repeater.rb

@@ -0,0 +1,2 @@
+require "repeater/version"
+require "repeater/kernel/retryable"

data/lib/repeater/kernel/retryable.rb

@@ -0,0 +1,90 @@
+# = Repeater gem
+
+module Kernel
+  class InvalidRetryableOptions < RuntimeError; end
+
+  ##
+  # This method catches specified exceptions and retries to execute code block again
+  #
+  # The possible +options+ :
+  #
+  #   [tries]       count of tries (by default 1)
+  #   [timeout]     timeout (by default 0)
+  #   [sleep]       waiting for some sleep in seconds after each attempt (by default 0)
+  #   [on]          what kind of exceptions it is required to catch (by default generic Exception class)
+  #   [matching]    matching some error text by regular expression (by default any text /.*/)
+  #   [logger]      custom logger, for instance Log4R (by default STDOUT)
+  #   [trace]       should we output handled errors? (by default false)
+  #   [silent]      should we generate exception after finishing? (by default false)
+  #
+  #  == Examples:
+  #  <tt>retryable { raise "Some fake error" }<tt>
+  #  <tt>rp(tries: 10, silent: true) { raise "Some fake error"}
+
+  def retryable(options = {}, &block)
+    opts = Retryable::merge_options(options)
+
+    return nil if opts[:tries] == 0
+
+    retry_exception = [ opts[:on] ].flatten
+    retries = 0
+    end_time = Time.now + opts[:timeout]
+    exception = nil
+    begin
+      begin
+        return block.call(retries)
+      rescue *retry_exception => e
+        exception = e
+        Retryable::log_or_raise(opts[:logger], e) unless e.message =~ opts[:matching]
+        Retryable::trace(opts[:logger], "#{e.class}: #{e.message}") if opts[:trace]
+        sleep opts[:sleep].respond_to?(:call) ? opts[:sleep].call(retries) : opts[:sleep]
+        if retries + 1 < opts[:tries]
+          retries += 1
+          retry if opts[:timeout] <= 0 || !Retryable::time_run_out?(end_time)
+        end
+      end
+    end until Retryable::time_run_out?(end_time)
+    Retryable::log_or_raise(opts[:logger], exception) unless exception.nil? || opts[:silent]
+  end
+
+  alias :rp :retryable
+
+  module Retryable # :nodoc: all
+    class << self
+
+      def time_run_out?(end_time)
+        Time.now >= end_time
+      end
+
+      def merge_options(options)
+        default_options = { tries: 1, timeout: 0, sleep: 0, on: Exception, matching: /.*/, logger: nil, trace: false, silent: false }
+        check_options(options, default_options)
+        default_options.merge!(options)
+      end
+
+      def check_options(custom_options, default_options)
+        invalid_options = default_options.merge(custom_options).keys - default_options.keys
+        unless invalid_options.empty?
+          Retryable::log_or_raise(opts[:logger], InvalidRetryableOptions.new("Invalid options: #{invalid_options.join(", ")}"))
+        end
+      end
+
+      def trace(logger, msg)
+        if logger.nil?
+          puts "[WARN] Kernel.retryable: #{msg}"
+        else
+          logger.warn msg
+        end
+      end
+
+      def log_or_raise(logger, *args)
+        if logger.nil?
+          raise *args
+        else
+          logger.send :error, *args
+        end
+      end
+    end
+  end
+
+end

data/lib/repeater/version.rb

@@ -0,0 +1,3 @@
+module Repeater
+  VERSION = "0.0.1"
+end

data/repeater.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/repeater/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Roman Parashchenko"]
+  gem.email         = %w(romikoops1@gmail.com)
+  gem.description   = %q{Flexible Ruby code re-execution}
+  gem.summary       = %q{The gem allows to handle specific exceptions for some code, and try to execute code again }
+  gem.homepage      = "https://github.com/romikoops/repeater"
+
+  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          = "repeater"
+  gem.require_paths = ["lib"]
+  gem.version       = Repeater::VERSION
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: repeater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roman Parashchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies: []
+description: Flexible Ruby code re-execution
+email:
+- romikoops1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/repeater.rb
+- lib/repeater/kernel/retryable.rb
+- lib/repeater/version.rb
+- repeater.gemspec
+homepage: https://github.com/romikoops/repeater
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.8.11
+signing_key: 
+specification_version: 3
+summary: The gem allows to handle specific exceptions for some code, and try to execute
+  code again
+test_files: []