handbrake 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+0.3.1
+=====
+
+- Add `:dry_run` option for {HandBrake::CLI}. When true, the commands
+  that would be executed otherwise are printed to standard out
+  instead.
+- Ensure that the directories needed by a call to
+  {HandBrake::CLI#output} exist before writing to them.
+- Ensure that the options hash passed into #output is not modified.
+
 0.3.0
 =====
 

data/lib/handbrake/cli.rb

@@ -1,4 +1,5 @@
 require 'handbrake'
+require 'fileutils'
 
 module HandBrake
   ##
@@ -18,18 +19,28 @@ module HandBrake
     # @return [Boolean]
     attr_writer :trace
 
+    ##
+    # Set whether dry_run mode is selected.
+    #
+    # @return [Boolean]
+    attr_writer :dry_run
+
     ##
     # @param [Hash] options
     # @option options [String] :bin_path ('HandBrakeCLI') the full
     #   path to the executable to use
     # @option options [Boolean] :trace (false) whether {#trace?} is
     #   enabled
+    # @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.
     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)
 
       @args = []
@@ -55,14 +66,32 @@ module HandBrake
       @trace
     end
 
+    ##
+    # Is this instance in `dry_run` mode?
+    #
+    # If it is, then no commands will actually be executed. The
+    # constructed `HandBrakeCLI` invocations will be printed to
+    # standard out, instead.
+    def dry_run?
+      @dry_run
+    end
+
+    def fileutils_options
+      {
+        :noop => dry_run?,
+        :verbose => trace? || dry_run?
+      }
+    end
+    private :fileutils_options
+
     ##
     # Performs a conversion. This method immediately begins the
     # transcoding process; set all other options first.
     #
     # @param [String] filename the desired name for the final output
-    #   file
+    #   file.
     # @param [Hash] options additional options to control the behavior
-    #   of the output process
+    #   of the output process. The provided hash will not be modified.
     # @option options [Boolean,:ignore] :overwrite (true) determines
     #   the behavior if the desired output file already exists. If
     #   `true`, the file is replaced. If `false`, an exception is
@@ -84,6 +113,7 @@ module HandBrake
     #
     # @return [void]
     def output(filename, options={})
+      options = options.dup
       overwrite = options.delete :overwrite
       case overwrite
       when true, nil
@@ -116,6 +146,7 @@ module HandBrake
         raise "Unknown options for output: #{options.keys.inspect}"
       end
 
+      FileUtils.mkdir_p(File.dirname(interim_filename), fileutils_options)
       run('--output', interim_filename)
 
       if filename != interim_filename
@@ -135,7 +166,8 @@ module HandBrake
           else
             true
           end
-        FileUtils.mv(interim_filename, filename, :verbose => trace?) if replace
+        FileUtils.mkdir_p(File.dirname(filename), fileutils_options)
+        FileUtils.mv(interim_filename, filename, fileutils_options) if replace
       end
     end
 
@@ -280,13 +312,18 @@ module HandBrake
         cmd = "'" + arguments.unshift(@cli.bin_path).join("' '") + "' 2>&1"
 
         $stderr.puts "Spawning HandBrakeCLI using #{cmd.inspect}" if @cli.trace?
-        IO.popen(cmd) do |io|
-          while line = io.read(60)
-            output << line
-            $stderr.write(line) if @cli.trace?
+        if @cli.dry_run?
+          puts cmd
+          RunnerResult.new('', 0)
+        else
+          IO.popen(cmd) do |io|
+            while line = io.read(60)
+              output << line
+              $stderr.write(line) if @cli.trace?
+            end
           end
+          RunnerResult.new(output, $?)
         end
-        RunnerResult.new(output, $?)
       end
     end
 

data/lib/handbrake/version.rb

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

data/spec/handbrake/cli_spec.rb

@@ -96,6 +96,18 @@ module HandBrake
             should raise_error('Unknown options for output: [:quux]')
         end
 
+        it 'does not directly modify the passed-in options hash' do
+          options = { :overwrite => true }
+          cli.output(filename, options)
+          options[:overwrite].should be_true
+        end
+
+        it 'creates the target directory when it does not exist' do
+          new_dir = File.join(tmpdir, 'quux')
+          cli.output(File.join(new_dir, 'baz.m4v'))
+          File.directory?(new_dir).should be_true
+        end
+
         describe ':overwrite' do
           context 'true' do
             it 'executes when the file does not exist' do
@@ -179,12 +191,19 @@ module HandBrake
               File.read(filename).should == 'This is the file created by --output'
             end
 
+            it 'creates the directory for the desired filename if necessary' do
+              new_dir = File.join(tmpdir, 'quux')
+              cli.output(File.join(new_dir, 'baz.m4v'), :atomic => atomic_option_value)
+              File.directory?(new_dir).should be_true
+            end
+
             it 'removes the temporary file' do
               cli.output(filename, :atomic => atomic_option_value)
               File.exist?(expected_temporary_file).should be_false
             end
 
             it 'overwrites the temporary file if it exists' do
+              FileUtils.mkdir_p File.dirname(expected_temporary_file)
               FileUtils.touch expected_temporary_file
               cli.output(filename, :atomic => atomic_option_value)
               it_should_have_run(expected_temporary_file)
@@ -242,7 +261,7 @@ module HandBrake
           end
 
           context 'an alternate path' do
-            let(:atomic_option_value) { tmpdir('somewhere/else') }
+            let(:atomic_option_value) { File.join(tmpdir, 'somewhere/else') } # not mkdir'd
             let(:expected_temporary_file) { File.join(atomic_option_value, "foo.handbraking.m4v") }
             let(:expected_no_extension_temporary_filename) {
               File.join(atomic_option_value, 'foo.handbraking')

metadata

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