mini_exiftool 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdeb9b98998342750a3fcbae84d333e667292f58
-  data.tar.gz: c71bdba7f4db16bc4ef8b939d97fbce7bc595117
+  metadata.gz: 8a1a8c6d521b719133ac256c568185efbb46b261
+  data.tar.gz: 538c8f074435883a599b39a522e4e24d15c8a7d6
 SHA512:
-  metadata.gz: a9d3353b6a770152ae4a914699bfa633ef5d2943ce610b2c72c5fb316a827aa2ac46cb5b93ae66d14fe7ee6d14aad2cee750a94ca540ab83dc9f5227f152a78f
-  data.tar.gz: ee36b1a1febb01b4c83904a55eb5c6539efe24a7749379d6a25107f5445f61d28fbb96b5b65eede550acd8f03ecaf4b379f57b02641bcdcf783d45c33cdabaf6
+  metadata.gz: cd2cbfa6f6b5b0f11d30dec2c7a0b4cbd6566120d7a86065d62340607ba746bd0ea0ec7d07d45f1a88c77d96357cca9750b1ba49be72bc135a9f51d2520bda5a
+  data.tar.gz: 1ae605775fb808b8e26b486c6addd8c99c0b5d859b0c159fadbd888578b5aa7f09eeafdff2c9dd958e2174e86b3537af4c375f420178bc948e91b2ee3fe5fd79

data/Changelog

@@ -1,7 +1,16 @@
+2.7.0
+- Use duck typing to determine if filename_or_io is a filename or an IO
+  instance.
+- New option :fast2.
+- Add example show_speedup_with_fast_option.
+- Update docs.
+
 2.6.0
 - Support reading from IO instances.
+  Thanks to Gaelan <gbs@canishe.com> for the idea.
 - New option :fast to increase speed when extracting information from JPEG
   images which are piped across a slow network connection.
+  Thanks to Felipe Cypriano <felipe@cypriano.me> for the idea.
 - Refactoring: Use Open3 for all command-line calls.
 
 2.5.1

data/README.rdoc

@@ -48,10 +48,14 @@ after require 'mini_exiftool'.
 
 In general MiniExiftool is very intuitive to use as the following examples show:
 
- # Reading meta data
+ # Reading meta data from a file
  photo = MiniExiftool.new 'photo.jpg'
  puts photo.title
 
+ # Alternative reading meta data from an IO instance
+ photo = MiniExiftool.new io
+ puts photo.title
+
  # Writing meta data
  photo = MiniExiftool.new 'photo.jpg'
  photo.title = 'This is the new title'

data/Tutorial.rdoc

@@ -17,7 +17,6 @@
  photo = MiniExiftool.new 'photo.jpg'
  puts photo['DateTimeOriginal']
 
-
 === Smart Tag Names
 In the example above we use <code>photo['DateTimeOriginal']</code> to
 get the value for the time the photo was taken. But tag names are not
@@ -41,7 +40,6 @@ using dynamic method access. You can write:
 or also
  photo.date_time_original
 
-
 === Value Types
 
 Following types of values are at the moment supported:
@@ -52,7 +50,7 @@ Following types of values are at the moment supported:
 * Time (e. g. DateTimeOriginal => 2005:09:13 20:08:50)
 
 Be aware, if there is only one value in a tag which can hold multiple
-values the result is'nt an array! But you can get one with the Array
+values the result isn't an array! But you can get one with the Array
 method:
   # only _one_ keyword
   p1 = MiniExiftool.new 'p1.jpg'
@@ -103,18 +101,43 @@ Further options are
 * <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>:fast2</code> useful when reading JPEGs over a slow network connection
+  (See -fast2-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+
+* <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)
 
-=== Further Example
+=== Using an IO instance
 
-For understanding reading access to meta data also have a look at the
-example file <code>print_portraits.rb</code> in the +examples+
-directory.
+ require 'mini_exiftool'
+ require 'open3'
 
-== Lesson 2: Writing Meta Data
+ # Using external curl command
+ input, output = Open3.popen2("curl -s http://www.url.of.a.photo")
+ input.close
+ photo = MiniExiftool.new output
+ puts photo['ISO']
 
