kintama 0.1.9 → 0.2

data/test/usage/09_expectations_and_mocking_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+require 'kintama/mocha'
+
+class ExpectationsAndMockingTest < KintamaIntegrationTest
+
+  def setup
+    super
+    # This is normally called automatically when requiring 'kintama/mocha'
+    # but in these tests we totally reset Kintama, and so we need to
+    # ensure that the mocha integration is loaded properly.
+    Kintama::Mocha.setup
+  end
+
+  def test_should_allow_setting_of_expectations_in_tests
+    context "Given an expectation" do
+      setup do
+        @thing = stub('thing')
+      end
+
+      expect "blah to be called" do
+        @thing.expects(:blah)
+        @thing.blah
+      end
+    end.
+    should_output(%{
+      Given an expectation
+        expect blah to be called
+    }).
+    and_pass
+  end
+
+  def test_should_report_failed_expectations_as_failures
+    context "Given an expectation" do
+      setup do
+        @thing = stub('thing')
+      end
+
+      expect "blah to be called" do
+        @thing.expects(:blah)
+      end
+    end.
+    should_fail.
+    with_failure(%{
+      unsatisfied expectations:
+      - expected exactly once, invoked never: #<Mock:thing>.blah
+    })
+  end
+
+  def test_should_set_expectations_before_action_is_called
+    context "Given an action" do
+      setup do
+        @thing = stub('thing')
+      end
+
+      action do
+        @thing.go
+      end
+
+      expect "go to be called on thing" do
+        @thing.expects(:go)
+      end
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_should_not_set_expectations_for_normal_tests_defined_near_the_expect
+    context "Given an expectation" do
+      setup do
+        @thing = [1,2,3]
+      end
+
+      expect "blah to be called" do
+        @thing.expects(:join)
+        @thing.join
+      end
+
+      it "should retain original behaviour in other tests" do
+        assert_equal "123", @thing.join
+      end
+    end.
+    should_run_tests(2).
+    and_pass
+  end
+end

data/test/usage/10_let_and_subject_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+class LetAndSubjectTest < KintamaIntegrationTest
+
+  def test_let_should_return_value_of_block_when_called_in_tests
+    context "Defining a `let` attribute with a given name in a context" do
+      let(:thing) do
+        "a thing"
+      end
+
+      should "allow that attribute to be called as a method within tests" do
+        assert_equal "a thing", thing
+      end
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_let_should_return_the_same_instance_within_a_test
+    context "Defining a `let` attribute in a context" do
+      let(:thing) do
+        Object.new
+      end
+
+      should "memoize the returned object within a test" do
+        instance_a = thing()
+        instance_b = thing()
+        assert_equal instance_a.object_id, instance_b.object_id
+      end
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_let_should_return_the_same_instance_within_a_test_and_its_setup
+    context "Defining a `let` attribute in a context" do
+      let(:thing) do
+        Object.new
+      end
+
+      setup do
+        $object_id = thing.object_id
+      end
+
+      should "memoize the returned object between setup and test" do
+        assert $object_id && $object_id == thing.object_id
+      end
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_let_should_return_different_instances_in_different_tests
+    context "Defining a `let` attribute in a context" do
+      let(:thing) do
+        Object.new
+      end
+
+      should "return a one instance in one test" do
+        $object_id = thing.object_id
+      end
+
+      should "return some other instance in a different test" do
+        assert $object_id && $object_id != thing.object_id
+      end
+    end.
+    should_run_tests(2).
+    and_pass
+  end
+
+  def test_let_methods_should_be_callable_from_other_let_methods
+    context "Defining a `let` attribute in a context" do
+      let(:alpha) do
+        123
+      end
+
+      let(:beta) do
+        alpha == 123
+      end
+
+      should "allow one `let` attribute to be referenced from another one" do
+        assert beta
+      end
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_subject_should_work_just_like_lets
+    $object_id_in_test_one = nil
+    $object_id_in_test_two = nil
+
+    context "Defining a `subject` attribute in a context" do
+      subject do
+        Object.new
+      end
+
+      should "return one instance in one test" do
+        $object_id_in_test_one = subject.object_id
+        if $object_id_in_test_two # this test might run first
+          assert_not_equal $object_id_in_test_one, $object_id_in_test_two, "object ids should be different between tests"
+        end
+      end
+
+      should "return a different instance in a different test" do
+        $object_id_in_test_two = subject.object_id
+        if $object_id_in_test_one # or this test might run first
+          assert_not_equal $object_id_in_test_one, $object_id_in_test_two, "object ids should be different between tests"
+        end
+      end
+    end.
+    should_run_tests(2).
+    and_pass
+  end
+
+  def test_should_use_a_single_instance_of_the_subject_within_a_test
+    context "Given a context with a subject" do
+      subject do
+        Array.new
+      end
+
+      should "allow me to poke around with subject like it was a variable" do
+        subject << 1
+        assert_equal [1], subject
+      end
+
+      should "now be empty again because it's a new instance" do
+        assert subject.empty?
+      end
+    end.
+    should_run_tests(2).
+    and_pass
+  end
+end

data/test/usage/11_matcher_test.rb

