handbrake 0.3.1 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.4.0
+=====
+
+- Allow the `:runner` option for {HandBrake::CLI} to take a lambda
+  that returns the runner. (#4)
+- Document the default runner to make the runner protocol
+  explicit. (#4)
+- Ensure that arguments that contain quotes are properly escaped
+  during execution. (#2; reported by bmatsuo)
+
 0.3.1
 =====
 

data/lib/handbrake/cli.rb

@@ -25,6 +25,14 @@ module HandBrake
     # @return [Boolean]
     attr_writer :dry_run
 
+    ##
+    # The runner to use to actually invoke HandBrakeCLI. This should
+    # be an object following the protocol laid out in the
+    # documentation for {PopenRunner}.
+    #
+    # @return [#run]
+    attr_accessor :runner
+
     ##
     # @param [Hash] options
     # @option options [String] :bin_path ('HandBrakeCLI') the full
@@ -34,18 +42,35 @@ module HandBrake
     # @option options [Boolean] :dry_run (false) if true, nothing will
     #   actually be executed. The commands that would have been
     #   executed will be printed to standard out.
-    # @option options [#run] :runner (a PopenRunner instance) the class
-    #   encapsulating the execution method for HandBrakeCLI. You
-    #   shouldn't usually need to replace this.
+    # @option options [#run, #call] :runner (a PopenRunner instance)
+    #   the object encapsulating the execution method for HandBrakeCLI
+    #   or a lambda which may be invoked to create the runner. A lambda will
+    #   receive the {CLI} instance that's being constructed as its
+    #   sole argument.  You shouldn't usually need to replace this. If
+    #   you do, look at {#runner} for more details.
     def initialize(options={})
       @bin_path = options[:bin_path] || 'HandBrakeCLI'
       @trace = options[:trace].nil? ? false : options[:trace]
       @dry_run = options[:dry_run] || false
-      @runner = options[:runner] || PopenRunner.new(self)
+      @runner = build_runner(options[:runner])
 
       @args = []
     end
 
+    def build_runner(selected)
+      default_runner_creator = lambda { |cli| PopenRunner.new(cli) }
+
+      case
+      when selected.nil?
+        default_runner_creator.call(self)
+      when selected.respond_to?(:call)
+        selected.call(self) || default_runner_creator.call(self)
+      else
+        selected
+      end
+    end
+    private :build_runner
+
     ##
     # Ensures that `#dup` produces a separate copy.
     #
@@ -253,7 +278,7 @@ module HandBrake
 
     def run(*more_args)
       @runner.run(arguments.push(*more_args)).tap do |result|
-        unless result.status == 0
+        unless result.status.to_i == 0
           unless trace?
             $stderr.write result.output
           end
@@ -282,13 +307,19 @@ module HandBrake
     end
 
     ##
-    # @private
     # The default runner. Uses `IO.popen` to spawn
     # HandBrakeCLI. General use of this library does not require
     # monkeying with this class.
+    #
+    # If you have non-general use case, a replacement runner must have
+    # a method matching the signature of {#run}.
+    #
+    # @see CLI#initialize the HandBrake::CLI constructor
+    # @see CLI#runner HandBrake::CLI#runner
     class PopenRunner
       ##
-      # @param [CLI] cli_instance the {CLI} instance whose configuration to share
+      # @param [CLI] cli_instance the {CLI} instance for which this
+      #   runner will execute.
       def initialize(cli_instance)
         @cli = cli_instance
       end
@@ -309,7 +340,7 @@ module HandBrake
       def run(arguments)
         output = ''
 
-        cmd = "'" + arguments.unshift(@cli.bin_path).join("' '") + "' 2>&1"
+        cmd = command(arguments)
 
         $stderr.puts "Spawning HandBrakeCLI using #{cmd.inspect}" if @cli.trace?
         if @cli.dry_run?
@@ -325,13 +356,20 @@ module HandBrake
           RunnerResult.new(output, $?)
         end
       end
+
+      ##
+      # @return [String] the concatentated command string to pass to IO.popen.
+      def command(arguments)
+        "'#{arguments.unshift(@cli.bin_path).collect { |a| a.gsub(%r(')) { %('\\\'') } }.join("' '")}' 2>&1"
+      end
     end
 
     ##
-    # @private
     # The raw result of one execution of HandBrakeCLI.
     #
-    # General use of the library will not require use of this class.
+    # General use of the library will not require use of this
+    # class. If you create your own {CLI#runner runner} its `run`
+    # method should return an instance of this class.
     #
     # @attr [String] output a string containing the combined output
     #   and error streams from the run

data/lib/handbrake/version.rb

@@ -1,5 +1,5 @@
 module HandBrake
   ##
   # The current version
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/handbrake/cli_spec.rb

@@ -23,6 +23,38 @@ module HandBrake
       end
     end
 
+    describe '#runner' do
+      let(:default_runner_class) { HandBrake::CLI::PopenRunner }
+
+      it 'is a PopenRunner by default' do
+        HandBrake::CLI.new.runner.should be_a default_runner_class
+      end
+
+      it 'can be set with a static value' do
+        HandBrake::CLI.new(:runner => HandBrake::Spec::StaticRunner.new).runner.
+          should be_a HandBrake::Spec::StaticRunner
+      end
+
+      describe 'set from a lambda' do
+        let(:recorder_class) { Struct.new(:input) }
+        let(:runner_constructor) { lambda { |cli| recorder_class.new(cli) } }
+        let(:cli) { HandBrake::CLI.new(:runner => runner_constructor) }
+
+        it 'calls the lambda' do
+          cli.runner.should be_a recorder_class
+        end
+
+        it 'yields the CLI instance' do
+          cli.runner.input.should be cli
+        end
+
+        it 'uses the default if the lambda returns nil' do
+          HandBrake::CLI.new(:runner => lambda { |cli| nil }).runner.
+            should be_a default_runner_class
+        end
+      end
+    end
+
     describe "building a command" do
       let(:cli) { HandBrake::CLI.new }
 
@@ -356,4 +388,27 @@ module HandBrake
       end
     end
   end
+
+  describe CLI::PopenRunner do
+    describe '#command' do
+      subject { CLI::PopenRunner.new(CLI.new(:bin_path => '/foo/hbcli')) }
+
+      it 'starts with the bin path' do
+        subject.command(%w(--bar)).should =~ %r{^'/foo/hbcli'}
+      end
+
+      it 'quotes the arguments' do
+        subject.command(%w(--bar)).should =~ %r{'--bar'}
+      end
+
+      it 'redirects stderr to stdout' do
+        subject.command([]).should =~ %r{2>&1$}
+      end
+
+      it 'escapes single quotes in the arguments' do
+        subject.command(["--output", "/quux/boo's.m4v"]).
+          should == %('/foo/hbcli' '--output' '/quux/boo'\\''s.m4v' 2>&1)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handbrake
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-21 00:00:00.000000000Z
+date: 2011-09-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytree
-  requirement: &2152476560 !ruby/object:Gem::Requirement
+  requirement: &2157010300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152476560
+  version_requirements: *2157010300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152476060 !ruby/object:Gem::Requirement
+  requirement: &2157009800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *2152476060
+  version_requirements: *2157009800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152475600 !ruby/object:Gem::Requirement
+  requirement: &2157009340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2152475600
+  version_requirements: *2157009340
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152475140 !ruby/object:Gem::Requirement
+  requirement: &2157008880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2152475140
+  version_requirements: *2157008880
 description: A lightweight literate ruby wrapper for HandBrakeCLI, the command-line
   interface for the HandBrake video transcoder.
 email: