multi_exiftool 0.0.1 → 0.1.0

data/lib/multi_exiftool/values.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+require 'date'
+module MultiExiftool
+
+  # Representing (tag, value) pairs of metadata.
+  # Access via bracket-methods or dynamic method-interpreting via
+  # method_missing.
+  class Values
+
+    def initialize values
+      @values = {}
+      values.map do |tag,val|
+        val = val.kind_of?(Hash) ? Values.new(val) : val
+        @values[Values.unify_tag(tag)] = val
+      end
+    end
+
+    def [](tag)
+      parse_value(@values[Values.unify_tag(tag)])
+    end
+
+    def self.unify_tag tag
+      tag.gsub(/[-_]/, '').downcase
+    end
+
+    private
+
+    def method_missing tag, *args, &block
+      res = self[Values.unify_tag(tag.to_s)]
+      if res && block_given?
+        if block.arity > 0
+          yield res
+        else
+          res.instance_eval &block
+        end
+      end
+      res
+    end
+
+    def parse_value val
+      return val unless val.kind_of?(String)
+      case val
+      when /^(\d{4}):(\d\d):(\d\d) (\d\d):(\d\d):(\d\d)([-+]\d\d:\d\d)?$/
+        arr = $~.captures[0,6].map {|cap| cap.to_i}
+        arr << $7 if $7
+        if arr.size == 7
+          DateTime.new(*arr).to_time
+        else
+          Time.local(*arr)
+        end
+      when %r(^(\d+)/(\d+)$)
+        Rational($1, $2)
+      else
+        val
+      end
+    end
+
+  end
+
+end

data/lib/multi_exiftool/writer.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+require_relative 'executable'
+
+module MultiExiftool
+
+  # Handle writing of metadata via exiftool.
+  # Composing the command for the command-line executing it and parsing
+  # possible errors.
+  class Writer
+
+    attr_accessor :overwrite_original
+    attr_writer :values
+
+    include Executable
+
+    def values
+      Array(@values)
+    end
+
+    # Options to use with the exiftool command.
+    def options
+      opts = super
+      opts[:overwrite_original] = true if @overwrite_original
+      opts
+    end
+
+    # Getting the command for the command-line which would be executed
+    # when calling #write. It could be useful for logging, debugging or
+    # maybe even for creating a batch-file with exiftool command to be
+    # processed.
+    def command
+      cmd = [exiftool_command]
+      cmd << options_args
+      cmd << values_args
+      cmd << escaped_filenames
+      cmd.flatten.join(' ')
+    end
+
+    alias write execute # :nodoc:
+
+    private
+
+    def values_args
+      raise MultiExiftool::Error.new('No values.') if values.empty?
+      @values.map {|tag, val| "-#{tag}=#{escape(val.to_s)}"}
+    end
+
+    def parse_results
+      @errors = @stderr.readlines
+      @errors.empty?
+    end
+
+  end
+
+end

data/multi_exiftool.gemspec

@@ -2,34 +2,43 @@
 
 Gem::Specification.new do |s|
   s.name = %q{multi_exiftool}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Friedrich"]
