rspec_multi_matchers 1.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-11-18
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/match_each.rb
+lib/match_enum.rb
+lib/match_in_order.rb
+lib/rspec_multi_matchers.rb
+script/console
+script/destroy
+script/generate
+spec/match_each_spec.rb
+spec/match_enum_spec.rb
+spec/match_in_order_spec.rb
+spec/shared_enum_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,72 @@
+= rspec-multi-matchers
+
+* http://github.com/gregwebs/rspec-multi-matchers
+
+== DESCRIPTION:
+
+* match_each
+* match_enum
+* match_in_order
+
+    require 'rubygems'
+    require 'spec'
+    require 'rspec_multi_matchers'
+    
+    describe 'array of ones' do
+      it 'should be all ones' do
+        [1,2,3].should each { |n| 
+          n.should == 1
+        }
+      end
+    end
+    
+    =begin output
+    'array of ones should fail on 2' FAILED
+        line: 14
+      item 1: 2
+    expected: 1,
+         got: 2 (using ==)
+    =end
+
+As expected, the output shows expected and got fields
+line is the line number of the expectiation inside the block
+the item line gives the index of the item being yielded to the block, and the item itself
+
+
+=== Warning
+
+Note the use of brackets  '{ ... }' instead of 'do ... end'
+this is necessary because 'do .. end' does not bind strong enough
+
+== RELATED ARTICLES:
+
+* http://blog.thoughtfolder.com/2008-11-05-rspec-should-each-matcher.html
+
+== INSTALL:
+
+* sudo gem install gregwebs-rspec-multi-matchers --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Greg Weber
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rspec_multi_matchers'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rspec_multi_matchers', RspecMultiMatchers::VERSION) do |p|
+  p.developer('Greg Weber', '')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  #path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  #p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  #p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+remove_task :default
+task :default => [:spec]

data/lib/match_each.rb

