mini_exiftool 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 159cfbc0f0d31089460212c5e262d0f33741fab9
-  data.tar.gz: 5371c34ee8764f93c172b45d831d0b5ef25f39d6
+  metadata.gz: 1503e85ca2e2cb25cee0dc50a680d6c1641c8000
+  data.tar.gz: 01bc4385657a026eb0fe93a5a8969c1ceb14665e
 SHA512:
-  metadata.gz: b954c6e2d92c8a355a2d1be4b84f321ee5f8ecdd2a1005ab02f9a4898080ab92514df488e306d4124e3fc8f1e714aa5e23e313a9b8440992682ca59354854ea8
-  data.tar.gz: 31d4634627c91a491018ae78cc768c692f54c2e080b4cf5da827ce8bfa50adadb52625448932f1fb1361880ba17f2048e1550c3e969394b5920b54a2f311b57e
+  metadata.gz: 40d2c11befb48e3e024b45d770d572ead5dbc088bc8497f10ff9fad5a930bffdbea19ded6da5248f376d7a5442758ed4ff5739cf78dedbfee3161eac98ba04e6
+  data.tar.gz: d4f821e8f2c389e7b0f32f54eea60db3b9d72f1b1bddfbbaba421287550c03181f325348f906e4becd432f25592f0a8f615789545a80b30c799787efaad0dbf2

data/Changelog

@@ -1,3 +1,10 @@
+2.3.0
+- New options :exif_encoding, :iptc_encodings,
+  :xmp_encodings etc. to change specific encodings
+  See -charset option of the exiftool commandline
+  application
+- Some internal improvements
+
 2.2.1
 - Bugfix: Ignore filename specific tags to avoid encoding
   confusions.

data/Rakefile

@@ -1,7 +1,6 @@
 require 'rim'
 require 'rim/check_version'
 require 'rim/gem'
-require 'rim/rdoc'
 require 'rim/test'
 
 $:.unshift 'lib'
@@ -15,7 +14,6 @@ Rim.setup do |p|
   p.summary = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
   p.homepage = 'http://gitorious.org/mini_exiftool'
   p.gem_files << 'Tutorial.rdoc'
