on 0.2.1 → 0.3.0

data/README.rdoc

@@ -53,6 +53,40 @@ Syntatic sugar for creating an +on+ callback from Proc.
     end
   end
 
+== Testing with On::TestHelper
+
+  require 'minitest/autorun'
+  require 'on'
+  require 'on/test_helper'
+
+  class SomeTest < MiniTest::Spec
+    include On::TestHelper
+
+    let(:recorder) { On::TestHelper::Recorder.new }
+
+    it "records everything" do
+      on = On.new(:success, :failure, &recorder)
+      on.call :success, :some, :args
+      assert_callback recorder, :success, :some, :args
+    end
+
+    it "calls nothing" do
+      on = On.new(:success, :failure, &recorder)
+      # nothing called
+      refute_callbacks recorder
+    end
+
+    it "records everything manually" do
+      on = On.new(:success, :failure) do |result|
+        recorder.record_block
+        recorder.record_callback(result, :success, :failure)
+      end
+      on.call :success, :some, :args
+      assert_callback recorder, :success, :some, :args
+    end
+  end
+
+
 == Installation
 
 Add this line to your application's Gemfile:

data/lib/on/test_helper.rb

@@ -0,0 +1,115 @@
+class On
+  # Helper for testing On callbacks.
+  #
+  # == Example
+  #
+  #   require 'minitest/autorun'
+  #   require 'on'
+  #   require 'on/test_helper'
+  #
+  #   class SomeTest < MiniTest::Spec
+  #     include On::TestHelper
+  #
+  #     let(:recorder) { On::TestHelper::Recorder.new }
+  #
+  #     it "records everything" do
+  #       on = On.new(:success, :failure, &recorder)
+  #       on.call :success, :some, :args
+  #       assert_callback recorder, :success, :some, :args
+  #     end
+  #
+  #     it "calls nothing" do
+  #       on = On.new(:success, :failure, &recorder)
+  #       # nothing called
+  #       refute_callbacks recorder
+  #     end
+  #
+  #     it "records everything manually" do
+  #       on = On.new(:success, :failure) do |result|
+  #         recorder.record_block
+  #         recorder.record_callback(result, :success, :failure)
+  #       end
+  #       on.call :success, :some, :args
+  #       assert_callback recorder, :success, :some, :args
+  #     end
+  #   end
+  module TestHelper
+    # Asserts that a certain callbacks has been recorded by +recorder+.
+    #
+    # == Example
+    #
+    #   assert_callback recorder, :success, "some", "args"
+    #
+    def assert_callback(recorder, name, *args)
+      callback = recorder.last_record
+      assert callback, "No callbacks found"
+      assert_equal name, callback.name, "Callback was #{callback}"
+      assert_equal args, callback.args, "Callback was #{callback}"
+    end
+
+    # Asserts that *no* callbacks has been recorder by +recorder+.
+    def refute_callbacks(recorder)
+      assert recorder.empty?, "Something has been recorded #{recorder.inspect}"
+    end
+
+    # Record callbacks.
+    class Recorder
+      Callback = Struct.new(:name, :args)
+
+      def initialize
+        @block      = false
+        @callbacks  = []
+      end
+
+      def block_called?
+        @block
+      end
+
+      def empty?
+        @callbacks.empty?
+      end
+
+      # Pops the last recorded recorded.
+      def last_record
+        @callbacks.pop
+      end
+
+      # Records block and all defined callbacks.
+      def record_all
+        proc do |on|
+          record_block
+          record_callback(on, *on.callbacks)
+        end
+      end
+
+      # Records a block.
+      #
+      #   recorder = Recorder.new
+      #   On.new(:success) do |callback|
+      #     recorder.record_block
+      #     callback.on :success do
+      #       # assert...
+      #     end
+      #   end
+      #
+      #   assert recorder.block_called?
+      def record_block
+        @block = true
+      end
+
+      # Records a single callback.
+      def record_callback(on, *names)
+        names.each do |name|
+          on.on name do |*args|
+            @callbacks << Callback.new(name, args)
+          end
+        end
+      end
+
+      # Short-hand for &+recorder.record_all+.
+      def to_proc
+        record_all
+      end
+    end
+  end
+end

data/lib/on/version.rb

@@ -1,3 +1,3 @@
 class On
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/test/helper.rb

@@ -1,22 +1,10 @@
 require 'minitest/autorun'
 require 'testem'
 
-class Testem
-  let(:called) { [] }
-
-  setup do
-    called.clear
-  end
+require 'on/test_helper'
 
-  def called!(*args)
-    called << args
-  end
-
-  def assert_called(*args)
-    assert_equal called, args
-  end
+class Testem
+  include On::TestHelper
 