@@ -0,0 +1,79 @@
+class MatchEach
+
+  class MatchEachError < Exception; end
+  class NoBlockGivenError < MatchEachError; end
+
+  class BlankEnumerableError < MatchEachError; end
+
+  def initialize(options, &block)
+    @empty_okay = (options and options[:empty])
+    @block = block
+    if !@block
+      raise NoBlockGivenError, 'no block given, you probably need to use brackets instead of "do...end"'
+    end
+  end
+
+  def matches?(target)
+    if target.nil?
+      raise BlankEnumerableError, "Expected an enumerable object, but got nil"
+    end
+
+    if !@empty_okay && target.empty?
+      raise BlankEnumerableError, "No items in the given enumerator.\nTo allow an empty enumerator pass the :empty option with a true value"
+    end
+
+    @counter = 0
+    target.each do |obj|
+      begin
+        @block.call(obj)
+      rescue Spec::Expectations::ExpectationNotMetError => e
+        @error = e
+        @failure_object = obj
+        return false
+      end
+      @counter += 1
+    end
+    true
+  end
+
+  def object_description
+    insp = @failure_object.inspect
+    return insp if insp.length < 300
+
+    if @failure_object.respond_to?(:to_s)
+      str = @failure_object.to_s
+      return str if str .length < 300
+    end
+
+    insp[0..300] + ' ... '
+  end
+  
+  def failure_line
+    # find 'matches?' in statck trace
+    # then move back to the first line number that is not a function call
+    error_line = nil
+    @error.backtrace.each do |line|
+      if line.match(/:\d+:in\s*[`'"](.*)[`'"]\s*$/)
+        return error_line if $1 == 'matches?'
+      else
+        error_line = line.match(/^[^:]+:(\d+)/)[1]
+      end
+    end
+
+    nil # should not reach here
+  end
+
+  def failure_message
+    padding = ' ' * if @error.message =~ /expected not/ then 4 else 0 end
+
+    ["    line: #{failure_line}",
+     "  item #{@counter}: #{object_description}"
+    ].map { |line| padding + line }.push(@error.message).join("\n")
+  end
+
+  # no need for should_not, so no negative_failure_messages
+end
+
+def each(options=nil, &block)
+  MatchEach.new options, &block
+end

data/lib/match_enum.rb

@@ -0,0 +1,66 @@
+class MatchEnum
+  @@enum_methods = [] # avoid re-defining
+
+  class MatchEnumError < Exception; end
+  class BlankEnumerableError < MatchEnumError; end
+  class NoBlockGivenError < MatchEnumError; end
+
+  def initialize(method, options, &block)
+    @method = method
+    @empty_okay = (options and options[:empty])
+    @block = block
+    if !@block
+      raise NoBlockGivenError, 'no block given, you probably need to use brackets instead of "do...end"'
+    end
+
+    @num_args = @block.arity
+    @num_args = 0 if @num_args == -1 # correct ruby error
+    return if @@enum_methods[@num_args]
+    @@enum_methods[@num_args] = true
+
+    args = (1..(@num_args)).map {|i| 'arg_' << i.to_s}.join(',')
+    eval <<-EOS
+    def enum_#{@num_args}(target)
+      @counter = 0
+      target.send(@method) do |#{args}|
+        begin
+          @block.call(#{args})
+        rescue Spec::Expectations::ExpectationNotMetError => e
+          @error_msg = e.to_s
+          @failure_object = [#{args}]
+          return false
+        end
+        @counter += 1
+      end
+      true
+    end
+    EOS
+  end
+
+  def enum(target)
+    eval("enum_#{@num_args}(target)")
+  end
+
+  def matches?(target)
+    if target.nil?
+      raise BlankEnumerableError, "Expected an enumerable object, but got nil"
+    end
+
+    if !@empty_okay && target.empty?
+      raise BlankEnumerableError, "No items in the given enumerator.\nTo allow an empty enumerator pass the :empty option with a true value"
+    end
+
+    return enum(target)
+  end
+
+  def failure_message
+    if @error_msg =~ /expected not/ then '    ' else '' end <<
+      "  item #{@counter}: #{@failure_object.inspect}\n#{@error_msg}"
+  end
+
+  # no need for should_not, so no negative_failure_messages
+end
+
+def enum(method, options=nil, &block)
+  MatchEnum.new method, options, &block
+end

data/lib/match_in_order.rb

@@ -0,0 +1,31 @@
+class MatchInOrder
+  def initialize(regexps)
+    @regexps = regexps
+  end
+
+  def matches?(target)
+    @target = target
+    @regexps.inject(target) do |str, regexp|
+      m = str.match(regexp)
+      if m.nil?
+        @failure_string = str
+        @failure_regex = regexp
+        return false
+      end
+      m.post_match
+    end
+    true
+  end
+
+  def failure_message
+    "expected #{@failure_string.inspect} to match #{@failure_regex.inspect}\nwithin string: #{@target.inspect}"
+  end
+
+  def negative_failure_message
+    "expected #{@target.inspect} to not match in order against: #{@regexps.inspect}"
+  end
+end
+
+def match_in_order(*regexps)
+  MatchInOrder.new(regexps)
+end

data/lib/rspec_multi_matchers.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module RspecMultiMatchers
+  VERSION = '1.0.0'
+end
+
+require "match_each"
+require "match_enum"
+require "match_in_order"

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rspec_multi_matchers.rb'}"
+puts "Loading rspec_multi_matchers gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/match_each_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MatchEach do
+  it_should_behave_like "each matcher"
+
+  before do
+    @class = MatchEach
+    @iterator = [:each]
+  end
+
+  it 'should add to the inner error message' do
+    begin
+      2.should == 1
+    rescue Spec::Expectations::ExpectationNotMetError => e
+      @line = __LINE__ + 2
+      lambda{ [1,2,3].should each { |n|
+        n.should == 1
+      } }.should raise_error(
+        Spec::Expectations::ExpectationNotMetError, /^\s*line: #{@line}\s*item 1: 2\s*#{Regexp.escape(e.message)}/m)
+    else fail
+    end
+  end
+end

data/spec/match_enum_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MatchEnum do
+  it_should_behave_like "each matcher"
+
+  before do
+    @class = MatchEnum
+    @iterator = [:enum, :each]
+  end
+
+  it 'should enum with each_with_index' do
+    [1,2,3].should enum(:each_with_index) { |n,i| n.should == i + 1 }
+  end
+end

data/spec/match_in_order_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MatchInOrder do
+
+  it "should match a single regular expression" do
+    "a".should match_in_order(//)
+    "a".should match_in_order(/a/)
+    "a".should_not match_in_order(/b/)
+    "z".should_not match_in_order(/a/)
+  end
+
+  it "should not match the same regular expressions twice" do
+    "a".should_not match_in_order(/a/,/a/)
+    lambda{ "a".should match_in_order(/a/,/a/) }.should raise_error(Spec::Expectations::ExpectationNotMetError, 'expected "" to match /a/' << "\n" << 'within string: "a"')
+
+    "abc".should_not match_in_order(/a/,/b/,/c/,/a/)
+    lambda{ "abc".should match_in_order(/a/,/b/,/c/,/a/) }.should raise_error(Spec::Expectations::ExpectationNotMetError, 'expected "" to match /a/' << "\n" << 'within string: "abc"') 
+  end
+
+  it "should match multiple regular expressions in order" do
+    "abc".should match_in_order(/a/,/b/,/c/)
+    lambda{ "abc".should_not match_in_order(/a/,/b/,/c/) }.should raise_error(Spec::Expectations::ExpectationNotMetError,'expected "abc" to not match in order against: [/a/, /b/, /c/]') 
+
+    "abc".should_not match_in_order(/a/,/c/,/b/)
+    lambda{ "abc".should match_in_order(/a/,/c/,/b/) }.should raise_error(Spec::Expectations::ExpectationNotMetError,'expected "" to match /b/' << "\n" << 'within string: "abc"')
+
+    "abc".should_not match_in_order(/b/,/a/,/c/)
+    lambda{ "abc".should match_in_order(/b/,/a/,/c/) }.should raise_error(Spec::Expectations::ExpectationNotMetError,'expected "c" to match /a/' << "\n" << 'within string: "abc"')
+  end
+end

data/spec/shared_enum_spec.rb

@@ -0,0 +1,29 @@
+shared_examples_for "each matcher" do
+  it 'should raise an error when a block is not given' do
+    # do...end does not bind strongly enough, must use brackets
+    lambda do
+      [1,2,3].should send(*@iterator) do |n| n.should == n end
+    end.should raise_error(@class::NoBlockGivenError)
+  end
+
+  it 'should not raise an error for met expectations' do
+    [1,2,3].should send(*@iterator) {|n| n.should == n}
+  end
+
+  it 'should raise an error if there are no items in the enumerable object' do
+    lambda{ [].should send(*@iterator){} }.should raise_error(@class::BlankEnumerableError)
+    [false, nil].each do |f|
+      @iterator.push(:empty => f)
+      lambda{ [].should send(*@iterator){}}.should raise_error(@class::BlankEnumerableError)
+      @iterator.pop
+    end
+  end
+
+  it 'should not raise an error if there are no items in the enumerable object and the empty flag is passed' do
+    ['okay', true].each do |t|
+      @iterator.push(:empty => t)
+      lambda{ [].should send(*@iterator){} }.should_not raise_error
+      @iterator.pop
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__))
+require 'rspec_multi_matchers'
+require 'shared_enum_spec'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_multi_matchers
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Greg Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: "* match_each * match_enum * match_in_order  require 'rubygems' require 'spec' require 'gregwebs-rspec_multi_matchers'  describe 'array of ones' do it 'should be all ones' do [1,2,3].should each { |n|  n.should == 1 } end end  =begin output 'array of ones should fail on 2' FAILED line: 14 item 1: 2 expected: 1, got: 2 (using ==) =end  As expected, the output shows expected and got fields line is the line number of the expectiation inside the block the item line gives the index of the item being yielded to the block, and the item itself"
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/match_each.rb
+- lib/match_enum.rb
+- lib/match_in_order.rb
+- lib/rspec_multi_matchers.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/match_each_spec.rb
+- spec/match_enum_spec.rb
+- spec/match_in_order_spec.rb
+- spec/shared_enum_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/gregwebs/rspec-multi-matchers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rspec_multi_matchers
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: "* match_each * match_enum * match_in_order  require 'rubygems' require 'spec' require 'gregwebs-rspec_multi_matchers'  describe 'array of ones' do it 'should be all ones' do [1,2,3].should each { |n|  n.should == 1 } end end  =begin output 'array of ones should fail on 2' FAILED line: 14 item 1: 2 expected: 1, got: 2 (using ==) =end  As expected, the output shows expected and got fields line is the line number of the expectiation inside the block the item line gives the index of the item being yielded to the block, and the item itself"
+test_files: []
+