qcmd 0.1.15 → 0.1.16.pre

data/lib/qcmd/actions/base_action.rb

@@ -1,6 +1,7 @@
 module Qcmd
   class BaseAction
     attr_reader :code
+    attr_accessor :modification
 
     # initialize and evaluate in one shot
     def self.evaluate action_input
@@ -24,7 +25,7 @@ module Qcmd
         expression = Qcmd::Parser.parse(expression)
       end
 
-      @code = parse(expression)
+      parse(expression)
     end
 
     def evaluate
@@ -32,7 +33,7 @@ module Qcmd
         nil
       else
         @code = code.map do |token|
-          if token.is_a?(Action)
+          if token.is_a?(BaseAction)
             Qcmd.debug "[Action evaluate] evaluating nested action: #{ token.code.inspect }"
             token.evaluate
           else
@@ -42,17 +43,22 @@ module Qcmd
 
         Qcmd.debug "[Action evaluate] evaluating code: #{ code.inspect }"
 
-        send_message
+        response = send_message
+        if modification
+          modification.call(response)
+        else
+          response
+        end
       end
     end
 
+    # convert nested arrays into new actions
     def parse(expression)
-      # unwrap nested arrays
       if expression.size == 1 && expression[0].is_a?(Array)
         expression = expression[0]
       end
 
-      expression.map do |token|
+      @code = 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 }"
@@ -66,6 +72,31 @@ module Qcmd
       end.tap {|exp|
         Qcmd.debug "[Action parse] returning: #{ exp.inspect }"
       }
+
+      # if there's a trailing modifier command, replace it with an action that will
+      # return a value that can be modified.
+      if tm = trailing_modifier
+        Qcmd.debug "[Action parse] found trailing modifier: #{ tm.inspect }"
+
+        mod_type = tm[0]
+        mod_value = tm[2].to_f
+
+        # clone this action without the final arg
+        new_action = self.class.new(@code[0, @code.size - 1])
+
+        Qcmd.debug "[Action parse] creating modification proc: value.send(:#{ mod_type }, #{ mod_value })"
+        new_action.modification = Proc.new {|value|
+          Qcmd.debug "[Action parse] executing modification proc: #{ value }.send(:#{ mod_type }, #{ mod_value })"
+          if value.respond_to?(mod_type)
+            value.send mod_type, mod_value
+          else
+            Qcmd.log :warning, "The command `#{ new_action.code.join(' ') }` returned a value of type #{ value.class.to_s } which does not understand the #{ mod_type } modifier."
+            value
+          end
+        }
+
+        code[code.size - 1] = new_action
+      end
     end
 
     # the default command builder
@@ -97,14 +128,47 @@ module Qcmd
 
     private
 
