mini_exiftool 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85c8d58c8a6e5dd3372fab24ddcbad3d8ec940a5
-  data.tar.gz: 2de6dc0ca9ea4fc221d9e019dca237d555c8bc13
+  metadata.gz: b0e0fe3eca725bd05c5eef9f9907856e213e08c8
+  data.tar.gz: 20d86a8c55a4da6bab8f34a35c14e465bb9bde5b
 SHA512:
-  metadata.gz: 01aafd921026ba2f6828cb3cb1355d86bfaa9dbac7b5d09da7db514aa3109b4d88680ea702bf7fbba4b3360bf6c35f6336c5770dbb7d29e518af66e24380e87f
-  data.tar.gz: 2d7b5ef57000167e18523b47cf9945a6c74598469be6d74957e2095bd29b78dc7ebcae8e3dbea854eba4847a334906d6c188fa3cd79b9d7c375451805f513665
+  metadata.gz: f2dd6a906910217fff909a4302edf1b7836c9aeef8721dba8df8639c71462711259389319c8fa5457af119030cc98bee14547736faba93b8f14d5f7e9d360c86
+  data.tar.gz: 3dc83dc895f1f1349e4493cab61685a631014db5325da40250a1d54a3085af00d5c73e91e52cd3ce4bf1478e09465cdc9ea7e2b4d895891b133283939b2e6803

data/Changelog

@@ -1,3 +1,10 @@
+2.5.0
+- Make the pstore dir customizable:
+  MiniExiftool.pstore_dir and MiniExiftool.pstore_dir=
+  Thanks to Shawn Pyle for the idea and a first approach
+  of implementation.
+- Update README.
+
 2.4.2
 - Bugfix: Don't ignoring *_encoding options when saving.
 

data/README.rdoc

@@ -27,6 +27,23 @@ install the gem with
 If you need to support older versions of Ruby or exiftool (see Requirements above)
   gem install --version "< 2.0.0" mini_exiftool
 
+== Configuration
+
+You can manually set the exiftool command that should be used via
+  MiniExiftool.command = '/path/to/my/exiftool'
+
+In addition, you can also tell MiniExiftool where to store the PStore files with tags
+which exiftool supports. The PStore files are used for performance issues.
+Per default the PStore files are stored in a sub directory .mini_exiftool or
+_mini_exiftool under your home directory.
+  MiniExiftool.pstore_dir = '/path/to/pstore/dir'
+
+If you're using Rails, this is easily done with
+  MiniExiftool.pstore_dir = Rails.root.join('tmp').to_s
+
+Important hint: if you have to change the configuration you have to do this direct
+after require 'mini_exiftool'.
+
 == Usage
 
 In general MiniExiftool is very intuitive to use as the following examples show:
@@ -49,6 +66,56 @@ 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.
 
