handbrake 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.2.0
+=====
+
+- Support overwrite detection and behaviors for the
+  {HandBrake::CLI#output}.
+- Support "atomic" output mode in {HandBrake::CLI#output}.
+
 0.1.0
 =====
 

data/README.md

@@ -126,6 +126,13 @@ To put it more technically, the chain object returned from each
 intermediate configuration step returns an independent copy of the
 configuration chain.
 
+### Output options
+
+By default, the `output` execution method behaves just like invoking
+HandBrakeCLI directly. `handbrake.rb` also supports a couple of
+additional behaviors, including overwrite detection and atomic output
+file creation. See {HandBrake::CLI#output} for more details.
+
 Additional resources
 --------------------
 

data/lib/handbrake.rb

@@ -8,4 +8,10 @@ module HandBrake
   autoload :Titles,  'handbrake/titles'
   autoload :Title,   'handbrake/titles'
   autoload :Chapter, 'handbrake/titles'
+
+  ##
+  # The exception thrown when a file exists that shouldn't.
+  #
+  # @see CLI#output
+  class FileExistsError < StandardError; end;
 end

data/lib/handbrake/cli.rb

@@ -59,11 +59,88 @@ module HandBrake
     # 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
+    # @param [Hash] options additional options to control the behavior
+    #   of the output process
+    # @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
+    #   thrown. If `:ignore`, the file is skipped; i.e., HandBrakeCLI
+    #   is not invoked.
+    # @option options [Boolean] :atomic (false) provides a
+    #   pseudo-atomic mode for transcoded output. If true, the
+    #   transcode will go into a temporary file and only be copied to
+    #   the specified filename if it completes. The temporary filename
+    #   is the target filename with `.handbraking` inserted before the
+    #   extension. Any `:overwrite` checking will be applied to the
+    #   target filename both before and after the transcode happens
+    #   (the temporary file will always be overwritten). This option
+    #   is intended to aid in writing automatically resumable batch
+    #   scripts.
+    #
     # @return [void]
-    def output(filename)
-      run('--output', filename)
+    def output(filename, options={})
+      overwrite = options.delete :overwrite
+      case overwrite
+      when true, nil
+        # no special behavior
+      when false
+        raise FileExistsError, filename if File.exist?(filename)
+      when :ignore
+        if File.exist?(filename)
+          trace "Ignoring transcode to #{filename.inspect} because it already exists"
+          return
+        end
+      else
+        raise "Unsupported value for :overwrite: #{overwrite.inspect}"
+      end
+
+      atomic = options.delete :atomic
+      interim_filename =
+        if atomic
+          partial_filename(filename)
+        else
+          filename
+        end
+
+      unless options.empty?
+        raise "Unknown options for output: #{options.keys.inspect}"
+      end
+
+      run('--output', interim_filename)
+
+      if filename != interim_filename
+        replace =
+          if File.exist?(filename)
+            trace "#{filename.inspect} showed up during transcode"
+            case overwrite
+            when false
+              raise FileExistsError, filename
+            when :ignore
+              trace "- will leave #{filename.inspect} as is; copy #{interim_filename.inspect} manually if you want to replace it"
+              false
+            else
+              trace '- will replace with new transcode'
+              true
+            end
+          else
+            true
+          end
+        FileUtils.mv interim_filename, filename if replace
+      end
     end
 
+    def partial_filename(name)
+      if File.basename(name).index '.'
+        dot_at = name.rindex '.'
+        name.dup.insert dot_at, '.handbraking'
+      else
+        name + '.handbraking'
+      end
+    end
+    private :partial_filename
+
     ##
     # Performs a title scan. Unlike HandBrakeCLI, if you do not
     # specify a title, this method will return information for all
@@ -136,6 +213,10 @@ module HandBrake
       end
     end
 
+    def trace(msg)
+      $stderr.puts msg if trace?
+    end
+
     ##
     # Copies this CLI instance and appends another command line switch
     # plus optional arguments.

data/lib/handbrake/version.rb

@@ -1,5 +1,5 @@
 module HandBrake
   ##
   # The current version
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/spec/handbrake/cli_spec.rb

@@ -71,14 +71,167 @@ module HandBrake
         end
 
         it 'works' do
-          lambda { cli.update }.should_not raise_error
+          lambda { cli.preset_list }.should_not raise_error
         end
       end
 
       describe '#output' do
+        let(:filename) { File.join(tmpdir, 'foo.m4v') }
+
+        def it_should_have_run(expected_fn=filename)
+          runner.actual_arguments.should == ['--output', expected_fn]
+        end
+
+        def it_should_not_have_run
+          runner.actual_arguments.should be_nil
+        end
+
         it 'uses the --output argument' do
-          cli.output('/foo/bar.m4v')
-          runner.actual_arguments.should == %w(--output /foo/bar.m4v)
+          cli.output(filename)
+          runner.actual_arguments.should == ['--output', filename]
+        end
+
+        it 'fails for an unknown option' do
+          lambda { cli.output(filename, :quux => 'zap') }.
+            should raise_error('Unknown options for output: [:quux]')
+        end
+
+        describe ':overwrite' do
+          context 'true' do
+            it 'executes when the file does not exist' do
+              cli.output(filename, :overwrite => true)
+              it_should_have_run
+            end
+
+            it 'executes when the file exists' do
+              FileUtils.touch filename
+              cli.output(filename, :overwrite => true)
+              it_should_have_run
+            end
+
+            it 'is the default' do
+              FileUtils.touch filename
+              cli.output(filename)
+              it_should_have_run
+            end
+          end
+
+          context 'false' do
+            it 'executes when the file does not exist' do
+              cli.output(filename, :overwrite => false)
+              it_should_have_run
+            end
+
+            it 'throws an exception when the file does exist' do
+              FileUtils.touch filename
+              lambda { cli.output(filename, :overwrite => false) }.
+                should raise_error(HandBrake::FileExistsError)
+            end
+          end
+
+          context ':ignore' do
+            it 'executes when the file does not exist' do
+              cli.output(filename, :overwrite => :ignore)
+              it_should_have_run
+            end
+
+            it 'does nothing when the file does exist' do
+              FileUtils.touch filename
+              cli.output(filename, :overwrite => :ignore)
+              it_should_not_have_run
+            end
+          end
+
+          context 'other value' do
+            it 'throws an exception' do
+              lambda { cli.output(filename, :overwrite => 'flip') }.
+                should raise_error('Unsupported value for :overwrite: "flip"')
+            end
+          end
+        end
+
+        describe ':atomic' do
+          context 'false' do
+            it 'executes normally' do
+              cli.output(filename, :atomic => false)
+              it_should_have_run
+            end
+
+            it 'is the default' do
+              cli.output(filename)
+              it_should_have_run
+            end
+          end
+
+          context 'true' do
+            let(:expected_temporary_file) { File.join(tmpdir, "foo.handbraking.m4v") }
+
+            it 'outputs to the temporary file with ".handbraking" inserted before the extension' do
+              cli.output(filename, :atomic => true)
+              it_should_have_run(expected_temporary_file)
+            end
+
+            it 'appends .handbraking if the output file does not have an extension' do
+              cli.output(File.join(tmpdir('a.b.c'), 'foo'), :atomic => true)
+              it_should_have_run(File.join(tmpdir('a.b.c'), 'foo.handbraking'))
+            end
+
+            it 'copies the output to the desired filename' do
+              cli.output(filename, :atomic => true)
+              File.read(filename).should == 'This is the file created by --output'
+            end
+
+            it 'removes the temporary file' do
+              cli.output(filename, :atomic => true)
+              File.exist?(expected_temporary_file).should be_false
+            end
+
+            it 'overwrites the temporary file if it exists' do
+              FileUtils.touch expected_temporary_file
+              cli.output(filename, :atomic => true)
+              it_should_have_run(expected_temporary_file)
+            end
+
+            describe 'and :overwrite' do
+              describe 'false' do
+                it 'throws an exception if the target filename exists initially' do
+                  FileUtils.touch filename
+                  lambda { cli.output(filename, :atomic => true, :overwrite => false) }.
+                    should raise_error(HandBrake::FileExistsError)
+                end
+
+                it 'throws an exception if the target filename exists after output' do
+                  runner.behavior = lambda { FileUtils.touch filename }
+                  lambda { cli.output(filename, :atomic => true, :overwrite => false) }.
+                    should raise_error(HandBrake::FileExistsError)
+                end
+              end
+
+              describe ':ignore' do
+                it 'does nothing if the target filename exists initially' do
+                  FileUtils.touch filename
+                  cli.output(filename, :atomic => true, :overwrite => :ignore)
+                  it_should_not_have_run
+                end
+
+                it 'does not copy the output if the target filename exists after encoding' do
+                  runner.behavior = lambda {
+                    File.open(filename, 'w') { |f| f.write 'Other process result' }
+                  }
+                  cli.output(filename, :atomic => true, :overwrite => :ignore)
+                  File.read(filename).should == 'Other process result'
+                end
+
+                it 'does not remove the temporary output if the target filename exists after encoding' do
+                  runner.behavior = lambda {
+                    File.open(filename, 'w') { |f| f.write 'Other process result' }
+                  }
+                  cli.output(filename, :atomic => true, :overwrite => :ignore)
+                  File.exist?(expected_temporary_file).should be_true
+                end
+              end
+            end
+          end
         end
       end
 

data/spec/spec_helper.rb

@@ -2,38 +2,29 @@ require 'bundler'
 Bundler.setup
 
 require 'rspec'
+require 'fileutils'
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require 'handbrake'
 
 RSpec.configure do |config|
-  # Captures everything printed to stdout during the block
-  # and returns it as a string.
-  def capture_stdout
-    old_stdout, $stdout = $stdout, StringIO.new
-    begin
-      yield
-      $stdout.string
-    ensure
-      $stdout = old_stdout
-    end
-  end
-
   def tmpdir(sub=nil)
     @tmpdir ||= begin
                   dirname = File.expand_path("../tmp", __FILE__)
-                  mkdir_p dirname
+                  FileUtils.mkdir_p dirname
                   dirname
                 end
     if sub
       full = File.join(@tmpdir, sub)
-      mkdir_p full
+      FileUtils.mkdir_p full
       full
     else
       @tmpdir
     end
   end
+
+  config.after { FileUtils.rm_rf @tmpdir if @tmpdir }
 end
 
 module HandBrake
@@ -42,10 +33,22 @@ module HandBrake
     # A stub implementation of the runner for HandBrake::CLI.
     class StaticRunner
       attr_accessor :output, :status
+      ##
+      # A lambda that specifies desired side effects of execution or
+      # simulates things happening outside the execution but
+      # simultaneous with it.
+      attr_accessor :behavior
       attr_reader :actual_arguments
 
       def run(args)
         @actual_arguments = args
+        if i = args.index('--output')
+          fn = args[i + 1]
+          File.open(fn, 'w') { |f| f.write 'This is the file created by --output' }
+        end
+        if behavior
+          behavior.call
+        end
         HandBrake::CLI::RunnerResult.new(output, status)
       end
 

metadata

@@ -1,96 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: handbrake
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Rhett Sutphin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-15 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rubytree
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153799900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 8
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153799900
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153799400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 5
-        version: "2.5"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153799400
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153798940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2153798940
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153798480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 7
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
-  version_requirements: *id004
-description: A lightweight literate ruby wrapper for HandBrakeCLI, the command-line interface for the HandBrake video transcoder.
-email: 
+  prerelease: false
+  version_requirements: *2153798480
+description: A lightweight literate ruby wrapper for HandBrakeCLI, the command-line
+  interface for the HandBrake video transcoder.
+email:
 - rhett@detailedbalance.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - .travis.yml
@@ -112,41 +84,31 @@ files:
 - spec/handbrake/titles_spec.rb
 - spec/handbrake/version_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/rsutphin/handbrake.rb
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A ruby wrapper for HandBrakeCLI
-test_files: 
+test_files:
 - spec/handbrake/cli_spec.rb
 - spec/handbrake/sample-preset-list.out
 - spec/handbrake/sample-titles-scan.err