qcmd 0.1.9 → 0.1.10

data/CHANGELOG.md

@@ -1,6 +1,6 @@
-### 0.1.8 -> 0.1.9
+### 0.1.8 to 0.1.9
 
-* add "alias" command to help
+* add help documentation for the "alias" command
 * add "new" command to create new cues in QLab
 * add "select" command to allow selection of a given cue (by number)
   * `select 2; go` would select and start the QLab workspace at the given cue
@@ -15,4 +15,15 @@ Internals:
 * fix `-c "COMMAND"` command line option
 * various small bug fixes
 
+### 0.1.7 to 0.1.8
 
+* create "alias" command to allow creation of commands from qcmd interactive interface
+* add ".." (disconnect one level) command
+* update location of qcmd settings and log files: `/Users/$USER/.qcmd/`
+* replace CLI parser with aarongough/sexpistol
+* use TCP connection and alwaysReply instead of UDP connection
+* show current time and connection state in interactive mode
+* persist command history across interactive qcmd sessions
+* allow multiple commands separated with ";". For example,
+  `cue 1 name; cue 2 name` would show the names of cues 1 and 2.
+* better debug logging

data/README.md

@@ -35,7 +35,9 @@ From there, you can connect to a machine, connect to a workspace, and then
 send commands to cues and the workspace.
 
 `qcmd` supports tab completion for commands in case you get stuck or are
-wondering what you can do from the console.
+wondering what you can do from the console. Type the beginning of a command and
+hit tab to auto-complete the command, or hit it twice to see all possible
+completions.
 
 Run `qcmd` with the -v option to get full debugging output. Use the main
 project repository (https://github.com/Figure53/qcmd) to report any issues.
@@ -43,95 +45,91 @@ project repository (https://github.com/Figure53/qcmd) to report any issues.
 An example session might look like this:
 
     $ qcmd
-                         .::::    .::                .::
-                       .::    .:: .::                .::
-                     .::       .::.::         .::    .::
-                     .::       .::.::       .::  .:: .:: .::
-                     .::       .::.::      .::   .:: .::   .::
-                       .:: .: .:: .::      .::   .:: .::   .::
-                         .:: ::   .::::::::  .:: .:::.:: .::
-                              .:
+                             .::::    .::                .::
+                           .::    .:: .::                .::
+                         .::       .::.::         .::    .::
+                         .::       .::.::       .::  .:: .:: .::
+                         .::       .::.::      .::   .:: .::   .::
+                           .:: .: .:: .::      .::   .:: .::   .::
+                             .:: ::   .::::::::  .:: .:::.:: .::
+                                  .:
 
-                   qcmd 0.1.0 (c) 2012 Figure 53, Baltimore, MD.
+                       qcmd 0.1.9 (c) 2012 Figure 53, Baltimore, MD.
 
     Found 2 QLab machines
 
-    1. adam-retina
-    2. f53zwimac
+    1. my-mac-laptop
+    2. f53imac
 
-    type `connect MACHINE` to connect to a machine
+    Type `connect "MACHINE NAME"` or `connect IP_ADDRESS` to connect to a machine
 
-    > connect adam-retina
-    connecting to machine: adam-retina
-    -------------------------------- Workspaces --------------------------------
+    13:40
+    > connect my-mac-laptop
+    Connecting to machine: my-mac-laptop
+    Connected to machine "my-mac-laptop"
+    Connecting to workspace: Untitled Workspace 1
+    Connected to "Untitled Workspace 1"
+    Loaded 3 cues
+    13:41 [my-mac-laptop] [Untitled Workspace 1]
+    > cues
 
-    1. Untitled Workspace
+    ------------------------------- Cues: Main Cue List -------------------------------
 
-    Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. Only enter a
-    passcode if your workspace uses one
+       Number	   Id	        Name	    Type
 
-    adam-retina> use "Untitled Workspace"
-    connecting to workspace: Untitled Workspace
-    connected to workspace
-    loaded 2 cues
-    adam-retina:Untitled Workspace> cues
+            1	    1	         YOP	   Audio
+            2	    2	  Not Armory	   Audio
+            3	    3	        BUTT	   Audio
 
-    ----------------------------------- Cues -----------------------------------
 
-      Number          Id      Name    Type
+    13:41 [my-mac-laptop] [Untitled Workspace 1]
+    > cue 3 name "Fix this name"
+    ok
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [3 Fix this name]
+    > start
+    ok
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [3 Fix this name]
+    > ..
+    13:41 [my-mac-laptop] [Untitled Workspace 1]
+    > hardStop
+    ok
+    13:41 [my-mac-laptop] [Untitled Workspace 1]
+    > copy-name 3 2
+    ok
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [2 Fix this name]
+    > cues
 
-           1           2      Nope    Wait
-           2           3      Nipe   Audio
+    ------------------------------- Cues: Main Cue List -------------------------------
 
+       Number	   Id	           Name	    Type
 
-    adam-retina:Untitled Workspace> cue 2 start
-    adam-retina:Untitled Workspace> cue 2 isRunning
-    true
-    adam-retina:Untitled Workspace> workspace runningCues
+            1	    1	            YOP	   Audio
+            2	    2	  Fix this name	   Audio
+            3	    3	  Fix this name	   Audio
 
-    ------------------------------- Running Cues -------------------------------
 
-     Number  Id      Name     Type
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [2 Fix this name]
+    > alias smiley (cue $1 name ":) :) :) :) :) :)")
+    Added alias for "smiley": (cue $1 name ":) :) :) :) :) :)")
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [2 Fix this name]
+    > smiley 2
+    ok
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [2 :) :) :) :) :) :)]
+    > cues
 
-          2   3      Nipe    Audio
+    ------------------------------- Cues: Main Cue List -------------------------------
 
+       Number	   Id	               Name	    Type
 
-    adam-retina:Untitled Workspace> cue 2
-    1                       2                       actionElapsed
-    allowsEditingDuration   armed                   basics
-    children                colorName               connect
-    continueMode            cue                     cueLists
-    cueTargetId             cueTargetNumber         disconnect
-    duration                exit                    flagged
-    hasCueTargets           hasFileTargets          isBroken
-    isLoaded                isPaused                isRunning
-    load                    loadAt                  name
-    notes                   number                  panic
-    pause                   percentActionElapsed    percentPostWaitElapsed
-    percentPreWaitElapsed   postWait                postWaitElapsed
-    preview                 preWait                 preWaitElapsed
-    reset                   resume                  runningCues
-    runningOrPausedCues     selectedCues            stop
-    thump                   type                    uniqueID
-    workspace               workspaces
-    adam-retina:Untitled Workspace> cue 2 pause
-    adam-retina:Untitled Workspace> cue 2 isRunning
-    false
-    adam-retina:Untitled Workspace> cue 2 percentActionElapsed
-    0.109189204871655
-    adam-retina:Untitled Workspace> disconnect
+            1	    1	                YOP	   Audio
+            2	    2	  :) :) :) :) :) :)	   Audio
+            3	    3	      Fix this name	   Audio
 
-    Found 2 QLab machines
-
-    1. adam-retina
-    2. f53zwimac
-
-    type `connect MACHINE` to connect to a machine
 
+    13:41 [my-mac-laptop] [Untitled Workspace 1] [2 :) :) :) :) :) :)]
     > exit
     exiting...
 
-
 ## Contributing
 
 1. Fork it

data/lib/qcmd.rb

@@ -25,9 +25,11 @@ module Qcmd
   autoload :Network, 'qcmd/network'
   autoload :QLab, 'qcmd/qlab'
   autoload :VERSION, 'qcmd/version'
-  autoload :Action, 'qcmd/action'
   autoload :Aliases, 'qcmd/aliases'
 
+  autoload :Action, 'qcmd/action'
+  autoload :CueAction, 'qcmd/action'
+
   # on launch
 
   class << self