+The kind of the parameter +filename_or_io+ is determined via duck typing:
+if the argument responds to +to_str+ it is interpreted as filename, if it
+responds to +read+ it is interpreted es IO instance.
+Attention: If you use an IO instance then writing of values is not supported!
+
+Look at the show_speedup_with_fast_option example in the MiniExiftool examples
+directory for more details about using an IO instance.
+
+
+== Lesson 2: Writing Meta Data
 
 === Also A Very Simple Example
 
@@ -127,12 +150,12 @@ directory.
 
 === Save Is Atomar
 
-If you have changed serval values and call the +save+-method either
+If you have changed several values and call the +save+-method either
 all changes will be written to the file or nothing. The return value
 of the +save+-method is +true+ if all values are written to the file
 otherwise save returns +false+. In the last case you can use the
 +errors+-method which returns a hash of the tags which values couldn't
-be writed with an error message for each of them.
+be written with an error message for each of them.
 
 
 === Interesting Methods
@@ -144,10 +167,6 @@ specific tag or in general all changes.
 
 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
 
@@ -167,6 +186,9 @@ Have a look in the examples folder of MiniExiftool.
  # 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.
+
+
+== Further Examples
+
+Have a look in the examples folder of MiniExiftool.

data/lib/mini_exiftool.rb

@@ -26,14 +26,15 @@ require 'time'
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
 
-  VERSION = '2.6.0'
+  VERSION = '2.7.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, :fast => false, :ignore_minor_errors => false,
-   :replace_invalid_chars => false, :timestamps => Time }
+  @@opts = { :numerical => false, :composite => true, :fast => false, :fast2 => false,
+             :ignore_minor_errors => false, :replace_invalid_chars => false,
+             :timestamps => Time }
 
   # Encoding of the filesystem (filenames in command line)
   @@fs_enc = Encoding.find('filesystem')
@@ -64,6 +65,12 @@ class MiniExiftool
     opts_accessor encoding_opt(enc_type)
   end
 
+  # +filename_or_io+ The kind of the parameter is determined via duck typing:
+  # if the argument responds to +to_str+ it is interpreted as filename, if it
+  # responds to +read+ it is interpreted es IO instance.
+  #
+  # <b>ATTENTION:</b> If using an IO instance writing of meta data is not supported!
+  #
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
   # * <code>:composite</code> for including composite tags while loading,
@@ -75,6 +82,8 @@ class MiniExiftool
   #   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>:fast2</code> useful when reading JPEGs over a slow network connection
+  #   (See -fast2-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+
@@ -121,16 +130,15 @@ class MiniExiftool
 
   # Load the tags of filename or io.
   def load filename_or_io
-    case filename_or_io
-    when String
+    if filename_or_io.respond_to? :to_str # String-like
       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
+      @filename = filename_or_io.to_str
+    elsif filename_or_io.respond_to? :read # IO-like
       @io = filename_or_io
       @filename = '-'
     else
@@ -143,6 +151,7 @@ class MiniExiftool
     params << (@opts[:composite] ? '' : '-e ')
     params << (@opts[:coord_format] ? "-c \"#{@opts[:coord_format]}\"" : '')
     params << (@opts[:fast] ? '-fast ' : '')
+    params << (@opts[:fast2] ? '-fast2 ' : '')
     params << generate_encoding_params
     if run(cmd_gen(params, @filename))
       parse_output
@@ -384,11 +393,12 @@ class MiniExiftool
     status = Open3.popen3(cmd) do |inp, out, err, thr|
       if @io
         begin
-          data = @io.read
-        rescue Exception
+          IO.copy_stream @io, inp
+        rescue Errno::EPIPE
+          # Output closed, no problem
+        rescue ::IOError => e
           raise MiniExiftool::Error.new("IO is not readable.")
         end
-        inp.write data
         @io.close
         inp.close
       end

data/test/test_io.rb

@@ -36,7 +36,7 @@ class TestIo < TestCase
     end
   end
 
-  def test_fast_option
+  def test_fast_options
     $DEBUG = true
     s = StringIO.new
     $stderr = s
@@ -48,6 +48,11 @@ class TestIo < TestCase
     MiniExiftool.new open_real_io, :fast => true
     s.rewind
     assert_equal 'exiftool -j -fast  "-"', s.read.chomp
+    s = StringIO.new
+    $stderr = s
+    MiniExiftool.new open_real_io, :fast2 => true
+    s.rewind
+    assert_equal 'exiftool -j -fast2  "-"', s.read.chomp
   ensure
     $DEBUG = false
     $stderr = STDERR

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_exiftool
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim