motion-wiretap 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 603a0ed4a62d6d94d14f2d6f14d08393d6c37b40
-  data.tar.gz: dc884f2877a4e6d03b0075b859aa736d20d23bf8
+  metadata.gz: 99db3db8e4cf9422189294a89b8291de93af7548
+  data.tar.gz: f8565d3e0cde697b9ca8c02bdf1f932f0ce635bc
 SHA512:
-  metadata.gz: 09e75aa157623d36f01c589a43d839a29f263e9a4cb0967822234ea26827998ed7dded620b47541045e464329058323baefff08cb08109081402fe8040f026d6
-  data.tar.gz: f7649b063c71f4fec9a8c30d630cfdf5f15dc703a1fbe56a16eb193549a4cb9cdc44d2a77f05e8db66bf6b296acac0d107d5d39acf6c2e33030c3b8feb5f9f25
+  metadata.gz: 1e217902b0a8c869efcf462ad728046dffcd492a613781e8284d2db7449caa4e2780bdeebc0390eda3a453fdc7a6c4282c89314d767f61e0e757ddde2955ec6a
+  data.tar.gz: 64755e1482c0fb48241805ff5d30a41832833a3fb77d9878ef25e01fbf2612575844eff88aa8a71621f8321ec61fd1856f392ce6c435c8599bfecf6e76b95f8a

data/lib/motion-wiretap/all/signal.rb

@@ -4,10 +4,9 @@ module MotionWiretap
   # Signal is triggered with a new value, or it is completed, or canceled with
   # an error event.
   class Signal < Wiretap
-    # This is the default initial value - it does not trigger a 'change' event.
-    # This value is for internal use only.
-    SINGLETON = Class.new.new
 
+    # The SINGLETON value does not trigger a 'change' event. It is for internal
+    # use only.
     def initialize(value=SINGLETON, &block)
       @value = value
       super(&block)
@@ -21,17 +20,37 @@ module MotionWiretap
       end
     end
 
-    def next(value)
-      raise "don't do that please" if value == SINGLETON
-      @value = value
-      trigger_changed(@value)
+    # If you pass multiple values to this method, the 'value' will be the array
+    # of all the values, but they will be passed on to 'trigger_changed' using
+    # the splat operator, and so will be passed to listener blocks as individual
+    # arguments.
+    #
+    # Example:
+    #     signal = Signal.new
+    #     signal.listen do |a, b|
+    #       @added = a + b
+    #     end
+    #     signal.next(1, 5)    # works great, @added will be 6
+    #     signal.next([1, 5])  # this works, too, because of how args are assigned to blocks in ruby
+    #     signal.next(1)  # a will be 1 and b will be nil (error!)
+    def next(value, *values)
+      if values.length > 0
+        raise "don't do that please" if values.include? SINGLETON
+        value = [value].concat values
+        @value = value
+        trigger_changed(*value)
+      else
+        raise "don't do that please" if value == SINGLETON
+        @value = value
+        trigger_changed(@value)
+      end
     end
 
     def complete
       trigger_completed
     end
 
-    def error(error)
+    def error(error=SINGLETON)
       trigger_error(error)
     end
 

data/lib/motion-wiretap/all/wiretap.rb

@@ -4,6 +4,10 @@ end
 
 module MotionWiretap
 
+  # This placeholder value is used anywhere you want to accept any value,
+  # including nil.
+  SINGLETON = Class.new.new
+
   class Wiretap
 
     def initialize(&block)
@@ -74,6 +78,7 @@ module MotionWiretap
       return self
     end
 
+    # Sends the block or wiretap a changed signal
     def trigger_changed_on(block_or_wiretap, values)
       if block_or_wiretap.is_a? Wiretap
         block_or_wiretap.trigger_changed(*values)
@@ -107,6 +112,7 @@ module MotionWiretap
       return self
     end
 
+    # Sends the block or wiretap a completed signal
     def trigger_completed_on(block_or_wiretap)
       if block_or_wiretap.is_a? Wiretap
         block_or_wiretap.trigger_completed
@@ -128,9 +134,12 @@ module MotionWiretap
       return self
     end
 
-    def trigger_error(error)
+    def trigger_error(error=SINGLETON)
       return if @is_torn_down || @is_completed || @is_error
-      error ||= true
+      raise "You must pass a truthy value to `trigger_error()`" unless error
+
+      # convert SINGLETON to a default error value
+      error = true if error == SINGLETON
       @is_error = error
 
       @error_handlers.each do |block_or_wiretap|
@@ -141,6 +150,7 @@ module MotionWiretap
       return self
     end
 
+    # Sends the block or wiretap an error value
     def trigger_error_on(block_or_wiretap, error)
       if block_or_wiretap.is_a? Wiretap
         block_or_wiretap.trigger_error(error)

data/lib/motion-wiretap/version.rb

@@ -1,3 +1,3 @@
 module MotionWiretap
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-wiretap
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Colin T.A. Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies: []
 description: |
   ReactiveCocoa is an amazing system, and RubyMotion could benefit from the