mattly-schuschein-client 0.1

data/README.mkdn

@@ -0,0 +1,31 @@
+# Schuschein Client
+
+by Matthew Lyon <matt@flowerpowered.com>
+
+## DESCRIPTION:
+
+Schuschein is a protocol for synchronizing events across multiple processes and possibly multiple computers on a very rapid timeline. It is intended to be used in music sequencing.
+
+The name comes from the "Glass Clock of Bad Schuschein" in Terry Pratchett's [Thief of Time](http://wiki.lspace.org/wiki/Glass_Clock) novel, after a clock that ticks at the speed of the universe, thereby destroying time.
+
+## FEATURES
+
+- Stores blocks in a queue to be called at a specified tick time in the future
+- Receives Time Packets from Schuschein Server (not yet released), pulls scheduled processes out and calls them.
+  
+# SYNOPSIS
+
+    scheduler = Schuschein.new 5000
+    process = lambda {|tick, sch| puts "the time is now: #{tick}" }
+    [480, 960, 1440, 1920].each {|time| scheduler.queue.push time, process}
+    a.listen
+    sleep 30
+    # start the Schuschein server at position 0
+    # => the time is now: 480
+    # => the time is now: 960
+    # => the time is now: 1440
+    # => the time is now: 1920
+
+## REQUIREMENTS
+
+- [Datagrammer](http://github.com/mattly/datagrammer)

data/Rakefile

@@ -0,0 +1,5 @@
+require "rake"
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+desc "Run the specs."
+task :default => :spec

data/lib/schuschein.rb

@@ -0,0 +1,39 @@
+require 'datagrammer'
+
+alias :L :lambda
+
+$:.unshift File.dirname(__FILE__)
+require 'schuschein/schedule'
+class Schuschein
+  
+  def initialize(port=33333, address="0.0.0.0")
+    @queue = Schuschein::Schedule.new
+    @listener = Datagrammer.new(port, :address => address) 
+  end
+  
+  attr_accessor :position, :now, :queue, :listener
+  
+  def listen
+    @listener.listen do |dg, msg|
+      send(msg.shift.sub(/^\//,''), *msg)
+    end
+  end
+  
+  def tick(bar, beat, pulse, absolute)
+    @position = bar, beat, pulse
+    @now = absolute
+    @queue.shift_to(@now).each {|time, proc| proc.call(time, self) }
+  end
+  
+  def tempo(rate=nil)
+    return @tempo unless rate
+    self.tempo = rate
+  end
+  
+  def tempo=(rate=nil)
+    return unless rate.kind_of?(Numeric)
+    @tempo = rate
+    @listener.speak('/tempo', rate)
+  end
+  
+end

data/lib/schuschein/schedule.rb

@@ -0,0 +1,30 @@
+class Schuschein
+  class Schedule
+  
+    def initialize
+      @contents = []
+      @time = 0
+    end
+  
+    attr_accessor :contents, :time
+  
+    def at(position, &block)
+      @contents.push [position.to_i, block]
+    end
+    
+    def in(delta, &block)
+      at @time + delta.to_i.abs, &block
+    end
+    
+    def next(multiple, &block)
+      at @time + multiple - @time % multiple, &block
+    end
+    
+    def shift_to(position)
+      @time = position
+      ready, @contents = @contents.partition {|pos, proc| pos <= position }
+      ready
+    end
+
+  end
+end

data/spec/schedule_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Schuschein::Schedule do
+  
+  before do
+    @schedule = Schuschein::Schedule.new
+  end
+  
+  it "has an empty queue" do
+    @schedule.contents.should be_empty
+  end
+  
+  it "has a zero time value" do
+    @schedule.time.should be_zero
+  end
+  
+  describe "queueing" do
+    before do
+      @event = L{ puts "hi" }
+    end
+    
+    it "queues things to a specific time with at" do
+      @schedule.at(100, &@event)
+      @schedule.contents.should include([100, @event])
+    end
+    
+    it "queues things to an arbitrary future time with in" do
+      @schedule.time = 100
+      @schedule.in(100, &@event)
+      @schedule.contents.should include([200, @event])
+    end
+    
+    it "queues things to the next multiple of time with next" do
+      @schedule.time = 500
+      @schedule.next(480, &@event)
+      @schedule.contents.should include([960, @event])
+    end
+    
+  end
+  
+  describe "dequeueing" do
+    before do
+      @time = 100
+      @event = L{ puts "hi"}
+      @schedule.at @time, &@event
+    end
+    
+    it "doesn't return events after the given time" do
+      @schedule.shift_to(99).should be_empty
+    end
+    
+    it "doesn't remove items after the given time" do
+      @schedule.shift_to(99)
+      @schedule.contents.should == [[@time, @event]]
+    end
+    
+    it "returns events for the specified time" do
+      @schedule.shift_to(100).should == [[@time, @event]]
+    end
+    
+    it "returns events before the specified time" do
+      @schedule.shift_to(101).should == [[@time, @event]]
+    end
+    
+    it "removes events when returning them" do
+      @schedule.shift_to(100)
+      @schedule.contents.should be_empty
+    end
+    
+    it "sets the internal time for reference" do
+      @schedule.shift_to(100)
+      @schedule.time.should == 100
+    end
+  end
+  
+end

data/spec/schuschein_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Schuschein do
+  
+  before do
+    @s = Schuschein.new
+  end
+  
+  after do
+    @s.listener.socket.close
+  end
+  
+  it "should have a schedule object for its queue" do
+    @s.queue.should be_kind_of(Schuschein::Schedule)
+  end
+  
+  it "should have a datagrammer for its listener" do
+    @s.listener.should be_kind_of(Datagrammer)
+  end
+  
+  describe "responding to tick messages" do
+    
+    def tick
+      @s.tick(4,1,1,7680)
+    end
+    
+    it "sets the position" do
+      tick
+      @s.position.should == [4,1,1]
+    end
+    
+    it "shifts the queue to the absolute time" do
+      @s.queue.should_receive(:shift_to).with(7680).and_return([[7679, proc { "" }]])
+      tick
+    end
+    
+    it "calls the procs returned from the queue" do
+      var = 0
+      @s.queue.stub!(:shift_to).and_return([[7679, proc {|t,s| var = t }]])
+      tick
+      var.should == 7679
+    end
+    
+  end
+  
+  describe "tempo" do
+    it "returns the tempo on #tempo without arguments" do
+      @s.instance_variable_set(:@tempo, 120)
+      @s.tempo.should == 120
+    end
+    
+    it "stores the tempo value on #tempo(arg)" do
+      @s.tempo(96)
+      @s.tempo.should == 96
+    end
+    
+    it "responds by calling #tempo= on #tempo(arg)" do
+      @s.should_receive(:tempo=).with(96)
+      @s.tempo(96)
+    end
+    
+    it "tells the listener to speak the new tempo on #tempo=" do
+      @s.listener.should_receive(:speak).with("/tempo", 96)
+      @s.tempo = 96
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+begin
+  require 'spec'
+rescue LoadError
+  gem 'rspec'
+  require 'spec'
+end
+
+gem 'ruby-debug'
+require 'ruby-debug'
+
+require "#{File.dirname(__FILE__)}/../lib/schuschein"
+
+Debugger.start

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: mattly-schuschein-client
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Matthew Lyon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mattly-datagrammer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+description: client for the schuschein distributed scheduler
+email: matt@flowerpowered.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.mkdn
+- Rakefile
+- spec/schedule_spec.rb
+- spec/schuschein_spec.rb
+- spec/spec_helper.rb
+- lib/schuschein
+- lib/schuschein/schedule.rb
+- lib/schuschein.rb
+has_rdoc: false
+homepage: http://github.com/mattly/schuschein-client
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: client for the schuschein distributed scheduler
+test_files: []
+