data/lib/qcmd/action.rb

@@ -1,164 +1,3 @@
-module Qcmd
-  class Action
-    attr_reader :code
-
-    # initialize and evaluate in one shot
-    def self.evaluate action_input
-      is_cue_action = false
-
-      if action_input.is_a?(String)
-        is_cue_action = %w(cue cue_id).include?(action_input.split.first)
-      else
-        is_cue_action = ['cue', 'cue_id', :cue, :cue_id].include?(action_input.first)
-      end
-
-      if is_cue_action
-        CueAction.new(action_input).evaluate
-      else
-        Action.new(action_input).evaluate
-      end
-    end
-
-    def initialize(expression)
-      if expression.is_a?(String)
-        expression = Qcmd::Parser.parse(expression)
-      end
-
-      @code = parse(expression)
-    end
-
-    def evaluate
-      if code.size == 0
-        nil
-      else
-        @code = code.map do |token|
-          if token.is_a?(Action)
-            Qcmd.debug "[Action evaluate] evaluating nested action: #{ token.code.inspect }"
-            token.evaluate
-          else
-            token
-          end
-        end
-
-        Qcmd.debug "[Action evaluate] evaluating code: #{ code.inspect }"
-
-        send_message
-      end
-    end
-
-    def parse(expression)
-      # unwrap nested arrays
-      if expression.size == 1 && expression[0].is_a?(Array)
-        expression = expression[0]
-      end
-
-      expression.map do |token|
-        if token.is_a?(Array)
-          if [:cue, :cue_id].include?(token.first)
-            Qcmd.debug "nested cue action detected in #{ expression.inspect }"
-            CueAction.new(token)
-          else
-            Action.new(token)
-          end
-        else
-          token
-        end
-      end.tap {|exp|
-        Qcmd.debug "[Action parse] returning: #{ exp.inspect }"
-      }
-    end
-
-    # the default command builder
-    def osc_message
-      OSC::Message.new osc_address.to_s, *osc_arguments
-    end
-
-    def osc_address
-      # prefix w/ slash if necessary
-      if %r[^/] !~ code[0].to_s
-        "/#{ code[0] }"
-      else
-        code[0]
-      end
-    end
-
-    def osc_address=(value)
-      code[0] = value
-    end
-
-    def osc_arguments
-      stringify code[1..-1]
-    end
-
-    # the raw command
-    def command
-      code[0]
-    end
-
-    private
-
-    def send_message
-      responses = []
-
-      Qcmd.debug "[Action send_message] send #{ osc_message.encode }"
-      Qcmd.context.qlab.send(osc_message) do |response|
-        # puts "response to: #{ osc_message.inspect }"
-        # puts response.inspect
-
-        responses << QLab::Reply.new(response)
-      end
-
-      if responses.size == 1
-        q_reply = responses[0]
-        Qcmd.debug "[Action send_message] got one response: #{q_reply.inspect}"
-
-        if q_reply.has_data?
-          q_reply.data
-        else
-          q_reply
-        end
-      else
-        responses
-      end
-    end
-
-    def stringify args
-      if args.nil?
-        nil
-      else
-        args.map {|arg|
-          if arg.is_a?(Symbol)
-            arg.to_s
-          else
-            arg
-          end
-        }
-      end
-    end
-  end
-
-  class CueAction < Action
-    # cue commands work differently
-    def command
-      code[2]
-    end
-
-    def osc_address
-      "/#{ code[0] }/#{ code[1] }/#{ code[2] }"
-    end
-
-    def osc_arguments
-      stringify code[3..-1]
-    end
-
-    # cue specific fields
-
-    def id_field
-      code[0]
-    end
-
-    def identifier
-      code[1]
-    end
-  end
-end
+require 'qcmd/actions/base_action'
+require 'qcmd/actions/action'
+require 'qcmd/actions/cue_action'

data/lib/qcmd/actions/action.rb

