spicycode-micronaut 0.0.2 → 0.0.3

data/examples/lib/micronaut/matchers/change_example.rb

@@ -0,0 +1,329 @@
+#Based on patch from Wilson Bilkovich
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+class SomethingExpected
+  attr_accessor :some_value
+end
+
+describe "should change(actual, message)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when actual is modified by the block" do
+    lambda {@instance.some_value = 6}.should change(@instance, :some_value)
+  end
+
+  it "should fail when actual is not modified by the block" do
+    lambda do
+      lambda {}.should change(@instance, :some_value)
+    end.should fail_with("some_value should have changed, but is still 5")
+  end
+end
+
+describe "should_not change(actual, message)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when actual is not modified by the block" do
+    lambda { }.should_not change(@instance, :some_value)
+  end
+
+  it "should fail when actual is not modified by the block" do
+    lambda do
+      lambda {@instance.some_value = 6}.should_not change(@instance, :some_value)
+    end.should fail_with("some_value should not have changed, but did change from 5 to 6")
+  end
+end
+
+describe "should change { block }" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when actual is modified by the block" do
+    lambda {@instance.some_value = 6}.should change { @instance.some_value }
+  end
+
+  it "should fail when actual is not modified by the block" do
+    lambda do
+      lambda {}.should change{ @instance.some_value }
+    end.should fail_with("result should have changed, but is still 5")
+  end
+  
+  it "should warn if passed a block using do/end instead of {}" do
+    lambda do
+      lambda {}.should change do; end
+    end.should raise_error(Micronaut::Matchers::MatcherError, /block passed to should or should_not/)
+  end
+end
+
+describe "should_not change { block }" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when actual is modified by the block" do
+    lambda {}.should_not change{ @instance.some_value }
+  end
+
+  it "should fail when actual is not modified by the block" do
+    lambda do
+      lambda {@instance.some_value = 6}.should_not change { @instance.some_value }
+    end.should fail_with("result should not have changed, but did change from 5 to 6")
+  end
+  
+  it "should warn if passed a block using do/end instead of {}" do
+    lambda do
+      lambda {}.should_not change do; end
+    end.should raise_error(Micronaut::Matchers::MatcherError, /block passed to should or should_not/)
+  end
+end
+
+describe "should change(actual, message).by(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by expected amount" do
+    lambda { @instance.some_value += 1 }.should change(@instance, :some_value).by(1)
+  end
+
+  it "should fail when the attribute is changed by unexpected amount" do
+    lambda do
+      lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by(1)
+    end.should fail_with("some_value should have been changed by 1, but was changed by 2")
+  end
+
+  it "should fail when the attribute is changed by unexpected amount in the opposite direction" do
+    lambda do
+      lambda { @instance.some_value -= 1 }.should change(@instance, :some_value).by(1)
+    end.should fail_with("some_value should have been changed by 1, but was changed by -1")
+  end
+end
+
+describe "should change{ block }.by(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by expected amount" do
+    lambda { @instance.some_value += 1 }.should change{@instance.some_value}.by(1)
+  end
+
+  it "should fail when the attribute is changed by unexpected amount" do
+    lambda do
+      lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by(1)
+    end.should fail_with("result should have been changed by 1, but was changed by 2")
+  end
+
+  it "should fail when the attribute is changed by unexpected amount in the opposite direction" do
+    lambda do
+      lambda { @instance.some_value -= 1 }.should change{@instance.some_value}.by(1)
+    end.should fail_with("result should have been changed by 1, but was changed by -1")
+  end
+end
+
+describe "should change(actual, message).by_at_least(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by greater than the expected amount" do
+    lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by_at_least(1)
+  end
+  
+  it "should pass when attribute is changed by the expected amount" do
+    lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by_at_least(2)
+  end  
+
+  it "should fail when the attribute is changed by less than the expected amount" do
+    lambda do
+      lambda { @instance.some_value += 1 }.should change(@instance, :some_value).by_at_least(2)
+    end.should fail_with("some_value should have been changed by at least 2, but was changed by 1")
+  end
+
+end
+
+describe "should change{ block }.by_at_least(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by greater than expected amount" do
+    lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by_at_least(1)
+  end
+  
+  it "should pass when attribute is changed by the expected amount" do
+    lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by_at_least(2)
+  end  
+
+  it "should fail when the attribute is changed by less than the unexpected amount" do
+    lambda do
+      lambda { @instance.some_value += 1 }.should change{@instance.some_value}.by_at_least(2)
+    end.should fail_with("result should have been changed by at least 2, but was changed by 1")
+  end
+end
+
+
+describe "should change(actual, message).by_at_most(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by less than the expected amount" do
+    lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by_at_most(3)
+  end
+  
+  it "should pass when attribute is changed by the expected amount" do
+    lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by_at_most(2)
+  end  
+
+  it "should fail when the attribute is changed by greater than the expected amount" do
+    lambda do
+      lambda { @instance.some_value += 2 }.should change(@instance, :some_value).by_at_most(1)
+    end.should fail_with("some_value should have been changed by at most 1, but was changed by 2")
+  end
+
+end
+
+describe "should change{ block }.by_at_most(expected)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 5
+  end
+
+  it "should pass when attribute is changed by less than expected amount" do
+    lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by_at_most(3)
+  end
+  
+  it "should pass when attribute is changed by the expected amount" do
+    lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by_at_most(2)
+  end  
+
+  it "should fail when the attribute is changed by greater than the unexpected amount" do
+    lambda do
+      lambda { @instance.some_value += 2 }.should change{@instance.some_value}.by_at_most(1)
+    end.should fail_with("result should have been changed by at most 1, but was changed by 2")
+  end
+end
+
+describe "should change(actual, message).from(old)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+
+  it "should pass when attribute is == to expected value before executing block" do
+    lambda { @instance.some_value = "astring" }.should change(@instance, :some_value).from("string")
+  end
+
+  it "should fail when attribute is not == to expected value before executing block" do
+    lambda do
+      lambda { @instance.some_value = "knot" }.should change(@instance, :some_value).from("cat")
+    end.should fail_with("some_value should have initially been \"cat\", but was \"string\"")
+  end
+end
+
+describe "should change{ block }.from(old)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+
+  it "should pass when attribute is == to expected value before executing block" do
+    lambda { @instance.some_value = "astring" }.should change{@instance.some_value}.from("string")
+  end
+
+  it "should fail when attribute is not == to expected value before executing block" do
+    lambda do
+      lambda { @instance.some_value = "knot" }.should change{@instance.some_value}.from("cat")
+    end.should fail_with("result should have initially been \"cat\", but was \"string\"")
+  end
+end
+
+describe "should change(actual, message).to(new)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+  
+  it "should pass when attribute is == to expected value after executing block" do
+    lambda { @instance.some_value = "cat" }.should change(@instance, :some_value).to("cat")
+  end
+
+  it "should fail when attribute is not == to expected value after executing block" do
+    lambda do
+      lambda { @instance.some_value = "cat" }.should change(@instance, :some_value).from("string").to("dog")
+    end.should fail_with("some_value should have been changed to \"dog\", but is now \"cat\"")
+  end
+end
+
+describe "should change{ block }.to(new)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+  
+  it "should pass when attribute is == to expected value after executing block" do
+    lambda { @instance.some_value = "cat" }.should change{@instance.some_value}.to("cat")
+  end
+
+  it "should fail when attribute is not == to expected value after executing block" do
+    lambda do
+      lambda { @instance.some_value = "cat" }.should change{@instance.some_value}.from("string").to("dog")
+    end.should fail_with("result should have been changed to \"dog\", but is now \"cat\"")
+  end
+end
+
+describe "should change(actual, message).from(old).to(new)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+  
+  it "should pass when #to comes before #from" do
+    lambda { @instance.some_value = "cat" }.should change(@instance, :some_value).to("cat").from("string")
+  end
+
+  it "should pass when #from comes before #to" do
+    lambda { @instance.some_value = "cat" }.should change(@instance, :some_value).from("string").to("cat")
+  end
+end
+
+describe "should change{ block }.from(old).to(new)" do
+  before do
+    @instance = SomethingExpected.new
+    @instance.some_value = 'string'
+  end
+  
+  it "should pass when #to comes before #from" do
+    lambda { @instance.some_value = "cat" }.should change{@instance.some_value}.to("cat").from("string")
+  end
+
+  it "should pass when #from comes before #to" do
+    lambda { @instance.some_value = "cat" }.should change{@instance.some_value}.from("string").to("cat")
+  end
+end
+
+describe Micronaut::Matchers::Change do
+  it "should work when the receiver has implemented #send" do
+    @instance = SomethingExpected.new
+    @instance.some_value = "string"
+    def @instance.send(*args); raise "DOH! Library developers shouldn't use #send!" end
+    
+    lambda {
+      lambda { @instance.some_value = "cat" }.should change(@instance, :some_value)
+    }.should_not raise_error
+  end
+end

