basic-sequencer 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69fcf47b967d669ca28420c35c71dd4a642229da
-  data.tar.gz: 96e296ed53e0f27a539dcfb8f32a9ebf461fc519
+  metadata.gz: 4893d5a6b3ec06799900f1b5b4e53303d35bc6c8
+  data.tar.gz: 943da273874a7d6f9ad2b38b9a34fa6ae4300eb3
 SHA512:
-  metadata.gz: 79b566c5927160eead43d655a1a06c08eea322f63b6ec12bb1bcbf5ed64cfd48ad75aaa9210107829ef39fac244a42f6350278cd9fe3cc96d4084de9bc03d303
-  data.tar.gz: dae58578dc14438b6133954e076679ad6bad8da0606ece4b222cf3488a80b7b934997ca93ffda0693425a8983f0e9286d0267ba5adb47da185e590e8c2286512
+  metadata.gz: 3bf48f0045b0f43c72f76ab778d0cafd1055cbafec7049eafa152ba036befeba9ffda0ba377b435ef4c9d50e22a6c485166d4447735602acd4da0aa17ca1fa13
+  data.tar.gz: 19668ba5050d6410ffada46a86282d6537beb6fc46b95bbcd9d422b1fad40107a62fae3459585cd28eb17694ef83155a83c2c0bbe4c4ce5d697373c3bd7a464c

data/lib/sequencer.rb

@@ -19,6 +19,6 @@ require "sequencer/loop"
 
 module Sequencer
   
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   
 end

data/lib/sequencer/core.rb

@@ -20,7 +20,7 @@ module Sequencer
       perform(sequence) && step(sequence)
     end
 
-    # Step the sequencer and fire the step event
+    # Step the sequencer and fire Event#step event
     # @param [Array] sequence
     # @return [Boolean]
     def step(sequence)
@@ -33,10 +33,17 @@ module Sequencer
       true
     end
 
-    # If a stop is triggered, stop. Otherwise if reset is triggered, reset. Finally,
-    # fire the perform event on the current step of the sequence
+    # Represents performance of a single sequence frame
+    #
+    # Order of events:
+    #
+    # 1. If Event#next for the current pointer, fire
+    # 2. If EventTrigger#stop, fire Event#stop, otherwise:
+    #   3. If EventTrigger#reset, fire Event#reset
+    #   4. Fire Event#perform with the sequence frame
+    # 
     # @param [Array] sequence
-    # @return [Boolean] True if perform event was fired
+    # @return [Boolean] Whether Event#perform event was fired
     def perform(sequence)
       data = sequence.at(@pointer)
       @event.do_next(@pointer, data) if @event.next?(@pointer)

data/lib/sequencer/event.rb

@@ -10,23 +10,33 @@ module Sequencer
       @stop = []
     end
 
+    # Fire an event the next time the pointer reaches the given number
+    # @param [Fixnum, nil] pointer The pointer number when the callback should be fired.  If nil, it will be fired whenever Event#do_next is called.
+    # @param [Proc] block
+    # @return [Array<Proc>]
     def next(pointer = nil, &block)
+      @next[pointer] ||= []
       if block_given?
-        @next[pointer] ||= []
+        @next[pointer].clear
         @next[pointer] << block
       end
-      hash
+      @next[pointer]
     end
 
+    # Whether any callbacks exist for the given pointer (or nil)
+    # @param [Fixnum, nil] pointer
+    # @return [Boolean]
     def next?(pointer = nil)
       !@next[pointer].nil?
     end
 
+    # @param [Fixnum, nil] pointer The pointer number (or nil) to fire callbacks for.
+    # @param [Object] data The data for the current pointer
+    # @return [Array<Object>]
     def do_next(pointer, data)
       keys = [pointer, nil]
       callbacks = keys.map { |key| @next.delete(key) }.flatten.compact
-      callbacks.each(&:call)
-      true
+      callbacks.map(&:call)
     end
 
     # Set the step event
@@ -43,7 +53,7 @@ module Sequencer
     # Fire the step events
     # @return [Boolean]
     def do_step
-      !@step.empty? && @step.map(:call)
+      @step.map(&:call)
     end
 
     # Access the stop events

data/lib/sequencer/loop.rb

@@ -1,5 +1,6 @@
 module Sequencer
 
+  # Define a looping behavior for the sequencer
   class Loop
 
     attr_reader :count, :range
@@ -17,35 +18,51 @@ module Sequencer
       @range = to_range(value)
     end
 
+    # The starting pointer position for this loop.  For the default loop, position is 0
+    # @return [Fixnum]
     def start
       default? ? 0 : @range.begin
     end
 
+    # Mark a completed loop and return the start position
+    # @return [Fixnum] The loop start position (see Loop#start)
     def next
       @count += 1
       start
     end
 
