midi-topaz 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ce370c533a7d6bf26395da93632c35985e939c3
-  data.tar.gz: 2d225a7fd71f4fe2390278fd63c1c50e4ac3e3b1
+  metadata.gz: c9f83fa43c38e0489f38bec2e2270421bd87d2e6
+  data.tar.gz: 2c4f5c820ce0eaf0fd330b8c232a47f6fcca0d5c
 SHA512:
-  metadata.gz: 563c0fcec28ebd826488239e42b95ebab118b1d35f13bf50e590f2d44adff102da9a434c63990f370cbb9b1df20fa3ec8969a9269119a7b860e653c0ba31e4e2
-  data.tar.gz: 8205a2ec2232efb86edb38d2ec0280cd4c69516ad6334e861fc8160ca03b19367551dc3fa3bc40c335b3121c1cd29814c022fe132d550b88cab964a9b123cc2f
+  metadata.gz: c2a78d859d6e086983421936fb68e7ccf7a780adf79eefa82189fc9c1380cac3bc0bd19187053c54c384b415dca482b83996f0e86ddb30f7f3f8045a3f8ba3de
+  data.tar.gz: 37ab0b21755412718141df5d1cf21c2ecdaadc68ba8b5e0b4e6e33cd880a0da041d39140002eea7fea09e7618aba23e41df27b4e592305fe136e65e293c79c16

data/README.md

@@ -33,74 +33,63 @@ end
 sequencer = Sequencer.new
 ```
 
-The simplest application of Topaz is to create a clock to step that sequencer at a given rate.  Using timing generated internally by your computer, the passed in block will be called repeatedly at 130 BPM
+The Topaz clock can now be used to step that sequencer.  Timed by Topaz, the passed in block will be called repeatedly at 130 BPM
 
 ```ruby
-@tempo = Topaz::Clock.new(130) { sequencer.step }
+@clock = Topaz::Clock.new(130) { sequencer.step }
 ```
 
-You may also use another MIDI device to generate timing and control the tempo.  The unimidi input to which that device is connected can be passed to the Tempo constructor    
+A MIDI device can be used to time and control the tempo.  To accomplish this, pass a [unimidi](https://github.com/arirusso/unimidi) input to the Clock constructor   
 
 ```ruby
-@input = UniMIDI::Input.first.open # an midi input 
+@input = UniMIDI::Input.gets # select a midi input 
   
-@tempo = Topaz::Clock.new(@input) { sequencer.step }
+@clock = Topaz::Clock.new(@input) { sequencer.step }
 ```
         
-Topaz can also act as a master clock. If a MIDI output is passed to Topaz, MIDI start, stop and clock signals will automatically be sent to that output at the appropriate time
+Topaz can also act as a MIDI master clock. If a MIDI output is passed to Topaz, MIDI clock messages will automatically be sent to that output at the appropriate time
 
 ```ruby
-@output = UniMIDI::Output.first.open # a midi output 
+@output = UniMIDI::Output.gets # select a midi output 
   
-@tempo = Topaz::Clock.new(120, :midi => @output) do
+@clock = Topaz::Clock.new(120, :midi => @output) do
   sequencer.step
 end
 ```
 
-Input and multiple outputs can be used simultaneously
+Input and multiple outputs can be used simultaneously, for MIDI thru
 
 ```ruby
-@tempo = Topaz::Clock.new(@input, :midi => [@output1, @output2]) do 
+@clock = Topaz::Clock.new(@input, :midi => [@output1, @output2]) do 
   sequencer.step
 end
 ```
 
-Once the Tempo object is initialized, start the clock
+Once the Clock object is initialized, start the clock
 
 ```ruby
-@tempo.start
+@clock.start
 ```
 
-If you are syncing to external clock, nothing will happen until a "start" or "clock" message is received
-  
-#### Other things to note
-
-Whether or not you are using an internal or external clock source, the event block will be called at quarter note intervals by default.  If you wish to change this set the option :interval.  In this case, the event will be fired 4 times per beat (16th notes) at 138 BPM   
+Topaz will run in a background thread if the option `:background => true` is passed in.
 
 ```ruby
-@tempo = Topaz::Clock.new(138, :interval => 16) do
-  sequencer.step
-end
+@clock.start(:background => true)
 ```
+
+If you are syncing to an external MIDI source, this will start the listener waiting for MIDI clock messages.
   
-View the current tempo, which is calculated by Topaz if you're using an external MIDI source.
-(this feature is currently in-progress and may return some low values - 5/26/2011)
+You can view the current tempo:
 
 ```ruby
-@tempo.tempo
+@clock.tempo
   => 132.422000
 ```
-
-Run the generator in a background thread by passing :background => true to Tempo#start
-
-```ruby
-@tempo.start(:background => true)
-```
   
 Pass in a block that will stop the clock when it evaluates to true
 
 ```ruby