+== Encodings
+
+In MiniExiftool all strings are encoded in UTF-8. If you need other
+encodings in your project use the String#encod* methods.
+
+If you have problems with corrupted strings when using MiniExiftool
+there are two reasons for this:
+
+=== Internal character sets
+
+You can specify the charset in which the meta data is in the file encoded
+if you read or write to some sections of meta data (i.e. IPTC, XMP ...).
+It exists various options of the form *_encoding: exif, iptc, xmp, png,
+id3, pdf, photoshop, quicktime, aiff, mie and vorbis.
+
+For IPTC meta data it is recommended to set also the CodedCharacterSet
+tag.
+
+Please read the section about the character sets of the ExifTool command
+line application carefully to understand what's going on
+(http://www.sno.phy.queensu.ca/~phil/exiftool/faq.html#Q10)!
+
+ # Using UTF-8 as internal encoding for IPTC tags and MacRoman
+ # as internal encoding for EXIF tags
+ photo = MiniExiftool.new('photo.jpg', iptc_encoding: 'UTF8',
+                          exif_encoding: 'MacRoman'
+ # IPTC CaptionAbstract is already UTF-8 encoded
+ puts photo.caption_abstract
+ # EXIF Comment is converted from MacRoman to UTF-8
+ puts photo.comment
+
+ photo = MiniExiftool.new('photo.jpg', iptc_encoding: 'UTF8',
+                          exif_encoding: 'MacRoman'
+ # When saving IPTC data setting CodedCharacterSet as recommended
+ photo.coded_character_set = 'UTF8'
+ # IPTC CaptionAbstract will be stored in UTF-8 encoding
+ photo.caption_abstract = 'Some text with Ümläuts'
+ # EXIF Comment will be stored in MacRoman encoding
+ photo.comment = 'Comment with Ümläuts'
+ photo.save
+
+=== Corrupt characters
+
+You use the correct internal character set but in the string are still corrupt
+characters.
+This problem you can solve with the option replace_invalid_chars:
+
+ # Replace all invalid characters with a question mark
+ photo = MiniExiftool.new('photo.jpg', replace_invalid_chars: '?')
+
 == Contribution
 
 The code is hosted in a git repository on Gitorious at

data/lib/mini_exiftool.rb

@@ -25,7 +25,7 @@ require 'time'
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
-  VERSION = '2.4.2'
+  VERSION = '2.5.0'
 
   # Name of the Exiftool command-line application
   @@cmd = 'exiftool'
@@ -335,6 +335,22 @@ class MiniExiftool
     tag.to_s.gsub(/[-_]/,'').downcase
   end
 
+  @@running_on_windows = /mswin|mingw|cygwin/ === RbConfig::CONFIG['host_os']
+
+  def self.pstore_dir
+    unless defined? @@pstore_dir
+      # This will hopefully work on *NIX and Windows systems
+      home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] || ENV['USERPROFILE']
+      subdir = @@running_on_windows ? '_mini_exiftool' : '.mini_exiftool'
+      @@pstore_dir = File.join(home, subdir)
+    end
+    @@pstore_dir
+  end
+
+  def self.pstore_dir= dir
+    @@pstore_dir = dir
+  end
+
   # Exception class
   class MiniExiftool::Error < StandardError; end
 
@@ -462,14 +478,9 @@ class MiniExiftool
     result
   end
 
-  @@running_on_windows = /mswin|mingw|cygwin/ === RbConfig::CONFIG['host_os']
-
   def self.load_or_create_pstore
-    # This will hopefully work on *NIX and Windows systems
-    home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] || ENV['USERPROFILE']
-    subdir = @@running_on_windows ? '_mini_exiftool' : '.mini_exiftool'
-    FileUtils.mkdir_p(File.join(home, subdir))
-    pstore_filename = File.join(home, subdir, 'exiftool_tags_' << exiftool_version.gsub('.', '_') << '.pstore')
+    FileUtils.mkdir_p(pstore_dir)
+    pstore_filename = File.join(pstore_dir, 'exiftool_tags_' << exiftool_version.gsub('.', '_') << '.pstore')
     @@pstore = PStore.new pstore_filename
     if !File.exist?(pstore_filename) || File.size(pstore_filename) == 0
       @@pstore.transaction do |ps|

data/test/test_pstore.rb

@@ -0,0 +1,24 @@
+# -- encoding: utf-8 --
+require 'helpers_for_test'
+
+class TestPstore < TestCase
+
+  def test_pstore
+    pstore_dir = Dir.mktmpdir
+    s = MiniExiftool.writable_tags.size.to_s
+    cmd = %Q(#{RUBY_ENGINE} -EUTF-8 -I lib -r mini_exiftool -e "MiniExiftool.pstore_dir = '#{pstore_dir}'; p MiniExiftool.writable_tags.size")
+    a = Time.now
+    result = `#{cmd}`
+    b = Time.now
+    assert_equal s, result.chomp
+    assert_equal 1, Dir[File.join(pstore_dir, '*')].size
+    c = Time.now
+    result = `#{cmd}`
+    d = Time.now
+    assert_equal s, result.chomp
+    assert 10 * (d - c) < (b - a)
+  ensure
+    FileUtils.rm_rf pstore_dir
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_exiftool
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -57,6 +57,7 @@ files:
 - test/test_from_hash.rb
 - test/test_invalid_byte_sequence_in_utf8.rb
 - test/test_invalid_rational.rb
+- test/test_pstore.rb
 - test/test_read.rb
 - test/test_read_coordinates.rb
 - test/test_read_numerical.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).