mustard 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Bates
+
+MIT License
+
+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/README.md

@@ -0,0 +1,98 @@
+# Mustard
+
+An expectation library that adds "must" and "must_not" which can have matchers called on them. Comes with a default set of matchers, and additional matchers can be easily added. Works with RSpec, MiniTest, and Test::Unit. Requires Ruby 1.9 or greater.
+
+
+## Installation
+
+Add this line to your application's Gemfile and run the `bundle` command.
+
+```ruby
+gem 'mustard', group: :test
+```
+
+
+## Usage
+
+Inside of a test or spec, call `must` or `must_not` on any object followed by a matcher. Some matchers have aliases.
+
+```ruby
+5.must.equal 5
+5.must_not.eq 4
+
+5.must.be_greater_than 4
+5.must.be_gt 4
+
+[].must.be :empty? # calls the method to see if it's true
+record.must.be :valid?
+5.must.be :between?, 6, 7
+# raises Mustard::Failure: expected 5 to be between 6 and 7
+
+-> { 5.bad_call }.must.raise_exception(NoMethodError)
+```
+
+See [the source code](https://github.com/ryanb/mustard/blob/master/lib/mustard.rb#L26) for a complete list of matchers and their behavior.
+
+
+### Adding Matchers
+
+Matchers are very easy to add. If a block is passed, it will be executed in the context of the subject.
+
+```ruby
+Mustard.matcher(:be_empty) { empty? }
+[].must.be_empty?
+[1].must.be_empty? # fail: expected [1] to be empty
+```
+
+Alternatively, you can pass a class to fully customize the behavior.
+
+```ruby
+class BetweenMatcher
+  # Subject is always passed, any extra arguments will be added after
+  def initialize(subject, min, max)
+    @subject = subject
+    @min = min
+    @max = max
+  end
+
+  def match?
+    @subject.between? @min, @max
+  end
+
+  def failure_message
+    "expected #{@subject.inspect} to be between #{@min.inspect} and #{@max.inspect}."
+  end
+
+  def negative_failure_message
+    "expected #{@subject.inspect} to not be between #{@min.inspect} and #{@max.inspect}."
+  end
+end
+
+Mustard.matcher(:be_between, BetweenMatcher)
+5.must.be_between(5, 7)
+```
+
+
+### Disabling Other Matchers
+
+**For RSpec,** add this line to your `spec_helper.rb` if you want to disable other matchers.
+
+```ruby
+config.expect_with Mustard
+```
+
+**For MiniTest::Spec,** add this line to your `test_helper.rb` if you want to disable existing matchers.
+
+```ruby
+ENV["MT_NO_EXPECTATIONS"] = "true"
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make changes and ensure they pass with `rspec .`
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mustard.rb

@@ -0,0 +1,52 @@
+require "mustard/version"
+require "mustard/object_extension"
+require "mustard/failure"
+require "mustard/must"
+require "mustard/matchers/default_matcher"
+require "mustard/matchers/be_matcher"
+require "mustard/matchers/close_matcher"
+
+module Mustard
+  def self.matcher(*args, &block)
+    Must.matcher(*args, &block)
+  end
+
+  def self.fail(message = nil)
+    if defined?(RSpec::Mustard::Failure)
+      raise RSpec::Mustard::Failure.new(message)
+    else
+      raise Failure.new(message)
+    end
+  end
+
+  def fail(*args)
+    Mustard.fail(*args)
+  end
+
+  matcher(:equal, :eq) { |other| self == other }
+  matcher(:match)      { |other| self =~ other }
+  matcher(:be_true)    { self }
+  matcher(:be_false)   { !self }
+  matcher(:be_nil)     { nil? }
+  matcher(:include)    { |*args| include?(*args) }
+  matcher(:respond_to) { |*args| respond_to?(*args) }
+
+  matcher(:be_greater_than, :be_gt)              { |other| self > other }
+  matcher(:be_greater_than_or_equal_to, :be_gte) { |other| self >= other }
+  matcher(:be_less_than, :be_lt)                 { |other| self < other }
+  matcher(:be_less_than_or_equal_to, :be_lte)    { |other| self <= other }
+
+  matcher(:be, BeMatcher)
+  matcher(:be_close_to, CloseMatcher)
+
+  matcher(:raise_exception) do |*args|
+    raised = false
+    exception = args.first || StandardError
+    begin
+      call
+    rescue exception
+      raised = true
+    end
+    raised
+  end
+end

data/lib/mustard/failure.rb

@@ -0,0 +1,19 @@
+module Mustard
+  if defined?(MiniTest::Assertion)
+    class Failure < MiniTest::Assertion; end
+  elsif defined?(Test::Unit::AssertionFailedError)
+    class Failure < Test::Unit::AssertionFailedError; end
+  else
+    class Failure < StandardError; end
+  end
+end
+
+# Kind of silly but the failure class must start with "RSpec"
+# for it to not show up in RSpec output.
+if defined?(RSpec)
+  module RSpec
+    module Mustard
+      class Failure < ::Mustard::Failure; end
+    end
+  end
+end

data/lib/mustard/matchers/be_matcher.rb

@@ -0,0 +1,27 @@
+module Mustard
+  class BeMatcher
+    def initialize(subject, method, *args)
+      @subject = subject
+      @method = method
+      @args = args
+    end
+
+    def match?
+      @subject.send(@method, *@args)
+    end
+
+    def failure_message
+      "expected #{@subject.inspect} to be #{message_action}"
+    end
+
+    def negative_failure_message
+      "expected #{@subject.inspect} to not be #{message_action}"
+    end
+
+    def message_action
+      message_action = @method.to_s.sub(/\?$/, "")
+      message_action += " " + @args.map(&:inspect).join(" and ") unless @args.empty?
+      message_action
+    end
+  end
+end

data/lib/mustard/matchers/close_matcher.rb

@@ -0,0 +1,25 @@
+module Mustard
+  class CloseMatcher
+    def initialize(subject, expected, delta = 0.001)
+      @subject = subject
+      @expected = expected
+      @delta = delta
+    end
+
+    def match?
+      @delta >= (@subject - @expected).abs
+    end
+
+    def failure_message
+      "expected #{@subject.inspect} to #{message_expected}"
+    end
+
+    def negative_failure_message
+      "expected #{@subject.inspect} to not #{message_expected}"
+    end
+
+    def message_expected
+      "be within #{@delta.inspect} of #{@expected.inspect}"
+    end
+  end
+end

data/lib/mustard/matchers/default_matcher.rb

@@ -0,0 +1,39 @@
+module Mustard
+  class DefaultMatcher
+    # This will genereate a subclass of DefaultMatcher to
+    # act as the matcher class. This way we can persist the
+    # name of the matcher and the block of behavior.
+    def self.subclass_for(name, behavior)
+      klass = Class.new(self)
+      class << klass
+        attr_accessor :name, :behavior
+      end
+      klass.name = name
+      klass.behavior = behavior
+      klass
+    end
+
+    def initialize(subject, *args)
+      @subject = subject
+      @args = *args
+    end
+
+    def match?
+      @subject.instance_exec(*@args, &self.class.behavior)
+    end
+
+    def failure_message
+      "expected #{@subject.inspect} to #{message_action}"
+    end
+
+    def negative_failure_message
+      "expected #{@subject.inspect} to not #{message_action}"
+    end
+
+    def message_action
+      message_action = self.class.name.to_s.tr("_", " ")
+      message_action += " " + @args.map(&:inspect).join(", ") unless @args.empty?
+      message_action
+    end
+  end
+end

data/lib/mustard/must.rb

@@ -0,0 +1,31 @@
+module Mustard
+  class Must
+    def self.matcher(name, *other_names, &block)
+      if block
+        matcher_class = DefaultMatcher.subclass_for(name, block)
+      else
+        matcher_class = other_names.pop
+      end
+      define_method(name) do |*args|
+        _assert matcher_class.new(@subject, *args)
+      end
+      other_names.each do |other_name|
+        alias_method other_name, name
+      end
+    end
+
+    def initialize(subject, negate = false)
+      @subject = subject
+      @negate = negate
+    end
+
+  private
+
+    def _assert(matcher)
+      if @negate == !!matcher.match?
+        message = @negate ? matcher.negative_failure_message : matcher.failure_message
+        Mustard.fail(message)
+      end
+    end
+  end
+end

data/lib/mustard/object_extension.rb

@@ -0,0 +1,13 @@
+module Mustard
+  module ObjectExtension
+    def must
+      Must.new(self)
+    end
+
+    def must_not
+      Must.new(self, true)
+    end
+  end
+end
+
+Object.send(:include, Mustard::ObjectExtension)

data/lib/mustard/version.rb

@@ -0,0 +1,3 @@
+module Mustard
+  VERSION = "0.1.0"
+end

data/minitest_test.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "minitest/autorun"
+require "mustard"
+
+describe Mustard::Failure do
+  it "inherits from MiniTest::Assertion" do
+    (Mustard::Failure < MiniTest::Assertion).must.be_true
+  end
+end

data/mustard.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mustard/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mustard"
+  gem.version       = Mustard::VERSION
+  gem.authors       = ["Ryan Bates"]
+  gem.email         = ["ryan@railscasts.com"]
+  gem.description   = "Simple \"must\" matchers for specs."
+  gem.summary       = "Adds \"must\" and \"must_not\" methods which can have matchers called upon them. Matchers can be added easily."
+  gem.homepage      = "https://github.com/ryanb/mustard"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/spec/mustard_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe Mustard do
+  it "fails when calling fail with message" do
+    failure { fail }
+    failure("something went wrong") { fail "something went wrong" }
+  end
+
+  it "raises an exception when match fails" do
+    failure { 5.must.equal 4 }
+  end
+
+  it "raises an RSpec::Mustard::Failure exception in RSpec" do
+    -> { 5.must.eq 4 }.must.raise_exception(RSpec::Mustard::Failure)
+  end
+
+  it "does not raise an exception when match succeeds" do
+    5.must.equal 5
+  end
+
+  it "negates with must_not" do
+    failure { 5.must_not.equal 5 }
+    5.must_not.equal 4
+  end
+
+  it "has a message when failing" do
+    failure("expected 5 to equal 4") { 5.must.equal 4 }
+    failure("expected 5 to not equal 5") { 5.must_not.equal 5 }
+    failure('expected "5" to equal "4"') { "5".must.equal "4" }
+  end
+
+  it "adds custom matcher" do
+    Mustard.matcher(:be_empty) { empty? }
+    [].must.be_empty
+    failure('expected [1] to be empty') { [1].must.be_empty }
+  end
+
+  it "adds custom matcher with alias" do
+    Mustard.matcher(:be_empty, :be_vacant) { empty? }
+    failure('expected [1] to be empty') { [1].must.be_vacant }
+  end
+
+  it "has eq matcher" do
+    5.must.eq 5
+    failure("expected 5 to equal 4") { 5.must.eq 4 }
+  end
+
+  it "has be_greater_than matcher" do
+    5.must.be_greater_than 4
+    failure("expected 5 to be greater than 5") do
+      5.must.be_greater_than 5
+    end
+    failure("expected 5 to be greater than 5") do
+      5.must.be_gt 5
+    end
+  end
+
+  it "has be_greater_than_or_equal_to matcher" do
+    5.must.be_greater_than_or_equal_to 5
+    failure("expected 5 to be greater than or equal to 6") do
+      5.must.be_greater_than_or_equal_to 6
+    end
+    failure("expected 5 to be greater than or equal to 6") do
+      5.must.be_gte 6
+    end
+  end
+
+  it "has be_less_than matcher" do
+    5.must.be_less_than 6
+    failure("expected 5 to be less than 5") do
+      5.must.be_less_than 5
+    end
+    failure("expected 5 to be less than 5") do
+      5.must.be_lt 5
+    end
+  end
+
+  it "has be_less_than_or_equal_to matcher" do
+    5.must.be_less_than_or_equal_to 5
+    failure("expected 5 to be less than or equal to 4") do
+      5.must.be_less_than_or_equal_to 4
+    end
+    failure("expected 5 to be less than or equal to 4") do
+      5.must.be_lte 4
+    end
+  end
+
+  it "has be matcher" do
+    [].must.be :empty?
+    failure("expected [1] to be empty") do
+      [1].must.be :empty?
+    end
+    failure("expected 3 to be between 4 and 6") do
+      3.must.be :between?, 4, 6
+    end
+  end
+
+  it "has be_true/false/nil matchers" do
+    true.must.be_true
+    false.must.be_false
+    1.must.be_true
+    nil.must.be_false
+    nil.must.be_nil
+    failure("expected false to be true") do
+      false.must.be_true
+    end
+    failure("expected true to be false") do
+      true.must.be_false
+    end
+    failure("expected false to be nil") do
+      false.must.be_nil
+    end
+  end
+
+  it "has include matcher" do
+    [1, 2, 3].must.include 3
+    failure("expected [1, 2, 3] to include 4") do
+      [1, 2, 3].must.include 4
+    end
+  end
+
+  it "has match matcher" do
+    "foobar".must.match /foo/
+    failure("expected \"foo\" to match /bar/") do
+      "foo".must.match /bar/
+    end
+  end
+
+  it "has respond_to matcher" do
+    "foobar".must.respond_to :length
+    failure("expected \"foo\" to respond to :invalid_method") do
+      "foo".must.respond_to :invalid_method
+    end
+  end
+
+  it "has be_close_to matcher" do
+    5.00001.must.be_close_to 5.0
+    failure("expected 5.01 to be within 0.001 of 5.0") do
+      5.01.must.be_close_to 5.0
+    end
+    failure("expected 6.0 to be within 0.1 of 5.0") do
+      6.0.must.be_close_to 5.0, 0.1
+    end
+  end
+
+  it "has raise_exception matcher" do
+    -> { raise "foo" }.must.raise_exception
+    -> { raise Mustard::Failure }.must.raise_exception(Mustard::Failure)
+    failure { -> { nil }.must.raise_exception }
+  end
+
+  it "allows custom class for matcher" do
+    matcher_class = Struct.new(:subject, :other) do
+      def match?
+        subject == other
+      end
+
+      def failure_message
+        "failure message"
+      end
+
+      def negative_failure_message
+        "negative failure message"
+      end
+    end
+
+    Mustard.matcher(:be_equal, matcher_class)
+    5.must.be_equal 5
+    failure("failure message") { 5.must.be_equal 4 }
+    failure("negative failure message") { 5.must_not.be_equal 5 }
+  end
+
+  def failure(message = nil)
+    failed = false
+    begin
+      yield
+    rescue Mustard::Failure => exception
+      failed = true
+      exception.message.must.equal message if message
+    end
+    raise "match did not fail" unless failed
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'mustard'
+
+RSpec.configure do |config|
+  config.expect_with Mustard
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: mustard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Simple "must" matchers for specs.
+email:
+- ryan@railscasts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mustard.rb
+- lib/mustard/failure.rb
+- lib/mustard/matchers/be_matcher.rb
+- lib/mustard/matchers/close_matcher.rb
+- lib/mustard/matchers/default_matcher.rb
+- lib/mustard/must.rb
+- lib/mustard/object_extension.rb
+- lib/mustard/version.rb
+- minitest_test.rb
+- mustard.gemspec
+- spec/mustard_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ryanb/mustard
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3046544350976815495
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3046544350976815495
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adds "must" and "must_not" methods which can have matchers called upon them.
+  Matchers can be added easily.
+test_files:
+- spec/mustard_spec.rb
+- spec/spec_helper.rb