-  p.rdoc_files << 'Tutorial.rdoc'
   p.install_message = %q{
 +-----------------------------------------------------------------------+
 | Please ensure you have installed exiftool at least version 7.65       |

data/lib/mini_exiftool.rb

@@ -25,6 +25,8 @@ require 'time'
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
+  VERSION = '2.3.0'
+
   # Name of the Exiftool command-line application
   @@cmd = 'exiftool'
 
@@ -35,11 +37,31 @@ class MiniExiftool
   # Encoding of the filesystem (filenames in command line)
   @@fs_enc = Encoding.find('filesystem')
 
-  attr_reader :filename
-  attr_accessor :numerical, :composite, :ignore_minor_errors, :errors,
+  def self.opts_accessor *attrs
+    attrs.each do |a|
+      define_method a do
+        @opts[a]
+      end
+      define_method "#{a}=" do |val|
+        @opts[a] = val
+      end
+    end
+  end
+
+  attr_reader :filename, :errors
+
+  opts_accessor :numerical, :composite, :ignore_minor_errors,
     :replace_invalid_chars, :timestamps
 
-  VERSION = '2.2.1'
+  @@encoding_types = %w(exif iptc xmp png id3 pdf photoshop quicktime aiff mie vorbis)
+
+  def self.encoding_opt enc_type
+    (enc_type.to_s + '_encoding').to_sym
+  end
+
+  @@encoding_types.each do |enc_type|
+    opts_accessor encoding_opt(enc_type)
+  end
 
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
@@ -59,20 +81,21 @@ 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>!
+  # * <code>:exif_encoding</code>, <code>:iptc_encoding</code>,
+  #   <code>:xmp_encoding</code>, <code>:png_encoding</code>,
+  #   <code>:id3_encoding</code>, <code>:pdf_encoding</code>,
+  #   <code>:photoshop_encoding</code>, <code>:quicktime_encoding</code>,
+  #   <code>:aiff_encoding</code>, <code>:mie_encoding</code>,
+  #   <code>:vorbis_encoding</code> to set this specific encoding (see
+  #   -charset option of the exiftool command-line application, default is
+  #   +nil+: no encoding specified)
   def initialize filename=nil, opts={}
-    opts = @@opts.merge opts
-    @numerical = opts[:numerical]
-    @composite = opts[:composite]
-    if opts[:convert_encoding]
+    @opts = @@opts.merge opts
+    if @opts[:convert_encoding]
       warn 'Option :convert_encoding is not longer supported!'
       warn 'Please use the String#encod* methods.'
     end
-    @ignore_minor_errors = opts[:ignore_minor_errors]
-    @timestamps = opts[:timestamps]
-    @coord_format = opts[:coord_format]
-    @replace_invalid_chars = opts[:replace_invalid_chars]
     @values = TagHash.new
-    @tag_names = TagHash.new
     @changed_values = TagHash.new
     @errors = TagHash.new
     load filename unless filename.nil?
@@ -104,12 +127,16 @@ class MiniExiftool
     end
     @filename = filename
     @values.clear
-    @tag_names.clear
     @changed_values.clear
     params = '-j '
-    params << (@numerical ? '-n ' : '')
-    params << (@composite ? '' : '-e ')
-    params << (@coord_format ? "-c \"#{@coord_format}\"" : '')
+    params << (@opts[:numerical] ? '-n ' : '')
+    params << (@opts[:composite] ? '' : '-e ')
+    params << (@opts[:coord_format] ? "-c \"#{@opts[:coord_format]}\"" : '')
+    @@encoding_types.each do |enc_type|
+      if enc_val = @opts[MiniExiftool.encoding_opt(enc_type)]
+        params << "-charset #{enc_type}=#{enc_val} "
+      end
+    end
     if run(cmd_gen(params, @filename))
       parse_output
     else
@@ -157,7 +184,7 @@ class MiniExiftool
 
   # Returns an array of the tags (original tag names) of the read file.
   def tags
-    @values.keys.map { |key| @tag_names[key] }
+    @values.keys.map { |key| MiniExiftool.original_tag(key) }
   end
 
   # Returns an array of all changed tags.
@@ -181,7 +208,7 @@ class MiniExiftool
       arr_val.map! {|e| convert_before_save(e)}
       params = '-q -P -overwrite_original '
       params << (arr_val.detect {|x| x.kind_of?(Numeric)} ? '-n ' : '')
-      params << (@ignore_minor_errors ? '-m ' : '')
+      params << (@opts[:ignore_minor_errors] ? '-m ' : '')
       arr_val.each do |v|
         params << %Q(-#{original_tag}=#{escape(v)} )
       end
@@ -202,7 +229,7 @@ class MiniExiftool
   def save!
     unless save
       err = []
-      self.errors.each do |key, value|
+      @errors.each do |key, value|
         err << "(#{key}) #{value}"
       end
       raise MiniExiftool::Error.new("MiniExiftool couldn't save. The following errors occurred: #{err.empty? ? "None" : err.join(", ")}")
@@ -214,7 +241,7 @@ class MiniExiftool
   def to_hash
     result = {}
     @values.each do |k,v|
-      result[@tag_names[k]] = v
+      result[MiniExiftool.original_tag(k)] = v
     end
     result
   end
@@ -353,8 +380,8 @@ class MiniExiftool
 
   def parse_output
     @output.force_encoding('UTF-8')
-    if @replace_invalid_chars && !@output.valid_encoding?
-      @output.encode!('UTF-16le', invalid: :replace, replace: @replace_invalid_chars).encode!('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)
@@ -372,12 +399,12 @@ class MiniExiftool
     when /^\d{4}:\d\d:\d\d \d\d:\d\d:\d\d/
       s = value.sub(/^(\d+):(\d+):/, '\1-\2-')
       begin
-        if @timestamps == Time
+        if @opts[:timestamps] == Time
           value = Time.parse(s)
-        elsif @timestamps == DateTime
+        elsif @opts[:timestamps] == DateTime
           value = DateTime.parse(s)
         else
-          raise MiniExiftool::Error.new("Value #@timestamps not allowed for option timestamps.")
+          raise MiniExiftool::Error.new("Value #{@opts[:timestamps]} not allowed for option timestamps.")
         end
       rescue ArgumentError
         value = false
@@ -397,7 +424,6 @@ class MiniExiftool
   end
 
   def set_value tag, value
-    @tag_names[tag] = tag
     @values[tag] = value
   end
 

data/test/test_encodings.rb

@@ -0,0 +1,19 @@
+# -- encoding: utf-8 --
+require 'helpers_for_test'
+
+class TestEncodings < TestCase
+
+  def setup
+    @data_dir = File.dirname(__FILE__) + '/data'
+    @filename_test = @data_dir + '/test_encodings.jpg'
+    @mini_exiftool = MiniExiftool.new @filename_test
+  end
+
+  def test_iptc_encoding
+    object_name = "Möhre"
+    assert_not_equal object_name, @mini_exiftool.object_name
+    correct_iptc = MiniExiftool.new(@filename_test, iptc_encoding: 'MacRoman')
+    assert_equal object_name, correct_iptc.object_name
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_exiftool
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -42,12 +42,14 @@ files:
 - test/data/test.jpg
 - test/data/test.jpg.json
 - test/data/test_coordinates.jpg
+- test/data/test_encodings.jpg
 - test/data/test_special_dates.jpg
 - test/helpers_for_test.rb
 - test/test_bad_preview_ifd.rb
 - test/test_class_methods.rb
 - test/test_composite.rb
 - test/test_dumping.rb
+- test/test_encodings.rb
 - test/test_filename_access.rb
 - test/test_from_hash.rb
 - test/test_invalid_byte_sequence_in_utf8.rb