rhod 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e38a0b14c5bc5b47d92df1a87fba15f554276ce
-  data.tar.gz: 86bbfc6da898d50d9fe574cd893d112412ce7ac3
+  metadata.gz: 4fdc88634e5041f5eb95de18515709647bd9edd2
+  data.tar.gz: fa5cdadac5ca8fcaaef6066862e5b09552b39aee
 SHA512:
-  metadata.gz: 6f796a4dbdb6170a7b688f3828a89cadf8be3bc3239e57f3fb2e43656d63522abac99cd7dfb703995d5014540b33c2ddfdee43ce188d8b7d8f9cf2303b783909
-  data.tar.gz: 62dd2d51886b9b78e1f61a60ef5c732562f6064298651a850d4e968c58aac0d3eca3c08174d05ea707214fc10c07e381bed62962ff1e77a30c1f7bdd4a48d94e
+  metadata.gz: bb25f0ef2719d5141211eab7f9981938efd5be0dc1fb1a64362280ff844624da0899458e714682e38e6a5021bc7ca7ecc70a48eca151d3b71b260fd7a5733947
+  data.tar.gz: a9d86ea5c9e59a1ea39df024f69bac790adb79c4e87990af471cedff1cc341b7174d9a5bd092661746139f516b2ad0c3caa5725bdd82d15f315cd3d1a8cdd2bb

data/.pryrc

@@ -1 +1,2 @@
-require './lib/rhod'
+require 'benchmark'
+require './lib/rhod'

data/Changes.md

@@ -1,3 +1,10 @@
+# v0.1.2
+Added logging as a feature - dleung - PR #8
+
+# v0.1.0 & v0.1.1
+Changed backoffs to be threadsafe, requiring an API change.
+Added support for profiles so commonly used Rhod settings could be located in one place.
+
 # v0.0.3
 Add support for connection pooling to be attached to a Rhod command.
 

data/README.md

@@ -63,6 +63,7 @@ Or install it yourself as:
 
 ## Configuration
 
+### Creating or Editing a New Profile
 To configure Rhod's defaults, just overwrite the default profile with any changes you'd like to make. If you're on Rails, a good place for your profiles is `config/initializers/rhod.rb`
 
 ```ruby
@@ -93,7 +94,9 @@ Rhod.create_profile(:redis,
   retries: 10,
   backoffs: :^,
   pool: ConnectionPool.new(size: 3, timeout: 10) { Redis.new },
-  exceptions: [Redis::BaseError])
+  exceptions: [Redis::BaseError],
+  logger: Logger.new("log.txt")
+  )
 
 Rhod.with_redis("1") {|r, a| r.set('test',a)}
 # => "OK"

data/lib/rhod.rb

@@ -1,4 +1,5 @@
 require 'connection_pool'
+require 'logger'
 require_relative "rhod/version"
 require_relative "rhod/backoffs"
 require_relative "rhod/command"

data/lib/rhod/command.rb

@@ -3,25 +3,24 @@ class Rhod::Command
   EXCEPTIONS = [Exception, StandardError]
 
   def initialize(*args, &block)
-    opts = args[-1].kind_of?(Hash) ? args.pop : {}
-    @args = args
-    @args ||= []
+    opts            = args[-1].kind_of?(Hash) ? args.pop : {}
+    @args           = args || []
 
-    @request = block
+    @request        = block
 
-    @retries = opts[:retries]
-    @retries ||= 0
-    @attempts = 0
+    @retries        = opts[:retries] || 0
+    @attempts       = 0
 
-    @backoffs = Rhod::Backoffs.backoff_sugar_to_enumerator(opts[:backoffs])
-    @backoffs ||= Rhod::Backoffs::Logarithmic.new(1.3)
+    @logger         = opts[:logger]
 
-    @fallback = opts[:fallback]
+    @backoffs       = Rhod::Backoffs.backoff_sugar_to_enumerator(opts[:backoffs])
+    @backoffs     ||= Rhod::Backoffs::Logarithmic.new(1.3)
 
-    @pool = opts[:pool]
+    @fallback       = opts[:fallback]
 
-    @exceptions = opts[:exceptions]
-    @exceptions ||= EXCEPTIONS
+    @pool           = opts[:pool]
+
+    @exceptions     = opts[:exceptions] || EXCEPTIONS
   end
 
   ### Class methods
@@ -44,10 +43,12 @@ class Rhod::Command
       else
         @request.call(*@args)
       end
-    rescue *@exceptions
+    rescue *@exceptions => e
       @attempts += 1
+      @next_attempt = @backoffs.next
       if @attempts <= @retries
-        sleep(@backoffs.next)
+        @logger.warn("Rhod - Caught an exception: #{e.message}.  Attempt #{@attempts} in #{sprintf("%.2f", @next_attempt)} secs") if @logger && @logger.respond_to?(:warn)
+        sleep(@next_attempt)
         retry
       else
         return @fallback.call(*@args) if @fallback
@@ -55,5 +56,4 @@ class Rhod::Command
       end
     end
   end
-
 end

data/lib/rhod/middleware.rb

@@ -0,0 +1,10 @@
+class Rhod::Middleware
+  def use(middleware, *args, &block)
+    self.stack << [middleware, args, block]
+  end
+
+  protected
+  def stack
+    @stack ||= []
+  end
+end

data/lib/rhod/profile.rb

@@ -2,7 +2,7 @@ class Rhod::Profile < Hash
   @@profiles = {}
 
   def initialize(name, options={})
-    # When creating new profiles, copy from the global default, incase it was customized.
+    # When creating new profiles, copy from the global default, in case it was customized.
     if @@profiles[:default]
       default = @@profiles[:default].dup
     else
@@ -29,9 +29,7 @@ class Rhod::Profile < Hash
 end
 
 Rhod::Profile.new(:default,
-  retries: 0,
+  retries: 5,
   backoffs: Rhod::Backoffs::Logarithmic.new(1.3),
-  fallback: nil,
-  pool: nil,
   exceptions: [Exception, StandardError],
 )

data/lib/rhod/version.rb

@@ -1,3 +1,3 @@
 module Rhod
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/test_command.rb

@@ -1,4 +1,5 @@
 require 'minitest/autorun'
+require 'stringio'
 require File.expand_path(File.dirname(__FILE__) + '/helper')
 
 describe Rhod::Command do
@@ -46,6 +47,17 @@ describe Rhod::Command do
           backoff.verify
         end
 
+        describe "with logging" do
+          it "logs failures" do
+            test_log = Logger.new(output = StringIO.new)
+            begin
+              Rhod::Command.new(logger: test_log, retries: 1) {raise StandardError}.execute
+            rescue
+            end
+            output.string.must_match(/^W.*Rhod - Caught an exception.*Attempt \d in \d\.\d\d secs$/)
+          end
+        end
+
       end
 
       describe "it uses fallbacks" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rhod
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paul Bergeron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-04 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/rhod/backoffs/logarithmic.rb
 - lib/rhod/backoffs/random.rb
 - lib/rhod/command.rb
+- lib/rhod/middleware.rb
 - lib/rhod/profile.rb
 - lib/rhod/version.rb
 - rhod.gemspec