bean_counter 0.0.3 → 0.0.4

data/lib/bean_counter/tube_expectation.rb

@@ -4,46 +4,75 @@ class BeanCounter::TubeExpectation
 
   def_delegators BeanCounter, :strategy
 
-  # The value that the expectation expects
+  # The Hash of options given at instantiation that the expectation expects when
+  # matching.
+  # @return [Hash]
   attr_reader :expected
 
-  # The tube found by the expecation during matching
+  # The tube found by the expecation during matching if one exists.
+  # @return [Strategy::Tube]
   attr_reader :found
 
 
   # Builds the failure message used in the event of a positive expectation
-  # failure
+  # failure.
+  #
+  # @return [String] the failure message to be used in the event of a positive
+  #   expectation failure.
   def failure_message
     return '' unless found.nil?
     return "expected tube matching #{expected.to_s}, found none."
   end
 
 
-  # Create a new tube expectation. Uses the given +expected+ Hash to determine
+  # Creates a new tube expectation. Uses the given `expected` Hash to determine
   # if any tubes exist that match the expected options.
   #
-  # Each _key_ in the +expected+ Hash is a String or a Symbol that identifies
-  # an attribute of a tube that the corresponding _value_ should be compared
-  # against. All attribute comparisons are performed using the triple equal
-  # (===) operator/method of the given _value_.
+  # Each `key` in the `expected` Hash is a String or a Symbol that identifies
+  # an attribute of a tube that the corresponding `value` should be compared
+  # against. All attribute comparisons are performed using the triple-equal
+  # (===) operator/method of the given `value`.
+  #
+  # See {BeanCounter::Strategy::MATCHABLE_TUBE_ASSERTIONS} for a list of those
+  # attributes that can be used when matching.
+  #
+  # See {BeanCounter::TestAssertions} and/or {BeanCounter::SpecMatchers} for more
+  # information.
   #
-  # See BeanCounter::MiniTest and/or BeanCounter::SpecMatchers for more information.
+  # @see BeanCounter::Strategy::MATCHABLE_TUBE_ATTRIBUTES
+  # @see BeanCounter::TestAssertions
+  # @see BeanCounter::SpecMatchers
+  # @param expected
+  #   [Hash{String, Symbol => Numeric, Proc, Range, Regexp, String, Symbol}]
+  #   Options expected when evaluating match.
   def initialize(expected)
     @expected = expected
   end
 
 
-  # Checks all tubes in the beanstalkd pool for a tube matching the expected
-  # options hash given at instantiation. The expectation succeeds if any tube
-  # exists that matches all of the expected options. If no tube exists
+  # Checks all tubes in the Beanstalkd pool for a tube matching the expected
+  # options hash given during instantiation. The expectation succeeds if any
+  # tube exists that matches all of the expected options. If no tube exists
   # matching all of the given options, the expectation fails.
   #
-  # See Strategy#tube_matches? and/or the #tube_matches? method of the strategy
-  # in use for more detailed information on how it is determined whether or not
-  # a tube matches the options expected.
+  # See {BeanCounter::Strategy::MATCHABLE_TUBE_ATTRIBUTES} for a list of those
+  # attributes that can be used when matching.
   #
-  # See also BeanCounter::MiniTest and/or BeanCounter::SpecMatchers for additional
-  # information.
+  # See {BeanCounter::Strategy#tube_matches?} and/or the #tube_matches? method
+  # of the strategy in use for more detailed information on how it is determined
+  # whether or not a tube matches the options expected.
+  #
+  # See also {BeanCounter::TestAssertions} and/or {BeanCounter::SpecMatchers}
+  # for additional information.
+  #
+  # @see BeanCounter::Strategy::MATCHABLE_TUBE_ATTRIBUTES
+  # @see BeanCounter::TestAssertions
+  # @see BeanCounter::SpecMatchers
+  # @param given [Object] ignored. All expectations should be included in
+  #   the expected options given at instantiation. Nothing will be infered
+  #   from the given Object.
+  # @return [Boolean] If a tube matching the expectation is found, returns true.
+  #   Otherwise, returns false.
   def matches?(given = nil)
     @found = strategy.tubes.detect do |tube|
       strategy.tube_matches?(tube, expected)
@@ -54,7 +83,10 @@ class BeanCounter::TubeExpectation
 
 
   # Builds the failure message used in the event of a negative expectation
-  # failure
+  # failure.
+  #
+  # @return [String] the message to be used in the event of a negative
+  #   expectation failure.
   def negative_failure_message
     return '' if found.nil?
     return [

data/lib/bean_counter/version.rb

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

data/test/unit/core_test.rb

@@ -17,7 +17,7 @@ class CoreTest < BeanCounter::TestCase
         BeanCounter.beanstalkd_url
       end
 
-      new_url = 'beanstalk://beaneater'
+      new_url = ['beanstalk://beaneater', 'beaneater:11300']
       Beaneater.configuration.beanstalkd_url = new_url
       assert_equal new_url, BeanCounter.beanstalkd_url
       Beaneater.configuration.beanstalkd_url = original_url_beaneater
@@ -25,10 +25,9 @@ class CoreTest < BeanCounter::TestCase
 
       new_url = 'beanstalk://bean_counter'
       BeanCounter.beanstalkd_url = new_url
-      assert_equal new_url, BeanCounter.beanstalkd_url
+      assert_equal [new_url], BeanCounter.beanstalkd_url
       BeanCounter.beanstalkd_url = original_url_bean_counter
 
-      # Env beanstalkd_url is always turned into an array
       new_url = 'beanstalk://env'
       ENV['BEANSTALKD_URL'] = new_url
       assert_equal [new_url], BeanCounter.beanstalkd_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bean_counter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beaneater