qcmd 0.1.6 → 0.1.7

data/README.md

@@ -4,6 +4,9 @@
 QLab 3's new OSC interface. `qcmd` should be useable from any machine on
 the same local network as the QLab workspace you intend to work with.
 
+This project is OS X only and has been tested against Ruby 1.8.7-p358 (OS X
+10.8 default), Ruby 1.8.7 REE 2012.02, and Ruby 1.9.3-p327.
+
 **This project should be considered experimental. DO NOT RUN SHOWS WITH
 IT.**
 
@@ -16,6 +19,7 @@ Install this gem to your machine by running the following command:
 
 That should do ya.
 
+
 ## Starting the `qcmd` console.
 
 Run the following command in a terminal window:
@@ -122,6 +126,7 @@ An example session might look like this:
     > exit
     exiting...
 
+
 ## Contributing
 
 1. Fork it

data/lib/qcmd.rb

@@ -1,11 +1,17 @@
+require 'socket'
+require 'osc-ruby'
+
 require 'qcmd/version'
+
+require 'qcmd/plaintext'
+require 'qcmd/commands'
 require 'qcmd/input_completer'
 
 require 'qcmd/core_ext/array'
 require 'qcmd/core_ext/osc/message'
+require 'qcmd/core_ext/osc/stopping_server'
 
 module Qcmd
-  # Your code goes here...
   autoload :Handler, 'qcmd/handler'
   autoload :Server, 'qcmd/server'
   autoload :Context, 'qcmd/context'
@@ -14,8 +20,6 @@ module Qcmd
   autoload :Machine, 'qcmd/machine'
   autoload :Network, 'qcmd/network'
   autoload :QLab, 'qcmd/qlab'
-  autoload :Plaintext, 'qcmd/plaintext'
-  autoload :Commands, 'qcmd/commands'
   autoload :VERSION, 'qcmd/version'
 
   class << self
@@ -33,13 +37,21 @@ module Qcmd
       self.log_level = :warning
     end
 
+    def silent!
+      self.log_level = :none
+    end
+
+    def silent?
+      self.log_level == :none
+    end
+
     def quiet?
       self.log_level == :warning
     end
 
     def while_quiet
       previous_level = self.log_level
-      self.log_level = :warning unless previous_level == :debug
+      self.log_level = :warning
       yield
       self.log_level = previous_level
     end

data/lib/qcmd/cli.rb

@@ -3,7 +3,6 @@ require 'qcmd/server'
 require 'readline'
 
 require 'osc-ruby'
-require 'osc-ruby/em_server'
 
 module Qcmd
   class CLI
@@ -36,7 +35,7 @@ module Qcmd
 
           if options[:command_given]
             handle_message options[:command]
-            puts %[sent command "#{ options[:command] }"]
+            print %[sent command "#{ options[:command] }"]
             exit 0
           end
         end
@@ -146,7 +145,22 @@ module Qcmd
 
         Qcmd.debug "(using workspace: #{ workspace_name.inspect })"
 
-        connect_to_workspace_by_name workspace_name, passcode
+        if workspace_name
+          connect_to_workspace_by_name workspace_name, passcode
+        else
+          print "No workspace name given. The following workspaces are available:"
+          Qcmd.context.print_workspace_list
+        end
+
+      when 'help'
+        help_command = args.shift
+
+        if help_command.nil?
+          Qcmd::Commands::Help.print_all_commands
+          # print help according to current context
+        else
+          # print command specific help
+        end
 
       when 'cues'
         if !Qcmd.context.workspace_connected?
@@ -179,13 +193,21 @@ module Qcmd
           print
           print "  > cue NUMBER COMMAND ARGUMENTS"
           print
-          print_wrapped("available cue commands are: #{Qcmd::InputCompleter::ReservedCueWords.join(', ')}")
+          print_wrapped("available cue commands are: #{Qcmd::Commands::ALL_CUE_COMMANDS.join(', ')}")
         elsif cue_action.nil?
           server.send_workspace_command("cue/#{ cue_number }")
         else
           server.send_cue_command(cue_number, cue_action, *args)
         end
 