-  def assert_nothing_called
-    assert_called
-  end
+  let(:recorder) { On::TestHelper::Recorder.new }
 end

data/test/integration_test.rb

@@ -14,53 +14,30 @@ class IntegrationTest < Testem
   end
 
   test "it calls success" do
-    tweet "Sir, hello world" do |callback|
-      called! :method
-      callback.on :success do |message|
-        called! :success, message
-      end
-      callback.on :failure do |message|
-        called! :failure, message
-      end
-    end
-
-    assert_called [ :method ], [ :success, "Sir, hello world" ]
+    tweet "Sir, hello world", &recorder
+    assert_callback recorder, :success, "Sir, hello world"
   end
 
   test "it calls failure" do
-    tweet nil do |callback|
-      called! :method
-      callback.on :success do |message|
-        called! :success, message
-      end
-      callback.on :failure do |message|
-        called! :failure, message
-      end
-    end
-
-    assert_called [ :method ], [ :failure, "blank" ]
+    tweet nil, &recorder
+    assert_callback recorder, :failure, "blank"
   end
 
   test "no callback called" do
-    tweet "you're such a fool" do |callback|
-      called! :method
-    end
-
-    assert_called
+    tweet "you're such a fool", &recorder
+    refute_callbacks recorder
+    refute recorder.block_called?
   end
 
   test "invalid callback name" do
     e = assert_raises On::InvalidCallback do
       tweet "Sir, hi" do |callback|
-        called! :method
-
-        callback.on :invalid do
-          called! :invalid
-        end
+        recorder.record_block
+        callback.on(:invalid) {}
       end
     end
     assert_equal "Invalid callback :invalid", e.message
-
-    assert_called [:method]
+    assert recorder.block_called?
+    refute_callbacks recorder
   end
 end

data/test/on_proc_test.rb

@@ -12,22 +12,11 @@ class OnProcTest < Testem
     end
   end
 
-  def verify(number)
-    oddeven(number) do |callback|
-      called! :block, number
-      callback.on :odd do
-        called! :odd
-      end
-      callback.on :even do
-        called! :even
-      end
-    end
-  end
-
   test "call proc" do
-    verify(1)
-    verify(2)
+    oddeven(1, &recorder)
+    assert_callback recorder, :odd
 
-    assert_called [ :block, 1 ], [ :odd ], [ :block, 2 ], [ :even ]
+    oddeven(2, &recorder)
+    assert_callback recorder, :even
   end
 end

data/test/on_test.rb

@@ -20,10 +20,6 @@ class OnTest < Testem
   end
 
   context "with an instance" do
-    before do
-      called.clear
-    end
-
     test "returns a list of supported callback names" do
       on = On.new(:success, :failure) {}
       assert_equal 2, on.callbacks.size
@@ -32,27 +28,20 @@ class OnTest < Testem
     end
 
     test "calls callback w/o args" do
-      on = On.new(:success) do |callback|
-        called! :block
-        callback.on :success do |*args|
-          called! :success, *args
-        end
-      end
+      on = On.new(:success, &recorder)
       on.call :success
 
-      assert_called [ :block ], [ :success ]
+      assert recorder.block_called?
+      assert_callback recorder, :success
     end
 
     test "calls callback with args" do
-      on = On.new(:success) do |callback|
-        called! :block
-        callback.on :success do |*args|
-          called! :success, *args
-        end
-      end
+      on = On.new(:success, &recorder)
       on.call :success, :foo, :bar
 
-      assert_called [ :block ], [ :success, :foo, :bar ]
+      assert recorder.block_called?
+      assert_callback recorder, :success, :foo, :bar
+
       assert on.callback
       assert_equal :success, on.callback.name
     end
@@ -68,26 +57,20 @@ class OnTest < Testem
 
     test "handles invalid callback" do
       on = On.new(:correct) do |callback|
-        called! :block
         callback.on :wrong
       end
       e = assert_raises On::InvalidCallback do
         on.call :correct
       end
-
       assert_equal "Invalid callback :wrong", e.message
-      assert_called [ :block ]
     end
 
     test "does not explode when nothing called" do
-      on = On.new(:something) do
-        called! :block
-      end
-      on.on :something do
-        called! :something
-      end
+      on = On.new(:something, &recorder)
+
+      refute_callbacks recorder
+      refute recorder.block_called?
 
-      assert_nothing_called
       assert_nil on.callback
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 'on'
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,6 +89,7 @@ files:
 - Rakefile
 - lib/on.rb
 - lib/on/proc.rb
+- lib/on/test_helper.rb
 - lib/on/version.rb
 - on.gemspec
 - on.rb
@@ -110,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2576027221997955073
+      hash: -2276299258964583998
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2576027221997955073
+      hash: -2276299258964583998
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24