WatersOfOblivion-easy-matchers 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.0 2009-06-19
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/easy-matchers.rb
+script/console
+script/destroy
+script/generate
+spec/easy-matchers_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,90 @@
+= easy-matchers
+
+* http://github.com/WatersOfOblivion/easy-matchers
+
+== DESCRIPTION:
+
+A DSL for easily writing RSpec matchers
+
+== FEATURES/PROBLEMS:
+
+* Simple matcher syntax
+* Automatically handles error messages
+
+== SYNOPSIS:
+
+  should :be_named do
+    match do
+      unless @options[:dont_do_it]
+        if @target.respond_to? :name
+          if @target.name == @expected
+            fail "it is actually named #{@target.name.inspect}"
+          end
+        else
+          fail "it is not named"
+        end
+      end
+    end
+
+    failure do
+      "#{@target.class} should be named #{@expected.inspect}"
+    end
+  end
+
+  class Foo
+    def name
+      "Foo"
+    end
+  end
+
+  class Bar
+  end
+
+  describe "My specs" do
+    before do
+      @foo = Foo.new
+    end
+
+    it "should pass" do
+      @foo.should :be_named "Foo"
+      @foo.should :be_named "Bar", :dont_do_it => true
+    end
+
+    it "should not pass" do
+      @foo.should :be_named "Bar" # => 'Foo should be named "Bar": it is actually named "Foo"'
+      @bar.should :be_named "Bar" # => 'Bar should be named "Bar": it is not named'
+    end
+  end
+
+== REQUIREMENTS:
+
+* RSpec
+
+== INSTALL:
+
+* sudo gem install WatersOfOblivion-easy-matchers -s http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jonathan Bryant
+
+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 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/easy-matchers'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('easy-matchers', EasyMatchers::VERSION) do |p|
+  p.developer('Jonathan Bryant', 'jonathan@watersofoblivion.com')
+  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 }
+
+task :default => :spec

data/lib/easy-matchers.rb

@@ -0,0 +1,61 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module EasyMatchers
+  VERSION = '0.0.1'
+
+  def should name, &block
+    matcher = Class.new AbstractMatcher
+    matcher.instance_eval &block if block_given?
+
+    define_method name do |*expected|
+      matcher.new *expected
+    end
+  end
+
+  class MatchFailure < Exception
+  end
+
+  class AbstractMatcher
+    class << self
+      def match &block
+        define_method :match, &block
+      end
+
+      def failure &block
+        define_method :failure_message do
+          "#{block.call}" + (@failure && !@failure.empty? ? ": #{@failure}" : "")
+        end
+      end
+    end
+
+    def initialize *args
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @expected = args.shift
+    end
+
+    def matches? target
+      @target = target
+      begin
+        result = match
+        (result.is_a?(TrueClass) || result.is_a?(FalseClass)) ? result : true
+      rescue MatchFailure => ex
+        @failure = ex.message
+        false
+      end
+    end
+
+    def failure_message
+      "#{@target} did not match #{@expected}"
+    end
+
+    def fail *args
+      raise MatchFailure.new *args
+    end
+
+    protected
+
+    def match
+    end
+  end
+end

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/easy-matchers.rb'}"
+puts "Loading easy-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/easy-matchers_spec.rb

