mini_exiftool 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1503e85ca2e2cb25cee0dc50a680d6c1641c8000
-  data.tar.gz: 01bc4385657a026eb0fe93a5a8969c1ceb14665e
+  metadata.gz: 945fdce2c08a3ae7c09603eb14156ccc853ad8c8
+  data.tar.gz: 29a87004f5057d4b647a17a0818c02d98700b92f
 SHA512:
-  metadata.gz: 40d2c11befb48e3e024b45d770d572ead5dbc088bc8497f10ff9fad5a930bffdbea19ded6da5248f376d7a5442758ed4ff5739cf78dedbfee3161eac98ba04e6
-  data.tar.gz: d4f821e8f2c389e7b0f32f54eea60db3b9d72f1b1bddfbbaba421287550c03181f325348f906e4becd432f25592f0a8f615789545a80b30c799787efaad0dbf2
+  metadata.gz: 468bd686cc92722e3b516e046681a8ae1854a68ea9089beaa4cbdd51aa2eddcb120e8f3776d3ab66db6f0ca1105f6a36aabc5dd83f13594e3d453b1057e5cf20
+  data.tar.gz: 9400b0fdfc174246734c2071e4e76a9f0253215c70c4d89eb317327fe1f9f65af34e8e97f54c8d8518ad3c4f7927888024590aa54837f7184026d1a9289f008a

data/Changelog

@@ -1,3 +1,12 @@
+2.4.0
+- New method MiniExiftool#copy_tags_from.
+  Many thanks to cgat for the hint and implementing a first
+  approach.
+- Saver handling of encoding problems.
+- Approving documentation.
+- Using regtest for integration testing.
+- Some internal refactorings.
+
 2.3.0
 - New options :exif_encoding, :iptc_encodings,
   :xmp_encodings etc. to change specific encodings

data/README.rdoc

@@ -23,21 +23,36 @@ http://rubygems.org/gems/mini_exiftool_vendored .
 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
 
-If you need support of older versione (see Requirements above)
+If you need to support older versions of Ruby or exiftool (see Requirements above)
   gem install --version "< 2.0.0" mini_exiftool
 
-Alternative you can download the tarball or zip file and run
- ruby setup.rb config
- ruby setup.rb setup
- sudo ruby setup.rb install
+== Usage
+
+In general MiniExiftool is very intuitive to use as the following examples show:
+
+ # Reading meta data
+ photo = MiniExiftool.new 'photo.jpg'
+ puts photo.title
+
+ # Writing meta data
+ photo = MiniExiftool.new 'photo.jpg'
+ photo.title = 'This is the new title'
+ photo.save
+
+ # Copying meta data
+ photo = MiniExiftool.new('photo.jpg')
+ photo.copy_tags_from('another_photo.jpg', :author)
+
+
+For further information about using MiniExiftool read the Tutorial.rdoc
+in the project root folder and have a look at the examples in directory
+examples.
 
 == Contribution
 
-The code is also hostet in a git repository on Gitorious at
-http://gitorious.org/projects/mini_exiftool
+The code is hostet in a git repository on Gitorious at
+http://gitorious.org/mini_exiftool
 and github at
 https://github.com/janfri/mini_exiftool
 feel free to contribute!
@@ -50,9 +65,3 @@ Copyright (c) 2007-2013 by Jan Friedrich
 
 Licensed under terms of the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1,
 February 1999 (see file COPYING for more details)
-
-== Usage
-
-For further information about using MiniExiftool read the Tutorial.rdoc
-in the project root folder and have a look at the examples in directory
-examples.

data/Rakefile

@@ -2,6 +2,7 @@ require 'rim'
 require 'rim/check_version'
 require 'rim/gem'
 require 'rim/test'
+require 'regtest/task'
 
 $:.unshift 'lib'
 require 'mini_exiftool'

data/Tutorial.rdoc

@@ -12,7 +12,6 @@
 
 === A Simple Example
 
