qcmd 0.1.13 → 0.1.14

data/README.md

@@ -13,11 +13,11 @@ IT.**
 
 ## Installation
 
-Before installing qcmd, you'll have to install the [Command Line Tools for
+Before installing `qcmd`, you'll have to install the [Command Line Tools for
 Xcode](https://developer.apple.com/downloads). They're free, but you'll need an
 Apple ID to download them.
 
-Once you've done that, you can install qcmd to your machine by running the
+Once you've done that, you can install `qcmd` to your machine by running the
 following command:
 
     $ sudo gem install qcmd
@@ -130,6 +130,35 @@ An example session might look like this:
     > exit
     exiting...
 
+
+If you already know the machine you want to connect to, you can use the `-m`
+option to connect immediately from the command line:
+
+    $ qcmd -m "my mac laptop"
+    Connecting to workspace: Untitled Workspace 1
+    Connected to "Untitled Workspace 1"
+    Loaded 1 cue
+    10:15 [my mac laptop] [Untitled Workspace 1]
+    >
+
+
+If there's only one workspace available, `qcmd` will connect to the given machine
+and then try to automatically connect to that workspace. If there's more than
+one workspace, you can list it on the command line as well to connect immediately:
+
+    $ qcmd -m "my mac laptop" -w "very special cues.cues"
+    10:36 [my mac laptop] [very special cues.cues]
+    >
+
+
+Finally, if all you want `qcmd` to do is run a single command and exit, you can
+use the `-c` option from the command line along with the `-m` and `-w` to make
+sure `qcmd` knows where to send the message:
+
+    $ qcmd -m "my mac laptop" -w "very special cues.cues" -c "cue 1 start"
+    ok
+
+
 ## Contributing
 
 1. Fork it

data/bin/qcmd

@@ -11,14 +11,50 @@ opts = Trollop::options do
   version VERSION_STRING
   opt :verbose, 'Use verbose mode', :default => false
   opt :debug, "Show full debug output, don't make changes to workspaces", :default => false
-  opt :machine, "Automatically try to connect to the machine with the given name", :type => :string
-  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
+  opt :machine, 'Automatically try to connect to the machine with the given name', :type => :string
+  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
+  opt :version_check, 'Check if a new version of qcmd is available and quit', :default => false
 end
 
 Qcmd.log_level = :info
 
+if opts[:version_check]
+  if Qcmd.available_version
+    if Qcmd.installed_version.to_s != Qcmd.available_version.to_s
+      puts "You have version #{ Qcmd.installed_version }, but #{ Qcmd.available_version.to_s } is available."
+      puts "Run `sudo gem update qcmd` to get the most recent version."
+    else
+      puts "You have the current version of qcmd installed."
+      puts VERSION_STRING
+    end
+  else
+    puts "We were unable to reach #{ Qcmd.rubygems_uri } to check the available qcmd version."
+  end
+
+  exit
+else
+  # version check on every command line open
+  Qcmd.while_quiet do
+    if !Qcmd::Configuration.config['skip_version_warning'] && Qcmd.available_version
+      known_available_version = Qcmd::Configuration.config['available_version']
+
+      if Qcmd.installed_version.to_s != Qcmd.available_version.to_s &&
+          (!Qcmd::Configuration.config['version_warning'] || Qcmd.available_version != known_available_version)
+        # use 'puts' to make sure the message is available
+        puts "A new version of qcmd is available! You have #{ Qcmd.installed_version }, but #{ Qcmd.available_version.to_s } is the most recent."
+        puts
+
+        Qcmd::Configuration.update('available_version', Qcmd.available_version)
+        Qcmd::Configuration.update('version_warning', true)
+      end
+    else
+      Qcmd::Configuration.update('skip_version_warning', true)
+    end
+  end
+end
+
 if opts[:verbose]
   Qcmd.log_level = :debug
 end

data/lib/qcmd.rb

@@ -86,9 +86,9 @@ module Qcmd
 
     def debug message
       # always write to log
-
       Qcmd::Configuration.log.puts "[%s] %s" % [Time.now.strftime('%T'), message]
 
+      # forward message to log
       log(:debug, message)
     end
 

data/lib/qcmd/cli.rb

@@ -57,7 +57,7 @@ module Qcmd
     end
 
     def aliases
-      @aliases ||= Qcmd::Aliases.defaults.merge(Qcmd::Configuration.config['aliases'])
+      @aliases ||= Qcmd::Aliases.defaults.merge(Qcmd::Configuration.config['aliases'] || {})
     end
 
     def alias_arg_matcher
@@ -156,7 +156,7 @@ module Qcmd
 
       # tell QLab to always reply to messages
       response = Qcmd::Action.evaluate('/alwaysReply 1')
-      if response.nil? || response.empty?
+      if response.nil? || response.to_s.empty?
         log(:error, %[Failed to connect to QLab machine "#{ machine.name }"])
       elsif response.status == 'ok'
         print %[Connected to machine "#{ machine.name }"]
@@ -178,14 +178,23 @@ module Qcmd
       machine = nil
 
       # machine name can be found or IPv4 address is given
-      if Qcmd::Network.find(machine_name)
+
+      if machine_name.nil? || machine_name.to_s.empty?
+        machine = nil
+      elsif Qcmd::Network.find(machine_name)
         machine = Qcmd::Network.find(machine_name)
-      elsif Qcmd::Network::IPV4_MATCHER  =~ machine_name
+      elsif Qcmd::Network::IPV4_MATCHER  =~ machine_name.to_s
         machine = Qcmd::Machine.new(machine_name, machine_name, 53000)
       end
 
       if machine.nil?
-        log(:warning, 'Sorry, that machine could not be found')
+        if machine_name.nil? || machine_name.to_s.empty?
+          log(:warning, 'You must include a machine name to connect.')
+        else
+          log(:warning, 'Sorry, that machine could not be found')
+        end
+
+        disconnected_machine_warning
       else
         print "Connecting to machine: #{machine_name}"
         connect_machine machine
@@ -322,10 +331,12 @@ module Qcmd
           connect_to_machine_by_name machine_ident
         end
 
-        load_workspaces
+        if Qcmd.context.machine_connected?
+          load_workspaces
 
-        if !connect_default_workspace
-          Handler.print_workspace_list
+          if !connect_default_workspace
+            Handler.print_workspace_list
+          end
         end
 
       when 'disconnect'
@@ -657,7 +668,9 @@ module Qcmd
     ## QLab commands
 
     def load_workspaces
-      Qcmd.context.machine.workspaces = Qcmd::Action.evaluate('workspaces').map {|ws| QLab::Workspace.new(ws)}
+      if !Qcmd.context.machine.nil?
+        Qcmd.context.machine.workspaces = Qcmd::Action.evaluate('workspaces').map {|ws| QLab::Workspace.new(ws)}
+      end
     end
 
     def connect_default_workspace

data/lib/qcmd/configuration.rb

@@ -41,6 +41,9 @@ module Qcmd
                       end
 
                       JSON.load(File.open(config_file))
+                    rescue
+                      Qcmd.log(:error, "Failed to load configuration, make sure #{ config_file } is valid JSON.\n\n")
+                      raise
                     end
       end
 

data/lib/qcmd/core_ext/string.rb

@@ -6,4 +6,3 @@ if !String.new.respond_to?(:force_encoding)
   end
 end
 
-

data/lib/qcmd/parser.rb

@@ -12,9 +12,8 @@ module Qcmd
         # make sure string is wrapped in parens to make the parser happy
         begin
           parser.parse_string "#{ string }"
-        rescue => ex
-          puts "parser FAILED WITH EXCEPTION: #{ ex.message }"
-          raise
+        rescue ParseException => ex
+          puts "Command parser failed with exception: #{ ex.message }"
         end
       end
 

data/lib/qcmd/version.rb

@@ -1,3 +1,37 @@
 module Qcmd
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
+
+  class << self
+    def installed_version
+      Gem.loaded_specs["qcmd"].version
+    end
+
+    def rubygems_uri
+      @rubygems_uri ||= URI.parse("http://rubygems.org/api/v1/gems/qcmd.json")
+    end
+
+    def available_version
+      @available_version ||= begin
+                              require "net/http"
+                              require "uri"
+
+                              begin
+                                # Shortcut
+                                response = Net::HTTP.get_response(rubygems_uri)
+                              rescue => ex
+                                Qcmd.debug "error loading #{ rubygems_uri }"
+                                Qcmd.debug "couldn't load remote qcmd version: #{ ex.message }"
+                                return false
+                              end
+
+                              begin
+                                JSON.parse(response.body)['version']
+                              rescue => ex
+                                Qcmd.debug "error parsing #{ rubygems_uri }"
+                                Qcmd.debug "couldn't parse remote qcmd version: #{ ex.message }"
+                                false
+                              end
+                             end
+    end
+  end
 end

data/lib/vendor/sexpistol/sexpistol/sexpistol_parser.rb

@@ -1,5 +1,8 @@
 require 'strscan'
 
+class ParseException < Exception
+end
+
 class SexpistolParser < StringScanner
 
   def initialize(string)
@@ -7,6 +10,7 @@ class SexpistolParser < StringScanner
     in_string_literal = false
     escape_char = false
     paren_count = 0
+
     string.bytes.each do |byte|
       if escape_char
         escape_char = false
@@ -31,9 +35,9 @@ class SexpistolParser < StringScanner
     end
 
     if paren_count > 0
-      raise Exception, "Missing closing parentheses"
+      raise ParseException.new("Missing closing parentheses")
     elsif paren_count < 0
-      raise Exception, "Missing opening parentheses"
+      raise ParseException.new("Missing opening parentheses")
     end
 
     super(string)
@@ -43,19 +47,19 @@ class SexpistolParser < StringScanner
     exp = []
     while true
       case fetch_token
-        when '('
-          exp << parse
-        when ')'
-          break
-        when :"'"
-          case fetch_token
-          when '(' then exp << [:quote].concat([parse])
-          else exp << [:quote, @token]
-          end
-        when String, Fixnum, Float, Symbol
-          exp << @token
-        when nil
-          break
+      when '('
+        exp << parse
+      when ')'
+        break
+      when :"'"
+        case fetch_token
+        when '(' then exp << [:quote].concat([parse])
+        else exp << [:quote, @token]
+        end
+      when String, Fixnum, Float, Symbol
+        exp << @token
+      when nil
+        break
       end
     end
     exp
@@ -73,10 +77,10 @@ class SexpistolParser < StringScanner
     elsif scan(/"([^"\\]|\\.)*"/)
       eval(matched)
     # Match a float literal