data/examples/lib/micronaut/matchers/description_generation_example.rb

@@ -0,0 +1,167 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe "Matchers should be able to generate their own descriptions" do
+  after(:each) do
+    Micronaut::Matchers.clear_generated_description
+  end
+
+  it "should == expected" do
+    "this".should == "this"
+    Micronaut::Matchers.generated_description.should == "should == \"this\""
+  end
+  
+  it "should not == expected" do
+    "this".should_not == "that"
+    Micronaut::Matchers.generated_description.should == "should not == \"that\""
+  end
+  
+  it "should be empty (arbitrary predicate)" do
+    [].should be_empty
+    Micronaut::Matchers.generated_description.should == "should be empty"
+  end
+  
+  it "should not be empty (arbitrary predicate)" do
+    [1].should_not be_empty
+    Micronaut::Matchers.generated_description.should == "should not be empty"
+  end
+  
+  it "should be true" do
+    true.should be_true
+    Micronaut::Matchers.generated_description.should == "should be true"
+  end
+  
+  it "should be false" do
+    false.should be_false
+    Micronaut::Matchers.generated_description.should == "should be false"
+  end
+  
+  it "should be nil" do
+    nil.should be_nil
+    Micronaut::Matchers.generated_description.should == "should be nil"
+  end
+  
+  it "should be > n" do
+    5.should be > 3
+    Micronaut::Matchers.generated_description.should == "should be > 3"
+  end
+  
+  it "should be predicate arg1, arg2 and arg3" do
+    5.0.should be_between(0,10)
+    Micronaut::Matchers.generated_description.should == "should be between 0 and 10"
+  end
+
+  it "should be_few_words predicate should be transformed to 'be few words'" do
+    5.should be_kind_of(Fixnum)
+    Micronaut::Matchers.generated_description.should == "should be kind of Fixnum"
+  end
+
+  it "should preserve a proper prefix for be predicate" do
+    5.should be_a_kind_of(Fixnum)
+    Micronaut::Matchers.generated_description.should == "should be a kind of Fixnum"
+    5.should be_an_instance_of(Fixnum)
+    Micronaut::Matchers.generated_description.should == "should be an instance of Fixnum"
+  end
+  
+  it "should equal" do
+    expected = "expected"
+    expected.should equal(expected)
+    Micronaut::Matchers.generated_description.should == "should equal \"expected\""
+  end
+  
+  it "should_not equal" do
+    5.should_not equal(37)
+    Micronaut::Matchers.generated_description.should == "should not equal 37"
+  end
+  
+  it "should eql" do
+    "string".should eql("string")
+    Micronaut::Matchers.generated_description.should == "should eql \"string\""
+  end
+  
+  it "should not eql" do
+    "a".should_not eql(:a)
+    Micronaut::Matchers.generated_description.should == "should not eql :a"
+  end
+  
+  it "should have_key" do
+    {:a => "a"}.should have_key(:a)
+    Micronaut::Matchers.generated_description.should == "should have key :a"
+  end
+  
+  it "should have n items" do
+    team.should have(3).players
+    Micronaut::Matchers.generated_description.should == "should have 3 players"
+  end
+  
+  it "should have at least n items" do
+    team.should have_at_least(2).players
+    Micronaut::Matchers.generated_description.should == "should have at least 2 players"
+  end
+  
+  it "should have at most n items" do
+    team.should have_at_most(4).players
+    Micronaut::Matchers.generated_description.should == "should have at most 4 players"
+  end
+  
+  it "should include" do
+    [1,2,3].should include(3)
+    Micronaut::Matchers.generated_description.should == "should include 3"
+  end
+  
+  it "should match" do
+    "this string".should match(/this string/)
+    Micronaut::Matchers.generated_description.should == "should match /this string/"
+  end
+  
+  it "should raise_error" do
+    lambda { raise }.should raise_error
+    Micronaut::Matchers.generated_description.should == "should raise Exception"
+  end
+  
+  it "should raise_error with type" do
+    lambda { raise }.should raise_error(RuntimeError)
+    Micronaut::Matchers.generated_description.should == "should raise RuntimeError"
+  end
+  
+  it "should raise_error with type and message" do
+    lambda { raise "there was an error" }.should raise_error(RuntimeError, "there was an error")
+    Micronaut::Matchers.generated_description.should == "should raise RuntimeError with \"there was an error\""
+  end
+  
+  it "should respond_to" do
+    [].should respond_to(:insert)
+    Micronaut::Matchers.generated_description.should == "should respond to [:insert]"
+  end
+  
+  it "should throw symbol" do
+    lambda { throw :what_a_mess }.should throw_symbol
+    Micronaut::Matchers.generated_description.should == "should throw a Symbol"
+  end
+  
+  it "should throw symbol (with named symbol)" do
+    lambda { throw :what_a_mess }.should throw_symbol(:what_a_mess)
+    Micronaut::Matchers.generated_description.should == "should throw :what_a_mess"
+  end
+  
+  def team
+    Class.new do
+      def players
+        [1,2,3]
+      end
+    end.new
+  end
+end
+
+describe "a Matcher with no description" do
+  def matcher
+     Class.new do
+       def matches?(ignore); true; end
+       def failure_message; ""; end
+     end.new
+  end
+  
+  it "should provide a helpful message when used in a string-less example block" do
+    5.should matcher
+    Micronaut::Matchers.generated_description.should =~ /When you call.*description method/m
+  end
+end

