multi_exiftool 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ca8548908a3e26fbdea1a74a49af9dc597361a8
-  data.tar.gz: f0bfc40076a49f6c5bc71cc8b416cb9321fb2afb
+  metadata.gz: ab58cfbd7358a3bf89c39cfecaddbb22f80b50b8
+  data.tar.gz: 224cfd83f86b6dff424400d0d69ab5cc93428553
 SHA512:
-  metadata.gz: 7a6ce9840e83312e0922373b2f485524b25ddbb9933e1a16f75d84f7e437cbc9637de32f17bae8174eea428d421592c62f626e4b67e321a9f9cf14a2fbc42879
-  data.tar.gz: 2f6ff90bcea1fc6852d0650a24258c70d9c710f9e6bc8d5ecccac5f338e40e1080b7afc0a605a2dd3639bc91456e3b7eea442530abfc6534fd47e46a5484a1d9
+  metadata.gz: e3212194490e8eea822f5d064ede3b51f5a755b60f7fb7018288c05b7507663a19c1d2162c8cd2225407226991eacca712031e746b3861bef0af6b1e5c8fd44f
+  data.tar.gz: 9da30d30b957eb0e8e16c91e26529ab54ec87a9f93c619fda500c2a796e25d5c4fb224b782a4b2c53b472a31c25e60627b505cc54d5d910fa07eaa279a2acec1

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.4.0
+New method Values#tags to get access to unmodified tag names.
+Directly sending parameters to stdin of exiftool to make it
+work on windows with umlauts in filenames (Many thanks to
+Claudius Coenen for the research, implementing and testing the
+idea!).
+Complete rewrite of the test suite to use real tests.
+Allow to set tags as single value.
+A lot of internal refactoring.
+
 0.3.0
 New functional api.
 Update documentation.
@@ -9,7 +19,7 @@ Support writing to specific group with hash hierarchy.
 Support array-like values for tags like keywords.
 
 0.1.3