@@ -0,0 +1,4 @@
+module Qcmd
+  class Action < BaseAction
+  end
+end

data/lib/qcmd/actions/base_action.rb

@@ -0,0 +1,139 @@
+module Qcmd
+  class BaseAction
+    attr_reader :code
+
+    # initialize and evaluate in one shot
+    def self.evaluate action_input
+      is_cue_action = false
+
+      if action_input.is_a?(String)
+        is_cue_action = %w(cue cue_id).include?(action_input.split.first)
+      else
+        is_cue_action = ['cue', 'cue_id', :cue, :cue_id].include?(action_input.first)
+      end
+
+      if is_cue_action
+        CueAction.new(action_input).evaluate
+      else
+        Action.new(action_input).evaluate
+      end
+    end
+
+    def initialize(expression)
+      if expression.is_a?(String)
+        expression = Qcmd::Parser.parse(expression)
+      end
+
+      @code = parse(expression)
+    end
+
+    def evaluate
+      if code.size == 0
+        nil
+      else
+        @code = code.map do |token|
+          if token.is_a?(Action)
+            Qcmd.debug "[Action evaluate] evaluating nested action: #{ token.code.inspect }"
+            token.evaluate
+          else
+            token
+          end
+        end
+
+        Qcmd.debug "[Action evaluate] evaluating code: #{ code.inspect }"
+
+        send_message
+      end
+    end
+
+    def parse(expression)
+      # unwrap nested arrays
+      if expression.size == 1 && expression[0].is_a?(Array)
+        expression = expression[0]
+      end
+
+      expression.map do |token|
+        if token.is_a?(Array)
+          if [:cue, :cue_id].include?(token.first)
+            Qcmd.debug "nested cue action detected in #{ expression.inspect }"
+            CueAction.new(token)
+          else
+            Action.new(token)
+          end
+        else
+          token
+        end
+      end.tap {|exp|
+        Qcmd.debug "[Action parse] returning: #{ exp.inspect }"
+      }
+    end
+
+    # the default command builder
+    def osc_message
+      OSC::Message.new osc_address.to_s, *osc_arguments
+    end
+
+    def osc_address
+      # prefix w/ slash if necessary
+      if %r[^/] !~ code[0].to_s
+        "/#{ code[0] }"
+      else
+        code[0]
+      end
+    end
+
+    def osc_address=(value)
+      code[0] = value
+    end
+
+    def osc_arguments
+      stringify code[1..-1]
+    end
+
+    # the raw command
+    def command
+      code[0]
+    end
+
+    private
+
+    def send_message
+      responses = []
+
+      Qcmd.debug "[Action send_message] send #{ osc_message.encode }"
+      Qcmd.context.qlab.send(osc_message) do |response|
+        # puts "response to: #{ osc_message.inspect }"
+        # puts response.inspect
+
+        responses << QLab::Reply.new(response)
+      end
+
+      if responses.size == 1
+        q_reply = responses[0]
+        Qcmd.debug "[Action send_message] got one response: #{q_reply.inspect}"
+
+        if q_reply.has_data?
+          q_reply.data
+        else
+          q_reply
+        end
+      else
+        responses
+      end
+    end
+
+    def stringify args
+      if args.nil?
+        nil
+      else
+        args.map {|arg|
+          if arg.is_a?(Symbol)
+            arg.to_s
+          else
+            arg
+          end
+        }
+      end
+    end
+  end
+end

data/lib/qcmd/actions/cue_action.rb

@@ -0,0 +1,27 @@
+module Qcmd
+  class CueAction < Action
+    # cue commands work differently
+    def command
+      code[2]
+    end
+
+    def osc_address
+      "/#{ code[0] }/#{ code[1] }/#{ code[2] }"
+    end
+
+    def osc_arguments
+      stringify code[3..-1]
+    end
+
+    # cue specific fields
+
+    def id_field
+      code[0]
+    end
+
+    def identifier
+      code[1]
+    end
+  end
+end
+

data/lib/qcmd/cli.rb