data/examples/lib/micronaut/matchers/eql_example.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+module Micronaut
+  module Matchers
+    describe "eql" do
+      it "should match when actual.eql?(expected)" do
+        eql(1).matches?(1).should be_true
+      end
+      it "should not match when !actual.eql?(expected)" do
+        eql(1).matches?(2).should be_false
+      end
+      it "should describe itself" do
+        matcher = eql(1)
+        matcher.matches?(1)
+        matcher.description.should == "eql 1"
+      end
+      it "should provide message, expected and actual on #failure_message" do
+        matcher = eql("1")
+        matcher.matches?(1)
+        matcher.failure_message.should == ["expected \"1\", got 1 (using .eql?)", "1", 1]
+      end
+      it "should provide message, expected and actual on #negative_failure_message" do
+        matcher = eql(1)
+        matcher.matches?(1)
+        matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .eql?)", 1, 1]
+      end
+    end
+  end
+end

data/examples/lib/micronaut/matchers/equal_example.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+module Micronaut
+  module Matchers
+    describe "equal" do
+      it "should match when actual.equal?(expected)" do
+        equal(1).matches?(1).should be_true
+      end
+      it "should not match when !actual.equal?(expected)" do
+        equal("1").matches?("1").should be_false
+      end
+      it "should describe itself" do
+        matcher = equal(1)
+        matcher.matches?(1)
+        matcher.description.should == "equal 1"
+      end
+      it "should provide message, expected and actual on #failure_message" do
+        matcher = equal("1")
+        matcher.matches?(1)
+        matcher.failure_message.should == ["expected \"1\", got 1 (using .equal?)", "1", 1]
+      end
+      it "should provide message, expected and actual on #negative_failure_message" do
+        matcher = equal(1)
+        matcher.matches?(1)
+        matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .equal?)", 1, 1]
+      end
+    end
+  end
+end