- require 'rubygems'
  require 'mini_exiftool'
 
  photo = MiniExiftool.new 'photo.jpg'
@@ -119,7 +118,6 @@ directory.
 
 === Also A Very Simple Example
 
- require 'rubygems'
  require 'mini_exiftool'
 
  photo = MiniExiftool.new 'photo.jpg'
@@ -149,3 +147,26 @@ You should also look at the rdoc information of MiniExiftool.
 === Further Examples
 
 Have a look in the examples folder of MiniExiftool.
+
+
+== Lesson 3: Copying Meta Data
+
+=== Examples
+
+ require 'mini_exiftool'
+
+ photo = MiniExiftool.new('photo.jpg')
+
+ # Update the author tag of photo.jpg with the value of the author tag
+ # of another_photo.jpg
+ photo.copy_tags_from('another_photo.jpg', 'Author')
+
+ # It's also possible to use symbols and case is also not meaningful
+ photo.copy_tags_from('another_photo.jpg', :author)
+
+ # Further more than one tag can be copied at once
+ photo.copy_tags_from('another_photo', %w[author copyright])
+
+=== Further Example
+
+Look at the file copy_icc_profile.rb in the examples folder of MiniExiftool.

data/lib/mini_exiftool.rb

@@ -8,7 +8,7 @@
 # Read and write access is done in a clean OO manner.
 #
 # Author: Jan Friedrich
-# Copyright (c) 2007-2013 by Jan Friedrich
+# Copyright (c) 2007-2014 by Jan Friedrich
 # Licensed under the GNU LESSER GENERAL PUBLIC LICENSE,
 # Version 2.1, February 1999
 #
@@ -25,7 +25,7 @@ require 'time'
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 
   # Name of the Exiftool command-line application
   @@cmd = 'exiftool'
@@ -102,10 +102,8 @@ class MiniExiftool
   end
 
   def initialize_from_hash hash # :nodoc:
-    hash.each_pair do |tag,value|
-      set_value tag, convert_after_load(tag, value)
-    end
-    set_attributes_by_heuristic
+    set_values hash
+    set_opts_by_heuristic
     self
   end
 
@@ -236,6 +234,20 @@ class MiniExiftool
     end
   end
 
+  def copy_tags_from(source_filename, tags)
+    @errors.clear
+    unless File.exist?(source_filename)
+      raise MiniExiftool::Error.new("Source file #{source_filename} does not exist!")
+    end
+    params = '-q -P -overwrite_original '
+    tags_params = Array(tags).map {|t| '-' << t.to_s}.join(' ')
+    cmd = [@@cmd, params, '-tagsFromFile', escape(source_filename).encode(@@fs_enc), tags_params.encode('UTF-8'), escape(filename).encode(@@fs_enc)].join(' ')
+    cmd.force_encoding('UTF-8')
+    result = run(cmd)
+    reload
+    result
+  end
+
   # Returns a hash of the original loaded values of the MiniExiftool
   # instance.
   def to_hash
@@ -254,8 +266,8 @@ class MiniExiftool
 
   # Create a MiniExiftool instance from a hash. Default value
   # conversions will be applied if neccesary.
-  def self.from_hash hash
-    instance = MiniExiftool.new
+  def self.from_hash hash, opts={}
+    instance = MiniExiftool.new nil, opts
     instance.initialize_from_hash hash
     instance
   end
@@ -270,8 +282,8 @@ class MiniExiftool
 
   # Create a MiniExiftool instance from YAML data created with
   # MiniExiftool#to_yaml
-  def self.from_yaml yaml
-    MiniExiftool.from_hash YAML.load(yaml)
+  def self.from_yaml yaml, opts={}
+    MiniExiftool.from_hash YAML.load(yaml), opts
   end
 
   # Returns the command name of the called Exiftool application.
@@ -379,22 +391,20 @@ class MiniExiftool
   end
 
   def parse_output
