bean_counter 0.0.2 → 0.0.3

data/.yardopts

@@ -0,0 +1,7 @@
+--output-dir doc/
+--readme README.md
+--title BeanCounter
+--markup=markdown
+--protected
+--private
+lib/bean_counter/**/*.rb

data/README.md

@@ -1,5 +1,6 @@
 # BeanCounter
 
+[![Gem Version](https://badge.fury.io/rb/bean_counter.png)](http://badge.fury.io/rb/bean_counter)
 [![Build Status](https://secure.travis-ci.org/gemeraldbeanstalk/bean_counter.png)](http://travis-ci.org/gemeraldbeanstalk/bean_counter)
 [![Dependency Status](https://gemnasium.com/gemeraldbeanstalk/bean_counter.png)](https://gemnasium.com/gemeraldbeanstalk/bean_counter)
 [![Coverage Status](https://coveralls.io/repos/gemeraldbeanstalk/bean_counter/badge.png?branch=master)](https://coveralls.io/r/gemeraldbeanstalk/bean_counter)
@@ -8,50 +9,61 @@
 BeanCounter provides additional TestUnit/MiniTest assertions and/or RSpec matchers for testing Ruby code that relies on
 [Beaneater](https://github.com/beanstalkd/beaneater) and [Beanstalkd](https://github.com/kr/beanstalkd).
 
-##### TestUnit/MiniTest Assertions
+## Assertions/Matchers
+### TestUnit/MiniTest Assertions
 For TestUnit/MiniTest, BeanCounter provides 6 assertions/refutations
 for use in your tests:
-  - ```assert_enqueued/refute_enqueued``` - Searches all jobs in the beanstalkd
+
+  - `assert_enqueued/refute_enqueued` - Searches all jobs in the beanstalkd
   pool for jobs with attributes matching the keys/values of the Hash given
-  - ```assert_enqueues/refute_enqueues``` - Searches only those jobs in the
+  - `assert_enqueues/refute_enqueues` - Searches only those jobs in the
   beanstalkd pool enqueued during the execution of the provided block for jobs
   with attributes matching the keys/values of the Hash given
-  - ```assert_tube/refute_tube``` - Searches all tubes in the beanstalkd pool
+  - `assert_tube/refute_tube` - Searches all tubes in the beanstalkd pool
   for a tube with attributes matching the keys/values of a given Hash
 
-BeanCounter also provides a helper, ```BeanCounter.reset!``` to reset a given tube or
+BeanCounter also provides a helper, `BeanCounter.reset!` to reset a given tube or
 the entire beanstalkd pool by deleting the appropriate jobs.
 
-##### RSpec Matchers
+### RSpec Matchers
 For RSpec, BeanCounter provides 2 equivalent should/should_not matchers for use in your specs:
-  - ```have_enqueued``` - Searches for jobs in the beanstalkd
+
+  - `have_enqueued` - Searches for jobs in the beanstalkd
   pool with attributes matching the keys/values of the Hash given.
   If called on a block only inspects jobs enqueued during the execution of
   the block. Otherwise, inspects all jobs.
-  - ```have_tube``` - Searches all tubes in the beanstalkd pool
+  - `have_tube` - Searches all tubes in the beanstalkd pool
   for a tube with attributes matching the keys/values of a given Hash
 
-BeanCounter also provides a helper, ```BeanCounter.reset!``` to reset a given tube or
+BeanCounter also provides a helper, `BeanCounter.reset!` to reset a given tube or
 the entire beanstalkd pool by deleting the appropriate jobs.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'bean_counter'
+```ruby
+gem 'bean_counter'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it without bundler:
 
-    $ gem install bean_counter
+```
+$ gem install bean_counter
+```
+
 
 ## Test Framework Configuration
 #### TestUnit/MiniTest
 In order to use BeanCounter in your tests you'll need to require and configure
 it in your test_helper:
+
 ```ruby
 # To make the assertions available to all test cases you can require one of the
 # following in test/test_helper.rb:
@@ -91,6 +103,7 @@ end
 #### RSpec
 In order to use BeanCounter in your specs you'll need to require and configure
 it in your spec_helper:
+
 ```ruby
 # To make the BeanCounter matchers available to all specs, require
 # bean_counter/spec in spec/spec_helper.rb:
@@ -122,25 +135,28 @@ Beyond the configuration required to utilize BeanCounter with your test
 framework, BeanCounter may also require other test framework agnostic
 configuration to work properly or as desired.
 
-#####BeanCounter.beanstalkd_url
-```BeanCounter.beanstalkd_url``` allows you to directly provide a string or an
+###BeanCounter.beanstalkd_url
+
+`BeanCounter.beanstalkd_url` allows you to directly provide a string or an
 Array of strings that will be used by BeanCounter when communicating with the
 beanstalkd pool. By default, BeanCounter will try to intelligently determine
 the location of beanstalkd servers by checking for configuration in a few
 different places, though in some cases special configuration may be required.
 
 First, and of higest precedence, BeanCounter will check
-```ENV['BEANSTALKD_URL']``` for a comma separated list of beanstalkd
+`ENV['BEANSTALKD_URL']` for a comma separated list of beanstalkd
 servers. If no evironment variable is found, any value provided for
-```BeanCounter.beanstalkd_url``` will be used to connect to the the beanstalkd pool.
+`BeanCounter.beanstalkd_url` will be used to connect to the the beanstalkd pool.
 Finally, if no environment variable is found and no value has been provided for
 BeanCounter.beanstalkd_url, BeanCounter will try to use any configuration
 provided to Beaneater. If no beanstalkd_url can be determined, a Runtime error
 will be raised.
 
 Beanstalkd urls can be provided in any of the variety of formats shown below:
-```
-$ BEANSTALKD_URL='127.0.0.1,beanstalk://localhost:11300,localhost:11301' rake test
+
+```ruby
+# Started with environment variable:
+# BEANSTALKD_URL='127.0.0.1,beanstalk://localhost:11300,localhost:11301' rake test
 BeanCounter.beanstalkd_url
   #=> ['127.0.0.1', 'beanstalk://localhost:11300', 'localhost:11301']
 
@@ -153,8 +169,8 @@ BeanCounter.beanstalkd_url
   #=> ['127.0.0.1', 'beanstalk://localhost:11300', 'localhost:11301']
 ```
 
-#####BeanCounter.strategy
-```BeanCounter.strategy``` allows you to choose and configure the strategy
+###BeanCounter.strategy
+`BeanCounter.strategy` allows you to choose and configure the strategy
 BeanCounter uses for accessing and interacting with the beanstalkd pool. At
 present, there is only a single strategy available, but at least one other is
 in the works.
@@ -176,15 +192,16 @@ identifies an attribute of a job that the corresponding Hash value should be
 compared against. All attribute comparisons are performed using the triple-equal
 (===) operator/method of the given value.
 
-#####assert_enqueued/have_enqueued
-The attributes available on a job for comparison are: ```age```, ```body```,
-```buries```, ```connection```, ```delay```, ```id```, ```kicks```, ```pri```,
-```releases```, ```reserves```, ```state```, ```time-left```, ```timeouts```,
-```ttr```, and ```tube```.
+###assert_enqueued/have_enqueued
+The attributes available on a job for comparison are: `age`, `body`,
+`buries`, `connection`, `delay`, `id`, `kicks`, `pri`,
+`releases`, `reserves`, `state`, `time-left`, `timeouts`,
+`ttr`, and `tube`.
 
 To assert or set the expectation that a job with the body of 'foo'
 should have been enqueued on the default tube you could use the following:
-```
+
+```ruby
   # TestUnit/MiniTest
   assert_enqueued(:tube => 'default', :body => 'foo')
 
@@ -193,13 +210,14 @@ should have been enqueued on the default tube you could use the following:
   should have_enqueued(:tube => 'default', :body => /foo/)
 ```
 
-#####assert_enqueues/have_enqueued
+###assert_enqueues/have_enqueued
 The assert_enqueues assertion and the have_enqueued matcher also support a
 block form that will only check jobs enqueued during the execution of the given
 block for matches. For example, if you wanted to assert or set the expectation
 that a particular method caused a job to be enqueued to the exports tube in the
 ready state, you could use something like the following:
-```
+
+```ruby
   # TestUnit/MiniTest
   assert_enqueues(:tube => 'exports', :state => 'ready') do
     method_that_should_enqueue_a_job
@@ -212,7 +230,8 @@ ready state, you could use something like the following:
 ```
 
 The refutations/negative matches work the same way:
-```
+
+```ruby
   # TestUnit/MiniTest
   refute_enqueues(:tube => 'exports', :state => 'ready') do
     method_that_should_not_enqueue_a_job
@@ -237,7 +256,8 @@ triple-equal (===) operator/method of the value of the provided count evaluates
 to true when given the total number of matching jobs. Otherwise the assertion
 fails. The use of === allows for more advanced comparisons using Procs, Ranges,
 Regexps, etc.
-```
+
+```ruby
   # TestUnit/MiniTest
   assert_enqueues(:tube => 'default', :body => 'foo', :count => 1) do
     method_that_should_enqueue_exactly_one_job
@@ -253,23 +273,24 @@ Regexps, etc.
 A count key can also be used with the refutations/negative matches, but tends
 to be better stated as an assertion/positive match with a count.
 
-#####assert_tube/have_tube
+###assert_tube/have_tube
 Similar to the other assertions/matchers, assert_tube and have_tube take a Hash
 of options that will be used to find matching tubes. Each key in the options
 Hash is a String or a Symbol that identifies an attribute of a tube that the
 corresponding Hash value should be compared against. All attribute comparisons
 are performed using the triple-equal (===) operator/method of the given value.
 
-The attributes available on a tube for matching are: ```cmd-delete```,
-```cmd-pause-tube```, ```current-jobs-buried```, ```current-jobs-delayed```,
-```current-jobs-ready```, ```current-jobs-reserved```,
-```current-jobs-urgent```, ```current-using```, ```current-waiting```,
-```current-watching```, ```name```, ```pause```, ```pause-time-left```,
-and ```total-jobs```.
+The attributes available on a tube for matching are: `cmd-delete`,
+`cmd-pause-tube`, `current-jobs-buried`, `current-jobs-delayed`,
+`current-jobs-ready`, `current-jobs-reserved`,
+`current-jobs-urgent`, `current-using`, `current-waiting`,
+`current-watching`, `name`, `pause`, `pause-time-left`,
+and `total-jobs`.
 
 For example to assert that no connections are waiting on the default tube
 something like the following could be used:
-```
+
+```ruby
   # TestUnit/MiniTest
   assert_tube(:name => 'default', 'current-waiting' => 0)
 
@@ -279,7 +300,8 @@ something like the following could be used:
 
 Similarly one could use refute_tube or the negative matcher for have_tube to
 verify that the exports tube is paused:
-```
+
+```ruby
   # TestUnit/MiniTest
   refute_tube(:name => 'exports', :pause => 0)
 
@@ -288,14 +310,15 @@ verify that the exports tube is paused:
 ```
 
 For more detailed explanations and more examples make sure to check out the
-docs, expectations, and respective tests:  
-[docs](http://rubydoc.info/gems/bean_counter/0.0.2/frames)  
-[enqueued_expectation](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/enqueued_expectation.rb)  
-[tube_expectation](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/tube_expectation.rb)  
-[test_assertions](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/test_assertions.rb)  
-[spec_matchers](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/spec_matchers.rb)  
-[test_assertions_test](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/test/unit/test_assertions_test.rb)  
-[spec_spec](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/spec/spec_spec.rb)
+docs, expectations, and respective tests:
+
+- [docs](http://rubydoc.info/gems/bean_counter/0.0.3/frames)
+- [enqueued_expectation](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/enqueued_expectation.rb)
+- [tube_expectation](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/tube_expectation.rb)
+- [test_assertions](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/test_assertions.rb)
+- [spec_matchers](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/lib/bean_counter/spec_matchers.rb)
+- [test_assertions_test](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/test/unit/test_assertions_test.rb)
+- [spec_spec](https://github.com/gemeraldbeanstalk/bean_counter/tree/master/spec/spec_spec.rb)
 
 ## Contributing
 

data/lib/bean_counter/version.rb

@@ -1,4 +1,4 @@
 module BeanCounter
   # BeanCounter version number
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: bean_counter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
+  prerelease: 
 platform: ruby
 authors:
 - gemeraldbeanstalk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaneater
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: stalk_climber
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -77,6 +86,7 @@ files:
 - .rdoc_options
 - .rspec
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
@@ -106,26 +116,27 @@ files:
 homepage: https://github.com/gemeraldbeanstalk/bean_counter
 licenses:
 - MIT
-metadata: {}
 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: 2.1.11
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: BeanCounter provides additional assertions for testing Ruby code that relies
   on Beaneater
 test_files:
@@ -136,3 +147,4 @@ test_files:
 - test/unit/strategy_test.rb
 - test/unit/test_assertions_test.rb
 - test/unit/tube_expectation_test.rb
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjY0YjBhNjJmMjgxNGNhMDZjODU0ODA1MzY1ZmU3OThmYTk2NTAzZQ==
-  data.tar.gz: !binary |-
-    MmFhOWJiYTUwOTk5YjQ3ZjY5YWFlNDFmMzE3YTgzMGMwNGEzMjdlMA==
-SHA512:
-  metadata.gz: !binary |-
-    N2M4OWZiNzg2MWViZTkzMTcwMmIyNmJlN2M0ZTY5NzYxYTNjN2NlMmMyNjIy
-    YzcyNDIwOTcwNDZiOWFhNzVkZDc0MDhjMWU3MjZjNDU0NmU5OGMxM2NjZDMx
-    ZjcxZGQzNGQ2YmFjYjNiOThiZGRhOWE4YTNlZWViNmMxYjMyMzY=
-  data.tar.gz: !binary |-
-    YThmM2ZmYzNiNzFkNTIyOTIxYTYzNzllZWEyYmI2MzhlMjk3Y2Y3ZjhjNmEw
-    OGE3NTQ3OTc0MmJlMDE4YWQ2NTNmNmYzZDA2MDUzOWE5OGJlOGNjN2E3MjBh
-    MTM4MmI1YmQ5ZWQzYjRlYjA3ZTEzMTU3MmZmMjAwZmZjNGZlY2Q=