-@tempo.stop_when { @i.eql?(20) }
+@clock.trigger.stop { @i == 20 }
 ```
     
 ## Documentation

data/lib/topaz/timer.rb

@@ -69,10 +69,7 @@ module Topaz
         @thread = Thread.new do
           begin
             initialize_running_state
-            loop do 
-              dispatch 
-              advance
-            end
+            loop { perform } 
           rescue Exception => exception
             Thread.main.raise(exception)
           end
@@ -88,22 +85,38 @@ module Topaz
     # @return [Boolean]
     def dispatch
       # Stuff to do on every tick      
-      if time_for_midi_clock?
-        # look for stop
-        !@event.nil? && @event.do_clock        
-        @last_midi_clock = (@phase * 24).to_i
-        true
-      end
+      clock if clock?
       # Stuff to do on @interval
-      if time_for_tick?
-        !@event.nil? && !@pause && @event.do_tick
-        @last_tick_event = (@phase * @interval).to_i
-        true
-      end
+      tick if tick?
+      true
     end
     
     private
 
+    # Perform the timer function
+    # @return [Boolean]
+    def perform
+      dispatch 
+      advance
+      true
+    end
+
+    # Perform a tick
+    # @return [Boolean]
+    def tick
+      !@event.nil? && !@pause && @event.do_tick
+      @last_tick_event = (@phase * @interval).to_i
+      true
+    end
+
+    # Perform MIDI clock
+    # @return [Boolean]
+    def clock
+      !@event.nil? && @event.do_clock
+      @last_midi_clock = (@phase * 24).to_i
+      true
+    end
+
     # Initialize the variables that handle the running process of the timer
     # @return [Boolean]
     def initialize_running_state
@@ -115,14 +128,14 @@ module Topaz
     
     # Is the current phase appropriate for MIDI clock output?
     # @return [Boolean]
-    def time_for_midi_clock?
+    def clock?
       phase = (@phase * 24).to_i
       !@last_midi_clock.eql?(phase)
     end
     
     # Is the current phase appropriate for the tick event?
     # @return [Boolean]
-    def time_for_tick?
+    def tick?
       phase = (@phase * @interval).to_i
       !@last_tick_event.eql?(phase)
     end

data/lib/topaz.rb

@@ -1,7 +1,7 @@
 #
 # MIDI syncable tempo module in Ruby
 # (c)2011-2014 Ari Russo and licensed under the Apache 2.0 License
-# 
+#
 
 # libs
 require "forwardable"
@@ -22,7 +22,7 @@ require "topaz/tempo_calculator"
 require "topaz/timer"
 
 module Topaz
-  
-  VERSION = "0.2.1"
-  
+
+  VERSION = "0.2.2"
+
 end

data/test/clock_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::ClockTest < Test::Unit::TestCase
+class Topaz::ClockTest < Minitest::Test
 
   context "Clock" do
 
@@ -60,4 +60,3 @@ class Topaz::ClockTest < Test::Unit::TestCase
 
   end
 end
-

data/test/helper.rb

@@ -1,20 +1,20 @@
 dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + "/../lib"
 
-require "test/unit"
+require "minitest/autorun"
 require "mocha/test_unit"
 require "shoulda-context"
 require "topaz"
 
 module TestHelper
-  
+
   def self.select_devices
     $test_device ||= {}
     { :input => UniMIDI::Input, :output => UniMIDI::Output }.each do |type, klass|
       $test_device[type] = klass.gets
     end
   end
-     
+
 end
 
 TestHelper.select_devices

data/test/midi_clock_input_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::MIDIClockInputTest < Test::Unit::TestCase
+class Topaz::MIDIClockInputTest < Minitest::Test
 
   context "MIDIClockInput" do
 
@@ -32,7 +32,7 @@ class Topaz::MIDIClockInputTest < Test::Unit::TestCase
 
       should "tick when counter has reached tick threshold" do
         assert_equal 4, @clock.interval
-        23.times do 
+        23.times do
           refute @clock.send(:tick?)
           @clock.send(:advance)
         end
@@ -45,7 +45,3 @@ class Topaz::MIDIClockInputTest < Test::Unit::TestCase
   end
 
 end
-
-
-
-

data/test/midi_clock_output_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::MIDIClockOutputTest < Test::Unit::TestCase
+class Topaz::MIDIClockOutputTest < Minitest::Test
 
   context "MIDIClockOutput" do
 
@@ -10,34 +10,52 @@ class Topaz::MIDIClockOutputTest < Test::Unit::TestCase
     end
 
     context "#do_start" do
-      
-      should "emit start message" do
+
+      setup do
         @output.expects(:puts).once.with(250)
+      end
+
+      teardown do
+        @output.unstub(:puts)
+      end
+
+      should "emit start message" do
         result = @clock.do_start
         assert result
-        @output.unstub(:puts)
       end
 
     end
 
     context "#do_stop" do
 
-      should "emit stop message" do
+      setup do
         @output.expects(:puts).once.with(252)
+      end
+
+      teardown do
+        @output.unstub(:puts)
+      end
+
+      should "emit stop message" do
         result = @clock.do_stop
         assert result
-        @output.unstub(:puts)
       end
 
     end
 
     context "#do_clock" do
 
-      should "emit clock message" do
+      setup do
         @output.expects(:puts).once.with(248)
+      end
+
+      teardown do
+        @output.unstub(:puts)
+      end
+
+      should "emit clock message" do
         result = @clock.do_clock
         assert result
-        @output.unstub(:puts)
       end
 
     end
@@ -45,6 +63,3 @@ class Topaz::MIDIClockOutputTest < Test::Unit::TestCase
   end
 
 end
-
-
-

data/test/tempo_calculator_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::TempoCalculatorTest < Test::Unit::TestCase
+class Topaz::TempoCalculatorTest < Minitest::Test
 
   context "TempoCalculator" do
 
@@ -15,7 +15,7 @@ class Topaz::TempoCalculatorTest < Test::Unit::TestCase
         assert_nil @calc.calculate
         @calc.timestamps << 2
         @calc.timestamps << 3
-        assert_not_nil @calc.calculate
+        refute_nil @calc.calculate
       end
 
       should "limit timestamps do within the threshold" do
@@ -27,7 +27,7 @@ class Topaz::TempoCalculatorTest < Test::Unit::TestCase
       should "express tempo" do
         5.times { |i| @calc.timestamps << Time.now.to_f; sleep(1.0 / 24.0) }
         result = @calc.calculate
-        assert_not_nil result
+        refute_nil result
         assert (58..62).include?(result)
       end
 
@@ -36,4 +36,3 @@ class Topaz::TempoCalculatorTest < Test::Unit::TestCase
   end
 
 end
-

data/test/tempo_source_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::TempoSourceTest < Test::Unit::TestCase
+class Topaz::TempoSourceTest < Minitest::Test
 
   context "TempoSource" do
 
@@ -8,18 +8,18 @@ class Topaz::TempoSourceTest < Test::Unit::TestCase
 
       should "construct a timer" do
         result = Topaz::TempoSource.new(120)
-        assert_not_nil result
+        refute_nil result
         assert_equal Topaz::Timer, result.class
       end
 
       should "construct a midi input clock" do
         result = Topaz::TempoSource.new($test_device[:input])
-        assert_not_nil result
+        refute_nil result
         assert_equal Topaz::MIDIClockInput, result.class
       end
 
       should "throw an exception" do
-        assert_raise RuntimeError do
+        assert_raises RuntimeError do
           Topaz::TempoSource.new("something")
         end
       end
@@ -29,5 +29,3 @@ class Topaz::TempoSourceTest < Test::Unit::TestCase
   end
 
 end
-
-

data/test/timer_test.rb

@@ -1,6 +1,6 @@
 require "helper"
 
-class Topaz::TimerTest < Test::Unit::TestCase
+class Topaz::TimerTest < Minitest::Test
 
   context "Timer" do
 
@@ -14,15 +14,16 @@ class Topaz::TimerTest < Test::Unit::TestCase
         @event = Object.new
         @timer = Topaz::Timer.new(120, :event => @event)
         @timer.send(:initialize_running_state)
+        @event.expects(:do_clock).once.returns(true)
+        @event.expects(:do_tick).once.returns(true)
       end
 
-      should "fire MIDI clock event" do
-        @event.expects(:do_clock).once.returns(true)
-        @timer.send(:dispatch)
+      teardown do
+        @event.unstub(:do_clock)
+        @event.unstub(:do_tick)
       end
 
-      should "fire tick event" do
-        @event.expects(:do_tick).once.returns(true)
+      should "fire MIDI clock/tick events" do
         @timer.send(:dispatch)
       end
 
@@ -36,8 +37,8 @@ class Topaz::TimerTest < Test::Unit::TestCase
         loop until @timer.running?
 
         assert @timer.running?
-        assert_not_nil @timer.phase
-        assert_not_equal 0.0, @timer.phase
+        refute_nil @timer.phase
+        refute_equal 0.0, @timer.phase
       end
 
     end
@@ -53,14 +54,14 @@ class Topaz::TimerTest < Test::Unit::TestCase
       end
 
       should "stop running" do
-        assert_not_nil @timer.phase
-        assert_not_equal 0.0, @timer.phase
+        refute_nil @timer.phase
+        refute_equal 0.0, @timer.phase
         @timer.stop
         refute @timer.running?
       end
 
     end
-    
+
     context "#interval=" do
 
       should "change interval" do

metadata

@@ -1,15 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: midi-topaz
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ari Russo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: gamelan
   requirement: !ruby/object:Gem::Requirement
@@ -17,6 +97,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,66 +107,69 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: midi-message
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: midi-eye
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.3.7
 - !ruby/object:Gem::Dependency
   name: unimidi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.4.6
 description: A flexible tempo source that is capable of synchronizing with MIDI clocks.
 email:
 - ari.russo@gmail.com