qcmd 0.1.4 → 0.1.5

data/README.md

@@ -12,7 +12,7 @@ IT.**
 
 Install this gem to your machine by running the following command:
 
-    $ gem install qcmd
+    $ sudo gem install qcmd
 
 That should do ya.
 

data/TODO.md

@@ -1,3 +0,0 @@
-* make sure we can connect to workspaces
-* parse arguments with more finesse than String#split
-* make sure we can disconnect from workspaces / machines

data/bin/qcmd

@@ -13,6 +13,7 @@ opts = Trollop::options do
   opt :machine_passcode, "Use the given machine passcode", :type => :integer
   opt :workspace, "Automatically try to connect to the workspace with the given name", :type => :string
   opt :workspace_passcode, "Use the given workspace passcode", :type => :integer
+  opt :command, "Execute a single command and exit", :type => :string
 end
 
 if opts[:verbose]
@@ -26,10 +27,20 @@ end
 
 # browse local network and check for qlab + qlab workspaces
 
-Qcmd.ascii_qlab
-Qcmd.print
-Qcmd.print Qcmd.centered_text(VERSION_STRING)
+if !opts[:machine_given]
+  Qcmd.ascii_qlab
+  Qcmd.print
+  Qcmd.print Qcmd.centered_text(VERSION_STRING)
+
+  Qcmd::Network.browse_and_display opts
+else
+  Qcmd::Network.browse
+end
+
+if options[:command_given] && !(options[:machine_given] && options[:workspace_given])
+  Qcmd.print_wrapped("if you give a command, you must also give a
+                      machine name and a workspace name to connect to")
+end
 
-Qcmd::Network.browse_and_display opts
 
 Qcmd::CLI.launch opts

data/lib/qcmd.rb

@@ -33,6 +33,17 @@ module Qcmd
       self.log_level = :warning
     end
 
+    def quiet?
+      self.log_level == :warning
+    end
+
+    def while_quiet
+      previous_level = self.log_level
+      self.log_level = :warning unless previous_level == :debug
+      yield
+      self.log_level = previous_level
+    end
+
     def debug?
       !!debug_mode
     end

data/lib/qcmd/cli.rb

@@ -24,9 +24,21 @@ module Qcmd
 
       if options[:machine_given]
         Qcmd.debug "(autoconnecting to #{ options[:machine] })"
-        connect_to_machine_by_name options[:machine], options[:machine_passcode]
+
+        Qcmd.while_quiet do
+          connect_to_machine_by_name options[:machine], options[:machine_passcode]
+        end
+
         if options[:workspace_given]
-          connect_to_workspace_by_name options[:workspace], options[:workspace_passcode]
+          Qcmd.while_quiet do
+            connect_to_workspace_by_name options[:workspace], options[:workspace_passcode]
+          end
+
+          if options[:command_given]
+            handle_message options[:command]
+            puts %[sent command "#{ options[:command] }"]
+            exit 0
+          end
         end
       end
 
@@ -77,9 +89,12 @@ module Qcmd
       Qcmd.debug %[(connecting to workspace: "#{workspace.name}")]
       # set workspace in context. Will unset later if there's a problem.
       Qcmd.context.workspace = workspace
-      self.prompt = "#{ Qcmd.context.machine.name }:#{ workspace.name }> "
 
       server.connect_to_workspace workspace
+      if Qcmd.context.workspace_connected? && Qcmd.context.workspace.cues
+        print "loaded #{pluralize Qcmd.context.workspace.cues.size, 'cue'}"
+        self.prompt = "#{ Qcmd.context.machine.name }:#{ workspace.name }> "
+      end
     end
 
     def reset
@@ -107,9 +122,10 @@ module Qcmd
       command = args.shift
 
       case command
-      when 'exit'
+      when 'exit', 'quit', 'q'
         print 'exiting...'
         exit 0
+
       when 'connect'
         Qcmd.debug "(connect command received args: #{ args.inspect })"
 
@@ -117,9 +133,11 @@ module Qcmd
         passcode     = args.shift
 
         connect_to_machine_by_name machine_name, passcode
+
       when 'disconnect'
         reset
         Qcmd::Network.browse_and_display
+
       when 'use'
         Qcmd.debug "(use command received args: #{ args.inspect })"
 
@@ -129,18 +147,29 @@ module Qcmd
         Qcmd.debug "(using workspace: #{ workspace_name.inspect })"
 
         connect_to_workspace_by_name workspace_name, passcode
+
       when 'cues'
         if !Qcmd.context.workspace_connected?
-          print "You must be connected to a workspace before you can view a cue list."
-        elsif Qcmd.context.workspace.cues
-          print
-          print centered_text(" Cues ", '-')
-          table ['Number', 'Id', 'Name', 'Type'], Qcmd.context.workspace.cues.map {|cue|
-            [cue.number, cue.id, cue.name, cue.type]
-          }
-          print
+          failed_workspace_command message
+          return
         end
-      when 'cue'
+
+        # reload cues
+        server.load_cues
+
+        print
+        print centered_text(" Cues ", '-')
+        table ['Number', 'Id', 'Name', 'Type'], Qcmd.context.workspace.cues.map {|cue|
+          [cue.number, cue.id, cue.name, cue.type]
+        }
+        print
+
+      when 'cue', 'c'
+        if !Qcmd.context.workspace_connected?
+          failed_workspace_command message
+          return
+        end
+
         # pull off cue number
         cue_number = args.shift
         cue_action = args.shift
@@ -150,25 +179,50 @@ module Qcmd
           print
           print "  > cue NUMBER COMMAND ARGUMENTS"
           print
-          print wrapped_text("available cue commands are: #{Qcmd::InputCompleter::ReservedCueWords.inspect}")
+          print_wrapped("available cue commands are: #{Qcmd::InputCompleter::ReservedCueWords.join(', ')}")
         elsif cue_action.nil?
-          server.send_workspace_command(cue_number)
+          server.send_workspace_command("cue/#{ cue_number }")
         else
           server.send_cue_command(cue_number, cue_action, *args)
         end
+
       when 'workspace'
         workspace_command = args.shift
 
+        if !Qcmd.context.workspace_connected?
+          handle_failed_workspace_command message
+          return
+        end
+
         if workspace_command.nil?
-          print wrapped_text("no workspace command given. available workspace commands are: #{Qcmd::InputCompleter::ReservedWorkspaceWords.inspect}")
+          print_wrapped("no workspace command given. available workspace commands
+                         are: #{Qcmd::InputCompleter::ReservedWorkspaceWords.join(', ')}")
         else
           server.send_workspace_command(workspace_command, *args)
         end
 
       else
-        server.send_command(command, *args)
+        if Qcmd.context.workspace_connected?
+          if Qcmd::InputCompleter::ReservedWorkspaceWords.include?(command)
+            server.send_workspace_command(command, *args)
+          else
+            if %r[/] =~ command
+              # might be legit OSC command, try sending
+              server.send_command(command, *args)
+            else
+              print "unrecognized command: #{ command }"
+            end
+          end
+        else
+          handle_failed_workspace_command message
+        end
       end
     end
 
+    def handle_failed_workspace_command command
+      print_wrapped(%[the command, "#{ command }" can't be processed yet. you must
+                      first connect to a machine and a workspace
+                      before issuing other commands.])
+    end
   end
 end

data/lib/qcmd/handler.rb

@@ -9,21 +9,22 @@ module Qcmd
       when %r[/workspaces]
         Qcmd.context.machine.workspaces = reply.data.map {|ws| Qcmd::QLab::Workspace.new(ws)}
 
-        print centered_text(" Workspaces ", '-')
-        print
-        Qcmd.context.machine.workspaces.each_with_index do |ws, n|
-          print "#{ n + 1 }. #{ ws.name }"
-        end
+        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_text('Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. ' +
-                           'Only enter a passcode if your workspace uses one')
-        print
+          print
+          print_wrapped('Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. Passcode is optional.')
+          print
+        end
 
       when %r[/workspace/[^/]+/connect]
         # connecting to a workspace
         if reply.data == 'badpass'
-          print 'failed to connect to workspace'
+          print 'failed to connect to workspace, bad passcode or no passcode given'
           Qcmd.context.disconnect_workspace
         elsif reply.data == 'ok'
           print 'connected to workspace'
@@ -38,8 +39,6 @@ module Qcmd
           cue_list['cues'].map {|cue| Qcmd::QLab::Cue.new(cue)}
         }.compact.flatten
 
-        print "loaded #{pluralize cues.size, 'cue'}"
-
       when %r[/(selectedCues|runningCues|runningOrPausedCues)]
         cues = reply.data.map {|cue|
           cues = [Qcmd::QLab::Cue.new(cue)]

data/lib/qcmd/input_completer.rb

@@ -2,12 +2,14 @@ require 'readline'
 
 module Qcmd
   module InputCompleter
+    # the commands listed here should represent every possible legal command
     ReservedWords = %w[
-      connect exit workspace workspaces disconnect
+      connect exit quit workspace workspaces disconnect
     ]
 
     ReservedWorkspaceWords = %w[
       cueLists selectedCues runningCues runningOrPausedCues thump
+      go stop pause resume reset panic disconnect
     ]
 
     ReservedCueWords = %w[
@@ -40,14 +42,7 @@ module Qcmd
           names           = Qcmd.context.machine.workspace_names
           quoted_names    = names.map {|wn| %["#{wn}"]}
           workspace_names = (names + quoted_names).grep(matcher)
-          workspace_names = workspace_names.map {|wsn|
-            if / / =~ wsn && /"/ !~ wsn
-              # if workspace name has a space and is not already quoted
-              %["#{ wsn }"]
-            else
-              wsn
-            end
-          }
+          workspace_names = quote_if_necessary workspace_names
           commands = commands + workspace_names
         end
       else
@@ -55,21 +50,29 @@ module Qcmd
         machine_names = Qcmd::Network.names
         quoted_names = machine_names.map {|mn| %["#{mn}"]}
         names = (quoted_names + machine_names).grep(matcher)
-        names = names.map {|wsn|
-          if / / =~ wsn && /"/ !~ wsn
-            # if workspace name has a space and is not already quoted
-            %["#{ wsn }"]
-          else
-            wsn
-          end
-        }
-
+        names = quote_if_necessary(names)
         # unquote
         commands = commands + names
       end
 
       commands
     }
+
+    class << self
+      # if the name of a thing has a space in it, it must be surrounded by double
+      # quotes to be properly handled by the parser. so before we pass back
+      # unquoted space-containing results, we must quote them.
+      def quote_if_necessary names
+        names.map do |name|
+          if / / =~ name && /"/ !~ name
+            # if name has a space and is not already quoted
+            %["#{ name }"]
+          else
+            name
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/qcmd/network.rb

@@ -2,11 +2,12 @@ require 'dnssd'
 
 module Qcmd
   class Network
-    BROWSE_TIMEOUT = 2
+    BROWSE_TIMEOUT = 8
 
     class << self
       attr_accessor :machines, :browse_thread
 
+      # browse can be used alone to populate the machines list
       def browse
         self.machines = []
         self.browse_thread = Thread.start do
@@ -21,9 +22,9 @@ module Qcmd
         changed = false
         previous = 0
 
-        # sleep for 3 seconds
+        # sleep for BROWSE_TIMEOUT loops
         while naps < BROWSE_TIMEOUT
-          sleep 1
+          sleep 0.2
           naps += 1
 
           if machines.size != previous
@@ -56,7 +57,7 @@ module Qcmd
 
       def browse_and_display options={}
         browse
-        if options[:machine_given] && !find(options[:machine_name]).nil?
+        if !options[:machine_given] || (options[:machine_given] && !find(options[:machine_name]).nil?)
           display options
         end
       end

data/lib/qcmd/plaintext.rb

@@ -54,9 +54,14 @@ module Qcmd
 
     # 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")
     end
 
+    def print_wrapped line
+      print wrapped_text(line)
+    end
+
     def right_text line
       diff = [(columns - line.size), 0].max
       "%s%s" % [' ' * diff, line]

data/lib/qcmd/server.rb

@@ -167,7 +167,7 @@ module Qcmd
 
     def connect_to_workspace workspace
       if workspace.passcode?
-        send_command "workspace/#{workspace.id}/connect", workspace.passcode
+        send_command "workspace/#{workspace.id}/connect", "%04i" % workspace.passcode
       else
         send_command "workspace/#{workspace.id}/connect"
       end

data/lib/qcmd/version.rb

@@ -1,3 +1,3 @@
 module Qcmd
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qcmd
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Adam Bachman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-16 00:00:00 -05:00
+date: 2012-11-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -161,7 +161,6 @@ files:
 - Rakefile
 - TODO.md
 - bin/qcmd
-- features/hello.feature
 - features/support/setup.rb
 - lib/qcmd.rb
 - lib/qcmd/cli.rb
@@ -223,7 +222,6 @@ signing_key:
 specification_version: 3
 summary: QLab 3 console
 test_files: 
-- features/hello.feature
 - features/support/setup.rb
 - spec/cli_spec.rb
 - spec/commands_spec.rb

data/features/hello.feature

@@ -1,13 +0,0 @@
-Feature: Hello
-  In order to render hello
-  As a CLI
-  I want to do the right thing
-
-  # Scenario: Phrase is default
-  #   When I run `qcmd`
-  #   Then the output should contain "hello world"
-
-  # Scenario: Phrase is given
-  #   When I run `qcmd Tomato`
-  #   Then the output should contain "Tomato"
-