+    adapt_encoding
+    set_values JSON.parse(@output).first
+  end
+
+  def adapt_encoding
     @output.force_encoding('UTF-8')
     if @opts[:replace_invalid_chars] && !@output.valid_encoding?
       @output.encode!('UTF-16le', invalid: :replace, replace: @opts[:replace_invalid_chars]).encode!('UTF-8')
     end
-    JSON.parse(@output)[0].each do |tag,value|
-      value = convert_after_load(tag, value)
-      set_value tag, value
-    end
   end
 
   def convert_after_load tag, value
     return value unless value.kind_of?(String)
-    if %w(sourcefile filename directory).include?(MiniExiftool.unify(tag))
-      # ignore filesystem relevant tags to avoid encoding problems
-      return nil
-    end
+    return value unless value.valid_encoding?
     case value
     when /^\d{4}:\d\d:\d\d \d\d:\d\d:\d\d/
       s = value.sub(/^(\d+):(\d+):/, '\1-\2-')
@@ -423,14 +433,27 @@ class MiniExiftool
     value
   end
 
-  def set_value tag, value
-    @values[tag] = value
+  def set_values hash
+    hash.each_pair do |tag,val|
+      @values[tag] = convert_after_load(tag, val)
+    end
+    # Remove filename specific tags use attr_reader
+    # MiniExiftool#filename instead
+    # Cause: value of tag filename and attribute
+    # filename have different content, the latter
+    # holds the filename with full path (like the
+    # sourcefile tag) and the former the basename
+    # of the filename also there is no official
+    # "original tag name" for sourcefile
+    %w(directory filename sourcefile).each do |t|
+      @values.delete(t)
+    end
   end
 
-  def set_attributes_by_heuristic
-    self.composite = tags.include?('ImageSize') ? true : false
-    self.numerical = self.file_size.kind_of?(Integer) ? true : false
-    self.timestamps = self.FileModifyDate.kind_of?(DateTime) ? DateTime : Time
+  def set_opts_by_heuristic
+    @opts[:composite] = tags.include?('ImageSize')
+    @opts[:numerical] = self.file_size.kind_of?(Integer)
+    @opts[:timestamps] = self.FileModifyDate.kind_of?(DateTime) ? DateTime : Time
   end
 
   def self.pstore_get attribute

data/test/helpers_for_test.rb

@@ -25,4 +25,9 @@ module TempfileTest
   def teardown
     @temp_file.close
   end
+
+  def assert_md5 md5, filename
+    assert_equal md5,  Digest::MD5.hexdigest(File.read(filename))
+  end
+
 end

data/test/test_cop_tags_from.rb

@@ -0,0 +1,55 @@
+# -- encoding: utf-8 --
+require 'helpers_for_test'
+
+class TestCopyTagsFrom < TestCase
+
+  include TempfileTest
+
+  def setup
+    super
+    @canon_filename = @data_dir + '/Canon.jpg'
+    FileUtils.cp(@canon_filename, @temp_filename)
+    @mini_exiftool = MiniExiftool.new(@temp_filename)
+    @source_filename = @data_dir + '/test.jpg'
+    @canon_md5 = Digest::MD5.hexdigest(File.read(@canon_filename))
+    @source_md5 = Digest::MD5.hexdigest(File.read(@source_filename))
+  end
+
+  def test_single_tag
+    assert_nil @mini_exiftool.title
+    res = @mini_exiftool.copy_tags_from(@source_filename, :title)
+    assert res
+    assert_equal 'Abenddämmerung', @mini_exiftool.title
+    assert_md5 @source_md5, @source_filename
+  end
+
+  def test_more_than_one_tag
+    assert_nil @mini_exiftool.title
+    assert_nil @mini_exiftool.keywords
+    res = @mini_exiftool.copy_tags_from(@source_filename, %w[title keywords])
+    assert res
+    assert_equal 'Abenddämmerung', @mini_exiftool.title
+    assert_equal %w[Orange Rot], @mini_exiftool.keywords
+    assert_md5 @source_md5, @source_filename
+  end
+
+  def test_non_existing_sourcefile
+    assert_raises MiniExiftool::Error do
+      @mini_exiftool.copy_tags_from('non_existend_file', :title)
+    end
+    assert_md5 @source_md5, @source_filename
+  end
+
+  def test_non_existend_tag
+    @mini_exiftool.copy_tags_from(@source_filename, :non_existend_tag)
+    assert_md5 @canon_md5, @canon_filename
+    assert_md5 @source_md5, @source_filename
+  end
+
+  def test_non_writable_tag
+    @mini_exiftool.copy_tags_from(@source_filename, 'JFIF')
+    assert_md5 @canon_md5, @canon_filename
+    assert_md5 @source_md5, @source_filename
+  end
+
+end