-  s.date = %q{2008-11-25}
-  s.description = %q{}
-  s.email = %q{janfri.rubyforge@gmail.com}
-  s.extra_rdoc_files = ["lib/multi_exiftool.rb", "lib/multi_exiftool/parser.rb", "lib/multi_exiftool/command_generator.rb", "lib/multi_exiftool/read_object.rb", "README", "CHANGELOG", "COPYING"]
-  s.files = ["Rakefile", "Manifest", "test/test_command_generator.rb", "test/test_helper.rb", "test/test_parser.rb", "test/test_read_object.rb", "lib/multi_exiftool.rb", "lib/multi_exiftool/parser.rb", "lib/multi_exiftool/command_generator.rb", "lib/multi_exiftool/read_object.rb", "README", "data/fixtures/read_non_existing_file.stderr", "data/fixtures/read_non_existing_file.stdout", "data/fixtures/read_two_files.stderr", "data/fixtures/read_one_file.stderr", "data/fixtures/read_one_file.stdout", "data/fixtures/read_two_files.stdout", "data/regression/read_command.rb", "data/regression/read_command.rb.out", "data/regression/write_command.rb", "data/regression/write_command.rb.out", "script/generate_fixture.rb", "script/colorize.rb", "CHANGELOG", "COPYING", "multi_exiftool.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://multiexiftool.rubyforge.org}
+  s.date = %q{2010-01-27}
+  s.description = %q{This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results.}
+  s.email = %q{janfri26@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/multi_exiftool.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "examples/01_simple_reading.rb", "examples/02_simple_writing.rb", "examples/03_reading_using_groups.rb", "lib/multi_exiftool.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb", "test/helper.rb", "test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb", "multi_exiftool.gemspec"]
+  s.homepage = %q{http://rubyforge.org/projects/multiexiftool}
+  s.post_install_message = %q{
++-----------------------------------------------------------------------+
+| Please ensure you have installed exiftool version 7.65 or higher and  |
+| it's found in your PATH (Try "exiftool -ver" on your commandline).    |
+| For more details see                                                  |
+| http://www.sno.phy.queensu.ca/~phil/exiftool/install.html             |
++-----------------------------------------------------------------------+
+  }
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Multi_exiftool", "--main", "README"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{multiexiftool}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{}
-  s.test_files = ["test/test_read_object.rb", "test/test_helper.rb", "test/test_command_generator.rb", "test/test_parser.rb"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
+  s.requirements = ["exiftool, version 7.65 or higher"]
+  s.rubyforge_project = %q{multi_exiftool}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).}
+  s.test_files = ["test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<yact>, [">= 0"])
+      s.add_development_dependency(%q<contest>, [">= 0"])
     else
-      s.add_dependency(%q<yact>, [">= 0"])
+      s.add_dependency(%q<contest>, [">= 0"])
     end
   else
-    s.add_dependency(%q<yact>, [">= 0"])
+    s.add_dependency(%q<contest>, [">= 0"])
   end
 end

data/test/helper.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+require_relative '../lib/multi_exiftool'
+require 'test/unit'
+require 'contest'
+require 'open3'
+require 'stringio'
+
+module TestHelper
+
+  def mocking_open3(command, outstr, errstr)
+    open3_eigenclass = class << Open3; self; end
+    open3_eigenclass.module_exec(command, outstr, errstr) do |cmd, out, err|
+      define_method :popen3 do |arg|
+        if arg == cmd
+          return [nil, StringIO.new(out), StringIO.new(err)]
+        else
+          raise ArgumentError.new("Expected call of Open3.popen3 with argument #{cmd.inspect} but was #{arg.inspect}.")
+        end
+      end
+    end
+  end
+
+end
+
+class Test::Unit::TestCase
+  include TestHelper
+end

data/test/test_reader.rb

@@ -0,0 +1,135 @@
+# coding: utf-8
+require_relative 'helper'
+
+class TestReader < Test::Unit::TestCase
+
+  setup do
+    @reader = MultiExiftool::Reader.new
+  end
+
+  context 'command method' do
+
+    test 'simple case' do
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      command = 'exiftool -J a.jpg b.tif c.bmp'
+      assert_equal command, @reader.command
+    end
+
+    test 'no filenames' do
+      assert_raises MultiExiftool::Error do
+        @reader.command
+      end
+      @reader.filenames = []
+      assert_raises MultiExiftool::Error do
+        @reader.command
+      end
+    end
+
+    test 'filenames with spaces' do
+      @reader.filenames = ['one file with spaces.jpg', 'another file with spaces.tif']
+      command = 'exiftool -J one\ file\ with\ spaces.jpg another\ file\ with\ spaces.tif'
+      assert_equal command, @reader.command
+    end
+
+    test 'tags' do
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.tags = %w(author fnumber)
+      command = 'exiftool -J -author -fnumber a.jpg b.tif c.bmp'
+      assert_equal command, @reader.command
+    end
+
+    test 'options with boolean argument' do
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.options = {:e => true}
+      command = 'exiftool -J -e a.jpg b.tif c.bmp'
+      assert_equal command, @reader.command
+    end
+
+    test 'options with value argument' do
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.options = {:lang => 'de'}
+      command = 'exiftool -J -lang de a.jpg b.tif c.bmp'
+      assert_equal command, @reader.command
+    end
+
+    test 'numerical flag' do
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.numerical = true
+      command = 'exiftool -J -n a.jpg b.tif c.bmp'
+      assert_equal command, @reader.command
+    end
+
+    test 'group flag' do
+      @reader.filenames = %w(a.jpg)
+      @reader.group = 0
+      command = 'exiftool -J -g0 a.jpg'
+      assert_equal command, @reader.command
+      @reader.group = 1
+      command = 'exiftool -J -g1 a.jpg'
+      assert_equal command, @reader.command
+    end
+
+  end
+
+  context 'read method' do
+
+    test 'try to read a non-existing file' do
+      mocking_open3('exiftool -J non_existing_file', '', 'File non_existing_file not found.')
+      @reader.filenames = %w(non_existing_file)
+      res = @reader.read
+      assert_equal [], res
+      assert_equal ['File non_existing_file not found.'], @reader.errors
+    end
+
+    test 'successful reading with one tag' do
+      json = <<-EOS
+        [{
+          "SourceFile": "a.jpg",
+          "FNumber": 11.0
+        },
+        {
+          "SourceFile": "b.tif",
+          "FNumber": 9.0
+        },
+        {
+          "SourceFile": "c.bmp",
+          "FNumber": 8.0
+        }]
+      EOS
+      json.gsub!(/^ {8}/, '')
+      mocking_open3('exiftool -J -fnumber a.jpg b.tif c.bmp', json, '')
+      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.tags = %w(fnumber)
+      res =  @reader.read
+      assert_kind_of Array, res
+      assert_equal [11.0, 9.0, 8.0], res.map {|e| e['FNumber']}
+      assert_equal [], @reader.errors
+    end
+
+    test 'successful reading of hierarichal data' do
+      json = <<-EOS
+        [{
+          "SourceFile": "a.jpg",
+          "EXIF": {
+            "FNumber": 7.1
+          },
+          "MakerNotes": {
+            "FNumber": 7.0
+          }
+        }]
+      EOS
+      json.gsub!(/^ {8}/, '')
+      mocking_open3('exiftool -J -g0 -fnumber a.jpg', json, '')
+      @reader.filenames = %w(a.jpg)
+      @reader.tags = %w(fnumber)
+      @reader.group = 0
+      res =  @reader.read.first
+      assert_equal 'a.jpg', res.source_file
+      assert_equal 7.1, res.exif.fnumber
+      assert_equal 7.0, res.maker_notes.fnumber
+      assert_equal [], @reader.errors
+    end
+
+  end
+
+end

data/test/test_values.rb

@@ -0,0 +1,75 @@
+# coding: utf-8
+require_relative 'helper'
+require 'date'
+
+class TestValues < Test::Unit::TestCase
+
+  context 'value access' do
+
+    setup do
+      hash = {'FNumber' => 8, 'Author' => 'janfri'}
+      @values = MultiExiftool::Values.new(hash)
+    end
+
+    test 'original spelling of tag name' do
+      assert_equal 8, @values['FNumber']
+    end
+
+    test 'variant spellings of tag names' do
+      assert_equal 8, @values['fnumber']
+      assert_equal 8, @values['f_number']
+      assert_equal 8, @values['f-number']
+    end
+
+    test 'tag access via methods' do
+      assert_equal 8, @values.fnumber
+      assert_equal 8, @values.f_number
+    end
+
+  end
+
+  context 'parsing of values' do
+
+    context 'timestamps' do
+
+      setup do
+        hash = {
+          'TimestampWithoutZone' => '2009:08:25 12:35:42',
+          'TimestampWithPositiveZone' => '2009:08:26 20:22:24+05:00',
+          'TimestampWithNegativeZone' => '2009:08:26 20:22:24-07:00'
+        }
+        @values = MultiExiftool::Values.new(hash)
+      end
+
+      test 'local Time object' do
+        time = Time.local(2009, 8, 25, 12, 35, 42)
+        assert_equal time, @values['TimestampWithoutZone']
+      end
+
+      test 'Time object with given zone' do
+        time = DateTime.new(2009,8,26,20,22,24,'+0500').to_time
+        assert_equal time, @values['TimestampWithPositiveZone']
+        time = DateTime.new(2009,8,26,20,22,24,'-0700').to_time
+        assert_equal time, @values['TimestampWithNegativeZone']
+      end
+
+    end
+
+    context 'other values' do
+
+      setup do
+        hash = {
+          'ShutterSpeed' => '1/200'
+        }
+        @values = MultiExiftool::Values.new(hash)
+      end
+
+      test 'rational values' do
+        assert_equal Rational(1, 200), @values['ShutterSpeed']
+      end
+
+    end
+
+  end
+
+end

data/test/test_values_using_groups.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+require_relative 'helper'
+
+class TestValuesUsingGroups < Test::Unit::TestCase
+
+  setup do
+    hash = {'EXIF' => {'FNumber' => 8, 'Author' => 'janfri'}}
+    @values = MultiExiftool::Values.new(hash)
+  end
+
+  test 'bracket access' do
+    assert_equal 8, @values['EXIF']['FNumber']
+    assert_equal 'janfri', @values['EXIF']['Author']
+  end
+
+  test 'method access' do
+    assert_equal 8, @values.exif.fnumber
+    assert_equal 'janfri', @values.exif.author
+  end
+
+  test 'mixed access' do
+    assert_equal 8, @values.exif['FNumber']
+    assert_equal 'janfri', @values.exif['Author']
+    assert_equal 8, @values['EXIF'].fnumber
+    assert_equal 'janfri', @values['EXIF'].author
+  end
+
+  test 'block access without block parameter' do
+    $ok = false
+    $block_self = nil
+    res = @values.exif do
+      $ok = true
+      $block_self = self
+    end
+    assert $ok, "Block for exif wasn't executed."
+    assert_equal @values.exif, $block_self
+    assert_equal @values.exif, res
+    @values.iptc do
+      assert false, "This block should not be executed because IPTC isn't aviable."
+    end
+  end
+
+  test 'block access with block parameter' do
+    $ok = false
+    $self = self
+    $block_param = nil
+    res = @values.exif do |e|
+      $ok = true
+      $self = self
+      $block_param = e
+    end
+    assert $ok, "Block for exif wasn't executed."
+    assert_equal @values.exif, $block_param
+    assert_equal self, $self
+    assert_equal @values.exif, res
+    @values.iptc do
+      assert false, "This block should not be executed because IPTC isn't aviable."
+    end
+  end
+
+end