+    # is the last argument to the osc command a modifier?
+    # returns nil or [modifier, matcher, matched_value]
+    def trailing_modifier
+      if osc_arguments && !osc_arguments.last.is_a?(BaseAction)
+        modifier = modifiers.find {|(_, matcher)|
+          matcher =~ osc_arguments.last.to_s
+        }
+
+        if modifier
+          modifier + [$1]
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    def number_matcher
+      # matches 1.9, .9, or 1
+      "(?: [0-9]+ \. [0-9]+ | \. [0-9]+ | [0-9]+ )"
+    end
+
+    def modifiers
+      [
+        [:+, /^\+\+(#{ number_matcher })/x],
+        [:-, /--(#{ number_matcher })/x],
+        [:/, /\/\/(#{ number_matcher })/x],
+        [:*, /\*\*(#{ number_matcher })/x]
+      ]
+    end
+
+    def modifier_matchers
+      modifiers.map(&:last)
+    end
+
     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
 

data/lib/qcmd/actions/cue_action.rb

@@ -1,6 +1,11 @@
 module Qcmd
-  class CueAction < Action
-    # cue commands work differently
+  class CueAction < BaseAction
+    # cue commands should be in the form:
+    #
+    #   [$id_field, $identifier, $command[, $arguments]]
+    #
+    # where arguments are optional.
+
     def command
       code[2]
     end

data/lib/qcmd/aliases.rb

@@ -3,7 +3,7 @@ module Qcmd
     def self.defaults
       @defaults ||= {
         'n' => 'cue $1 name $2',
-        # zero-out cue_number
+        # zero-out sliders for cue_number
         'zero-out' => '(log-silent)' +
                       (1..48).map {|n| "(cue $1 sliderLevel #{n} 0)"}.join(' ') +
                       '(log-noisy) (echo "set slider levels for cue $1 to all zeros")',
@@ -11,6 +11,8 @@ module Qcmd
         'copy-sliders' => '(log-silent)' +
                           (1..48).map {|n| "(cue $2 sliderLevel #{n} (cue $1 sliderLevel #{n}))"}.join(' ') +
                           '(log-noisy) (echo "copied slider levels from cue $1 to cue $2")',
+        'boost' => '(cue $1 sliderLevel $2 ++$3)',
+        'drop'  => '(cue $1 sliderLevel $2 --$3)'
       }.merge(copy_cue_actions)
     end
 

data/lib/qcmd/commands.rb

@@ -281,16 +281,38 @@ sleep NUMBER
 
   Will start cue number 3, then stop it two seconds later.
 
+
 log-silent, log-noisy
 
   Turn off output, turn it back on, respectively.
 
+
 log-debug, log-info
 
   Set output "level" to debug or info, respectively. Debug will tell you
   everything qcmd is doing, in great detail. It's really just for development
   purposes.
 
+
+--, ++, //, **
+
+  These are modifiers can be used with a number on cue specific commands to
+  drop, raise, divide, or multiply the given value by the given amount,
+  respectively. For example, instead of using:
+
+    cue 1 sliderLevel 1 0
+
+  to set the value of volume slider 1 on cue 1 to 0 absolute, you can use:
+
+    cue 1 sliderLevel 1 ++0.2
+
+  to raise the current value of slider 1 on cue 1 by 0.2. To lower it by 0.2
+  you'd use "--0.2". The same for ** and //.
+
+  This is handy if you know you want to adjust the value of the cue setting by
+  a small amount but you don't know what the value is at the moment.
+
+
 ]
         end
       end

data/lib/qcmd/version.rb

@@ -1,5 +1,5 @@
 module Qcmd
-  VERSION = "0.1.15"
+  VERSION = "0.1.16.pre"
 
   class << self
     def installed_version

data/spec/unit/action_spec.rb

@@ -10,6 +10,12 @@ class DeadHandler
   end
 end
 
+def stubbed_modified_action modifier
+  action = Qcmd::CueAction.new ''
+  action.stub(:code) { [:cue, 1, :sliderLevel, 0, modifier] }
+  action
+end
+
 describe Qcmd::Action do
   before do
     Qcmd.context = Qcmd::Context.new
@@ -78,6 +84,67 @@ describe Qcmd::Action do
       action = Qcmd::CueAction.new 'cue 1 name (cue 2 name)'
       action.code[3].should be_an_instance_of(Qcmd::CueAction)
     end
+
+    describe 'modifiers' do
+      describe 'positive' do
+        it 'should match int' do
+          action = stubbed_modified_action :'++1'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:+)
+          found.last.should eql('1')
+        end
+
+        it 'should match float' do
+          action = stubbed_modified_action :'++1.2'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:+)
+          found.last.should eql('1.2')
+        end
+
+        it 'should match bare float' do
+          action = stubbed_modified_action :'++.2'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:+)
+          found.last.should eql('.2')
+        end
+
+      end
+
+      describe 'negative' do
+        it 'should match int' do
+          action = stubbed_modified_action :'--1'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:-)
+          found.last.should eql('1')
+        end
+
+        it 'should match float' do
+          action = stubbed_modified_action :'--1.2'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:-)
+          found.last.should eql('1.2')
+        end
+
+        it 'should match bare float' do
+          action = stubbed_modified_action :'--.2'
+          found = action.send(:trailing_modifier)
+
+          found.should_not be_nil
+          found.first.should eql(:-)
+          found.last.should eql('.2')
+        end
+      end
+    end
   end
 
 end

data/spec/unit/parser_spec.rb

@@ -26,6 +26,11 @@ describe Qcmd::Parser do
     tokens.should eql([:cue, :'1.11.0'])
   end
 
+  it 'should parse modifiers as symbols' do
+    tokens = Qcmd::Parser.parse 'cue number ++1 --1'
+    tokens.should eql([:cue, :number, :'++1', :'--1'])
+  end
+
   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'])

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qcmd
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  prerelease: true
   segments: 
   - 0
   - 1
-  - 15
-  version: 0.1.15
+  - 16
+  - pre
+  version: 0.1.16.pre
 platform: ruby
 authors: 
 - Adam Bachman
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-03 00:00:00 -04:00
+date: 2013-06-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -192,11 +193,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: