pester 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e359e529e96c33e2c045131b4105c957f4574f1
-  data.tar.gz: 7ecedc1fd852d0ed9ffd87f0e453140a86a586c2
+  metadata.gz: 72934e84c8c0e2fd2f04a00cf0bf813514e22ee6
+  data.tar.gz: 67bdc3fd419f71dd3e5f9e4a49b507eeb97fd083
 SHA512:
-  metadata.gz: 1ee4066ba850950f881d26f79ef5128161732db89f6403a7f0ee6125a92661b4824dce2e9033e80cfe3da4150559a166fefd70e99c1d634b6e41f29fd31487c8
-  data.tar.gz: b6633b146f951025076480d0f236bf50232e27faef95ff0080764435e3e34f972b188d9bb1016648512059e384c8194c7b0cd35abf100fd5a6778f9e6dffcc19
+  metadata.gz: 2912019dd882c9f0d7f180e8de1c116efcad81af40ddccacdf39c81fc74250cd817f743a402ddb1e3a178da886e50322011d41815021c3ab7551ffd2a5372ade
+  data.tar.gz: 39fc544569277ab0b22972342a480196292155eab48bf4b6c583012608d851fbf69ed3b663099657d6f38dbadfdbc21fe71fadaa3650cdb2c166e83bb7e02fe5

data/README.md

@@ -87,6 +87,38 @@ Because it calls `include?`, this also works for regexes:
 
 ### Configuration
 
+#### Environments
+
+The easiest way to coordinate sets of Pester options across an app is via environments--these are basically option hashes configured in Pester by name:
+
+    Pester.configure do |c|
+      c.environments[:aws]      = { max_attempts: 3, delay_interval: 5 }
+      c.environments[:internal] = { max_attempts: 2, delay_interval: 0 }
+    end
+
+This will create two environments, `aws` and `internal`, which allow you to employ different backoff strategies, depending on the usage context. These are employed simply by calling `Pester.environment_name.retry` (where `retry` can also be another helper method):
+
+    def aws_action
+      Pester.aws.retry do
+        aws_call
+      end
+    end
+
+    def action
+      Pester.internal.retry do
+        some_other_call
+      end
+    end
+
+Environments can also be merged with retry helper methods:
+
+    Pester.aws.retry  # acts different from
+    Pester.aws.retry_with_exponential_backoff
+
+where the helper method's `Behavior` will take precedence.
+
+#### Logging
+
 Pester will write retry and exhaustion information into your logs, by default using a ruby `Logger` to standard out. This can be configured either per-call, or one time per application in your initializer via `Pester#configure`. The following will suppress all logs by using a class that simply does nothing with log data, as found in `spec/`:
 
     Pester.configure do |c|

data/lib/pester/config.rb

@@ -1,12 +1,17 @@
 module Pester
   class Config
     class << self
+      attr_reader :environments
       attr_writer :logger
 
       def configure
         yield self
       end
 
+      def environments
+        @environments ||= {}
+      end
+
       def logger
         require 'logger' unless defined? Logger
         @logger ||= Logger.new(STDOUT)

data/lib/pester/environment.rb