+      when 'workspaces'
+        if !Qcmd.context.machine_connected?
+          print 'cannot load workspaces until you are connected to a machine'
+          return
+        end
+
+        server.load_workspaces
+
       when 'workspace'
         workspace_command = args.shift
 

data/lib/qcmd/commands.rb

@@ -1,10 +1,34 @@
+require 'qcmd/plaintext'
+
 module Qcmd
   module Commands
-    # Commands that expect reponses
+    # All Commands
+    #
+    # *_RESPONSE lists are commands that expect responses
+    #
+
+    NO_MACHINE_RESPONSE = %w(connect)
+
     MACHINE_RESPONSE = %w(workspaces)
 
     WORKSPACE_RESPONSE = %w(
-      cueLists selectedCues runningCues runningOrPausedCues connect thump
+      cueLists selectedCues runningCues runningOrPausedCues thump
+    )
+
+    WORKSPACE_NO_RESPONSE = %w(
+      go stop pause resume reset panic
+    )
+
+    ALL_WORKSPACE_COMMANDS = [WORKSPACE_RESPONSE + WORKSPACE_NO_RESPONSE]
+
+    # commands that take no args and do not respond
+    CUE_NO_RESPONSE = %w(
+      start stop pause resume load preview reset panic
+    )
+
+    # commands that take args but do not respond
+    CUE_ARG_NO_RESPONSE = %w(
+      loadAt
     )
 
     # commands that always expect a response
@@ -16,14 +40,29 @@ module Qcmd
       basics children
     )
 
-    # commands that expect a response if given without args
+    # commands that take args but expect a response if given without args
     NO_ARG_CUE_RESPONSE = %w(
       number name notes cueTargetNumber cueTargetId preWait duration
       postWait continueMode flagged armed colorName
       sliderLevel
     )
 
+    # all cue commands that take arguments
+    CUE_ARG = CUE_ARG_NO_RESPONSE + NO_ARG_CUE_RESPONSE
+
+    ALL_CUE_COMMANDS = CUE_NO_RESPONSE +
+                       CUE_ARG_NO_RESPONSE +
+                       CUE_RESPONSE +
+                       NO_ARG_CUE_RESPONSE
+
     class << self
