mini_exiftool 1.5.1 → 1.6.0

data/Changelog

@@ -1,71 +1,80 @@
-v1.5.1
+1.6.0
+- Type conversion in MiniExiftool.from_hash.
+  Thanks to Ethan Soutar-Rau for the merge request.
+- Switching to rim. (No longer troubles with echoe.)
+- Exiftool version detection delayed.
+  Thanks to Sebastian Skałacki for the merge request.
+- New method MiniExiftool#save!
+  Cherry-picked commit from Wil Gieseler.
+
+1.5.1
 - Make rational values work on Ruby 1.8.7.
 
-v1.5.0
+1.5.0
 - Supporting exiftool command-line option -m.
   rubyforge request [#29587]
   Thanks to Michael Grove for reporting.
 - Supporting rational values.
 
-v1.4.4
+1.4.4
 - Fix escaping of values for older versions of Shellwords.
 
-v1.4.3
+1.4.3
 - Fixing rubyforge bug [#29596] (Quotes in values)
   Thanks to Michael Grove for reporting
 
-v1.4.2
+1.4.2
 - Add .yardopts file to gem.
 
-v1.4.1
+1.4.1
 - Update documentation for using yard.
 
-v1.4.0
+1.4.0
 - Allow symbols for tag access with [].
 - Refactoring tests.
 
-v1.3.1
+1.3.1
 - Remove TestEscapeFilename test and releating test photo
   because the latter produces errors on windows systems.
 - Version check in prerelease task.
 
-v1.3.0
+1.3.0
 - MiniExiftool is now ready for Ruby 1.9
   All tests in the test suite pass. :)
 
-v1.2.2
+1.2.2
 - Fixing ptore directory naming convention for darwin.
   Thanks to Denis Barushev for the hint.
 
-v1.2.1
+1.2.1
 - Switching to echoe.
 - Update e-mail address.
 
-v1.2.0
+1.2.0
 - Fixing time zone handling.
   Thanks to ccoenen for the hint.
 
-v1.1.0
+1.1.0
 - Escaping filenames in shell commands
   Thanks to Michael Hoy for the hint and implementing a patch which was
   the base for this fix.
 
-v1.0.2
+1.0.2
 - Fixing warings
   Thanks to Peter-Hinrich Krogmann for the hint.
 
-v1.0.1
+1.0.1
 - Fixing bug [#22726]
   Making MiniExiftool::Error public.
   Thanks to Mathias Stjernstrom for sending a patch.
 
-v1.0.0
+1.0.0
 - Be aware changing in the interface:
   - List tags (e.g. Keywords, SupplementalCategories) are now handled as
     arrays.
   - Tag SubjectLocation is not longer an array value but a string value!
 
-v0.7.0
+0.7.0
 - Changing composite behaviour: Composite tags are now included as standard!
 - New method MiniExiftool.opts which returns a hash of the standard
   options used for MiniExiftool.new
@@ -73,7 +82,7 @@ v0.7.0
   of the exiftool command-line application (see online documentation for it)
   Thanks to Henning Kulander for the causing of this change.
 
-v0.6.0
+0.6.0
 - New methods for serialization:
   - MiniExiftool.from_hash
   - MiniExiftool.from_yaml
@@ -83,20 +92,20 @@ v0.6.0
 - Refactoring of tests
 - Small documetation update
 
-v0.5.1
+0.5.1
 - Warning "parenthesize argument(s) for future version" removed
   Thanks to Greg from knobby.ws
 
-v0.5.0
+0.5.0
 - New option :timestamps to create DateTime objects instead of Time objects
   for timestamps (Fixing bug #16328)
 - Invalid values of timestamps (i.e. 0000:00:00 00:00:00) are now mapped
   to false
 
-v0.4.1
+0.4.1
 - Compatibility for Ruby 1.9
 
-v0.4.0
+0.4.0
 - MiniExiftool::Error inherits now from StandardError
 - Alternative installation via setup.rb
 - Bugfix
@@ -106,10 +115,10 @@ v0.4.0
 - Interna: Original tag names (all and writable) are now saved via pstore in
   a file for better performance
 
-v0.3.1
+0.3.1
 - Typos fixed
 
-v0.3.0
+0.3.0
 - Documentation completed and a Mini Tutorial added
 - Interface changes:
   - Test if a value for a tag can be saved is now done in
@@ -124,27 +133,27 @@ v0.3.0
     - :composite => read also composite tags
 - Tests added
 
-v0.2.0
+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
 
-v0.1.2
+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
 
-v0.1.1
+0.1.1
 - Fixing bug [#8073]
   Handling the '-' in tag Self-timer
   Thanks to Eric Young
 
-v0.1.0
+0.1.0
 - New method "revert"
 - More tests
 
-v0.0.1
+0.0.1
 - Initial release

data/Rakefile

@@ -1,12 +1,18 @@
-require 'rubygems'
-require 'echoe'
+require 'rim'
+require 'rim/check_version'
+require 'rim/gem'
+require 'rim/test'
 
-Echoe.new('mini_exiftool') do |p|
-  p.author = 'Jan Friedrich'
+$:.unshift 'lib'
+require 'mini_exiftool'
+
+Rim.setup do |p|
+  p.name = 'mini_exiftool'
+  p.version = MiniExiftool::VERSION
+  p.authors = 'Jan Friedrich'
   p.email = 'janfri26@gmail.com'
   p.summary = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
-  p.url = 'http://gitorious.org/mini_exiftool'
-  p.rdoc_files = %w(README.rdoc Tutorial.rdoc lib/*.rb)
+  p.homepage = 'http://gitorious.org/mini_exiftool'
   p.install_message = %q{
 +-----------------------------------------------------------------------+
 | Please ensure you have installed exiftool and it's found in your PATH |
@@ -14,12 +20,4 @@ Echoe.new('mini_exiftool') do |p|
 | http://www.sno.phy.queensu.ca/~phil/exiftool/install.html             |
 +-----------------------------------------------------------------------+
   }
-  p.changelog = 'Changelog'
-  task :prerelease do
-    require "#{File.dirname(__FILE__)}/lib/mini_exiftool"
-    unless p.version == MiniExiftool::VERSION
-      $stderr.puts "Version conflict: Release version is #{p.version} but MiniExiftool::VERSION is #{MiniExiftool::VERSION}."
-      exit(1)
-    end
-  end
 end

data/lib/mini_exiftool.rb

@@ -33,7 +33,7 @@ class MiniExiftool
   attr_reader :filename
   attr_accessor :numerical, :composite, :convert_encoding, :ignore_minor_errors, :errors, :timestamps
 
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
@@ -65,7 +65,7 @@ class MiniExiftool
 
   def initialize_from_hash hash # :nodoc:
     hash.each_pair do |tag,value|
-      set_value tag, value
+      set_value tag, perform_conversions(value)
     end
     set_attributes_by_heuristic
     self
@@ -73,6 +73,7 @@ class MiniExiftool
 
   # Load the tags of filename.
   def load filename
+    MiniExiftool.setup
     unless filename && File.exist?(filename)
       raise MiniExiftool::Error.new("File '#{filename}' does not exist.")
     end
@@ -145,6 +146,7 @@ class MiniExiftool
 
   # Save the changes to the file.
   def save
+    MiniExiftool.setup
     return false if @changed_values.empty?
     @errors.clear
     temp_file = Tempfile.new('mini_exiftool')
@@ -182,6 +184,16 @@ class MiniExiftool
     all_ok
   end
 
+  def save!
+    unless save
+      err = []
+      self.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(", ")}")
+    end
+  end
+
   # Returns a hash of the original loaded values of the MiniExiftool
   # instance.
   def to_hash
@@ -198,7 +210,7 @@ class MiniExiftool
     to_hash.to_yaml
   end
 
-  # Create a MiniExiftool instance from a hash
+  # Create a MiniExiftool instance from a hash. Default value conversions will be applied if neccesary.
   def self.from_hash hash
     instance = MiniExiftool.new
     instance.initialize_from_hash hash
@@ -270,15 +282,20 @@ class MiniExiftool
   private
   ############################################################################
 
-  @@error_file = Tempfile.new 'errors'
-  @@error_file.close
+  @@setup_done = false
+  def self.setup
+    return if @@setup_done
+    @@error_file = Tempfile.new 'errors'
+    @@error_file.close
 
-  if Float(exiftool_version) < 7.41
-    @@separator = ', '
-    @@sep_op = ''
-  else
-    @@separator = '@@'
-    @@sep_op = '-sep @@'
+    if Float(exiftool_version) < 7.41
+      @@separator = ', '
+      @@sep_op = ''
+    else
+      @@separator = '@@'
+      @@sep_op = '-sep @@'
+    end
+    @@setup_done = true
   end
 
   def run cmd
@@ -325,7 +342,14 @@ class MiniExiftool
 
   def parse_line line
     if line =~ /^([^\t]+)\t(.*)$/
-      tag, value = $1, $2
+      tag, value = $1, perform_conversions($2)
+    else
+      raise MiniExiftool::Error.new("Malformed line #{line.inspect} of exiftool output.")
+    end
+    return [tag, value]
+  end
+
+  def perform_conversions(value)
       case value
       when /^\d{4}:\d\d:\d\d \d\d:\d\d:\d\d/
         s = value.sub(/^(\d+):(\d+):/, '\1-\2-')
@@ -353,10 +377,7 @@ class MiniExiftool
       when /#{@@separator}/
         value = value.split @@separator
       end
-    else
-      raise MiniExiftool::Error.new("Malformed line #{line.inspect} of exiftool output.")
-    end
-    return [tag, value]
+      value
   end
 
   def set_value tag, value

data/test/data/test.jpg.json

@@ -0,0 +1,106 @@
+[{
+  "SourceFile": "test/data/test.jpg",
+  "ExifToolVersion": 8.77,
+  "FileName": "test.jpg",
+  "Directory": "test/data",
+  "FileSize": "46 kB",
+  "FileModifyDate": "2012:07:05 20:28:24-07:00",
+  "FilePermissions": "rw-r--r--",
+  "FileType": "JPEG",
+  "MIMEType": "image/jpeg",
+  "JFIFVersion": 1.01,
+  "ExifByteOrder": "Big-endian (Motorola, MM)",
+  "ImageDescription": "KONICA MINOLTA DIGITAL CAMERA",
+  "Make": "KONICA MINOLTA",
+  "Model": "DYNAX 7D",
+  "Orientation": "Horizontal (normal)",
+  "XResolution": 72,
+  "YResolution": 72,
+  "ResolutionUnit": "inches",
+  "Software": "DYNAX 7D v1.10",
+  "ModifyDate": "2005:09:13 20:08:50",
+  "YCbCrPositioning": "Centered",
+  "ExposureTime": "1/60",
+  "FNumber": 9.5,
+  "ExposureProgram": "Program AE",
+  "ISO": 400,
+  "ExifVersion": "0221",
+  "DateTimeOriginal": "2005:09:13 20:08:50",
+  "CreateDate": "2005:09:13 20:08:50",
+  "ComponentsConfiguration": "Y, Cb, Cr, -",
+  "BrightnessValue": 4.5,
+  "ExposureCompensation": -1,
+  "MaxApertureValue": 4.5,
+  "MeteringMode": "Multi-segment",
+  "LightSource": "Unknown",
+  "Flash": "Off, Did not fire",
+  "FocalLength": "75.0 mm",
+  "SubjectArea": "1504 1000 256 304",
+  "MakerNoteVersion": "MLT0",
+  "MinoltaImageSize": "Large",
+  "WhiteBalance": "Auto",
+  "FocusMode": "AF-A",
+  "AFPoints": "Center",
+  "FlashMode": "Normal",
+  "ISOSetting": 400,
+  "FreeMemoryCardImages": 202,
+  "HueAdjustment": 0,
+  "Rotation": "Horizontal (normal)",
+  "ImageNumber": 6,
+  "NoiseReduction": "Unknown (2)",
+  "ImageNumber2": 50,
+  "ZoneMatchingOn": "Off",
+  "CompressedImageSize": 1598477,
+  "PreviewImageStart": 39152,
+  "PreviewImageLength": 0,
+  "SceneMode": "Standard",
+  "ColorMode": "Natural sRGB",
+  "MinoltaQuality": "Fine",
+  "FlashExposureComp": 0,
+  "Teleconverter": "None",
+  "ImageStabilization": "On",
+  "ZoneMatching": "ISO Setting Used",
+  "ColorTemperature": 0,
+  "LensType": "Minolta AF 28-135mm F4-4.5 or Sigma Lens",
+  "UserComment": "",
+  "FlashpixVersion": "0100",
+  "ColorSpace": "sRGB",
+  "ExifImageWidth": 3008,
+  "ExifImageHeight": 2000,
+  "CustomRendered": "Normal",
+  "ExposureMode": "Auto",
+  "DigitalZoomRatio": 0,
+  "FocalLengthIn35mmFormat": "112 mm",
+  "SceneCaptureType": "Standard",
+  "GainControl": "Low gain up",
+  "Contrast": "Normal",
+  "Saturation": "Normal",
+  "Sharpness": "Normal",
+  "PrintIMVersion": "0300",
+  "Compression": "JPEG (old-style)",
+  "ThumbnailOffset": 39274,
+  "ThumbnailLength": 1820,
+  "CurrentIPTCDigest": "dd8d51d28ddf04f08f870e5ff2f64d01",
+  "Keywords": ["Orange","Rot"],
+  "ApplicationRecordVersion": 4,
+  "SupplementalCategories": "Natur",
+  "XMPToolkit": "Image::ExifTool 7.03",
+  "Title": "Abenddämmerung",
+  "ImageWidth": 300,
+  "ImageHeight": 199,
+  "EncodingProcess": "Baseline DCT, Huffman coding",
+  "BitsPerSample": 8,
+  "ColorComponents": 3,
+  "YCbCrSubSampling": "YCbCr4:2:0 (2 2)",
+  "Aperture": 9.5,
+  "ImageSize": "300x199",
+  "LensID": "Minolta AF 28-135mm F4-4.5",
+  "ScaleFactor35efl": 1.5,
+  "ShutterSpeed": "1/60",
+  "ThumbnailImage": "(Binary data 1820 bytes)",
+  "CircleOfConfusion": "0.020 mm",
+  "FOV": "18.3 deg",
+  "FocalLength35efl": "75.0 mm (35 mm equivalent: 112.0 mm)",
+  "HyperfocalDistance": "29.43 m",
+  "LightValue": 10.4
+}]

data/test/test_from_hash.rb

@@ -0,0 +1,22 @@
+require 'helpers_for_test'
+require 'json'
+
+class TestFromHash < TestCase
+  def setup
+    @data_dir = File.dirname(__FILE__) + '/data'
+    hash_data = JSON.parse(File.read( @data_dir + '/test.jpg.json')).first
+    @mini_exiftool = MiniExiftool.from_hash hash_data
+  end
+
+  def test_conversion
+    assert_kind_of String, @mini_exiftool.model
+    assert_kind_of Time, @mini_exiftool['DateTimeOriginal']
+    assert_kind_of Float, @mini_exiftool['MaxApertureValue']
+    assert_kind_of String, @mini_exiftool.flash
+    assert_kind_of Fixnum, @mini_exiftool['ExposureCompensation']
+    assert_kind_of String, (@mini_exiftool['SubjectLocation'] || @mini_exiftool['SubjectArea'])
+    assert_kind_of Array, @mini_exiftool['Keywords']
+    assert_kind_of String, @mini_exiftool['SupplementalCategories']
+    assert_kind_of Rational, @mini_exiftool.shutterspeed
+  end
+end