-Improve README and adapt project url.
+Improve README and adapt project URL.
 
 0.1.2
 Preserve time zone in time objects (don't convert to local zone).

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009-2014 Jan Friedrich
+Copyright (c) 2009-2015 Jan Friedrich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -67,6 +67,9 @@ See the examples in the examples directory.
 - An installation of the Exiftool command-line application (version 7.65 or
   higher). Instructions for installation you can find under
   http://www.sno.phy.queensu.ca/~phil/exiftool/install.html .
+- If you have problems with special characters (like German umlauts) in
+filenames on windows system it is recommended to use exiftool version 9.79
+or higher.
 
 == Installation
 
@@ -76,21 +79,21 @@ install the gem with
 
 == Contribution
 
-The code is also hostet in a git repository on Gitorious at
-http://gitorious.org/multi_exiftool
+The code is also hosted in a git repository at
+http://github.com/janfri/multi_exiftool
 or
-http://github.com/janfri/multi_exiftool-redesign
+https://bitbucket.org/janfri/multi_exiftool
 feel free to contribute!
 
 == Author
 
-Jan Friedrich (janfri26 AT gmail DOT com)
+Jan Friedrich <janfri26gmail.com>
 
 == Copyright / License
 
   The MIT License
 
-  Copyright (c) 2009-2014 Jan Friedrich
+  Copyright (c) 2009-2015 Jan Friedrich
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,16 +1,17 @@
-require 'rim'
-require 'rim/check_version'
-require 'rim/gem'
-require 'rim/test'
+require 'rim/tire'
+require 'rim/aspell'
+require 'rim/version'
+require 'regtest/task'
 
 Rim.setup do |p|
   p.name = 'multi_exiftool'
-  p.version = '0.3.0'
+  p.version = '0.4.0'
   p.authors = 'Jan Friedrich'
   p.email = 'janfri26@gmail.com'
-  p.summary = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
-  p.description = '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.'
+  p.summary = 'This library is a wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
+  p.description = 'This library a 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.'
   p.ruby_version = '>=1.9.1'
+  p.license = 'MIT'
   p.homepage = 'http://gitorious.org/multi_exiftool'
   p.install_message = %q{
 +-----------------------------------------------------------------------+
@@ -20,6 +21,6 @@ Rim.setup do |p|
 | http://www.sno.phy.queensu.ca/~phil/exiftool/install.html             |
 +-----------------------------------------------------------------------+
   }
-  p.development_dependencies << 'contest'
+  p.development_dependencies << 'contest' << 'regtest'
   p.requirements << 'exiftool, version 7.65 or higher'
 end

data/lib/multi_exiftool.rb

@@ -22,6 +22,9 @@ module MultiExiftool
     if val = opts.delete(:tags)
       reader.tags = val
     end
+    if val = opts.delete(:group)
+      reader.group = val
+    end
     reader.options = opts unless opts.empty?
     values = reader.read
     [values, reader.errors]
@@ -46,5 +49,25 @@ module MultiExiftool
 
   class Error < ::StandardError; end
 
+  @exiftool_command = 'exiftool'
+
+  class << self
+
+    attr_accessor :exiftool_command
+    attr_reader :exiftool_version
+
+    def exiftool_command= cmd
+      @exiftool_command = cmd
+      @exiftool_version = nil
+    end
+
+    # Exiftool version as float (since exiftool versions
+    # are numbered "float friendly")
+    def exiftool_version
+      @exiftool_version ||= `#{exiftool_command} -ver`.to_f
+    end
+
+  end
+
 end
 

data/lib/multi_exiftool/executable.rb

@@ -1,18 +1,15 @@
 # coding: utf-8
 require 'open3'
-require 'shellwords'
 
 module MultiExiftool
 
   # Mixin for Reader and Writer.
   module Executable
 
-    attr_reader :filenames
-    attr_accessor :exiftool_command, :errors, :numerical
-    attr_writer :options
+    attr_reader :errors
+    attr_accessor :filenames, :numerical, :options
 
     def initialize
-      @exiftool_command = 'exiftool'
       @options = {}
       @filenames = []
       @option_mapping = {numerical: :n}
@@ -36,13 +33,8 @@ module MultiExiftool
 
     private
 
-    def escape str
-      Shellwords.escape(str.to_s)
-    end
-
-    def escaped_filenames
-      raise MultiExiftool::Error.new('No filenames.') if filenames.empty?
-      filenames.map { |fn| Shellwords.escape(fn) }
+    def exiftool_command
+      MultiExiftool.exiftool_command
     end
 
     def options_args
@@ -53,7 +45,7 @@ module MultiExiftool
         if val == true
           "-#{arg}"
         else
-          "-#{arg} #{val}"
+          %W[-#{arg} #{val}]
         end
       end
     end
@@ -63,7 +55,12 @@ module MultiExiftool
     end
 
     def execute_command
-      stdin, @stdout, @stderr = Open3.popen3(command)
+      stdin, @stdout, @stderr = Open3.popen3(exiftool_command, '-@', '-')
+      exiftool_args.each do |part|
+        stdin << part
+        stdin << "\n"
+      end
+      stdin.close
     end
 
   end

data/lib/multi_exiftool/reader.rb

@@ -9,41 +9,52 @@ module MultiExiftool
   # the results as well as possible errors.
   class Reader
 
-    MANDATORY_ARGS = %w(-J)
-
     attr_accessor :tags, :group
 
     include Executable
 
     def initialize
       super
-      @option_mapping.merge! group: :g
+      @tags = []
+    end
+
+    def self.mandatory_args
+      if MultiExiftool.exiftool_version >= 9.79
+        %w(-J -charset FileName=utf8 -charset utf8)
+      else
+        %w(-J -charset utf8)
+      end
     end
 
     # Options to use with the exiftool command.
     def options
       opts = super
       if @group
-        opts[:g] = @group
+        opts["g#@group"] = true
       end
       opts
     end
 
-    # Getting the command for the command-line which would be executed
+    # Getting the command-line arguments which would be executed
     # when calling #read. 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 << MANDATORY_ARGS
+    def exiftool_args
+      fail MultiExiftool::Error, 'No filenames.' if filenames.empty?
+      cmd = []
+      cmd << Reader.mandatory_args
       cmd << options_args
       cmd << tags_args
-      cmd << escaped_filenames
-      cmd.flatten.join(' ')
+      cmd << filenames
+      cmd.flatten
     end
 
     alias read execute # :nodoc:
 
+    def tags= value
+      @tags = Array(value)
+    end
+
     private
 
     def tags_args

data/lib/multi_exiftool/values.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 require 'date'
+require 'set'
+
 module MultiExiftool
 
   # Representing (tag, value) pairs of metadata.
@@ -7,9 +9,13 @@ module MultiExiftool
   # method_missing.
   class Values
 
+    attr_reader :tags
+
     def initialize values
       @values = {}
+      @tags = Set.new
       values.map do |tag,val|
+        @tags << tag
         val = val.kind_of?(Hash) ? Values.new(val) : val
         @values[Values.unify_tag(tag)] = val
       end

data/lib/multi_exiftool/writer.rb

@@ -17,6 +17,14 @@ module MultiExiftool
       @values = {}
     end
 
+    def self.mandatory_args
+      if MultiExiftool.exiftool_version >= 9.79
+        %w(-charset FileName=utf8 -charset utf8)
+      else
+        %w(-charset utf8)
+      end
+    end
+
     # Options to use with the exiftool command.
     def options
       opts = super
@@ -24,16 +32,18 @@ module MultiExiftool
       opts
     end
 
-    # Getting the command for the command-line which would be executed
+    # Getting the command-line arguments 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]
+    def exiftool_args
+      fail MultiExiftool::Error, 'No filenames.' if filenames.empty?
+      cmd = []
+      cmd << Writer.mandatory_args
       cmd << options_args
       cmd << values_args
-      cmd << escaped_filenames
-      cmd.flatten.join(' ')
+      cmd << filenames
+      cmd.flatten
     end
 
     alias write execute # :nodoc:
@@ -51,9 +61,9 @@ module MultiExiftool
         if val.respond_to? :to_hash
           res << values_to_param_array(val.to_hash).map {|arg| "#{tag}:#{arg}"}
         elsif val.respond_to? :to_ary
-          res << val.map {|v| "#{tag}=#{escape(v)}"}
+          res << val.map {|v| "#{tag}=#{v}"}
         else
-          res << "#{tag}=#{escape(val)}"
+          res << "#{tag}=#{val}"
         end
       end
       res.flatten

data/test/helper.rb

@@ -1,42 +1,23 @@
 # coding: utf-8
 require_relative '../lib/multi_exiftool'
+require 'fileutils'
 require 'test/unit'
 require 'contest'
-require 'open3'
-require 'stringio'
-require 'yaml'
 
 module TestHelper
 
-  @@fixtures = YAML.load_file('test/fixtures.yml')
+  DATA_DIR = File.join(File.dirname(__FILE__), 'data')
+  TEMP_DIR = File.join(File.dirname(__FILE__), 'temp')
 
-  def use_fixture(name, &block)
-    @fixture = @@fixtures[name]
-    if @fixture.nil?
-      assert false, "Fixture #{name} not found!\n" << caller.first
-    end
-    mocking_open3(name, @fixture['stdout'], @fixture['stderr'], &block)
+  def prepare_temp_dir
+    FileUtils.rm_rf TEMP_DIR
+    FileUtils.cp_r DATA_DIR, TEMP_DIR
   end
 
-  def mocking_open3(command, outstr, errstr, &block)
-    executed = {exec: false}
-    open3_eigenclass = class << Open3; self; end
-    open3_eigenclass.module_exec(command, outstr, errstr, executed) do |cmd, out, err, exec|
-      define_method :popen3 do |arg|
-        exec[:exec] = true
-        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
-    begin
-      yield
-    rescue ArgumentError => e
-      assert false, e.message
+  def run_in_temp_dir &block
+    Dir.chdir TEMP_DIR do
+      block.call
     end
-    assert executed[:exec], "Open3.popen3 not executed!\n" << caller[0,2].inspect
   end
 
 end

data/test/test_exiftool_stuff.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+require_relative 'helper'
+
+class TestExiftoolStuff < Test::Unit::TestCase
+
+  test 'setting exiftool_command resets exiftool_version' do
+    MultiExiftool.exiftool_version # ensure @exiftool_version is set
+    assert_not_nil MultiExiftool.instance_variable_get('@exiftool_version')
+    MultiExiftool.exiftool_command = MultiExiftool.exiftool_command
+    assert_nil MultiExiftool.instance_variable_get('@exiftool_version')
+  end
+
+  test 'attribute exiftool_version is cached' do
+    MultiExiftool.instance_variable_set '@exiftool_version', nil
+    t_org = time do
+      v = MultiExiftool.exiftool_version
+      assert_not_nil v
+    end
+    t_now = time do
+      v = MultiExiftool.exiftool_version
+      assert_not_nil v
+    end
+    assert t_now * 100 < t_org
+  end
+
+  protected
+
+  def time
+    a = Time.now
+    yield
+    b = Time.now
+    b - a
+  end
+
+end

data/test/test_functional_api.rb

@@ -3,47 +3,62 @@ require_relative 'helper'
 
 class TestFunctionalApi < Test::Unit::TestCase
 
+  setup do
+    prepare_temp_dir
+  end
+
   context 'reading' do
 
+    setup do
+      @abc_authors = ['Jan Friedrich'] * 3
+      @abc_fnumbers = [5.6, 6.7, 8]
+      @abc_titles = 'Title A,Title B,Title C'.split(/,/)
+    end
+
     test 'successful reading only filenames' do
-      use_fixture 'exiftool -J a.jpg b.tif c.bmp' do
-        values, errors = MultiExiftool.read(%w(a.jpg b.tif c.bmp))
-        assert_kind_of Array, values
-        assert_equal [11.0, 9.0, 8.0], values.map {|e| e['FNumber']}
-        assert_equal [400, 200, 100], values.map {|e| e['ISO']}
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read(%w(a.jpg b.jpg c.jpg))
+        assert_equal @abc_authors, values.map {|e| e['Author']}
+        assert_equal @abc_fnumbers, values.map {|e| e['FNumber']}
+        assert_equal @abc_titles, values.map {|e| e['Title']}
         assert_equal [], errors
       end
     end
 
     test 'successful reading with one tag' do
-      use_fixture 'exiftool -J -fnumber a.jpg b.tif c.bmp' do
-        values, errors = MultiExiftool.read(%w(a.jpg b.tif c.bmp), tags: %w(fnumber))
-        assert_kind_of Array, values
-        assert_equal [11.0, 9.0, 8.0], values.map {|e| e['FNumber']}
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read(%w(a.jpg b.jpg c.jpg), tags: %w(title))
+        assert_equal @abc_titles, values.map {|e| e['Title']}
+        assert_equal [nil] * 3, values.map {|e| e['Author']}
         assert_equal [], errors
       end
     end
 
     test 'successful reading of hierarichal data' do
-      use_fixture 'exiftool -J -g 0 -fnumber a.jpg' do
-        values, errors = MultiExiftool.read(%w(a.jpg), tags: %w[fnumber], group: 0)
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read(%w(a.jpg), group: 0)
         res = values.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 5.6, res.exif.fnumber
         assert_equal [], errors
       end
     end
 
-    test 'generate correct command for numerical option' do
-      mocking_open3 'exiftool -J -n -orientation a.jpg', '', '' do
-        MultiExiftool.read(%w[a.jpg], tags: %w[orientation], numerical: true)
+    test 'successful reading with numerical option' do
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read(%w[a.jpg b.jpg c.jpg], tags: %w[orientation], numerical: true)
+        assert_equal [1, 2, 3], values.map {|e| e.orientation}
+        assert_equal [], errors
       end
     end
 
     test 'options with boolean argument' do
-      mocking_open3 'exiftool -J -e a.jpg b.tif c.bmp', '', '' do
-        MultiExiftool.read(%w[a.jpg b.tif c.bmp], e: true)
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read('a.jpg')
+        assert_equal 5.6, values.first.aperture
+        values, errors = MultiExiftool.read('a.jpg', e: true)
+        assert_equal nil, values.first.aperture
+        assert_equal [], errors
       end
     end
 
@@ -52,64 +67,71 @@ class TestFunctionalApi < Test::Unit::TestCase
   context 'writing' do
 
     setup do
-      @filenames = %w(a.jpg b.tif c.bmp)
+      @filenames = %w(a.jpg b.jpg c.jpg)
     end
 
     test 'simple case' do
-      mocking_open3 'exiftool -author=janfri a.jpg b.tif c.bmp', '', '' do
-        values = {:author => 'janfri'}
-        MultiExiftool.write @filenames, values
+      run_in_temp_dir do
+        values = {comment: 'foo'}
+        errors = MultiExiftool.write(@filenames, values)
+        assert errors.empty?
+        values, _errors = MultiExiftool.read(@filenames)
+        assert_equal %w(foo) * 3, values.map {|e| e.comment}
       end
     end
 
     test 'tags with spaces in values' do
-      mocking_open3 'exiftool -author=janfri -comment=some\ comment a.jpg b.tif c.bmp', '', '' do
-        values = {:author => 'janfri', :comment => 'some comment'}
-        MultiExiftool.write @filenames, values
+      run_in_temp_dir do
+        values = {author: 'Mister X'}
+        errors = MultiExiftool.write(@filenames, values)
+        assert errors.empty?
+        values, _errors = MultiExiftool.read(@filenames)
+        assert_equal ['Mister X'] * 3, values.map {|e| e.author}
       end
     end
 
     test 'tags with rational value' do
-      mocking_open3 'exiftool -shutterspeed=1/125 a.jpg b.tif c.bmp', '', '' do
-        values ={shutterspeed: Rational(1, 125)}
-        MultiExiftool.write @filenames, values
+      run_in_temp_dir do
+        values ={exposuretime: Rational(1, 125)}
+        errors = MultiExiftool.write(@filenames, values)
+        assert errors.empty?
+        values, _errors = MultiExiftool.read(@filenames)
+        assert_equal [Rational(1, 125)] * 3, values.map {|e| e.exposuretime}
       end
     end
 
     test 'tags with array-like values' do
-      mocking_open3 'exiftool -keywords=one -keywords=two -keywords=and\ three a.jpg b.tif c.bmp', '', '' do
-        values = {keywords: ['one', 'two', 'and three']}
-        MultiExiftool.write @filenames, values
+      run_in_temp_dir do
+        keywords = ['one', 'two', 'and three']
+        values = {keywords: keywords}
+        errors = MultiExiftool.write('a.jpg', values)
+        assert errors.empty?
+        values, _errors = MultiExiftool.read('a.jpg')
+        assert_equal keywords, values.first.keywords
       end
     end
 
     test 'options with boolean argument' do
-      mocking_open3 'exiftool -overwrite_original -author=janfri a.jpg b.tif c.bmp', '', '' do
-        values = {:author => 'janfri'}
-        options = {:overwrite_original => true}
-        MultiExiftool.write @filenames, values, options
+      run_in_temp_dir do
+        values = {comment: 'foo'}
+        options = {overwrite_original: true}
+        errors = MultiExiftool.write(@filenames, values, options)
+        assert errors.empty?
+        assert_equal [], Dir['*_original']
       end
     end
 
-    test 'options with value argument' do
-      mocking_open3 'exiftool -out output_file -author=janfri a.jpg b.tif c.bmp', '', '' do
-        values = {:author => 'janfri'}
-        options = {:out => 'output_file'}
-        MultiExiftool.write @filenames, values, options
-      end
+    test 'option with value argument' do
+      pend 'find a good example' if respond_to? :pend
     end
 
     test 'numerical flag' do
-      mocking_open3 'exiftool -n -author=janfri a.jpg b.tif c.bmp', '', '' do
-        values = {:author => 'janfri'}
-        MultiExiftool.write @filenames, values, numerical: true
-      end
-    end
-
-    test 'overwrite_original flag' do
-      mocking_open3 'exiftool -overwrite_original -author=janfri a.jpg b.tif c.bmp', '', '' do
-        values = {author: 'janfri'}
-        MultiExiftool.write @filenames, values, overwrite_original: true
+      run_in_temp_dir do
+        values = {orientation: 2}
+        errors = MultiExiftool.write(@filenames, values)
+        assert_equal ["Warning: Can't convert IFD0:Orientation (matches more than one PrintConv)", "Nothing to do."], errors
+        errors = MultiExiftool.write(@filenames, values, numerical: true)
+        assert errors.empty?
       end
     end
 

data/test/test_reader.rb

@@ -3,76 +3,91 @@ require_relative 'helper'
 
 class TestReader < Test::Unit::TestCase
 
+  MANDATORY_ARGS = MultiExiftool::Reader.mandatory_args
+
   setup do
     @reader = MultiExiftool::Reader.new
   end
 
-  context 'command method' do
+  context 'tags' do
+
+    test 'tags are initialized as array' do
+      assert_equal [], @reader.tags
+    end
+
+    test 'tags could be set as single value' do
+      @reader.tags = 'fnumber'
+      assert_equal ['fnumber'], @reader.tags
+    end
+
+  end
+
+  context 'exiftool_args 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
+      @reader.filenames = %w(a.jpg b.jpg c.jpg)
+      exiftool_args = MANDATORY_ARGS + %w(a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'no filenames' do
       assert_raises MultiExiftool::Error do
-        @reader.command
+        @reader.exiftool_args
       end
       @reader.filenames = []
       assert_raises MultiExiftool::Error do
-        @reader.command
+        @reader.exiftool_args
       end
     end
 
     test 'one filename as string' do
       @reader.filenames = 'a.jpg'
-      command = 'exiftool -J a.jpg'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(a.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     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
+      exiftool_args = MANDATORY_ARGS + ['one file with spaces.jpg', 'another file with spaces.tif']
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'tags' do
-      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.filenames = %w(a.jpg b.jpg c.jpg)
       @reader.tags = %w(author fnumber)
-      command = 'exiftool -J -author -fnumber a.jpg b.tif c.bmp'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-author -fnumber a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'options with boolean argument' do
-      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.filenames = %w(a.jpg b.jpg c.jpg)
       @reader.options = {:e => true}
-      command = 'exiftool -J -e a.jpg b.tif c.bmp'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-e a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'options with value argument' do
-      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.filenames = %w(a.jpg b.jpg c.jpg)
       @reader.options = {:lang => 'de'}
-      command = 'exiftool -J -lang de a.jpg b.tif c.bmp'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-lang de a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'numerical flag' do
-      @reader.filenames = %w(a.jpg b.tif c.bmp)
+      @reader.filenames = %w(a.jpg b.jpg c.jpg)
       @reader.numerical = true
-      command = 'exiftool -J -n a.jpg b.tif c.bmp'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-n a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
     test 'group flag' do
       @reader.filenames = %w(a.jpg)
       @reader.group = 0
-      command = 'exiftool -J -g 0 a.jpg'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-g0 a.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
       @reader.group = 1
-      command = 'exiftool -J -g 1 a.jpg'
-      assert_equal command, @reader.command
+      exiftool_args = MANDATORY_ARGS + %w(-g1 a.jpg)
+      assert_equal exiftool_args, @reader.exiftool_args
     end
 
   end
@@ -80,44 +95,54 @@ class TestReader < Test::Unit::TestCase
   context 'read method' do
 
     test 'try to read a non-existing file' do
-      use_fixture('exiftool -J non_existing_file') do
+      run_in_temp_dir do
         @reader.filenames = %w(non_existing_file)
         res = @reader.read
         assert_equal [], res
-        assert_equal ['File non_existing_file not found.'], @reader.errors
+        assert_equal ['File not found: non_existing_file'], @reader.errors
       end
     end
 
     test 'read from an existing and a non-existing file' do
-      use_fixture('exiftool -J -fnumber -foo a.jpg xxx') do
+      run_in_temp_dir do
         @reader.filenames = %w(a.jpg xxx)
         @reader.tags = %w(fnumber foo)
         res = @reader.read
-        assert_equal [9.5], res.map {|e| e['FNumber']}
+        assert_equal [5.6], res.map {|e| e['FNumber']}
         assert_equal ['File not found: xxx'], @reader.errors
       end
     end
 
     test 'successful reading with one tag' do
-      use_fixture('exiftool -J -fnumber a.jpg b.tif c.bmp') do
-        @reader.filenames = %w(a.jpg b.tif c.bmp)
+      run_in_temp_dir do
+        @reader.filenames = %w(a.jpg b.jpg c.jpg)
         @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 [5.6, 6.7, 8], res.map {|e| e['FNumber']}
+        assert_equal Set.new(%w(SourceFile FNumber)), res.first.tags
+        assert_equal [], @reader.errors
+      end
+    end
+
+    test 'successful reading with one tag as symbol' do
+      run_in_temp_dir do
+        @reader.filenames = %w(a.jpg b.jpg c.jpg)
+        @reader.tags = :fnumber
+        res =  @reader.read
+        assert_equal [5.6, 6.7, 8], res.map {|e| e.fnumber}
+        assert_equal Set.new(%w(SourceFile FNumber)), res.first.tags
         assert_equal [], @reader.errors
       end
     end
 
     test 'successful reading of hierarichal data' do
-      use_fixture('exiftool -J -g 0 -fnumber a.jpg') do
+      run_in_temp_dir do
         @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 5.6, res.exif.fnumber
         assert_equal [], @reader.errors
       end
     end

data/test/test_values.rb

@@ -79,4 +79,14 @@ class TestValues < Test::Unit::TestCase
 
   end
 
+  context 'tags' do
+
+    test 'tags preserves the original tag names' do
+      hash = {'FNumber' => 8, 'Author' => 'janfri', 'E-MailAddress' => 'janfri26@gmail.com'}
+      @values = MultiExiftool::Values.new(hash)
+      assert_equal hash.keys, @values.tags.to_a
+    end
+
+  end
+
 end

data/test/test_writer.rb

@@ -3,105 +3,106 @@ require_relative 'helper'
 
 class TestWriter < Test::Unit::TestCase
 
+  MANDATORY_ARGS = MultiExiftool::Writer.mandatory_args
+
   setup do
     @writer = MultiExiftool::Writer.new
   end
 
   context 'various filename combinations' do
 
-    test 'command method, no filenames set' do
-      @writer.values = {:author => 'janfri'}
+    test 'exiftool_args method, no filenames set' do
+      @writer.values = {comment: 'foo'}
       assert_raises MultiExiftool::Error do
-        @writer.command
+        @writer.exiftool_args
       end
       @writer.filenames = []
       assert_raises MultiExiftool::Error do
-        @writer.command
+        @writer.exiftool_args
       end
     end
 
     test 'one filename as string' do
-      @writer.values = {:author => 'janfri'}
+      @writer.values = {comment: 'foo'}
       @writer.filenames = 'a.jpg'
-      command = 'exiftool -author=janfri a.jpg'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + %w(-comment=foo a.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'filenames with spaces' do
       @writer.filenames = ['one file with spaces.jpg', 'another file with spaces.tif']
-      @writer.values = {:author => 'janfri'}
-      command = 'exiftool -author=janfri one\ file\ with\ spaces.jpg another\ file\ with\ spaces.tif'
-      assert_equal command, @writer.command
+      @writer.values = {comment: 'foo'}
+      exiftool_args = MANDATORY_ARGS + ['-comment=foo', 'one file with spaces.jpg',
+                                       'another file with spaces.tif']
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
   end
 
-  context 'command method, various tags' do
+  context 'exiftool_args method, various tags' do
 
     setup do
-      @writer.filenames = %w(a.jpg b.tif c.bmp)
+      @writer.filenames = %w(a.jpg b.jpg c.jpg)
     end
 
     test 'simple case' do
-      @writer.values = {:author => 'janfri'}
-      command = 'exiftool -author=janfri a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      @writer.values = {comment: 'foo'}
+      exiftool_args = MANDATORY_ARGS + %w(-comment=foo a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'no values set' do
       assert_raises MultiExiftool::Error do
-        @writer.command
+        @writer.exiftool_args
       end
       @writer.values = {}
       assert_raises MultiExiftool::Error do
-        @writer.command
+        @writer.exiftool_args
       end
     end
 
     test 'tags with spaces in values' do
-      @writer.values = {:author => 'janfri', :comment => 'some comment'}
-      command = 'exiftool -author=janfri -comment=some\ comment a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      @writer.values = {title: 'title', :comment => 'some comment'}
+      exiftool_args = MANDATORY_ARGS + ['-title=title', '-comment=some comment', 'a.jpg', 'b.jpg', 'c.jpg']
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'tags with rational value' do
       @writer.values ={shutterspeed: Rational(1, 125)}
-      command = 'exiftool -shutterspeed=1/125 a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + %w(-shutterspeed=1/125 a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'tags with array-like values' do
       @writer.values = {keywords: ['one', 'two', 'and three']}
-      command = 'exiftool -keywords=one -keywords=two -keywords=and\ three a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + ['-keywords=one', '-keywords=two', '-keywords=and three',
+                                        'a.jpg', 'b.jpg', 'c.jpg']
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'options with boolean argument' do
-      @writer.values = {:author => 'janfri'}
+      @writer.values = {comment: 'foo'}
       @writer.options = {:overwrite_original => true}
-      command = 'exiftool -overwrite_original -author=janfri a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + %w(-overwrite_original -comment=foo a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'options with value argument' do
-      @writer.values = {:author => 'janfri'}
-      @writer.options = {:out => 'output_file'}
-      command = 'exiftool -out output_file -author=janfri a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      pend 'find a good example' if respond_to? :pend
     end
 
     test 'numerical flag' do
-      @writer.values = {:author => 'janfri'}
+      @writer.values = {comment: 'foo'}
       @writer.numerical = true
-      command = 'exiftool -n -author=janfri a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + %w(-n -comment=foo a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
     test 'overwrite_original flag' do
-      @writer.values = {author: 'janfri'}
+      @writer.values = {comment: 'foo'}
       @writer.overwrite_original = true
-      command = 'exiftool -overwrite_original -author=janfri a.jpg b.tif c.bmp'
-      assert_equal command, @writer.command
+      exiftool_args = MANDATORY_ARGS + %w(-overwrite_original -comment=foo a.jpg b.jpg c.jpg)
+      assert_equal exiftool_args, @writer.exiftool_args
     end
 
   end
@@ -109,22 +110,22 @@ class TestWriter < Test::Unit::TestCase
   context 'write method' do
 
     test 'successful write' do
-      use_fixture('exiftool -author=janfri a.jpg b.tif c.bmp') do
-        @writer.filenames = %w(a.jpg b.tif c.bmp)
-        @writer.values = {:author => 'janfri'}
+      run_in_temp_dir do
+        @writer.filenames = %w(a.jpg b.jpg c.jpg)
+        @writer.values = {comment: 'foo'}
         rc = @writer.write
+        assert rc
         assert_equal [], @writer.errors
-        assert_equal true, rc
       end
     end
 
     test 'unsuccessful write' do
-      use_fixture('exiftool -author=janfri -foo=x a.jpg xxx') do
+      run_in_temp_dir do
         @writer.filenames = %w(a.jpg xxx)
-        @writer.values = {author: 'janfri', foo: 'x'}
+        @writer.values = {comment: 'foo', bar: 'x'}
         rc = @writer.write
-        assert_equal @fixture['stderr'].chomp, @writer.errors.join("\n")
-        assert_equal false, rc
+        assert !rc
+        assert_equal ["Warning: Tag 'bar' does not exist", "Error: File not found - xxx"], @writer.errors
       end
     end
 

data/test/test_writer_groups.rb

@@ -4,28 +4,32 @@ require 'yaml'
 
 class TestWriterGroups < Test::Unit::TestCase
 
+  MANDATORY_ARGS = MultiExiftool::Writer.mandatory_args
+
   setup do
     @writer = MultiExiftool::Writer.new
-    @writer.filenames = %w(a.jpg b.bmp c.tif)
+    @writer.filenames = %w(a.jpg b.jpg c.jpg)
   end
 
   test 'simple case' do
     @writer.values = {:exif => {:comment => 'test'}  }
-    command = 'exiftool -exif:comment=test a.jpg b.bmp c.tif'
-    assert_equal command, @writer.command
+    exiftool_args = MANDATORY_ARGS + %w(-exif:comment=test a.jpg b.jpg c.jpg)
+    assert_equal exiftool_args, @writer.exiftool_args
   end
 
   test 'more than one groups and tags' do
     @writer.values = YAML.load <<-END
       exif:
-        author: janfri
+        author: Mr. X
         comment: some comment
       xmp:
-        author: janfri
+        author: Mr. X
         subjectlocation: somewhere else
     END
-    command = 'exiftool -exif:author=janfri -exif:comment=some\ comment -xmp:author=janfri -xmp:subjectlocation=somewhere\ else a.jpg b.bmp c.tif'
-    assert_equal command, @writer.command
+    exiftool_args = MANDATORY_ARGS + ['-exif:author=Mr. X', '-exif:comment=some comment',
+                                      '-xmp:author=Mr. X', '-xmp:subjectlocation=somewhere else',
+                                      'a.jpg', 'b.jpg', 'c.jpg']
+    assert_equal exiftool_args, @writer.exiftool_args
   end
 
   test 'tags with array-like values' do
@@ -36,8 +40,9 @@ class TestWriterGroups < Test::Unit::TestCase
           - two
           - and three
     END
-    command = 'exiftool -exif:keywords=one -exif:keywords=two -exif:keywords=and\ three a.jpg b.bmp c.tif'
-    assert_equal command, @writer.command
+    exiftool_args = MANDATORY_ARGS + ['-exif:keywords=one', '-exif:keywords=two', '-exif:keywords=and three',
+                                      'a.jpg', 'b.jpg', 'c.jpg']
+    assert_equal exiftool_args, @writer.exiftool_args
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_exiftool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: contest
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool)
+- !ruby/object:Gem::Dependency
+  name: regtest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This library a 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.
@@ -56,9 +70,15 @@ files:
 - lib/multi_exiftool/reader.rb
 - lib/multi_exiftool/values.rb
 - lib/multi_exiftool/writer.rb
-- test/fixtures.yml
+- test/data/a.jpg
+- test/data/b.jpg
+- test/data/c.jpg
 - test/helper.rb
+- test/temp/a.jpg
+- test/temp/b.jpg
+- test/temp/c.jpg
 - test/test_executable.rb
+- test/test_exiftool_stuff.rb
 - test/test_functional_api.rb
 - test/test_reader.rb
 - test/test_values.rb
@@ -66,7 +86,8 @@ files:
 - test/test_writer.rb
 - test/test_writer_groups.rb
 homepage: http://gitorious.org/multi_exiftool
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: "\n+-----------------------------------------------------------------------+\n|
   Please ensure you have installed exiftool version 7.65 or higher and  |\n| it's
@@ -90,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - exiftool, version 7.65 or higher
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).
+summary: This library is a wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).
 test_files: []

data/test/fixtures.yml

@@ -1,72 +0,0 @@
-# reading
-"exiftool -J non_existing_file":
-  stdout: ""
-  stderr: "File non_existing_file not found."
-"exiftool -J -fnumber -foo a.jpg xxx":
-  stdout: |
-    [{
-      "SourceFile": "a.jpg",
-      "FNumber": 9.5
-    }]
-  stderr: |
-    File not found: xxx
-        1 image files read
-        1 files could not be read
-"exiftool -J a.jpg b.tif c.bmp":
-  stdout: |
-    [{
-      "SourceFile": "a.jpg",
-      "FNumber": 11.0,
-      "ISO": 400
-    },
-    {
-      "SourceFile": "b.tif",
-      "FNumber": 9.0,
-      "ISO": 200
-    },
-    {
-      "SourceFile": "c.bmp",
-      "FNumber": 8.0,
-      "ISO": 100
-    }]
-  stderr: ""
-"exiftool -J -fnumber a.jpg b.tif c.bmp":
-  stdout: |
-    [{
-      "SourceFile": "a.jpg",
-      "FNumber": 11.0
-    },
-    {
-      "SourceFile": "b.tif",
-      "FNumber": 9.0
-    },
-    {
-      "SourceFile": "c.bmp",
-      "FNumber": 8.0
-    }]
-  stderr: ""
-"exiftool -J -g 0 -fnumber a.jpg":
-  stdout: |
-    [{
-      "SourceFile": "a.jpg",
-      "EXIF": {
-        "FNumber": 7.1
-      },
-      "MakerNotes": {
-        "FNumber": 7.0
-      }
-    }]
-  stderr: ""
-
-# writing
-"exiftool -author=janfri a.jpg b.tif c.bmp":
-  stdout: |2
-        1 image files updated
-  stderr: ""
-"exiftool -author=janfri -foo=x a.jpg xxx":
-  stdout: |2
-        1 image files updated
-        1 files weren't updated due to errors
-  stderr: |
-    Warning: Tag 'foo' does not exist
-    Error: File not found - xxx