mini_exiftool 0.5.1 → 0.6.0

data/Changelog

@@ -1,3 +1,13 @@
+Version 0.6.0
+- New methods for serialization:
+  - MiniExiftool.from_hash
+  - MiniExiftool.from_yaml
+  - MiniExiftool#to_hash
+  - MiniExiftool#to_yaml
+  Thanks to Andrew Bennett for the initial idea of YAML-serialization
+- Refactoring of tests
+- Small documetation update
+
 Version 0.5.1
 - Warning "parenthesize argument(s) for future version" removed
   Thanks to Greg from knobby.ws

data/README

@@ -1,7 +1,7 @@
 = MiniExiftool
 
 This library is wrapper for the Exiftool command-line application
-(http://www.sno.phy.queensu.ca/~phil/exiftool/) written by Phil Harvey.
+(http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey.
 Read and write access is done in a clean OO manner.
 
 == Requirements
@@ -12,20 +12,28 @@ http://www.sno.phy.queensu.ca/~phil/exiftool/install.html .
 
 == Installation
 
-First you need Exiftool (see under Requirements above). Simply install the gem
-with
+First you need Exiftool (see under Requirements above). Then you can simply
+install the gem with
  gem install mini_exiftool
+respectively (on *nix sytems)
+ sudo gem install mini_exiftool
 
-Alternative you can download the tarball and run
- ruby setup config
- ruby setup setup
- sudo ruby setup install
+Alternative you can download the tarball or zip file and run
+ ruby setup.rb config
+ ruby setup.rb setup
+ sudo ruby setup.rb install
+
+== Contribution
+
+The code is also hostet in a git repository on Gitorious at
+http://gitorious.org/projects/mini_exiftool 
+feel free to contribute!
 
 == Author
-Jan Friedrich
+Jan Friedrich <janfri DOT rubyforge AT gmail DOT com>
 
 == Copyright / License
-Copyright (c) 2007 by Jan Friedrich
+Copyright (c) 2007-2008 by Jan Friedrich
 
 Licensed under terms of the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1, 
 February 1999 (see file COPYING for more details)

data/Rakefile

@@ -11,7 +11,7 @@ PROJECT = "MiniExiftool"
 MY_NAME = "Jan Friedrich"
 
 # Your email address, used in packaging.
-MY_EMAIL = "miniexiftool@googlemail.com"
+MY_EMAIL = "janfri.rubyforge@gmail.com"
 
 # Short summary of your project, used in packaging.
 PROJECT_SUMMARY = 'A library for nice OO access to the Exiftool command-line application written by Phil Harvey.'
@@ -40,7 +40,7 @@ EXT_SOURCES = FileList["#{EXT_DIR}/**/*.{c,h}"]
 # Eventually add other files from EXT_DIR, like "MANIFEST"
 EXT_DIST_FILES = EXT_SOURCES + EXTCONF_FILES
 #---
-REQUIRE_PATHS = ["lib"]
+REQUIRE_PATHS = ['lib', 'test']
 REQUIRE_PATHS << EXT_DIR if HAVE_EXT
 REQUIRE_PATHS.reverse_each do |p|
   $LOAD_PATH.unshift p

data/lib/mini_exiftool.rb

@@ -27,7 +27,7 @@ class MiniExiftool
   attr_reader :filename
   attr_accessor :numerical, :composite, :errors, :timestamps
 
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
@@ -39,7 +39,7 @@ class MiniExiftool
   #   <b>ATTENTION:</b> Time objects are created using <code>Time.local</code>
   #   therefore they use <em>your local timezone</em>, DateTime objects instead
   #   are created <em>without timezone</em>!
-  def initialize filename, opts={}
+  def initialize filename=nil, opts={}
     std_opts = {:numerical => false, :composite => false, :timestamps => Time}
     opts = std_opts.update opts
     @numerical = opts[:numerical]
@@ -49,14 +49,23 @@ class MiniExiftool
     @tag_names = TagHash.new
     @changed_values = TagHash.new
     @errors = TagHash.new
-    load filename
+    load filename unless filename.nil?
+  end
+
+  def initialize_from_hash hash # :nodoc: 
+    hash.each_pair do |tag,value|
+      set_value tag, value
+    end
+    set_attributes_by_heuristic
+    self
   end
 
   # Load the tags of filename.
   def load filename
-    if filename.nil? || !File.exist?(filename)
+    unless filename && File.exist?(filename)
       raise MiniExiftool::Error.new("File '#{filename}' does not exist.")
-    elsif File.directory?(filename)
+    end
+    if File.directory?(filename)
       raise MiniExiftool::Error.new("'#{filename}' is a directory.")
     end
     @filename = filename
@@ -149,7 +158,36 @@ class MiniExiftool
     temp_file.delete
     all_ok
   end
-  
+
+  # Returns a hash of the original loaded values of the MiniExiftool
+  # instance.
+  def to_hash
+    result = {}
+    @values.each do |k,v|
+      result[@tag_names[k]] = v
+    end
+    result
+  end 
+
+  # Returns a YAML representation of the original loaded values of the 
+  # MiniExiftool instance.
+  def to_yaml
+    to_hash.to_yaml
+  end
+
+  # Create a MiniExiftool instance from a hash
+  def self.from_hash hash
+    instance = MiniExiftool.new
+    instance.initialize_from_hash hash
+    instance
+  end
+
+  # Create a MiniExiftool instance from YAML data created with
+  # MiniExiftool#to_yaml
+  def self.from_yaml yaml
+    MiniExiftool.from_hash YAML.load(yaml)
+  end
+
   # Returns the command name of the called Exiftool application.
   def self.command
     @@cmd
@@ -239,8 +277,7 @@ class MiniExiftool
   def parse_output
     @output.each_line do |line|
       tag, value = parse_line line
-      @tag_names[tag] = tag
-      @values[tag] = value
+      set_value tag, value
     end
   end
 
@@ -277,6 +314,23 @@ class MiniExiftool
     return [tag, value]
   end
 
+  def set_value tag, value
+    @tag_names[tag] = tag
+    @values[tag] = value
+  end
+
+  def set_attributes_by_heuristic
+    if tags.include? 'ImageSize'
+      self.composite = true
+    end
+    if self.file_size.kind_of? Integer
+      self.numerical = true
+    end
+    if self.FileModifyDate.kind_of? DateTime
+      self.timestamps = DateTime
+    end
+  end
+
   def temp_filename
     unless @temp_filename
       temp_file = Tempfile.new('mini-exiftool')

data/test/helpers_for_test.rb

@@ -0,0 +1,13 @@
+require 'mini_exiftool'
+require 'test/unit'
+begin
+  require 'turn'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'turn'
+  rescue LoadError
+  end
+end
+
+include Test::Unit

data/test/test_class_methods.rb

@@ -1,16 +1,18 @@
-require 'mini_exiftool'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestClassMethods < Test::Unit::TestCase
+class TestClassMethods < TestCase
 
   def test_new
-    assert_raises MiniExiftool::Error do
+    assert_nothing_raised do
+      @mini_exiftool = MiniExiftool.new
+    end
+    assert_equal nil, @mini_exiftool.filename
+    assert_nothing_raised do
       MiniExiftool.new nil
     end
+    assert_raises MiniExiftool::Error do
+      MiniExiftool.new false 
+    end
     assert_raises MiniExiftool::Error do
       MiniExiftool.new ''
     end

data/test/test_composite.rb

@@ -1,11 +1,6 @@
-require 'mini_exiftool'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestComposite < Test::Unit::TestCase
+class TestComposite < TestCase
 
   def setup
     @data_dir = File.dirname(__FILE__) + '/data'

data/test/test_dumping.rb

@@ -0,0 +1,89 @@
+require 'helpers_for_test'
+require 'yaml'
+
+class TestDumping < TestCase
+
+  def setup
+    @data_dir = File.dirname(__FILE__) + '/data'
+    @filename_test = @data_dir + '/test.jpg'
+    @mini_exiftool = MiniExiftool.new @filename_test
+  end
+
+  def test_to_hash
+    hash = @mini_exiftool.to_hash
+    assert_equal Hash, hash.class
+    assert_equal @mini_exiftool.tags.size, hash.size, 'Size of Hash is not correct.'
+    assert_not_nil hash['ExifToolVersion'], 'Original name of exiftool tag is not preserved.'
+    all_ok = true
+    diffenent_tag = ''
+    hash.each do |k,v|
+      unless @mini_exiftool[k] == v
+        all_ok = false
+        diffenent_tag = k
+        break
+      end
+    end
+    assert all_ok, "Tag #{diffenent_tag}: expected: #{@mini_exiftool[diffenent_tag]}, actual: v"
+  end
+
+  def test_from_hash
+    hash = @mini_exiftool.to_hash
+    mini_exiftool_new = MiniExiftool.from_hash hash
+    assert_equal MiniExiftool, mini_exiftool_new.class
+    assert_equal @mini_exiftool.tags.size, mini_exiftool_new.tags.size
+    all_ok = true
+    diffenent_tag = ''
+    @mini_exiftool.tags.each do |tag|
+      unless @mini_exiftool[tag] == mini_exiftool_new[tag]
+        all_ok = false
+        diffenent_tag = tag
+        break
+      end
+    end
+    assert all_ok, "Tag #{diffenent_tag}: expected: #{@mini_exiftool[diffenent_tag]}, actual: #{mini_exiftool_new[diffenent_tag]}"
+
+  end
+
+  def test_to_yaml
+    hash = @mini_exiftool.to_hash
+    yaml = @mini_exiftool.to_yaml
+    assert_equal hash, YAML.load(yaml)
+  end
+
+  def test_from_yaml
+    hash = @mini_exiftool.to_hash
+    yaml = hash.to_yaml
+    mini_exiftool_new = MiniExiftool.from_yaml(yaml)
+    assert_equal MiniExiftool, mini_exiftool_new.class
+    assert_equal hash, mini_exiftool_new.to_hash
+  end
+
+  def test_heuristics_for_restoring_composite
+    standard = @mini_exiftool.to_hash
+    composite = MiniExiftool.new(@filename_test, :composite => true).to_hash
+    assert_equal false, MiniExiftool.from_hash(standard).composite
+    assert_equal true, MiniExiftool.from_hash(composite).composite
+    assert_equal false, MiniExiftool.from_yaml(standard.to_yaml).composite
+    assert_equal true, MiniExiftool.from_yaml(composite.to_yaml).composite
+  end
+
+  def test_heuristics_for_restoring_numerical
+    standard = @mini_exiftool.to_hash
+    numerical = MiniExiftool.new(@filename_test, :numerical => true).to_hash
+    assert_equal false, MiniExiftool.from_hash(standard).numerical
+    assert_equal true, MiniExiftool.from_hash(numerical).numerical
+    assert_equal false, MiniExiftool.from_yaml(standard.to_yaml).numerical
+    assert_equal true, MiniExiftool.from_yaml(numerical.to_yaml).numerical
+  end
+
+  def test_heuristics_for_restoring_timestamps
+    standard = @mini_exiftool.to_hash
+    timestamps = MiniExiftool.new(@filename_test, :timestamps => DateTime).to_hash
+    assert_equal Time, MiniExiftool.from_hash(standard).timestamps
+    assert_equal DateTime, MiniExiftool.from_hash(timestamps).timestamps
+    # Doesn't work yet.
+    # assert_equal Time, MiniExiftool.from_yaml(standard.to_yaml).timestamps
+    # assert_equal DateTime, MiniExiftool.from_yaml(timestamps.to_yaml).timestamps
+  end
+
+end

data/test/test_read.rb

@@ -1,11 +1,6 @@
-require 'mini_exiftool'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestRead < Test::Unit::TestCase
+class TestRead < TestCase
 
   def setup
     @data_dir = File.dirname(__FILE__) + '/data'

data/test/test_read_numerical.rb

@@ -1,11 +1,6 @@
-require 'mini_exiftool'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestReadNumerical < Test::Unit::TestCase
+class TestReadNumerical < TestCase
 
   def setup
     @data_dir = File.dirname(__FILE__) + '/data'

data/test/test_save.rb

@@ -1,14 +1,9 @@
 require 'digest/md5'
-require 'mini_exiftool'
 require 'fileutils'
 require 'tempfile'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestSave < Test::Unit::TestCase
+class TestSave < TestCase
 
   def setup
     @temp_file = Tempfile.new('test')

data/test/test_special.rb

@@ -1,13 +1,8 @@
 require 'fileutils'
-require 'mini_exiftool'
 require 'tempfile'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestSpecial < Test::Unit::TestCase
+class TestSpecial < TestCase
 
   CAPTION_ABSTRACT =  'Some text for caption abstract'
 

data/test/test_special_dates.rb

@@ -1,14 +1,9 @@
 require 'date'
 require 'fileutils'
-require 'mini_exiftool'
 require 'tempfile'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestSpecialDates < Test::Unit::TestCase
+class TestSpecialDates < TestCase
 
   def setup
     data_dir = File.dirname(__FILE__) + '/data'

data/test/test_write.rb

@@ -1,14 +1,9 @@
 require 'digest/md5'
-require 'mini_exiftool'
 require 'fileutils'
 require 'tempfile'
-require 'test/unit'
-begin
-  require 'turn'
-rescue LoadError
-end
+require 'helpers_for_test'
 
-class TestWrite < Test::Unit::TestCase
+class TestWrite < TestCase
 
   def setup
     @temp_file = Tempfile.new('test')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mini_exiftool
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Jan Friedrich
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-03 00:00:00 +01:00
+date: 2008-05-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: 
-email: miniexiftool@googlemail.com
+email: janfri.rubyforge@gmail.com
 executables: []
 
 extensions: []
@@ -31,7 +31,9 @@ files:
 - test/test_save.rb
 - test/test_composite.rb
 - test/test_read_numerical.rb
+- test/helpers_for_test.rb
 - test/test_special_dates.rb
+- test/test_dumping.rb
 - examples/external_photo.rb
 - examples/print_portraits.rb
 - examples/shift_time.rb
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: miniexiftool
-rubygems_version: 1.0.1
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: A library for nice OO access to the Exiftool command-line application written by Phil Harvey.
@@ -83,3 +85,4 @@ test_files:
 - test/test_composite.rb
 - test/test_read_numerical.rb
 - test/test_special_dates.rb
+- test/test_dumping.rb