waiter_ 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd0325695fdeaf22e3e8d68315874f9f4dbaeb83
+  data.tar.gz: 16016830d0702876aa84c58755dfcb415b2384a7
+SHA512:
+  metadata.gz: e44261b1a34d9e14053a2dc6b557f00d4fe75a9ac416073c7faf3494b59c1ac2353c975a9e9043e13e8b0bcc68b9959d927e58b161ae2d6fca37f973f9f74880
+  data.tar.gz: 42c81f41bf86dcbb66d4f29f4a181f4fa5c01192b6dd8a6f45f229ff9abf3dcd4e1e8189b888df8280a03141e34b5e0161a9190c3bf6b0d8bc0a484d95106f70

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/README.md

@@ -0,0 +1,56 @@
+# Waiter
+
+A simple wait/polling gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'waiter', git: 'git@github.atl.pdrop.net:dmcneil/waiter.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Just `include Waiter` and the following APIs will be available.
+
+```ruby
+wait('foo').to eq 'foo' # Will pass.
+wait('foo').to eq 'bar' # Will throw exception.
+wait('foo').to_not eq 'bar' # Will pass.
+wait('foo').to_not eq 'foo' # Will fail.
+```
+
+To adjust the timeout/polling, simple chain methods are supported.
+
+The *for* method accepts an Integer and adjusts the timeout. Use the *every* method with an Integer to adjust the polling time.
+
+```ruby
+# Wait for 30 seconds, polling every 2 second.
+wait('foo').every(2).for(30).to eq 'foo'
+```
+
+You do *not* have to use both methods, you can adjust one or the other. They can also be used in any order.
+
+```ruby
+# Wait for 30 seconds, using the default 1 second poll.
+wait('foo').for(30).to eq 'foo'
+
+# Wait for the default 15 seconds, polling every 5 seconds.
+wait('foo').every(5).to eq 'foo'
+```
+
+You can also pass a block to be evaluated, using *until*, until it is true.
+
+```ruby
+wait.until { true == true }
+
+wait.every(5).for(30).until {
+  true == true
+}
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Waiter
+  VERSION = '0.0.1'
+end

data/lib/waiter.rb

@@ -0,0 +1,131 @@
+require 'rspec/expectations'
+
+module Waiter
+  # Wrapper for RSpec expectations that allows waiting/polling.
+  #
+  # The default timeout is 15 seconds, polling every 1 second.
+  #
+  # @example
+  #
+  #   wait('foo').to eq 'foo' # Will pass.
+  #   wait('foo').to eq 'bar' # Will throw exception.
+  #   wait('foo').to_not eq 'bar' # Will pass.
+  #   wait('foo').to_not eq 'foo' # Will fail.
+  #
+  # To adjust the timeout/polling, simple chain methods are supported.
+  #
+  # The *for* method accepts an Integer and adjusts the timeout.
+  # Use the *every* method with an Integer to adjust the polling time.
+  #
+  # @example
+  #
+  #   # Wait for 30 seconds, polling every 2 second.
+  #   wait('foo').every(2).for(30).to eq 'foo'
+  #
+  # You do *not* have to use both methods, you can adjust one or the other.
+  # They can also be used in any order.
+  #
+  # @example
+  #
+  #   # Wait for 30 seconds, using the default 1 second poll.
+  #   wait('foo').for(30).to eq 'foo'
+  #
+  #   # Wait for the default 15 seconds, polling every 5 seconds.
+  #   wait('foo').every(5).to eq 'foo'
+  #
+  # You can also pass a block to be evaluated, using *until*, until it is true.
+  #
+  # @example
+  #
+  #   wait.until { true == true }
+  #
+  #   wait.every(5).for(30).until {
+  #     true == true
+  #   }
+  #
+  # @author Derek McNeil <dmcneil@pindrop.com>
+  def wait(value=true, &block)
+    WaitExpectationTarget.for(value, block)
+  end
+
+  alias_method :wait_for, :wait
+
+  class WaitExpectationTarget < RSpec::Expectations::ExpectationTarget
+    attr_reader :target
+    attr_accessor :timeout, :polling, :message
+
+    DEFAULT_TIMEOUT = 15
+    DEFAULT_POLLING = 1
+
+    def initialize(value)
+      @target = value
+      @timeout = DEFAULT_TIMEOUT
+      @polling = DEFAULT_POLLING
+    end
+
+    def wait(message=nil, &block)
+      unless @timeout > @polling
+        raise ArgumentError, 'Timeout must be a higher value than polling.'
+      end
+
+      @message = message || default_failure_message
+
+      while @timeout > 0 && @timeout > @polling
+        @result = begin
+          block.call
+        rescue Exception => error
+          @error = error
+          false
+        end
+
+        break if @result
+        sleep @polling
+        @timeout = @timeout - @polling
+      end
+
+      unless @result
+        if @error
+          @error.message.prepend @message
+        else
+          @error = RuntimeError.new @message
+        end
+
+        raise @error
+      end
+    end
+
+    alias_method :until, :wait
+
+    def every(seconds)
+      @polling = seconds
+      self
+    end
+
+    def for(seconds)
+      @timeout = seconds
+      self
+    end
+
+    def to(matcher=nil, message=nil, &block)
+      prevent_operator_matchers(:to) unless matcher
+      wait(message) do
+        RSpec::Expectations::PositiveExpectationHandler.handle_matcher(target, matcher, message, &block)
+      end
+      @target
+    end
+
+    def not_to(matcher=nil, message=nil, &block)
+      prevent_operator_matchers(:not_to) unless matcher
+      wait(message) do
+        RSpec::Expectations::NegativeExpectationHandler.handle_matcher(target, matcher, message, &block)
+      end
+      @target
+    end
+
+    alias_method :to_not, :not_to
+
+    def default_failure_message
+      "Timed out after waiting for #{@timeout} seconds, polling every #{@polling} second.\n"
+    end
+  end
+end

data/waiter.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'waiter_'
+  spec.version       = Waiter::VERSION
+  spec.authors       = ['Derek McNeil']
+  spec.email         = ['dmcneil@pindropsecurity.com']
+
+  spec.summary       = 'A simple polling gem.'
+  spec.homepage      = 'https://github.atl.pdrop.net/dmcneil/waiter'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: waiter_
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derek McNeil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- dmcneil@pindropsecurity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/version.rb
+- lib/waiter.rb
+- waiter.gemspec
+homepage: https://github.atl.pdrop.net/dmcneil/waiter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple polling gem.
+test_files: []