@@ -0,0 +1,148 @@
+require "test_helper"
+
+class MatcherTest < KintamaIntegrationTest
+
+  # As well as defining tests using blocks (see Basic Usage),
+  # the `should` method can define tests by accepting instances
+  # of "matcher" classes.
+  def test_should_allow_use_of_matchers_within_contexts
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should EqualMatcher.new(123)
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  # A matcher is just an object that responds to four methods:
+  #
+  # * `matches?(provided_value)`, which will be called with the `subject` object
+  #   as the argument. This is where you can compare aspects of the subject
+  #   with some expected value or criteria. It should return true or false.
+  #
+  # * `description`, which should return a String to form part of the test name
+  #
+  # * `failure_message`, which returns a String describing what happened if
+  #   `matches?` returned false
+  #
+  # * `negative_failure_message`, which returns a String describing what
+  #    happened if the matcher was being used in a negated form (see below)
+  #
+  # This is an example Matcher object which can check the equality of the
+  # subject against a given value. It's used above, and in the tests below.
+  class EqualMatcher
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(provided_value)
+      @actual = provided_value
+      @actual == @expected
+    end
+
+    def description
+      "be equal to #{@expected.inspect}"
+    end
+
+    def failure_message
+      "Expected #{@expected}, but got #{@actual}"
+    end
+
+    def negative_failure_message
+      "Didn't expect #{@expected}, but got it anyway"
+    end
+  end
+
+  def test_should_use_the_description_of_matchers_to_generate_test_names
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should EqualMatcher.new(123)
+    end.
+    should_output(%{
+      The number 123
+        should be equal to 123: .
+    }).
+    and_pass
+  end
+
+  def test_should_use_the_failure_message_of_matchers_to_generate_failure_messages
+    context "The number 456" do
+      subject do
+        456
+      end
+
+      should EqualMatcher.new(123)
+    end.
+    should_fail.
+    with_failure("Expected 123, but got 456")
+  end
+
+  def test_should_allow_negation_of_matchers
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should_not EqualMatcher.new(456)
+    end.
+    should_run_tests(1).
+    and_pass
+  end
+
+  def test_should_generate_corresponding_test_names_for_negated_matchers
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should_not EqualMatcher.new(456)
+    end.
+    should_output(%{
+      The number 123
+        should not be equal to 456: .
+    }).
+    and_pass
+  end
+
+  def test_should_use_the_negated_failure_message_of_negated_matchers_to_generate_failure_descriptions
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should_not EqualMatcher.new(123)
+    end.
+    should_fail.
+    with_failure("Didn't expect 123, but got it anyway")
+  end
+
+  # You can also define methods to extend kintama for more readable
+  # tests; instead of `should EqualMatcher.new(value)` you could write
+  # `should be_equal_to(value)`
+  module MethodsWhichReturnMatcherInstances
+    def be_equal_to(expected)
+      EqualMatcher.new(expected)
+    end
+  end
+
+  def test_should_allow_definition_of_matchers_in_contexts
+    Kintama.extend(MethodsWhichReturnMatcherInstances)
+
+    context "The number 123" do
+      subject do
+        123
+      end
+
+      should be_equal_to(123)
+      should_not be_equal_to(456)
+    end.
+    should_run_tests(2).
+    and_pass
+  end
+end

data/test/usage/12_action_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+
+class ActionTest < KintamaIntegrationTest
+
+  def test_should_run_action_between_setup_and_test
+    context "Given a context with an `action`" do
+      setup do
+        @thing = 123
+      end
+
+      action do
+        @thing += 1
+      end
+
+      it "should have called the action between the `setup` and the test" do
+        assert @thing == 124
+      end
+    end.
+    should_output(%{
+      Given a context with an `action`
+        it should have called the action between the `setup` and the test: .
+    }).
+    and_pass
+  end
+
+  def test_should_run_action_after_all_setups
+    context "Given an action" do
+      setup do
+        @thing = 123
+      end
+
+      setup do
+        @thing *= 2
+      end
+
+      action do
+        @thing += 1
+      end
+
+      it "should have called the action after all setup blocks" do
+        assert @thing == 247
+      end
+    end.
+    should_output(%{
+      Given an action
+        it should have called the action after all setup blocks
+    }).
+    and_pass
+  end
+
+  def test_should_run_action_after_setups_in_nested_contexts
+    context "Given an action" do
+      setup do
+        @thing = 123
+      end
+
+      action do
+        @thing += 1
+      end
+
+      it "should have called the action after the first setup for outer tests" do
+        assert @thing == 124
+      end
+
+      context "and a setup in a nested context" do
+        setup do
+          @thing *= 2
+        end
+        it "should have called the action after both outer and inner setups" do
+          assert @thing == 247
+        end
+      end
+    end.
+    should_output(%{
+      Given an action
+        it should have called the action after the first setup for outer tests: .
+        and a setup in a nested context
+          it should have called the action after both outer and inner setups: .
+    }).
+    and_pass
+  end
+
+  def test_should_allow_subcontexts_to_change_parameters_used_in_action
+    context "A doubling action" do
+      action do
+        @result = @parameter * 2
+      end
+
+      context "when the parameter is 2" do
+        setup do
+          @parameter = 2
+        end
+
+        should "result in 4" do
+          assert_equal 4, @result
+        end
+      end
+
+      context "when the parameter is 3" do
+        setup do
+          @parameter = 3
+        end
+
+        should "result in 6" do
+          assert_equal 6, @result
+        end
+      end
+    end.
+    should_output(%{
+      A doubling action
+        when the parameter is 2
+          should result in 4: .
+        when the parameter is 3
+          should result in 6: .
+    }).
+    and_pass
+  end
+end