-    elsif scan(/[\-\+]? [0-9]+ ((e[0-9]+) | (\.[0-9]+(e[0-9]+)?))(\)| )(\s|$)/x)
+    elsif scan(/[\-\+]? [0-9]+ ((e[0-9]+) | (\.[0-9]+(e[0-9]+)?))#{ expression_ender }/x)
       matched.to_f
     # Match an integer literal
-    elsif scan(/[\-\+]?[0-9]+(\)| )(\s|$)/x)
+    elsif scan(/[\-\+]?[0-9]+#{ expression_ender }/)
       matched.to_i
     # Match a comma (for comma quoting)
     elsif scan(/'/)
@@ -91,4 +95,12 @@ class SexpistolParser < StringScanner
     end
   end
 
+  def expression_ender
+    # end Fixnum and Float matchers with a non-grouping positive lookahead
+    # assertion that matches a closing paren, whitespace, or string end.  The
+    # positive lookahead (?=...) ensures the string scanner includes the ending
+    # character in next fetch_token call.
+    '(?=(?:\)|\s|$))'
+  end
+
 end

data/sample/fast-rate-change.rb

@@ -0,0 +1,30 @@
+# slide the playback rate up and down
+require 'rubygems'
+require 'osc-ruby'
+
+c = OSC::Client.new 'localhost', 53000
+
+# first cue
+cue_number = 1
+
+# pause between OSC messages. if this is much below 0.05 it'll just get weird
+sleep_time = 0.05
+
+# more steps means a longer slide
+steps = 100
+
+# how high should rate peak
+max_rate = 2.0
+
+10.times do
+  # start at 1 to avoid sending 0.0 to rate
+  (1..steps).each do |n|
+    c.send(OSC::Message.new("/cue/#{ cue_number }/rate", n / (steps / max_rate)))
+    sleep(sleep_time)
+  end
+
+  (1..steps).each do |n|
+    c.send(OSC::Message.new("/cue/#{ cue_number }/rate", (max_rate + 0.01) - (n / (steps / max_rate))))
+    sleep(sleep_time)
+  end
+end

data/spec/unit/parser_spec.rb

@@ -12,13 +12,13 @@ describe Qcmd::Parser do
   end
 
   it "should parse integers" do
-    tokens = Qcmd::Parser.parse 'go "word word" 10 (rate 10)'
-    tokens.should eql([:go, 'word word', 10, [:rate, 10]])
+    tokens = Qcmd::Parser.parse 'go "word word" 10 (rate 10) 1'
+    tokens.should eql([:go, 'word word', 10, [:rate, 10], 1])
   end
 
   it "should parse floats" do
-    tokens = Qcmd::Parser.parse '1.1 go ("word word" 10.2 -12.3 1.1.1 10.2)'
-    tokens.should eql([1.1, :go, ['word word', 10.2, -12.3, :'1.1.1', 10.2]])
+    tokens = Qcmd::Parser.parse '1.1 go ("word word" 10.2 -12.3 1.1.1) 10.2'
+    tokens.should eql([1.1, :go, ['word word', 10.2, -12.3, :'1.1.1'], 10.2])
   end
 
   it "should parse invalid numbers as symbols" do
@@ -28,7 +28,6 @@ describe Qcmd::Parser do
 
   it "should parse nested quotes" do
     tokens = Qcmd::Parser.parse 'go "word word" 10 -12.3 "life \"is good\" yeah"'
-
     tokens.should eql([:go, 'word word', 10, -12.3, 'life "is good" yeah'])
   end
 
@@ -83,7 +82,6 @@ describe Qcmd::Parser do
     it "should handle escaped double quotes" do
       expression = Qcmd::Parser.generate([:go, 'word word', 10, -12.3, 'life "is good" yeah'])
       expression.should eql('(go "word word" 10 -12.3 "life \"is good\" yeah")')
-
     end
   end
 end

metadata

@@ -1,136 +1,126 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: qcmd
-version: !ruby/object:Gem::Version
-  version: 0.1.13
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 14
+  version: 0.1.14
 platform: ruby
-authors:
+authors: 
 - Adam Bachman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-06-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: dnssd
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.7.7
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 7
+        - 7
         version: 1.7.7
-- !ruby/object:Gem::Dependency
-  name: osc-ruby
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: osc-ruby
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.0'
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: trollop
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 0
         version: 2.10.0
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.1
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 1
         version: 1.2.1
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: aruba
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: A simple interactive QLab 3 command line controller
-email:
+email: 
 - adam.bachman@gmail.com
-executables:
+executables: 
 - qcmd
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -174,6 +164,7 @@ files:
 - lib/vendor/sexpistol/sexpistol/sexpistol_parser.rb
 - qcmd.gemspec
 - sample/dnssd.rb
+- sample/fast-rate-change.rb
 - sample/simple_console.rb
 - sample/tcp_qlab_connection.rb
 - spec/spec_helper.rb
@@ -183,31 +174,37 @@ files:
 - spec/unit/parser_spec.rb
 - spec/unit/qcmd_spec.rb
 - spec/unit/qlab_spec.rb
+has_rdoc: true
 homepage: https://github.com/Figure53/qcmd
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: QLab 3 console
-test_files:
+test_files: 
 - features/support/setup.rb
 - spec/spec_helper.rb
 - spec/unit/action_spec.rb