data/examples/lib/micronaut/matchers/exist_example.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+class Substance
+  def initialize exists, description
+    @exists = exists
+    @description = description
+  end
+  
+  def exist?
+    @exists
+  end
+  
+  def inspect
+    @description
+  end
+end
+  
+class SubstanceTester
+  include Micronaut::Matchers
+  
+  def initialize substance
+    @substance = substance
+  end
+  
+  def should_exist
+    @substance.should exist
+  end
+  
+end
+
+describe "should exist," do
+  
+
+
+  describe "within an example group" do
+    
+    before do
+      @real = Substance.new true, 'something real'
+      @imaginary = Substance.new false, 'something imaginary'
+    end
+  
+    it "should pass if target exists" do
+      @real.should exist
+    end
+  
+    it "should fail if target does not exist" do
+      lambda { @imaginary.should exist }.should fail
+    end
+    
+    it "should pass if target doesn't exist" do
+      lambda { @real.should_not exist }.should fail
+    end
+  end
+
+  describe "outside of an example group" do
+    
+    before do
+      @real = Substance.new true, 'something real'
+      @imaginary = Substance.new false, 'something imaginary'
+    end
+
+    it "should pass if target exists" do
+      real_tester = SubstanceTester.new @real
+      real_tester.should_exist
+    end
+
+  end
+
+end