mini_exiftool 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e46fda672ff0194288aedc9f72b4cbc2f08c6c56
-  data.tar.gz: 2b1500c99a0ee477b446aa1df8fc1fae941df681
+  metadata.gz: cdeb9b98998342750a3fcbae84d333e667292f58
+  data.tar.gz: c71bdba7f4db16bc4ef8b939d97fbce7bc595117
 SHA512:
-  metadata.gz: f525d67968f75a1090404af11f016357f687a1852afb65503cafd8adc976d315bb93001e07e82281d2e3b267b9bafff73e1a3730d0bae6649a82d0370ec33013
-  data.tar.gz: 8db4eceb1025a4818d6fa2f2bc1ee5cff356ab62691f3fc6e104d226c9fbe9c80b99f4fc0195026329ea62b12ae735b827d42da13a2c650b086370961b5a3aea
+  metadata.gz: a9d3353b6a770152ae4a914699bfa633ef5d2943ce610b2c72c5fb316a827aa2ac46cb5b93ae66d14fe7ee6d14aad2cee750a94ca540ab83dc9f5227f152a78f
+  data.tar.gz: ee36b1a1febb01b4c83904a55eb5c6539efe24a7749379d6a25107f5445f61d28fbb96b5b65eede550acd8f03ecaf4b379f57b02641bcdcf783d45c33cdabaf6

data/Changelog

@@ -1,3 +1,9 @@
+2.6.0
+- Support reading from IO instances.
+- New option :fast to increase speed when extracting information from JPEG
+  images which are piped across a slow network connection.
+- Refactoring: Use Open3 for all command-line calls.
+
 2.5.1
 - Add gemspec.
 

data/README.rdoc

@@ -128,7 +128,7 @@ feel free to contribute!
 Jan Friedrich <janfri26@gmail.com>
 
 == Copyright / License
-Copyright (c) 2007-2014 by Jan Friedrich
+Copyright (c) 2007-2016 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/lib/mini_exiftool.rb

@@ -8,13 +8,14 @@
 # Read and write access is done in a clean OO manner.
 #
 # Author: Jan Friedrich
-# Copyright (c) 2007-2014 by Jan Friedrich
+# Copyright (c) 2007-2016 by Jan Friedrich
 # Licensed under the GNU LESSER GENERAL PUBLIC LICENSE,
 # Version 2.1, February 1999
 #
 
 require 'fileutils'
 require 'json'
+require 'open3'
 require 'pstore'
 require 'rational'
 require 'rbconfig'
@@ -25,13 +26,13 @@ require 'time'
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
-  VERSION = '2.5.1'
+  VERSION = '2.6.0'
 
   # Name of the Exiftool command-line application
   @@cmd = 'exiftool'
 
   # Hash of the standard options used when call MiniExiftool.new
