mini_exiftool 0.1.1 → 0.2.0

data/Changelog

@@ -1,3 +1,16 @@
+Version 0.2.0
+- Better error handling (i.e. error messages)
+- Checking if the exiftool command can be executed at loading the lib
+- New class method exiftool_version
+- Added tests
+- Documentation completed
+
+Version 0.1.2
+- Bugfix for Windows (Tempfile)
+  Thanks to Jérome Soika for testing
+- Regexes optimized (a little bit)
+- New class-method MiniExiftool.writable_tags
+
 Version 0.1.1
 - Fixing bug [#8073]
   Handling the '-' in tag Self-timer

data/lib/mini_exiftool.rb

@@ -13,63 +13,70 @@
 #
 
 require 'fileutils'
-require 'open3'
 require 'tempfile'
+require 'set'
 
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
   # Name of the exiftool command
-  ProgramName = 'exiftool'
+  @@cmd = 'exiftool'
 
   attr_reader :filename
   attr_accessor :numerical
 
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
   # opts at the moment only support :numerical for numerical values
   # (the -n parameter in the command line)
   def initialize filename, *opts
-    @prog = ProgramName
     @numerical = opts.include? :numerical
     load filename
   end
 
+  # Load the tags of filename
   def load filename
-    raise MiniExiftool::Error unless File.exists? filename
+    unless File.exists? filename
+      raise MiniExiftool::Error.new("File '#{filename}' does not exist.")
+    end
     @filename = filename
     @values = {}
     @tag_names = {}
     @changed_values = {}
     opt_params = @numerical ? '-n' : ''
-    cmd = %Q(#@prog -e -q -q -s -t #{opt_params} "#{filename}")
+    cmd = %Q(#@@cmd -e -q -q -s -t #{opt_params} "#{filename}")
     if run(cmd)
       parse_output
     else
-      raise MiniExiftool::Error
+      raise MiniExiftool::Error.new(@error_text)
     end
     self
   end
 
+  # Reload the tags of an already readed file
   def reload
     load @filename
   end
 
+  # Returns the value of a tag
   def [] tag
     unified_tag = unify tag
     @changed_values[unified_tag] || @values[unified_tag]
   end
 
+  # Set the value of a tag
   def []=(tag, val)
     unified_tag = unify tag
     converted_val = convert val
     opt_params = converted_val.kind_of?(Numeric) ? '-n' : ''
-    cmd = %Q(#@prog -q -q -P -overwrite_original #{opt_params} -#{unified_tag}="#{converted_val}" "#{temp_filename}")
+    cmd = %Q(#@@cmd -q -q -P -overwrite_original #{opt_params} -#{unified_tag}="#{converted_val}" "#{temp_filename}")
     if run(cmd)
       @changed_values[unified_tag] = val
     end
   end
 
+  # Return true if any tag value is changed or if the value of a
+  # given tag is changed
   def changed? tag=false
     if tag
       @changed_values.include? tag
@@ -78,6 +85,7 @@ class MiniExiftool
     end
   end
 
+  # Revert all changes or the change of a given tag
   def revert tag=nil
     if tag
       unified_tag = unify tag
@@ -90,21 +98,24 @@ class MiniExiftool
     res
   end
 
+  # Returns an array of the tags (original tag names) of the readed file
   def tags
     @values.keys.map { |key| @tag_names[key] }
   end
 
+  # Returns an array of all changed tags
   def changed_tags
     @changed_values.keys.map { |key| @tag_names[key] }
   end
 
+  # Save the changes to the file
   def save
     result = false
     @changed_values.each do |tag, val|
       unified_tag = unify tag
       converted_val = convert val
       opt_params = converted_val.kind_of?(Numeric) ? '-n' : ''
-      cmd = %Q(#@prog -q -q -P -overwrite_original #{opt_params} -#{unified_tag}="#{converted_val}" "#{filename}")
+      cmd = %Q(#@@cmd -q -q -P -overwrite_original #{opt_params} -#{unified_tag}="#{converted_val}" "#{filename}")
       run(cmd)
       result = true
     end
@@ -112,12 +123,56 @@ class MiniExiftool
     result
   end
   
+  # Returns the command name of the called Exiftool application
+  def self.command
+    @@cmd
+  end
+
+  # Setting the command name of the called Exiftool application
+  def self.command= cmd
+    @@cmd = cmd
+  end
+
+  @@writable_tags = Set.new
+
+  # Returns a set of all possible writable tags of Exiftool
+  def self.writable_tags
+    if @@writable_tags.empty?
+      lines = `#{@@cmd} -listw`
+      @@writable_tags = Set.new
+      lines.each do |line|
+        next unless line =~ /^\s/
+        @@writable_tags |= line.chomp.split
+      end
+    end
+    @@writable_tags
+  end
+
+  # Returns the version of the Exiftool command-line application
+  def self.exiftool_version
+    output = `#{MiniExiftool.command} -ver 2>&1`
+    if $?.exitstatus == 0
+      return output
+    else
+      raise MiniExiftool::Error.new("Command '#{MiniExiftool.command}' not found")
+    end
+  end
+
   private
 
+  @@error_file = Tempfile.new 'errors'
+  @@error_file.close
+
   def run cmd
-    @output = `#{cmd}`
+    @output = `#{cmd} 2>#{@@error_file.path}`
     @status = $?
-    @status.exitstatus == 0
+    unless @status.exitstatus == 0
+      @error_text = File.readlines(@@error_file.path).join
+      return false
+    else
+      @error_text = ''
+      return true
+    end
   end
 
   def unify name
@@ -134,8 +189,8 @@ class MiniExiftool
 
   def method_missing symbol, *args
     tag_name = symbol.id2name
-    if tag_name =~ /=$/
-      self[tag_name.gsub(/=$/, '')] = args.first
+    if tag_name.sub!(/=$/, '')
+      self[tag_name] = args.first
     else
       self[tag_name]
     end
@@ -151,7 +206,7 @@ class MiniExiftool
   end
 
   def parse_line line
-    if line =~ /^([^\t]+?)\t(.*)$/
+    if line =~ /^([^\t]+)\t(.*)$/
       tag, value = $1, $2
       case value
       when /^\d{4}:\d\d:\d\d \d\d:\d\d:\d\d$/
@@ -174,6 +229,7 @@ class MiniExiftool
   def temp_filename
     unless @temp_filename
       temp_file = Tempfile.new('mini-exiftool')
+      temp_file.close
       FileUtils.cp(@filename, temp_file.path)
       @temp_filename = temp_file.path
     end
@@ -183,3 +239,6 @@ class MiniExiftool
   class MiniExiftool::Error < Exception; end
 
 end
+
+# Test if we can run the Exiftool command
+MiniExiftool.exiftool_version

data/test/test_other.rb

@@ -0,0 +1,28 @@
+require 'mini_exiftool'
+require 'test/unit'
+begin
+  require 'turn'
+rescue LoadError
+end
+
+class TestOther < Test::Unit::TestCase
+
+  def test_command
+    cmd = MiniExiftool.command
+    assert_equal 'exiftool', cmd
+    MiniExiftool.command = 'non_existend'
+    assert_equal 'non_existend', MiniExiftool.command
+    assert_raises MiniExiftool::Error do
+      met = MiniExiftool.new(File.join(File.dirname(__FILE__), 
+                                       'data/test.jpg'))
+    end
+    MiniExiftool.command = cmd
+  end
+
+  def test_writable_tags
+    w_tags = MiniExiftool.writable_tags
+    assert w_tags.include?('ISO')
+    assert_equal false, w_tags.include?('xxxxxx')
+  end
+
+end

data/test/test_read.rb

@@ -21,12 +21,22 @@ class TestRead < Test::Unit::TestCase
     assert_raises MiniExiftool::Error do
       MiniExiftool.new 'not_existing_file'
     end
+    begin
+      MiniExiftool.new 'not_existing_file'
+    rescue MiniExiftool::Error => e
+      assert_match /File 'not_existing_file' does not exist/, e.message
+    end
   end
 
   def test_wrong_file
     assert_raises MiniExiftool::Error do
       MiniExiftool.new __FILE__ # file type wich Exiftool can not handle
     end
+    begin
+      MiniExiftool.new __FILE__ # file type wich Exiftool can not handle
+    rescue MiniExiftool::Error => e
+      assert_match /Error: Unknown image type/, e.message
+    end
   end
 
   def test_access

data/test/test_write.rb

@@ -12,6 +12,7 @@ class TestWrite < Test::Unit::TestCase
 
   def setup
     @temp_file = Tempfile.new('test')
+    @temp_file.close
     @temp_filename = @temp_file.path
     @org_filename = File.dirname(__FILE__) + '/data/test.jpg'
     FileUtils.cp(@org_filename, @temp_filename)
@@ -20,7 +21,7 @@ class TestWrite < Test::Unit::TestCase
   end
 
   def teardown
-    @temp_file.close
+    @temp_file.delete
   end
 
   def test_access_existing_tags

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: mini_exiftool
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-02-01 00:00:00 +01:00
+  version: 0.2.0
+date: 2007-02-22 00:00:00 +01:00
 summary: A library for nice OO access to the Exiftool command-line application written by Phil Harvey.
 require_paths: 
 - lib
@@ -33,6 +33,7 @@ files:
 - test/test_write.rb
 - test/test_read.rb
 - test/test_special.rb
+- test/test_other.rb
 - Rakefile
 - COPYING
 - Changelog
@@ -44,6 +45,7 @@ test_files:
 - test/test_write.rb
 - test/test_read.rb
 - test/test_special.rb
+- test/test_other.rb
 rdoc_options: 
 - --title
 - MiniExiftool API documentation