data/test/test_dumping.rb

@@ -16,15 +16,16 @@ class TestDumping < TestCase
     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 = ''
+    different_tag = ''
+    v = ''
     hash.each do |k,v|
       unless @mini_exiftool[k] == v
         all_ok = false
-        diffenent_tag = k
+        different_tag = k
         break
       end
     end
-    assert all_ok, "Tag #{diffenent_tag}: expected: #{@mini_exiftool[diffenent_tag]}, actual: v"
+    assert all_ok, "Tag #{different_tag.inspect}: expected: #{@mini_exiftool[different_tag].inspect}, actual: #{v.inspect}"
   end
 
   def test_from_hash
@@ -33,15 +34,15 @@ class TestDumping < TestCase
     assert_equal MiniExiftool, mini_exiftool_new.class
     assert_equal @mini_exiftool.tags.size, mini_exiftool_new.tags.size
     all_ok = true
-    diffenent_tag = ''
+    different_tag = ''
     @mini_exiftool.tags.each do |tag|
       unless @mini_exiftool[tag] == mini_exiftool_new[tag]
         all_ok = false
-        diffenent_tag = tag
+        different_tag = tag
         break
       end
     end
-    assert all_ok, "Tag #{diffenent_tag}: expected: #{@mini_exiftool[diffenent_tag]}, actual: #{mini_exiftool_new[diffenent_tag]}"
+    assert all_ok, "Tag #{different_tag.inspect}: expected: #{@mini_exiftool[different_tag].inspect}, actual: #{mini_exiftool_new[different_tag].inspect}"
 
   end
 

data/test/test_invalid_byte_sequence_in_utf8.rb

@@ -11,9 +11,10 @@ class TestInvalidByteSequenceInUtf8 < TestCase
     @json = File.read(File.dirname(__FILE__) + '/data/invalid_byte_sequence_in_utf8.json')
   end
 
-  def test_invalid_byte_sequence_in_utf8_cause_error
-    assert_raises ArgumentError do
-      MiniExiftool.from_json(@json)
+  def test_invalid_byte_sequence_gets_unconverted_value_with_invalid_encoding
+    assert_nothing_raised do
+      mini_exiftool = MiniExiftool.from_json(@json)
+      assert_equal 1561, mini_exiftool.color_balance_unknown.size
     end
   end
 

metadata

@@ -1,39 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: mini_exiftool
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.1
 description: ''
 email: janfri26@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
-- Changelog
 - COPYING
+- Changelog
+- README.rdoc
 - Rakefile
+- Tutorial.rdoc
 - lib/mini_exiftool.rb
 - test/data/Bad_PreviewIFD.jpg
 - test/data/Canon.jpg
@@ -48,6 +49,7 @@ files:
 - test/test_bad_preview_ifd.rb
 - test/test_class_methods.rb
 - test/test_composite.rb
+- test/test_cop_tags_from.rb
 - test/test_dumping.rb
 - test/test_encodings.rb
 - test/test_filename_access.rb
@@ -60,7 +62,6 @@ files:
 - test/test_special.rb
 - test/test_special_dates.rb
 - test/test_write.rb
-- Tutorial.rdoc
 homepage: http://gitorious.org/mini_exiftool
 licenses: []
 metadata: {}
@@ -77,17 +78,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).