@@ -36,12 +36,9 @@ module Qcmd
             handle_input Qcmd::Parser.parse(options[:command])
             return
           end
-        elsif Qcmd.context.machine.workspaces.size == 1 &&
-              !Qcmd.context.machine.workspaces.first.passcode? &&
-              !Qcmd.context.workspace_connected?
-          if !connect_default_workspace
-            Handler.print_workspace_list
-          end
+        elsif !connect_default_workspace
+          Handler.print_workspace_list
+          # end
         end
       end
 
@@ -385,7 +382,7 @@ module Qcmd
         workspace_command = args[1]
 
         if !Qcmd.context.workspace_connected?
-          handle_failed_workspace_command cli_input
+          handle_failed_workspace_command args
           return
         end
 
@@ -402,7 +399,7 @@ module Qcmd
 
       when 'cues'
         if !Qcmd.context.workspace_connected?
-          handle_failed_workspace_command cli_input
+          handle_failed_workspace_command args
           return
         end
 
@@ -425,7 +422,7 @@ module Qcmd
         # id_field = $1
 
         if !Qcmd.context.workspace_connected?
-          handle_failed_workspace_command cli_input
+          handle_failed_workspace_command args
           return
         end
 
@@ -525,14 +522,17 @@ module Qcmd
         elsif Qcmd.context.cue_connected? && Qcmd::InputCompleter::ReservedCueWords.include?(command)
           # prepend the given command with a cue address
           if Qcmd.context.cue.number.nil? || Qcmd.context.cue.number.size == 0
-            command = "cue_id/#{ Qcmd.context.cue.id }/#{ command }"
+            command_args = [:cue_id, Qcmd.context.cue.id, command]
           else
-            command = "cue/#{ Qcmd.context.cue.number }/#{ command }"
+            command_args = [:cue, Qcmd.context.cue.number, command]
           end
 
-          args = [command].push(*args[1..-1])
+          # add the rest of the given args
+          Qcmd.debug "adding #{args[1..-1].inspect} to #{ command_args.inspect }"
+          command_args.push(*args[1..-1])
 
-          cue_action = Qcmd::CueAction.new(args)
+          Qcmd.debug "creating cue action with #{command_args.inspect}"
+          cue_action = Qcmd::CueAction.new(command_args)
 
           reply = cue_action.evaluate
           handle_simple_reply reply
@@ -568,6 +568,7 @@ module Qcmd
     end
 
     def handle_failed_workspace_command command
+      command = command.join ' '
       print_wrapped(%[The command, "#{ command }" can't be processed yet. you must
                       first connect to a machine and a workspace
                       before issuing other commands.])
@@ -613,7 +614,7 @@ module Qcmd
     end
 
     def fixate_on_cue cue_action