+      def no_machine_response_matcher
+        @no_machine_response_matcher ||= %r[(#{NO_MACHINE_RESPONSE.join('|')})]
+      end
+      def no_machine_response_match command
+        !!(no_machine_response_matcher =~ command)
+      end
+
       def machine_response_matcher
         @machine_response_matcher ||= %r[(#{MACHINE_RESPONSE.join('|')})]
       end
@@ -63,7 +102,7 @@ module Qcmd
         when :none
           # shouldn't be dealing with OSC messages when unconnected to
           # machine or workspace
-          response = false
+          response = no_machine_response_match(address)
         when :machine
           # could be workspace or machine command
           response = machine_response_match(address) ||
@@ -100,5 +139,85 @@ module Qcmd
         /workspace/ =~ address && !(%r[cue/] =~ address || %r[cue_id/] =~ address)
       end
     end
+
+    module Help
+      class << self
+
+        def print_all_commands
+          Qcmd.print %[
+#{Qcmd.centered_text(' Available Commands ', '-')}
+
+exit
+
+  close qcmd
+
+
+connect MACHINE_NAME
+
+  connect to the machine with name MACHINE_NAME
+
+
+disconnect
+
+  disconnect from the current machine and workspace
+
+
+use WORKSPACE_NAME [PASSCODE]
+
+  connect to the workspace with name WORKSPACE_NAME using passcode PASSCODE. A
+  passcode is only required if the workspace has one enabled.
+
+
+workspaces
+
+  show a list of the available workspaces for the currently connected machine.
+
+
+workspace COMMAND [VALUE]
+
+  pass the given COMMAND to the connected workspace. The following commands will
+  act on a workspace but will not return a value:
+
+    #{Qcmd.wrapped_text(Qcmd::Commands::WORKSPACE_NO_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}
+
+  And these commands will not act on a workspace, but will return a value
+  (usually a list of cues):
+
+    #{Qcmd.wrapped_text((Qcmd::Commands::WORKSPACE_RESPONSE - ['connect']).sort.join(', '), :indent => '    ').join("\n")}
+
+  * Pro Tip: once you are connected to a workspace, you can just use COMMAND
+  and leave off "workspace" to quickly send the given COMMAND to the connected
+  workspace.
+
+
+cue NUMBER COMMAND [VALUE [ANOTHER_VALUE ...]]
+
+  send a command to the cue with the given NUMBER.
+
+  NUMBER can be a string or a number, depending on the command.
+
+  COMMAND can be one of:
+
+    #{Qcmd.wrapped_text(Qcmd::Commands::ALL_CUE_COMMANDS.sort.join(', '), :indent => '    ').join("\n")}
+
+  Of those commands, only some accept a VALUE. The following commands, if given
+  a value, will update the cue:
+
+    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_ARG.sort.join(', '), :indent => '    ').join("\n")}
+
+  Some cues are Read-Only and will return information about a cue:
+
+    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}
+
+  Finally, some commands act on a cue, but don't take a VALUE and don't
+  respond:
+
+    #{Qcmd.wrapped_text(Qcmd::Commands::CUE_NO_RESPONSE.sort.join(', '), :indent => '    ').join("\n")}
+
+]
+        end
+      end
+
+    end
   end
 end

data/lib/qcmd/context.rb

@@ -33,5 +33,18 @@ module Qcmd
         :workspace
       end
     end
+
+    def print_workspace_list
+      Qcmd.print Qcmd.centered_text(" Workspaces ", '-')
+      Qcmd.print
+
+      machine.workspaces.each_with_index do |ws, n|
+        Qcmd.print "#{ n + 1 }. #{ ws.name }#{ ws.passcode? ? ' [PROTECTED]' : ''}"
+      end
+
+      Qcmd.print
+      Qcmd.print_wrapped('Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. Passcode is optional.')
+      Qcmd.print
+    end
   end
 end

data/lib/qcmd/core_ext/osc/stopping_server.rb

@@ -0,0 +1,84 @@
+module OSC
+  class StoppingServer < Server
+    def initialize *args
+      @state = :initialized
+      @port  = args.first
+      super(*args)
+    end
+
+    def run
+      @state = :starting
+      super
+    end
+
+    def stop
+      @state = :stopping
+      stop_detector
+      stop_dispatcher
+    end
+
+    def state
+      @state
+    end
+
+  private
+
+    def stop_detector
+      # send listening port a "CLOSE" signal on the open UDP port
+      _closer = UDPSocket.new
+      _closer.connect('', @port)
+      _closer.puts "CLOSE-#{@port}"
+      _closer.close unless _closer.closed? || !_closer.respond_to?(:close)
+    end
+
+    def stop_dispatcher
+      @queue << :stop
+    end
+
+    def dispatcher
+      loop do
+        mesg = @queue.pop
+        dispatch_message( mesg )
+      end
+    rescue StopException
+      @state = :stopped
+    end
+
+    def dispatch_message message
+      if message.is_a?(Symbol) && message.to_s == 'stop'
+        raise StopException.new
+      end
+
+      super(message)
+    end
+
+    def detector
+      @state = :listening
+
+      loop do
+        osc_data, network = @socket.recvfrom( 16384 )
+
+        # quit if socket receives the close signal
+        if osc_data == "CLOSE-#{@port}"
+          @socket.close if !@socket.closed? && @socket.respond_to?(:close)
+          break
+        end
+
+        unpack_socket_receipt osc_data, network
+      end
+    end
+
+    def unpack_socket_receipt osc_data, network
+      ip_info = Array.new
+      ip_info << network[1]
+      ip_info.concat(network[2].split('.'))
+      OSC::OSCPacket.messages_from_network( osc_data, ip_info ).each do |message|
+        @queue.push(message)
+      end
+    rescue EOFError
+      # pass
+    end
+  end
+
+  class StopException < Exception; end
+end

data/lib/qcmd/handler.rb

@@ -10,15 +10,7 @@ module Qcmd
         Qcmd.context.machine.workspaces = reply.data.map {|ws| Qcmd::QLab::Workspace.new(ws)}
 
         unless Qcmd.quiet?
-          print centered_text(" Workspaces ", '-')
-          print
-          Qcmd.context.machine.workspaces.each_with_index do |ws, n|
-            print "#{ n + 1 }. #{ ws.name }#{ ws.passcode? ? ' [PROTECTED]' : ''}"
-          end
-
-          print
-          print_wrapped('Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. Passcode is optional.')
-          print
+          Qcmd.context.print_workspace_list
         end
 
       when %r[/workspace/[^/]+/connect]
@@ -69,8 +61,24 @@ module Qcmd
         if result.is_a?(String) || result.is_a?(Numeric)
           print result
         else
-          print result.inspect
+          case reply.address
+          when %r[/basics]
+            keys = result.keys.sort
+            table(['Field Name', 'Value'], keys.map {|key|
+              [key, result[key]]
+            })
+          else
+            begin
+              print JSON.pretty_generate(result)
+            rescue JSON::GeneratorError
+              print result.to_s
+            end
+          end
         end
+
+      when %r[/thump]
+        print reply.data
+
       else
         Qcmd.debug "(unrecognized message from QLab, cannot handle #{ reply.address })"
       end

data/lib/qcmd/input_completer.rb

@@ -4,23 +4,12 @@ module Qcmd
   module InputCompleter
     # the commands listed here should represent every possible legal command
     ReservedWords = %w[
-      connect exit quit workspace workspaces disconnect
+      connect exit quit workspace workspaces disconnect help
     ]
 
-    ReservedWorkspaceWords = %w[
-      cueLists selectedCues runningCues runningOrPausedCues thump
-      go stop pause resume reset panic disconnect
-    ]
+    ReservedWorkspaceWords = Qcmd::Commands::ALL_WORKSPACE_COMMANDS
 
-    ReservedCueWords = %w[
-      cue stop pause resume load preview reset panic loadAt uniqueID
-      hasFileTargets hasCueTargets allowsEditingDuration isLoaded isRunning
-      isPaused isBroken preWaitElapsed actionElapsed postWaitElapsed
-      percentPreWaitElapsed percentActionElapsed percentPostWaitElapsed
-      type number name notes cueTargetNumber cueTargetId preWait duration
-      postWait continueMode flagged armed colorName basics children
-      sliderLevel sliderLevels
-    ]
+    ReservedCueWords = Qcmd::Commands::ALL_CUE_COMMANDS
 
     CompletionProc = Proc.new {|input|
       # puts "input: #{ input }"

data/lib/qcmd/network.rb

@@ -2,7 +2,7 @@ require 'dnssd'
 
 module Qcmd
   class Network
-    BROWSE_TIMEOUT = 8
+    BROWSE_TIMEOUT = 2
 
     class << self
       attr_accessor :machines, :browse_thread
@@ -18,19 +18,7 @@ module Qcmd
           end
         end
 
-        naps = 0
-        changed = false
-        previous = 0
-
-        # sleep for BROWSE_TIMEOUT loops
-        while naps < BROWSE_TIMEOUT
-          sleep 0.2
-          naps += 1
-
-          if machines.size != previous
-            previous = machines.size
-          end
-        end
+        sleep BROWSE_TIMEOUT
 
         Thread.kill(browse_thread) if browse_thread.alive?
       end

data/lib/qcmd/osc.rb

@@ -0,0 +1 @@
+require 'qcmd/osc/server'

data/lib/qcmd/plaintext.rb

@@ -8,17 +8,21 @@ module Qcmd
       end
     end
 
-    # always output
+    # display output unless absolutely silent
     def print message=nil
-      log(message)
+      log(message) unless Qcmd.silent?
+    end
+
+    def set_columns value
+      @columns = value
     end
 
     def columns
-      begin
-        `stty size`.split.last.to_i
-      rescue
-        80
-      end
+      @columns || (begin
+                     @columns = `stty size`.split.last.to_i
+                   rescue
+                     @columns = 80
+                   end)
     end
 
     def pluralize n, word
@@ -27,12 +31,35 @@ module Qcmd
 
     def word_wrap(text, options={})
       options = {
-        :line_width => columns
+        :line_width => columns,
+        :preserve_whitespace => false
       }.merge options
 
-      text.split("\n").collect do |line|
-        line.length > options[:line_width] ? line.gsub(/(.{1,#{options[:line_width]}})(\s+|$)/, "\\1\n").strip : line
-      end * "\n"
+      unless options[:preserve_whitespace]
+        text = text.gsub(/\s+/, ' ') # collapse whitespace
+      end
+
+      prefix = options[:indent] ? options[:indent] : ''
+
+      line_width = options[:line_width]
+      lines = ['']
+
+      space = ' '
+      space_size = 2
+      space_left = line_width
+      text.split.each do |word|
+        if (word.size + space.size) >= space_left
+          word       = "%s%s" % [prefix, word]
+          space_left = line_width - (word.size + space_size)
+          lines << ""
+        else
+          space_left = space_left - (word.size + space_size)
+        end
+
+        lines.last << "%s%s" % [word, space]
+      end
+
+      lines
     end
 
     def ascii_qlab
@@ -53,9 +80,14 @@ module Qcmd
     end
 
     # turn line into lines of text of columns length
-    def wrapped_text line
-      line = line.gsub(/\s+/, ' ') # collapse whitespace
-      word_wrap(line, :line_width => columns).split("\n")
+    def wrapped_text *args
+      options = {
+        :line_width => columns
+      }.merge args.extract_options!
+
+      line = args.shift
+
+      word_wrap(line, options)
     end
 
     def print_wrapped line
@@ -103,6 +135,14 @@ module Qcmd
     def table headers, rows
       print
       columns = headers.map(&:size)
+
+      # coerce row values to strings
+      rows.each do |row|
+        columns.each_with_index do |col, n|
+          row[n] = row[n].to_s
+        end
+      end
+
       rows.each do |row|
         columns.each_with_index do |col, n|
           columns[n] = [col, row[n].size].max + 1

data/lib/qcmd/server.rb

@@ -1,9 +1,4 @@
 require 'osc-ruby'
-require 'osc-ruby/em_server'
-begin
-  require 'ruby-debug'
-rescue LoadError
-end
 
 require 'json'
 
@@ -49,11 +44,10 @@ module Qcmd
     # initialize
     def listen
       if receive_channel
-        Qcmd.debug "(stopping existing server)"
         stop
       end
 
-      self.receive_channel = OSC::EMServer.new(self.receive_port)
+      self.receive_channel = OSC::StoppingServer.new(self.receive_port)
 
       Qcmd.debug "(opening receiving channel: #{ self.receive_channel.inspect })"
 
@@ -133,7 +127,7 @@ module Qcmd
     end
 
     def stop
-      Thread.kill(receive_thread) if receive_thread.alive?
+      receive_channel.stop if receive_channel && receive_channel.state == :listening
     end
 
     def run

data/lib/qcmd/version.rb

@@ -1,3 +1,3 @@
 module Qcmd
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/qcmd.gemspec

@@ -18,13 +18,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'dnssd'
-  gem.add_runtime_dependency 'eventmachine'
   gem.add_runtime_dependency 'json'
   gem.add_runtime_dependency 'osc-ruby'
   gem.add_runtime_dependency 'trollop'
 
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", '~> 2.10.0'
   gem.add_development_dependency "cucumber"
   gem.add_development_dependency "aruba"
-  gem.add_development_dependency 'ruby-debug'
 end

data/sample/simple_console.rb

@@ -0,0 +1,148 @@
+#!/usr/bin/env ruby
+
+# ruby builtin
+require 'readline'
+
+require 'rubygems'
+
+# use Qcmd's parser for type conversions and double quote recognizing
+require 'qcmd/parser'
+
+# other gems
+require 'osc-ruby'
+require 'json'
+
+# handle Ctrl-C quitting
+trap("INT") { exit }
+
+# if there are args, there must be two:
+#
+#   send_address:send_port
+#
+# and
+#
+#   receive_port
+
+# default qlab send port 53000
+send_address = 'localhost'
+send_port    = 53000
+
+# default qlab receive port 53001
+receive_port = 53001
+
+if ARGV.size > 0
+  send_matcher = /([^:]+):(\d+)/
+  recv_matcher = /(\d+)/
+
+  if send_matcher =~ ARGV[0]
+    send_address, send_port = $1, $2
+  elsif recv_matcher =~ ARGV[0]
+    receive_port = $1
+  else
+    puts 'send address must be an address in the form SERVER_ADDRESS:PORT'
+  end
+
+  if ARGV[1]
+    if recv_matcher =~ ARGV[1]
+      receive_port = $1
+    else
+      puts 'send address must be a port number'
+    end
+  end
+end
+
+puts %[connecting to server #{send_address}:#{send_port} with receiver at port #{receive_port}]
+
+# how long to wait for responses from QLab. If you notice responses coming in
+# out of order, you may need to increase this value.
+REPLY_TIMEOUT = 1
+
+# open IO pipes to communicate between client / server process
+response_receiver, writer = IO.pipe
+
+# fork readline process to allow server to communicate because if we use
+# Thread.new, readline locks the WHOLE Ruby VM and the server can't start
+pid = fork do
+  # close the IO channel that server process will be using
+  writer.close
+
+  # native OSC connection, outbound
+  client = OSC::Client.new 'localhost', send_port
+
+  loop do
+    command_string = Readline.readline('> ', true)
+    next if command_string.nil? || command_string.strip.size == 0
+
+    # break command string up and properly typecast all given values
+    args    = Qcmd::Parser.parse(command_string)
+    address = args.shift
+
+    # quit, q, and exit all quit
+    exit if /^(q(uit)?|exit)/i =~ address
+
+    # "sanitize" the given address
+    if %r[^/] != address
+      if address == '>'
+        # pasted previous command line entry
+        address = args.shift
+      else
+        # add lazy slash
+        address = "/#{ address }"
+      end
+    end
+
+    message = OSC::Message.new(address, *args)
+    client.send message
+
+    # wait for response until TIMEOUT seconds
+    select = IO.select([response_receiver], [], [], REPLY_TIMEOUT)
+    if !select.nil?
+      rs = select[0]
+
+      # get readable channel
+      if in_channel = rs[0]
+        # read everything until end of stream
+        while line = in_channel.gets
+          if line.strip != '<<EOS>>'
+            puts line
+          else
+            break
+          end
+        end
+      end
+    else
+      # select timed out, probably not going to get a response,
+      # go back to command line mode
+    end
+  end
+end
+
+puts "launched console with process id #{ pid }, use Ctrl-c or 'exit' to quit"
+
+# close unused pipe
+response_receiver.close
+
+# native OSC connection, inbound
+server = OSC::Server.new receive_port
+
+# server listens and forwards responses to the forked process
+server.add_method %r[/reply] do |osc_message|
+  data = JSON.parse(osc_message.to_a.first)['data']
+
+  begin
+    writer.puts JSON.pretty_generate(data)
+  rescue JSON::GeneratorError
+    writer.puts data.to_s
+  end
+
+  # end of signal
+  writer.puts '<<EOS>>'
+end
+
+# start blocking server
+Thread.new do
+  server.run
+end
+
+# chill until the command line process quits
+Process.wait pid

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'osc-ruby'
+require 'rspec'

data/spec/unit/osc_server_spec.rb

@@ -0,0 +1,78 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+require 'qcmd'
+require 'socket'
+
+class PortFactory
+  @@counter = 12345
+
+  def self.new_port
+    @@counter += 1
+    @@counter
+  end
+end
+
+describe OSC::StoppingServer do
+  before :each do
+    @port = PortFactory.new_port
+  end
+
+  it "should bind to a socket when initialized" do
+    UDPSocket.any_instance.should_receive(:bind).with('', @port)
+    server = OSC::StoppingServer.new @port
+  end
+
+  it 'should start a listening thread when started' do
+    server = OSC::StoppingServer.new @port
+
+    test_thread = Thread.new do
+      Thread.should_receive :fork
+      server.run
+    end
+
+    server.stop
+  end
+
+  it 'should kill the listening thread and close socket when stopped' do
+    server = OSC::StoppingServer.new @port
+
+    test_thread = Thread.new do
+      server.run
+    end
+
+    sleep 0.1
+    server.stop
+    sleep 0.1
+
+    # server has stopped blocking
+    test_thread.alive?.should == false
+
+    # server claims it is closed
+    server.state.should == :stopped
+  end
+
+  it 'should create messages for legitimate OSC commands' do
+    server = OSC::StoppingServer.new @port
+
+    received = nil
+
+    server.add_method '/test' do |message|
+      received = message
+    end
+
+    test_thread = Thread.new do
+      server.run
+    end
+
+    received.should == nil
+
+    client = OSC::Client.new 'localhost', @port
+    client.send OSC::Message.new('/test', 'ansible')
+
+    sleep 0.1
+    server.stop
+
+    received.is_a?(OSC::Message).should == true
+    received.to_a.first.should == 'ansible'
+  end
+end
+

data/spec/{qcmd_spec.rb → unit/qcmd_spec.rb}

@@ -3,8 +3,7 @@ require 'qcmd'
 describe Qcmd do
   # tests go here
   it "should log debug messages when in verbose mode" do
-    Qcmd.should_receive(:log, 'hello')
-
+    Qcmd.should_receive(:log).with('hello')
     Qcmd.verbose!
     Qcmd.log_level.should eql(:debug)
     Qcmd.debug 'hello'
@@ -16,4 +15,17 @@ describe Qcmd do
     Qcmd.log_level.should eql(:warning)
     Qcmd.debug 'hello'
   end
+
+  it 'should not log debug messages when in quiet block' do
+    Qcmd.verbose!
+    Qcmd.log_level.should eql(:debug)
+
+    Qcmd.while_quiet do
+      Qcmd.should_not_receive(:log)
+      Qcmd.log_level.should eql(:warning)
+      Qcmd.debug 'hello'
+    end
+
+    Qcmd.log_level.should eql(:debug)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qcmd
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Adam Bachman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-21 00:00:00 -05:00
+date: 2012-11-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: eventmachine
+  name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: osc-ruby
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,7 +61,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: osc-ruby
+  name: trollop
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -75,21 +75,23 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: trollop
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 39
         segments: 
+        - 2
+        - 10
         - 0
-        version: "0"
-  type: :runtime
+        version: 2.10.0
+  type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: cucumber
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -103,7 +105,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: aruba
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -116,34 +118,6 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: aruba
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id009
 description: A simple interactive QLab 3 command line controller
 email: 
 - adam.bachman@gmail.com
@@ -168,10 +142,12 @@ files:
 - lib/qcmd/context.rb
 - lib/qcmd/core_ext/array.rb
 - lib/qcmd/core_ext/osc/message.rb
+- lib/qcmd/core_ext/osc/stopping_server.rb
 - lib/qcmd/handler.rb
 - lib/qcmd/input_completer.rb
 - lib/qcmd/machine.rb
 - lib/qcmd/network.rb
+- lib/qcmd/osc.rb
 - lib/qcmd/parser.rb
 - lib/qcmd/plaintext.rb
 - lib/qcmd/qlab.rb
@@ -182,11 +158,14 @@ files:
 - lib/qcmd/version.rb
 - qcmd.gemspec
 - sample/dnssd.rb
-- spec/cli_spec.rb
-- spec/commands_spec.rb
-- spec/parser_spec.rb
-- spec/qcmd_spec.rb
-- spec/qlab_spec.rb
+- sample/simple_console.rb
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+- spec/unit/commands_spec.rb
+- spec/unit/osc_server_spec.rb
+- spec/unit/parser_spec.rb
+- spec/unit/qcmd_spec.rb
+- spec/unit/qlab_spec.rb
 has_rdoc: true
 homepage: https://github.com/abachman/qcmd
 licenses: []
@@ -223,8 +202,10 @@ specification_version: 3
 summary: QLab 3 console
 test_files: 
 - features/support/setup.rb
-- spec/cli_spec.rb
-- spec/commands_spec.rb
-- spec/parser_spec.rb
-- spec/qcmd_spec.rb
-- spec/qlab_spec.rb
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+- spec/unit/commands_spec.rb
+- spec/unit/osc_server_spec.rb
+- spec/unit/parser_spec.rb
+- spec/unit/qcmd_spec.rb
+- spec/unit/qlab_spec.rb