mini_exiftool 0.7.0 → 1.0.0

data/Changelog

@@ -1,3 +1,8 @@
+Version 1.0.0
+- Be aware changing in the interface:
+  - List tags (e.g. Keywords, SupplementalCategories) are now handled as 
+    arrays.
+  - Tag SubjectLocation is not longer an array value but a string value!
 Version 0.7.0
 - Changing composite behaviour: Composite tags are now included as standard!
 - New method MiniExiftool.opts which returns a hash of the standard

data/Tutorial

@@ -42,12 +42,27 @@ or also
 === Value Types
 
 Following types of values are at the moment supported:
-* Array (e. g. SubjectLocation => 1504 1000 256 304)
+* Array (e. g. Keywords => ['tree', 'gras'])
 * Fixnum (e. g. ISO => 400)
 * Float (e. g. FNumber => 9.5) 
 * String (e. g. Model => DYNAX 7D)
 * Time (e. g. DateTimeOriginal => 2005:09:13 20:08:50)
 
+Be aware, if there is only one value in a tag which can hold multiple
+values the result is'nt an array! But you can get one with the to_a
+method:
+  # only _one_ keyword
+  p1 = MiniExiftool.new 'p1.jpg'
+  p1.keywords # => 'red'
+  # _more than one_ keywords
+  p3 = MiniExiftool.new 'p3.jpg'
+  p3.keywords # => ['red', 'yellow', 'green']
+
+  # if we want to get an array in both cases and don't know
+  # if there is one ore more values set let's take to_a
+  p1.keywords.to_a # => ['red']
+  p3.keywords.to_a # => ['red', 'yellow', 'green']
+
 The Exiftool command-line application has an option (-n) to get values
 as numbers if possible, in MiniExiftool you can do this with setting
 the <code>:numerical</code> option to +true+ while generating a new
@@ -66,15 +81,22 @@ This behaviour can be useful if you want to do calculations on the
 value, if you only want to show the value the standard behaviour is
 maybe better.
 
+The Time class of Ruby cannot handle timestamps before 1st January 1970
+on some platforms. If there are timestamps in files before this date it
+will result in an error. In this case we can set the option 
+<code>:timestamps</code> to +DateTime+ to use DateTime objects instead
+of Time objects.
+
+There is another option <code>:composite</code>. If this is set to
++false+ the composite tags are not calculated by the exiftool
+command-line application (option -e).
+
 === Further Example
 
 For understanding reading access to meta data also have a look at the
 example file <code>print_portraits.rb</code> in the +examples+
 directory.
 
-<b>TODO:</b> Describing the options <code>:composite</code> and
-<code>:timestamps</code>!
-
 == Lesson 2: Writing Meta Data
 
 

data/lib/mini_exiftool.rb

@@ -14,7 +14,6 @@
 
 require 'fileutils'
 require 'tempfile'
-require 'tmpdir'
 require 'pstore'
 require 'set'
 
@@ -30,7 +29,7 @@ class MiniExiftool
   attr_reader :filename
   attr_accessor :numerical, :composite, :convert_encoding, :errors, :timestamps
 
-  VERSION = '0.7.0'
+  VERSION = '1.0.0'
 
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
@@ -81,7 +80,7 @@ class MiniExiftool
     opt_params << (@numerical ? '-n ' : '')
     opt_params << (@composite ? '' : '-e ')
     opt_params << (@convert_encoding ? '-L ' : '')