@@ -0,0 +1,17 @@
+module Pester
+  class Environment
+    attr_accessor :options
+
+    def initialize(opts)
+      @options = opts
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s.start_with?('retry') && args.empty?
+        Pester.send(name, @options, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pester/version.rb

@@ -1,3 +1,3 @@
 module Pester
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/pester.rb

@@ -1,11 +1,15 @@
 require 'pester/behaviors'
 require 'pester/behaviors/sleep'
+require 'pester/environment'
 require 'pester/config'
 require 'pester/version'
 
 module Pester
   def self.configure(&block)
     Config.configure(&block)
+    unless Config.environments.nil?
+      self.environments = Hash[Config.environments.select { |_, e| e.is_a?(Hash) }.map { |k, e| [k.to_sym, Environment.new(e)] }]
+    end
   end
 
   def self.retry(options = {}, &block)
@@ -75,11 +79,27 @@ module Pester
     nil
   end
 
+  def respond_to?(method_sym)
+    super || Config.environments.key?(method_sym)
+  end
+
+  def method_missing(method_sym)
+    if Config.environments.key?(method_sym)
+      Config.environments[method_sym]
+    else
+      super
+    end
+  end
+
+  class << self
+    attr_accessor :environments
+  end
+
   private
 
   def self.should_retry?(e, opts = {})
-    retry_error_classes = opts[:retry_error_classes]
-    retry_error_messages = opts[:retry_error_messages]
+    retry_error_classes   = opts[:retry_error_classes]
+    retry_error_messages  = opts[:retry_error_messages]
     reraise_error_classes = opts[:reraise_error_classes]
 
     if retry_error_classes

data/pester.gemspec

@@ -18,8 +18,8 @@ EOD
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.6'

data/spec/environment_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Pester::Environment do
+  let(:options) { {} }
+  let!(:environment) { Pester::Environment.new(options) }
+
+  describe 'Delegation to Pester' do
+    context 'for retry-prefixed methods' do
+      context 'which are supported' do
+        let(:pester) { class_double('Pester').as_stubbed_const }
+
+        context 'without options' do
+          it 'calls Pester#retry without options' do
+            expect(pester).to receive(:send).with(:retry, {})
+            environment.retry {}
+          end
+        end
+        context 'with options' do
+          let(:options) { { test_opt: 1234 } }
+
+          it 'calls Pester#retry with the given options' do
+            expect(pester).to receive(:send).with(:retry, options)
+            environment.retry {}
+          end
+        end
+      end
+
+      context 'which do not exist' do
+        let(:options) { { test_opt: 1234 } }
+
+        it 'lets Pester raise NoMethodError' do
+          expect { environment.retry_does_not_exist {} }.to raise_error(NoMethodError)
+        end
+      end
+    end
+
+    context 'for non-retry-prefixed methods' do
+      let(:pester) { class_double('Pester').as_stubbed_const }
+
+      it 'raises NoMethodError' do
+        expect { environment.something_else {} }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/pester_spec.rb

@@ -87,7 +87,7 @@ shared_examples 'raises an error only in the correct cases with a reraise class'
   end
 end
 
-describe 'retry_action' do
+describe '#retry_action' do
   let(:intended_result) { 1000 }
   let(:action) { failer.fail(UnmatchedError, 'Dying') }
   let(:null_logger) { NullLogger.new }
@@ -258,7 +258,43 @@ describe 'retry_action' do
   end
 end
 
-describe 'logger' do
+describe '#environments' do
+  before { Pester.environments = {} }
+
+  context 'when a non-hash environment is configured' do
+    it 'does not add it to the Pester environment list' do
+      Pester.configure do |config|
+        config.environments[:abc] = 1234
+      end
+
+      expect(Pester.environments.count).to eq(0)
+    end
+  end
+
+  context 'when a non-hash environment is configured' do
+    let(:environment_name) { :abc }
+    let(:options) { { option: 1234 } }
+
+    it 'adds it to the Pester environment list' do
+      Pester.configure do |config|
+        config.environments[environment_name] = options
+      end
+
+      expect(Pester.environments.count).to eq(1)
+    end
+
+    it 'contains an Environment with the appropriate options' do
+      Pester.configure do |config|
+        config.environments[environment_name] = options
+      end
+
+      expect(Pester.environments[environment_name].class).to eq(Pester::Environment)
+      expect(Pester.environments[environment_name].options).to eq(options)
+    end
+  end
+end
+
+describe '#logger' do
   context 'when not otherwise configured' do
     it 'defaults to the ruby logger' do
       Pester.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pester
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Bollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-04 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,8 +74,10 @@ files:
 - lib/pester/behaviors.rb
 - lib/pester/behaviors/sleep.rb
 - lib/pester/config.rb
+- lib/pester/environment.rb
 - lib/pester/version.rb
 - pester.gemspec
+- spec/environment_spec.rb
 - spec/helpers/null_logger.rb
 - spec/helpers/scripted_failer.rb
 - spec/pester_spec.rb
@@ -105,6 +107,7 @@ signing_key:
 specification_version: 4
 summary: Common block-based retry for external calls.
 test_files:
+- spec/environment_spec.rb
 - spec/helpers/null_logger.rb
 - spec/helpers/scripted_failer.rb
 - spec/pester_spec.rb