@@ -0,0 +1,149 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module EasyMatchers
+  describe AbstractMatcher do
+    describe "class method" do
+      before do
+        @block = Proc.new { }
+      end
+
+      describe :match do
+        it "should redefine the :match method" do
+          AbstractMatcher.should_receive(:define_method).with(:match)
+          AbstractMatcher.match &@block
+        end
+      end
+
+      describe :failure do
+        it "should redefine the :failure_message method" do
+          AbstractMatcher.should_receive(:define_method).with(:failure_message)
+          AbstractMatcher.failure &@block
+        end
+      end
+    end
+
+    describe :initialize do
+      it "should put the first argument into @expected" do
+        AbstractMatcher.new.instance_variable_get("@expected").should be_nil
+        AbstractMatcher.new(:foo, :bar).instance_variable_get("@expected").should == :foo
+      end
+
+      it "should put the options hash in @options" do
+        AbstractMatcher.new.instance_variable_get("@options").should == {}
+        AbstractMatcher.new(:foo => :bar).instance_variable_get("@options").should == { :foo => :bar }
+      end
+    end
+
+    describe :matches? do
+      before do
+        @matcher = AbstractMatcher.new
+      end
+
+      it "should put the argument in @target" do
+        @matcher.instance_variable_get("@target").should be_nil
+        @matcher.matches?(:foo)
+        @matcher.instance_variable_get("@target").should == :foo
+      end
+
+      it "should call the match method if it exists" do
+        @matcher.should_receive(:match)
+        @matcher.matches?(:foo)
+      end
+
+      it "should return the result if the match method returns a boolean" do
+        @matcher.stub!(:match).and_return(true, false)
+        @matcher.matches?(:foo).should be_true
+        @matcher.matches?(:foo).should be_false
+      end
+
+      it "should return true otherwise" do
+        @matcher.stub! :match => nil
+        @matcher.matches?(:foo).should be_true
+      end
+
+      it "should return false if a MatchFailure was raised" do
+        @matcher.stub!(:match).and_raise(MatchFailure)
+        @matcher.matches?(:foo).should be_false
+      end
+
+      it "should set the error message to @failure" do
+        @matcher.stub!(:match).and_raise(MatchFailure.new "the error message")
+        @matcher.matches?(:foo)
+        @matcher.instance_variable_get("@failure").should == "the error message"
+      end
+    end
+
+    describe :failure_message do
+      before do
+        matcher = Class.new(AbstractMatcher)
+        matcher.failure do
+          "the message"
+        end
+        @matcher = matcher.new
+      end
+
+      it "should have a basic default" do
+        AbstractMatcher.new.failure_message.should match(/.* did not match .*/)
+      end
+
+      it "should display the given message" do
+        @matcher.failure_message.should == "the message"
+      end
+
+      it "should append the failure message if present" do
+        @matcher.instance_variable_set("@failure", "the failure")
+        @matcher.failure_message.should == "the message: the failure"
+      end
+    end
+
+    describe :fail do
+      it "should raise a MatchFailure exception" do
+        lambda {
+          AbstractMatcher.new.fail
+        }.should raise_error MatchFailure
+      end
+
+      it "should set the message of the exception to the parameter" do
+        begin
+          AbstractMatcher.new.fail "the message"
+        rescue MatchFailure => ex
+          ex.message.should == "the message"
+        end
+      end
+    end
+  end
+
+  describe "class method" do
+    describe :should do
+=begin
+
+      # Testing :should is difficult to test using RSpec
+
+      before do
+        @module = Module.new
+        @module.send :include, EasyMatchers
+      end
+
+      it "should subclass AbstractMatcher" do
+        matcher = mock "Matcher"
+        Class.should_receive(:new).and_return matcher
+        @module.should :foo
+      end
+
+      it "should instance_eval the block in the new subclass" do
+        lambda {
+          @module.should :foo do
+            fail if self.superclass == AbstractMatcher
+          end
+        }.should raise_error RuntimeError
+      end
+
+      it "should define a method with the name" do
+        @module.should_not respond_to? :foo
+        @module.should :foo
+        @module.should respond_to? :foo
+      end
+=end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'easy-matchers'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_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,87 @@
+--- !ruby/object:Gem::Specification 
+name: WatersOfOblivion-easy-matchers
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-22 00:00:00 -07: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.4.1
+    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: A DSL for easily writing RSpec matchers
+email: 
+- jonathan@watersofoblivion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/easy-matchers.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/easy-matchers_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/WatersOfOblivion/easy-matchers
+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: easy-matchers
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A DSL for easily writing RSpec matchers
+test_files: []
+