greatseth-mediainfo 0.1 → 0.3

data/Changelog

@@ -1 +1,14 @@
+v0.3 Mediainfo Is High Class
+- Class instead of instance-level customization of mediainfo binary path. 
+  Set Mediainfo.path = /path/to/binary if mediainfo is not in your shell 
+  path.
+- Instances retain the :last_command run. The API to rerun that command is 
+  still private.
+- Started defining custom Mediainfo exception classes and are now raising 
+  Mediainfo::ExecutionError instead of RuntimeError if the system command 
+  exits with anything other than 0.
+
+v0.2 Escape from the Shell
+- Added proper escaping for funky filenames. Thanks to Peter Vandenberk!
+
 v0.1 Initial Release

data/Manifest

@@ -1,7 +1,9 @@
 Changelog
 lib/mediainfo/attr_readers.rb
+lib/mediainfo/string.rb
 lib/mediainfo.rb
 LICENSE
 Manifest
+mediainfo.gemspec
 Rakefile
 README.markdown

data/README.markdown

@@ -1,10 +1,6 @@
 # Mediainfo
 
-Mediainfo is a class encapsulating the ability to run `mediainfo` 
-on a file and expose the information it produces in a straightforward 
-manner.
-
-The mediainfo CLI can be obtained at http://mediainfo.sourceforge.net.
+Mediainfo is a class wrapping [the mediainfo CLI](http://mediainfo.sourceforge.net).
 
 ## Usage
   
@@ -22,6 +18,14 @@ For a list of all possible attributes supported:
 In addition to the stock arguments provided by parsing `mediainfo` output, 
 some convenience methods and added behavior is added.
 
+Mediainfo is inspired by RVideo::Inspector, part of the rvideo gem. 
+The rvideo inspector is based on output from ffmpeg which is not 
+intended to be machine parseable. I spent a little while chasing 
+the ffmpeg development team, and decided finally that perhaps other 
+tools were better. As such, some of the API for Mediainfo is straight 
+from RVideo::Inspector. Some is not. Just saying.
+
 ## Contributors
 
-* Seth Thomas Rasmussen - http://greatseth.com
+* Seth Thomas Rasmussen - [http://greatseth.com](http://greatseth.com)
+* Peter Vandenberk - [http://github.com/pvdb](http://github.com/pvdb)

data/Rakefile

@@ -1,4 +1,5 @@
 require "rake/testtask"
+load "Rakefile.cloud" if File.exist? "Rakefile.cloud"
 
 Rake::TestTask.new do |t|
   t.libs << "test"

data/lib/mediainfo/string.rb

@@ -0,0 +1,9 @@
+class String
+  def shell_escape
+    # The gsub is for ANSI-C style quoting.
+    # 
+    # The $'' is for bash, see http://www.faqs.org/docs/bashman/bashref_12.html,
+    # but appears to be working for other shells: sh, zsh, ksh, dash
+    "$'#{gsub(/\\|'/) { |c| "\\#{c}" }}'"
+  end
+end

data/lib/mediainfo.rb

@@ -1,3 +1,4 @@
+require "mediainfo/string"
 require "mediainfo/attr_readers"
 
 # Mediainfo is a class encapsulating the ability to run `mediainfo` 
@@ -117,6 +118,19 @@ class Mediainfo
   mediainfo_duration_reader :audio_duration
   
   mediainfo_attr_reader :audio_sampling_rate
+  def audio_sample_rate
+    return unless rate = audio_sampling_rate_before_type_cast
+    number = rate.gsub(/[^\d.]+/, "").to_f
+    number = case rate
+    when /KHz/ then number * 1000
+    when /Hz/  then number
+    else
+      raise "unhandled sample rate! please report bug!"
+    end
+    number.to_i
+  end
+  alias_method :audio_sampling_rate, :audio_sample_rate
+  
   mediainfo_attr_reader :audio_stream_size
   mediainfo_attr_reader :audio_bit_rate
   mediainfo_attr_reader :audio_bit_rate_mode
@@ -154,38 +168,57 @@ class Mediainfo
   ###
   
   attr_reader :raw_response, :parsed_response,
-    :full_filename, :filename, :path
+    :full_filename, :filename, :path, :escaped_full_filename
   
   def initialize(full_filename)
-    @mediainfo_binary = "mediainfo"
-    
-    @full_filename = full_filename
+    @full_filename = File.expand_path full_filename
     @path          = File.dirname  @full_filename
     @filename      = File.basename @full_filename
     
     raise ArgumentError, "need a path to a video file, got nil" unless @full_filename
     raise ArgumentError, "need a path to a video file, #{@full_filename} does not exist" unless File.exist? @full_filename
     
+    @escaped_full_filename = @full_filename.shell_escape
     @raw_response = mediainfo!
     parse!
   end
   
-  attr_accessor :mediainfo_binary
+  class << self; attr_accessor :path; end
+  def path; self.class.path; end
+  
+  def self.default_mediainfo_path!; self.path = "mediainfo"; end
+  default_mediainfo_path! unless path
   
   def mediainfo_version
-    `#{@mediainfo_binary} --Version`[/v([\d.]+)/, 1]
+    `#{path} --Version`[/v([\d.]+)/, 1]
   end
   
+  attr_reader :last_command
+  
+  class Error < StandardError; end
+  class ExecutionError < Error; end
+  
 private
   def mediainfo!
-    `#{@mediainfo_binary} #{@full_filename}`
+    # for bash, see: http://www.faqs.org/docs/bashman/bashref_12.html
+    # but appears to be working for other shells: sh, zsh, ksh, dash
+    @last_command = "#{path} #{@escaped_full_filename}"
+    run_last_command!
+  end
+  
+  def run_last_command!
+    raw_response = `#{@last_command}`
+    unless $? == 0
+      raise ExecutionError, "Execution of `#{@last_command}` failed: #{raw_response.inspect}"
+    end
+    raw_response
   end
   
   def parse!
     @parsed_response = {}
     subsection = nil
     
-    @raw_response.split("\n").map { |x| x.strip }.each do |line|
+    @raw_response.to_s.split("\n").map { |x| x.strip }.each do |line|
       next if line.empty? || line == "General"
       
       if SECTIONS.include? line

data/mediainfo.gemspec

@@ -2,33 +2,30 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediainfo}
-  s.version = "0.1"
+  s.version = "0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seth Thomas Rasmussen"]
-  s.date = %q{2009-05-10}
+  s.date = %q{2009-07-20}
   s.description = %q{}
   s.email = %q{sethrasmussen@gmail.com}
-  s.extra_rdoc_files = ["lib/mediainfo/attr_readers.rb", "lib/mediainfo.rb", "LICENSE", "README.markdown"]
-  s.files = ["Changelog", "lib/mediainfo/attr_readers.rb", "lib/mediainfo.rb", "LICENSE", "Manifest", "Rakefile", "README.markdown", "mediainfo.gemspec", "test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
+  s.extra_rdoc_files = ["lib/mediainfo/attr_readers.rb", "lib/mediainfo/string.rb", "lib/mediainfo.rb", "LICENSE", "README.markdown"]
+  s.files = ["Changelog", "lib/mediainfo/attr_readers.rb", "lib/mediainfo/string.rb", "lib/mediainfo.rb", "LICENSE", "Manifest", "mediainfo.gemspec", "Rakefile", "README.markdown", "test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_string_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
   s.homepage = %q{http://greatseth.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Mediainfo", "--main", "README.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{mediainfo}
-  s.rubygems_version = %q{1.3.3}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{}
-  s.test_files = ["test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
+  s.test_files = ["test/mediainfo_awaywego_encoded_test.rb", "test/mediainfo_awaywego_test.rb", "test/mediainfo_dinner_test.rb", "test/mediainfo_hats_test.rb", "test/mediainfo_string_test.rb", "test/mediainfo_test.rb", "test/mediainfo_vimeo_test.rb", "test/mediainfo_vimeoimage_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<echoe>, [">= 0"])
     else
-      s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
-    s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

data/test/mediainfo_awaywego_encoded_test.rb

@@ -238,7 +238,9 @@ class MediainfoAwaywegoEncodedTest < ActiveSupport::TestCase
   end
 
   test "audio   Sampling rate" do
-    assert_equal "48.0 KHz", @info.audio_sampling_rate
+    assert_equal 48000, @info.audio_sample_rate
+    assert_equal 48000, @info.audio_sampling_rate
+    assert_equal "48.0 KHz", @info.audio_sampling_rate_before_type_cast
   end
 
   test "audio   Resolution" do

data/test/mediainfo_awaywego_test.rb

@@ -241,7 +241,9 @@ class MediainfoAwaywegoTest < ActiveSupport::TestCase
   end
 
   test "audio   Sampling rate" do
-    assert_equal "48.0 KHz", @info.audio_sampling_rate
+    assert_equal 48000, @info.audio_sample_rate
+    assert_equal 48000, @info.audio_sampling_rate
+    assert_equal "48.0 KHz", @info.audio_sampling_rate_before_type_cast
   end
 
   test "audio resolution" do

data/test/mediainfo_dinner_test.rb

@@ -225,7 +225,9 @@ class MediainfoDinnerTest < ActiveSupport::TestCase
   end
 
   test "audio   Sampling rate" do
-    assert_equal "8 000 Hz", @info.audio_sampling_rate
+    assert_equal 8000, @info.audio_sample_rate
+    assert_equal 8000, @info.audio_sampling_rate
+    assert_equal "8 000 Hz", @info.audio_sampling_rate_before_type_cast
   end
 
   test "audio resolution" do

data/test/mediainfo_hats_test.rb

@@ -225,7 +225,9 @@ class MediainfoHatsTest < ActiveSupport::TestCase
   end
 
   test "audio   Sampling rate" do
-    assert_equal "16.0 KHz", @info.audio_sampling_rate
+    assert_equal 16000, @info.audio_sample_rate
+    assert_equal 16000, @info.audio_sampling_rate
+    assert_equal "16.0 KHz", @info.audio_sampling_rate_before_type_cast
   end
 
   test "audio resolution" do

data/test/mediainfo_string_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+require "mediainfo_test_helper"
+
+class MediainfoStringTest < ActiveSupport::TestCase
+  test "escaping slashes" do
+    assert_equal '$\'foo\\\bar\'', 'foo\bar'.shell_escape
+  end
+  
+  test "escaping quotes" do
+    assert_equal '$\'foo\\\'bar\'', "foo'bar".shell_escape
+  end
+end

data/test/mediainfo_test.rb

@@ -75,10 +75,31 @@ class MediainfoTest < ActiveSupport::TestCase
     :image_height
   ]
   
-  supported_attributes.each do |attribute|
+  Mediainfo.supported_attributes.each do |attribute|
     test "supports #{attribute} attribute" do
-      assert Mediainfo.supported_attributes.include?(attribute),
+      assert supported_attributes.include?(attribute),
         "#{attribute} is not supported"
     end
   end
+  
+  def setup
+    Mediainfo.default_mediainfo_path!
+  end
+  
+  test "retains last system command generated" do
+    m = Mediainfo.new "/dev/null"
+    assert_equal "mediainfo $'/dev/null'", m.last_command
+  end
+  
+  test "allows customization of path to mediainfo binary" do
+    Mediainfo.any_instance.stubs(:run_last_command!)
+    
+    assert_equal "mediainfo", Mediainfo.path
+    
+    Mediainfo.path = "/opt/local/bin/mediainfo"
+    assert_equal "/opt/local/bin/mediainfo", Mediainfo.path
+    
+    m = Mediainfo.new "/dev/null"
+    assert_equal "/opt/local/bin/mediainfo $'/dev/null'", m.last_command
+  end
 end

data/test/mediainfo_vimeo_test.rb

@@ -225,7 +225,9 @@ class MediainfoVimeoTest < ActiveSupport::TestCase
   end
 
   test "audio   Sampling rate" do
-    assert_equal "11.025 KHz", @info.audio_sampling_rate
+    assert_equal 11025, @info.audio_sample_rate
+    assert_equal 11025, @info.audio_sampling_rate
+    assert_equal "11.025 KHz", @info.audio_sampling_rate_before_type_cast
   end
 
   test "audio resolution" do

data/test/test_helper.rb

@@ -12,6 +12,7 @@ end
 
 require "rubygems"
 require "mocha"
+begin; require "redgreen"; rescue LoadError; end
 
 $: << File.dirname(__FILE__) + "/../lib"
 require "mediainfo"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: greatseth-mediainfo
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.3"
 platform: ruby
 authors: 
 - Seth Thomas Rasmussen
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-10 00:00:00 -07:00
+date: 2009-07-20 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: ""
 email: sethrasmussen@gmail.com
 executables: []
@@ -30,22 +21,25 @@ extensions: []
 
 extra_rdoc_files: 
 - lib/mediainfo/attr_readers.rb
+- lib/mediainfo/string.rb
 - lib/mediainfo.rb
 - LICENSE
 - README.markdown
 files: 
 - Changelog
 - lib/mediainfo/attr_readers.rb
+- lib/mediainfo/string.rb
 - lib/mediainfo.rb
 - LICENSE
 - Manifest
+- mediainfo.gemspec
 - Rakefile
 - README.markdown
-- mediainfo.gemspec
 - test/mediainfo_awaywego_encoded_test.rb
 - test/mediainfo_awaywego_test.rb
 - test/mediainfo_dinner_test.rb
 - test/mediainfo_hats_test.rb
+- test/mediainfo_string_test.rb
 - test/mediainfo_test.rb
 - test/mediainfo_vimeo_test.rb
 - test/mediainfo_vimeoimage_test.rb
@@ -86,6 +80,7 @@ test_files:
 - test/mediainfo_awaywego_test.rb
 - test/mediainfo_dinner_test.rb
 - test/mediainfo_hats_test.rb
+- test/mediainfo_string_test.rb
 - test/mediainfo_test.rb
 - test/mediainfo_vimeo_test.rb
 - test/mediainfo_vimeoimage_test.rb