-      # fixate on cue
+      # fixate on the cue which is the subject of the given action
       if Qcmd.context.workspace.has_cues?
         _cue = Qcmd.context.workspace.cues.find {|cue|
           case cue_action.id_field
@@ -649,8 +650,12 @@ module Qcmd
     end
 
     def connect_default_workspace
-      if Qcmd.context.machine.workspaces.size == 1 && !Qcmd.context.machine.workspaces.first.passcode?
+      connectable = Qcmd.context.machine.workspaces.size == 1 &&
+        !Qcmd.context.machine.workspaces.first.passcode? &&
+        !Qcmd.context.workspace_connected?
+      if connectable
         connect_to_workspace_by_index(0, nil)
+
         true
       else
         false

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

@@ -52,16 +52,21 @@ module OSC
 
       send_char CHAR_END
 
+      # puts "[TCPClient] sent message: #{ enc_msg.inspect }"
+
       if block_given? || @handler
         messages = response
         if !messages.nil?
           messages.each do |message|
+            # puts "[TCPClient] got message #{ message }"
             if block_given?
               yield message
             else
               @handler.handle message
             end
           end
+        else
+          # puts "[TCPClient] response is nil"
         end
       end
     end

data/lib/qcmd/version.rb

@@ -1,3 +1,3 @@
 module Qcmd
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/qcmd.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["adam.bachman@gmail.com"]
   gem.description   = %q{A simple interactive QLab 3 command line controller}
   gem.summary       = %q{QLab 3 console}
-  gem.homepage      = "https://github.com/abachman/qcmd"
+  gem.homepage      = "https://github.com/Figure53/qcmd"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/unit/cli_spec.rb

@@ -11,4 +11,9 @@ describe Qcmd::CLI do
     Qcmd::CLI.should_receive :new
     Qcmd::CLI.launch
   end
+
+  describe 'handling input' do
+    it 'should evaluate cue commands' do
+    end
+  end
 end

data/spec/unit/commands_spec.rb

@@ -38,22 +38,27 @@ describe Qcmd::Commands do
 
     describe 'machine commands' do
       it 'should not raise errors' do
+        Qcmd.context.machine_connected?.should be_true
         test_log
 
         Qcmd::Commands::MACHINE.each do |machine_command|
           expect {
-            osc_message = OSC::Message.new "/#{ machine_command }"
+            osc_message = OSC::Message.new "/#{ machine_command }", 1
 
             reply = nil
 
+            test_log "[machine_command] sending #{ machine_command } - #{ osc_message.address } #{ osc_message.to_a.inspect }"
+
             # should be able to instantiate all OSC message reponses as QLab replies
             Qcmd.context.qlab.send(osc_message) do |response|
+              # test_log "[machine command] response: #{ response.inspect }"
               reply = Qcmd::QLab::Reply.new(response)
               # test_log "[machine command] #{ reply.address } got #{ reply.to_s }"
             end
 
-            test_log reply.address
             reply.should_not be_nil
+            # test_log reply.address
+
           }.to_not raise_error
         end
       end
@@ -122,6 +127,8 @@ describe Qcmd::Commands do
           Qcmd.context.qlab.send(osc_message) do |response|
             reply = Qcmd::QLab::Reply.new(response)
             @cue  = Qcmd::QLab::Cue.new(reply.data.first['cues'].first)
+
+            test_log "pulling cue from data: #{ reply.data.inspect }"
           end
         end
 
@@ -132,7 +139,11 @@ describe Qcmd::Commands do
 
           Qcmd::Commands::CUE.each do |cue_command|
             expect {
-              osc_message = OSC::Message.new "/workspace/#{workspace.id}/cue/#{ @cue.number }/#{ cue_command }"
+              test_log "using cue #{ @cue } : #{ @cue.data }"
+              cmd = "/workspace/#{workspace.id}/cue/#{ @cue.number }/#{ cue_command }"
+
+              test_log "sending #{ cmd }"
+              osc_message = OSC::Message.new cmd
 
               osc_response = nil
               reply = nil
@@ -146,7 +157,7 @@ describe Qcmd::Commands do
                 test_log reply.address
                 reply.should_not be_nil
               rescue => ex
-                puts "reply access fail '#{ ex.message }' on response #{ osc_response.inspect }"
+                test_log "reply access fail '#{ ex.message }' on response #{ osc_response.inspect }"
                 raise
               end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qcmd
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dnssd
@@ -142,6 +142,9 @@ files:
 - features/support/setup.rb
 - lib/qcmd.rb
 - lib/qcmd/action.rb
+- lib/qcmd/actions/action.rb
+- lib/qcmd/actions/base_action.rb
+- lib/qcmd/actions/cue_action.rb
 - lib/qcmd/aliases.rb
 - lib/qcmd/cli.rb
 - lib/qcmd/commands.rb
@@ -179,7 +182,7 @@ files:
 - spec/unit/parser_spec.rb
 - spec/unit/qcmd_spec.rb
 - spec/unit/qlab_spec.rb
-homepage: https://github.com/abachman/qcmd
+homepage: https://github.com/Figure53/qcmd
 licenses: []
 post_install_message: 
 rdoc_options: []