-  @@opts = { :numerical => false, :composite => true, :ignore_minor_errors => false,
+  @@opts = { :numerical => false, :composite => true, :fast => false, :ignore_minor_errors => false,
    :replace_invalid_chars => false, :timestamps => Time }
 
   # Encoding of the filesystem (filenames in command line)
@@ -48,7 +49,7 @@ class MiniExiftool
     end
   end
 
-  attr_reader :filename, :errors
+  attr_reader :filename, :errors, :io
 
   opts_accessor :numerical, :composite, :ignore_minor_errors,
     :replace_invalid_chars, :timestamps
@@ -72,6 +73,8 @@ class MiniExiftool
   # * <code>:coord_format</code> set format for GPS coordinates (See
   #   -c-option of the exiftool command-line application, default is +nil+
   #   that means exiftool standard)
+  # * <code>:fast</code> useful when reading JPEGs over a slow network connection
+  #   (See -fast-option of the exiftool command-line application, default is +false+)
   # * <code>:replace_invalid_chars</code> replace string for invalid
   #   UTF-8 characters or +false+ if no replacing should be done,
   #   default is +false+
@@ -89,16 +92,18 @@ class MiniExiftool
   #   <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={}
+  def initialize filename_or_io=nil, opts={}
     @opts = @@opts.merge opts
     if @opts[:convert_encoding]
       warn 'Option :convert_encoding is not longer supported!'
       warn 'Please use the String#encod* methods.'
     end
+    @filename = nil
+    @io = nil
     @values = TagHash.new
     @changed_values = TagHash.new
     @errors = TagHash.new
-    load filename unless filename.nil?
+    load filename_or_io unless filename_or_io.nil?
   end
 
   def initialize_from_hash hash # :nodoc:
@@ -114,22 +119,30 @@ class MiniExiftool
     self
   end
 
-  # 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
-    if File.directory?(filename)
-      raise MiniExiftool::Error.new("'#{filename}' is a directory.")
+  # Load the tags of filename or io.
+  def load filename_or_io
+    case filename_or_io
+    when String
+      unless filename_or_io && File.exist?(filename_or_io)
+        raise MiniExiftool::Error.new("File '#{filename_or_io}' does not exist.")
+      end
+      if File.directory?(filename_or_io)
+        raise MiniExiftool::Error.new("'#{filename_or_io}' is a directory.")
+      end
+      @filename = filename_or_io
+    when IO
+      @io = filename_or_io
+      @filename = '-'
+    else
+      raise MiniExiftool::Error.new("Could not open filename_or_io.")
     end
-    @filename = filename
     @values.clear
     @changed_values.clear
     params = '-j '
     params << (@opts[:numerical] ? '-n ' : '')
     params << (@opts[:composite] ? '' : '-e ')
     params << (@opts[:coord_format] ? "-c \"#{@opts[:coord_format]}\"" : '')
+    params << (@opts[:fast] ? '-fast ' : '')
     params << generate_encoding_params
     if run(cmd_gen(params, @filename))
       parse_output
@@ -188,7 +201,9 @@ class MiniExiftool
 
   # Save the changes to the file.
   def save
-    MiniExiftool.setup
+    if @io
+      raise MiniExiftool::Error.new('No writing support when using an IO.')
+    end
     return false if @changed_values.empty?
     @errors.clear
     temp_file = Tempfile.new('mini_exiftool')
@@ -324,11 +339,11 @@ class MiniExiftool
 
   # Returns the version of the Exiftool command-line application.
   def self.exiftool_version
-    output = `#{MiniExiftool.command} -ver 2>&1`
-    unless $?.exitstatus == 0
-      raise MiniExiftool::Error.new("Command '#{MiniExiftool.command}' not found")
+    Open3.popen3 "#{MiniExiftool.command} -ver" do |_inp, out, _err, _thr|
+      out.read.chomp!
     end
-    output.chomp!
+  rescue SystemCallError
+    raise MiniExiftool::Error.new("Command '#{MiniExiftool.command}' not found")
   end
 
   def self.unify tag
@@ -358,14 +373,6 @@ class MiniExiftool
   private
   ############################################################################
 
-  @@setup_done = false
-  def self.setup
-    return if @@setup_done
-    @@error_file = Tempfile.new 'errors'
-    @@error_file.close
-    @@setup_done = true
-  end
-
   def cmd_gen arg_str='', filename
     [@@cmd, arg_str.encode('UTF-8'), escape(filename.encode(@@fs_enc))].map {|s| s.force_encoding('UTF-8')}.join(' ')
   end
@@ -374,16 +381,22 @@ class MiniExiftool
     if $DEBUG
       $stderr.puts cmd
     end
-    @output = `#{cmd} 2>#{@@error_file.path}`
-    @status = $?
-    unless @status.exitstatus == 0
-      @error_text = File.readlines(@@error_file.path).join
-      @error_text.force_encoding('UTF-8')
-      return false
-    else
-      @error_text = ''
-      return true
+    status = Open3.popen3(cmd) do |inp, out, err, thr|
+      if @io
+        begin
+          data = @io.read
+        rescue Exception
+          raise MiniExiftool::Error.new("IO is not readable.")
+        end
+        inp.write data
+        @io.close
+        inp.close
+      end
+      @output = out.read
+      @error_text = err.read
+      thr.value.exitstatus
     end
+    status == 0
   end
 
   def convert_before_save val

data/test/test_class_methods.rb

@@ -63,13 +63,13 @@ class TestClassMethods < TestCase
   def test_all_tags
     all_tags = MiniExiftool.all_tags
     assert all_tags.include?('ISO')
-    assert all_tags.include?('OriginalFilename')
+    assert all_tags.include?('ExifToolVersion')
   end
 
   def test_writable_tags
     w_tags = MiniExiftool.writable_tags
     assert w_tags.include?('ISO')
-    assert_equal false, w_tags.include?('xxxxxx')
+    assert ! w_tags.include?('ExifToolVersion')
   end
 
   def test_exiftool_version

data/test/test_io.rb

@@ -0,0 +1,62 @@
+# -- encoding: utf-8 --
+require 'helpers_for_test'
+require 'stringio'
+
+class TestIo < TestCase
+
+  def test_simple_case
+    io = open_real_io
+    mini_exiftool = MiniExiftool.new(io)
+    assert io.closed?, 'IO should be closed after reading data.'
+    assert_equal 400, mini_exiftool.iso
+  end
+
+  def test_non_readable_io
+    assert_raises MiniExiftool::Error do
+      begin
+        MiniExiftool.new($stdout)
+      rescue MiniExiftool::Error => e
+        assert_equal 'IO is not readable.', e.message
+        raise e
+      end
+    end
+  end
+
+  def test_no_writing_when_using_io
+    io = open_real_io
+    m = MiniExiftool.new(io)
+    m.iso = 100
+    assert_raises MiniExiftool::Error do
+      begin
+        m.save
+      rescue MiniExiftool::Error => e
+        assert_equal 'No writing support when using an IO.', e.message
+        raise e
+      end
+    end
+  end
+
+  def test_fast_option
+    $DEBUG = true
+    s = StringIO.new
+    $stderr = s
+    MiniExiftool.new open_real_io
+    s.rewind
+    assert_equal 'exiftool -j  "-"', s.read.chomp
+    s = StringIO.new
+    $stderr = s
+    MiniExiftool.new open_real_io, :fast => true
+    s.rewind
+    assert_equal 'exiftool -j -fast  "-"', s.read.chomp
+  ensure
+    $DEBUG = false
+    $stderr = STDERR
+  end
+
+  protected
+
+  def open_real_io
+    File.open(File.join(File.dirname(__FILE__), 'data', 'test.jpg'), 'r')
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_exiftool
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2016-04-04 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_io.rb
 - test/test_pstore.rb
 - test/test_read.rb
 - test/test_read_coordinates.rb
@@ -92,9 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.6.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).
 test_files: []
-has_rdoc: