xdotcommer-rspec-custom-matchers 0.1.1

data/README.markdown

@@ -0,0 +1,54 @@
+RSpec Custom Matchers
+=====================
+
+This gem makes it really easy to define your own 
+RSpec custom matchers in 1 line of code.
+
+This class / project is created by [xdotcommer][].  
+I forked it to make it an easy-to-install RubyGem
+
+
+Install
+-------
+
+    sudo gem install remi-rspec-custom-matchers -s http://gems.github.com
+
+Usage
+-----
+
+Wherever you want to include the `matcher` method, `include CustomMatcher::Helper`
+
+Remember, if you want to be able to call `matcher(:foo)` in the body of a class, 
+you might want to `extend CustomMatcher::Helper` instead of including it.
+
+Personally, I like to keep all of my own custom matchers for a project in 
+a module, so I do ...
+
+    require 'rspec-custom-matchers'
+
+    module MyMatchers
+      extend CustomMatcher::Helper
+
+      matcher(:be_divisible_by) { |number, divisor| number % divisor == 0 }
+      matcher(:be_even)         { |even| even % 2 == 0 }
+      matcher(:be_odd)          { |odd|  odd % 2 != 0  }
+      matcher(:be_equal_to)
+    end
+
+and then, in my `spec_helper.rb`
+
+    require 'my_matchers'
+
+    Spec::Runner.configure do |config|
+      config.include MyMatchers # this will make the matchers available to your specs
+    end
+
+That's how I do it!
+
+TODO
+----
+
+ - should support `matcher(:x){}` as well as merb's `Spec::Matcher.create`, which has more features and can be found at `merb-core/lib/merb-core/test/test_ext/rspec.rb`
+
+
+[xdotcommer]:  http://github.com/xdotcommer

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/lib/rspec-custom-matchers.rb

@@ -0,0 +1,68 @@
+$:.unshift File.dirname(__FILE__)
+
+class CustomMatcher
+
+  def self.create(class_name, &block)
+    klass = Class.new(CustomMatcher)
+    klass.send(:define_method, :matcher, &block) if block_given?
+    Object.const_set(build_class_name(class_name), klass)
+  end
+  
+  def initialize(expected = nil)
+    @expected = expected
+  end
+  
+  def failure_message
+    message
+  end
+
+  def negative_failure_message
+    message(false)
+  end
+  
+  def matcher(target, expected)
+    target == expected
+  end
+  
+  def matches?(target)
+    @target = target
+    if self.method(:matcher).arity == 2
+      matcher(@target, @expected)
+    else
+      matcher(@target)
+    end
+  end
+
+  def description *args
+    class_display_name
+  end
+  
+private
+
+  def message(positive = true)
+    "#{positive ? 'Expected' : 'Did not expect'} #{@target.inspect} to #{class_display_name} #{@expected.inspect if self.method(:matcher).arity == 2}"
+  end
+  
+  def class_display_name
+    self.class.to_s.gsub(/[A-Z]/) {|m| ' ' + m.downcase }.lstrip
+  end
+  
+  def self.build_class_name(class_name)
+    class_name.to_s.split('_').map {|s| s.capitalize}.join
+  end
+end
+
+# module to include wherever you want the #matcher method defined
+module CustomMatcher::Helper
+  def matcher(name, context = self, &block)
+    klass = CustomMatcher.create(name, &block)
+    begin
+      context.send(:define_method, name) { |*args| klass.new(*args) }
+    rescue NoMethodError
+      # the object we're trying to define this method on doesn't 
+      # have a define_method method.  let's be nice and go ahead 
+      # and try defining this method on the class of the object.
+      context.class.send(:define_method, name) { |*args| klass.new(*args) }
+    end
+  end
+end

data/spec/custom_matcher_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe CustomMatcher do
+  describe "subclasses, in general (initialized without a block)" do
+    before(:all) do
+      CustomMatcher.create(:be_an_example)
+    end
+    
+    it "should inherit from Custom Matcher" do
+      BeAnExample.superclass.should == CustomMatcher
+    end
+    
+    it "should have the default matcher (==)" do
+      BeAnExample.new(10).matches?(10).should be_true
+      BeAnExample.new("10").matches?("10").should be_true
+      BeAnExample.new(Object.new).matches?(Object.new).should be_false
+    end
+    
+    it "should provide a failure message based on it's class" do
+      BeAnExample.new(10).failure_message.should == "Expected nil to be an example 10"
+    end
+
+    it "should provide a negative failure message based on it's class" do
+      BeAnExample.new(10).negative_failure_message.should == "Did not expect nil to be an example 10"
+    end
+  end
+  
+  describe "subclasses, initialized with a matcher block" do
+    before(:all) do
+      CustomMatcher.create(:be_divisible_by) do |target, expectation|
+        target % expectation == 0
+      end
+    end
+    
+    it "should take use the create block as the custom matcher" do
+      BeDivisibleBy.new(10).matches?(5).should be_false # 5 is NOT divisible by 10
+      BeDivisibleBy.new(10).matches?(20).should be_true # 20 IS divisible by 10
+    end
+  end
+end
+

data/spec/matcher_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include CustomMatcher::Helper
+
+matcher(:be_divisible_by) { |number, divisor| number % divisor == 0 }
+matcher(:be_even) {|even| even % 2 == 0}
+matcher(:be_odd) {|odd| odd % 2 != 0}
+matcher(:be_equal_to)
+
+describe "6" do
+  it "should be divisible by 3" do
+    6.should be_divisible_by(3)
+  end
+
+  it "should be divisible by 2" do
+    6.should be_divisible_by(2)
+  end
+  
+  it "should not be divisible by 12" do
+    6.should_not be_divisible_by(12)
+  end
+  
+  it "should be even" do
+    6.should be_even
+  end
+  
+  it "should not be odd" do
+    6.should_not be_odd
+  end
+  
+  it "should be equal to 6" do
+    6.should be_equal_to(6)
+  end
+
+  it "should not be equal to 7" do
+    6.should_not be_equal_to(7)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/rspec-custom-matchers'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: xdotcommer-rspec-custom-matchers
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- xdotcommer
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-28 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Define RSpec custom matchers in 1 line
+email: remi@remitaylor.com mcowden@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- README.markdown
+- lib/rspec-custom-matchers.rb
+- spec/custom_matcher_spec.rb
+- spec/matcher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/remi/rspec-custom-matchers
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Define RSpec custom matchers in 1 line
+test_files: []
+