-    cmd = %Q(#@@cmd -q -q -s -t #{opt_params} "#{filename}")
+    cmd = %Q(#@@cmd -q -q -s -t #{opt_params} #{@@sep_op} "#{filename}")
     if run(cmd)
       parse_output
     else
@@ -148,11 +147,16 @@ class MiniExiftool
     all_ok = true
     @changed_values.each do |tag, val|
       original_tag = MiniExiftool.original_tag(tag)
-      converted_val = convert val
+      arr_val = val.kind_of?(Array) ? val : [val]
+      arr_val.map! {|e| convert e}
+      tag_params = ''
+      arr_val.each do |v|
+        tag_params << %Q(-#{original_tag}="#{v}" )
+      end
       opt_params = ''
-      opt_params << (converted_val.kind_of?(Numeric) ? '-n ' : '')
+      opt_params << (arr_val.detect {|x| x.kind_of?(Numeric)} ? '-n ' : '')
       opt_params << (@convert_encoding ? '-L ' : '')
-      cmd = %Q(#@@cmd -q -P -overwrite_original #{opt_params} -#{original_tag}="#{converted_val}" "#{temp_filename}")
+      cmd = %Q(#@@cmd -q -P -overwrite_original #{opt_params} #{tag_params} "#{temp_filename}")
       result = run(cmd)
       unless result
         all_ok = false
@@ -255,6 +259,14 @@ class MiniExiftool
   @@error_file = Tempfile.new 'errors'
   @@error_file.close
 
+  if Float(exiftool_version) < 7.41
+    @@separator = ', '
+    @@sep_op = ''
+  else
+    @@separator = '@@'
+    @@sep_op = '-sep @@'
+  end
+
   def run cmd
     if $DEBUG
       $stderr.puts cmd
@@ -319,11 +331,20 @@ class MiniExiftool
       when /^-?\d+$/
         value = value.to_i
       when /^[\d ]+$/
-        value = value.split(/ /)
+        # nothing => String
+      when /#{@@separator}/
+        value = value.split @@separator
       end
     else
       raise MiniExiftool::Error.new("Malformed line #{line.inspect} of exiftool output.")
     end
+    unless value.respond_to?('to_a')
+      class << value
+        def to_a
+          [self]
+        end
+      end
+    end
     return [tag, value]
   end
 
@@ -359,7 +380,11 @@ class MiniExiftool
   end
 
   def self.load_or_create_pstore
-    filename = File.join(Dir.tmpdir, 'exiftool_tags_' + exiftool_version.gsub('.', '_'))
+    # This will hopefully work on *NIX and Windows systems
+    home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] || ENV['USERPROFILE']
+    subdir = RUBY_PLATFORM =~ /win/i ? '_mini_exiftool' : '.mini_exiftool'
+    FileUtils.mkdir_p(File.join(home, subdir))
+    filename = File.join(home, subdir, 'exiftool_tags_' << exiftool_version.gsub('.', '_') << '.pstore')
     @@pstore = PStore.new filename
     if !File.exist?(filename) || File.size(filename) == 0
       @@pstore.transaction do |ps|
@@ -408,5 +433,14 @@ class MiniExiftool
 
 end
 
+# Add to_a to Numerical if it's not yet defined
+unless Numeric.instance_methods.include? 'to_a'
+  class Numeric
+    def to_a
+      [self]
+    end
+  end
+end
+
 # Test if we can run the Exiftool command
 MiniExiftool.exiftool_version

data/test/test_read.rb

@@ -25,7 +25,16 @@ class TestRead < TestCase
     assert_kind_of Float, @mini_exiftool['MaxApertureValue']
     assert_kind_of String, @mini_exiftool.flash
     assert_kind_of Fixnum, @mini_exiftool['ExposureCompensation']
-    assert_kind_of Array, @mini_exiftool['SubjectLocation']
+    assert_kind_of String, @mini_exiftool['SubjectLocation']
+    assert_kind_of Array, @mini_exiftool['Keywords']
+    assert_kind_of String, @mini_exiftool['SupplementalCategories']
+    assert_kind_of Array, @mini_exiftool['SupplementalCategories'].to_a
+  end
+
+  def test_list_tags
+    assert_equal ['Orange', 'Rot'], @mini_exiftool['Keywords']
+    assert_equal 'Natur', @mini_exiftool['SupplementalCategories']
+    assert_equal ['Natur'], @mini_exiftool['SupplementalCategories'].to_a
   end
 
   def test_encoding_conversion

data/test/test_read_numerical.rb

@@ -22,7 +22,10 @@ class TestReadNumerical < TestCase
     assert_kind_of Fixnum, @mini_exiftool_num.flash
     assert_kind_of String, @mini_exiftool_num.exif_version
     assert_kind_of Fixnum, @mini_exiftool_num['ExposureCompensation']
-    assert_kind_of Array, @mini_exiftool_num['SubjectLocation']
+    assert_kind_of String, @mini_exiftool_num['SubjectLocation']
+    assert_kind_of Array, @mini_exiftool_num['Keywords']
+    assert_kind_of String, @mini_exiftool_num['SupplementalCategories']
+    assert_kind_of Array, @mini_exiftool_num['SupplementalCategories'].to_a
   end
 
 end

data/test/test_special.rb

@@ -22,7 +22,7 @@ class TestSpecial < TestCase
     assert_not_nil @canon['Self-timer']
     assert_not_nil @canon.self_timer
     # preserving the original tag name
-    assert @canon.tags.include?('Self-timer')
+    assert @canon.tags.include?('Self-timer') || @canon.tags.include?('SelfTimer')
     assert !@canon.tags.include?('self_timer')
   end
 

data/test/test_write.rb

@@ -86,6 +86,23 @@ class TestWrite < TestCase
     assert_equal new_mode, @mini_exiftool_num['MeteringMode']
   end
 
+  def test_list_conversion
+    arr =  ['a', 'b', 'c']
+    @mini_exiftool['Keywords'] = arr
+    ok = @mini_exiftool.save
+    assert ok
+    assert_equal arr, @mini_exiftool['Keywords']
+    arr = ['text, with', 'commas, let us look']
+    @mini_exiftool['Keywords'] = arr
+    ok = @mini_exiftool.save
+    assert ok
+    if MiniExiftool.exiftool_version.to_f < 7.41
+      assert_equal ['text', 'with', 'commas', 'let us look'], @mini_exiftool['Keywords']
+    else
+      assert_equal arr, @mini_exiftool['Keywords']
+    end
+  end
+
   def test_revert_one
     @mini_exiftool_num['Orientation'] = 2
     @mini_exiftool_num['ISO'] = 200

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mini_exiftool
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jan Friedrich
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-07 00:00:00 +02:00
+date: 2008-09-12 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -24,27 +24,27 @@ extra_rdoc_files:
 - Tutorial
 files: 
 - lib/mini_exiftool.rb
-- test/test_write.rb
 - test/test_read.rb
-- test/test_special.rb
-- test/test_class_methods.rb
-- test/test_save.rb
+- test/test_write.rb
 - test/test_composite.rb
-- test/test_read_numerical.rb
-- test/helpers_for_test.rb
+- test/test_save.rb
 - test/test_special_dates.rb
+- test/helpers_for_test.rb
 - test/test_dumping.rb
+- test/test_read_numerical.rb
+- test/test_special.rb
+- test/test_class_methods.rb
+- examples/shift_time.rb
 - examples/external_photo.rb
 - examples/print_portraits.rb
-- examples/shift_time.rb
 - setup.rb
 - Rakefile
 - COPYING
 - Changelog
-- test/data/test.jpg
 - test/data/Canon.jpg
-- test/data/INFORMATION
 - test/data/test_special_dates.jpg
+- test/data/INFORMATION
+- test/data/test.jpg
 - README
 - Tutorial
 has_rdoc: true
@@ -77,12 +77,12 @@ signing_key:
 specification_version: 2
 summary: A library for nice OO access to the Exiftool command-line application written by Phil Harvey.
 test_files: 
-- test/test_write.rb
 - test/test_read.rb
-- test/test_special.rb
-- test/test_class_methods.rb
-- test/test_save.rb
+- test/test_write.rb
 - test/test_composite.rb
-- test/test_read_numerical.rb
+- test/test_save.rb
 - test/test_special_dates.rb
 - test/test_dumping.rb
+- test/test_read_numerical.rb
+- test/test_special.rb
+- test/test_class_methods.rb