+    # Is this a default loop?  The default loops around the start and end of the sequence
+    # @return [Boolean]
     def default?
       @range.nil?
     end
 
+    # Is looping disabled?
+    # @return [Boolean]
     def disabled?
       @is_disabled
     end
 
+    # Disable looping
+    # @return [Boolean]
     def disable
       @is_disabled = true
     end
 
-    def in_bounds?(num, options = {})
+    # Is the given pointer position in bounds of the loop? 
+    # @param [Fixnum] pointer The pointer position to compare bounds to
+    # @param [Hash] options
+    # @option options [Fixnum] :length The sequence length (required if default loop is being used)
+    # @return [Boolean]
+    def in_bounds?(pointer, options = {})
       length = options[:length]
       range = default? ? 0..(length-1) : @range
-      range.include?(num)
+      range.include?(pointer)
     end
 
     private
 
+    # Convert the given value to a range
     # @param [Array<Fixnum>, Fixnum, Range] value
     # @return [FalseClass, Range]
     def to_range(value)

data/test/event_test.rb

@@ -0,0 +1,180 @@
+require "helper"
+
+class Sequencer::EventTriggerTest < Test::Unit::TestCase
+
+  context "EventTrigger" do
+
+    setup do
+      @trigger = Sequencer::Event.new
+      @cache = []
+    end
+
+    context "#next" do
+
+      should "fire callback" do
+        @trigger.next(3) do |p, d|
+          @cache << d
+        end
+        assert @cache.empty?
+        assert @trigger.next?(3)
+        refute @trigger.next?(2)
+        @trigger.do_next(3, true)
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "replace callback" do
+        @trigger.next(3) do |p, d|
+          @cache << d
+        end
+        assert @trigger.next?(3)
+        @trigger.next(3) do |p, d|
+          @cache << d
+        end
+        assert @cache.empty?
+        assert @trigger.next?(3)
+        refute @trigger.next?(2)
+        @trigger.do_next(3, true)
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "add callback" do
+        3.times do
+          @trigger.next(3) << proc do |p, d|
+            @cache << d
+          end
+        end
+        assert @cache.empty?
+        assert @trigger.next?(3)
+        refute @trigger.next?(2)
+        @trigger.do_next(3, true)
+        refute @cache.empty?
+        assert_equal 3, @cache.size
+      end
+
+    end
+
+    context "#perform" do
+
+      should "fire callback" do
+        @trigger.perform do |d|
+          @cache << d
+        end
+        assert @cache.empty?
+        @trigger.do_perform(true)
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "replace callback" do
+        @trigger.perform do |d|
+          @cache << d
+        end
+        @trigger.perform do |d|
+          @cache << d
+        end
+        assert @cache.empty?
+        @trigger.do_perform(true)
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "add callback" do
+        3.times do
+          @trigger.perform << proc do |p, d|
+            @cache << d
+          end
+        end
+        assert @cache.empty?
+        @trigger.do_perform(true)
+        refute @cache.empty?
+        assert_equal 3, @cache.size
+      end
+
+    end
+
+    context "#step" do
+
+      should "fire callback" do
+        @trigger.step do
+          @cache << true
+        end
+        assert @cache.empty?
+        @trigger.do_step
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "replace callback" do
+        @trigger.step do
+          @cache << true
+        end
+        @trigger.step do
+          @cache << true
+        end
+        assert @cache.empty?
+        @trigger.do_step
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "add callback" do
+        3.times do
+          @trigger.step << proc do
+            @cache << true
+          end
+        end
+        assert @cache.empty?
+        @trigger.do_step
+        refute @cache.empty?
+        assert_equal 3, @cache.size
+      end
+
+    end
+
+    context "#stop" do
+
+      should "fire callback" do
+        @trigger.stop do
+          @cache << true
+        end
+        assert @cache.empty?
+        @trigger.do_stop
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "replace callback" do
+        @trigger.stop do
+          @cache << true
+        end
+        @trigger.stop do
+          @cache << true
+        end
+        assert @cache.empty?
+        @trigger.do_stop
+        refute @cache.empty?
+        assert_equal 1, @cache.size
+      end
+
+      should "add callback" do
+        3.times do
+          @trigger.stop << proc do
+            @cache << true
+          end
+        end
+        assert @cache.empty?
+        @trigger.do_stop
+        refute @cache.empty?
+        assert_equal 3, @cache.size
+      end
+
+    end
+
+  end
+
+end
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basic-sequencer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: midi-topaz
@@ -67,6 +67,7 @@ files:
 - lib/sequencer/loop.rb
 - test/clock_test.rb
 - test/core_test.rb
+- test/event_test.rb
 - test/event_trigger_test.rb
 - test/helper.rb
 - test/loop_test.rb