multi_exiftool 0.12.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 317f91ac28f2791341c7c6354e996545c80f08fb7100607460295ae55c38d463
-  data.tar.gz: d98f7b7a4a0cca8e0ce2e18f1b718ef7227412a31ff5e9b8f3d4685077d97221
+  metadata.gz: 43d4f9d91d7d4c6321b5e9698e3aaecc38fd1044e140110f5e4ff22fdf15ee96
+  data.tar.gz: a9ff99dd7943f29ce6219f75a3dad31ce06c3e4abf458e50aa6c9e8903660022
 SHA512:
-  metadata.gz: 292b732d0940abb55c9dccebadfb8976767891ad33fb865e982689fd0b4a617590b95b195d1144831d073374357f68823dd51a4875962ef0374b0803753adf46
-  data.tar.gz: b1d1c48bfdf082f7f79ebf5f5b2feefd0e661fcfb2aebc23b73cfec25606e195b2c989c5e36b05e57257e56ddbb0b0b5fef452ed3a07cb7479508062bc302fbe
+  metadata.gz: 648a9ba62793a9c0215c06cc701935bd123612d7491be111e0e96398e9f2bcc42399f2bf42591ce70c2722579e04d113394832c337ca04674036c2b93f014f2b
+  data.tar.gz: 17d5d839ba13f1a07f2ec586c78b68bb950e54f2e6f67f2288fcdb01dda5f5ff341db462b8d103fa510eb5eb190080cf883c8d85de16fdcda89aee994414cd4a

data/.aspell.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 33 
+personal_ws-1.1 en 34 
 Coenen
 ExifTool
 Friedrich
@@ -13,6 +13,7 @@ README
 SemVer
 SemVerTag
 api
+config
 dir
 exiftool
 filenames

data/Changelog

@@ -1,3 +1,20 @@
+0.16.0
+Add option to use config files.
+
+0.15.0
+Make multi_exiftool work with Ruby 1.9 again.
+
+0.14.1
+Fix two typos.
+
+0.14.0
+Improve api for batch processing.
+
+0.13.0
+Implement batch processing to allow to write different values to multiple file
+with only one call of the ExifTool command-line application.
+Update documentation.
+
 0.12.0
 Implement Values#respond_to_missing?.
 Improve documentation and fix example code.

data/README.md

@@ -3,7 +3,7 @@
 ## Description
 
 This library is a wrapper for the ExifTool command-line application
-(http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey.
+(https://exiftool.org) written by Phil Harvey.
 It is designed for dealing with multiple files at once by creating
 commands to call exiftool with various arguments, call it and parsing
 the results.
@@ -60,6 +60,54 @@ else
 end
 ```
 
+If it is necessary to write different values to multiple files there is batch processing
+
+```ruby
+require 'multi_exiftool'
+
+# Object oriented approach
+
+batch = MultiExiftool::Batch.new
+Dir['*.jpg'].each_with_index do |filename, i|
+  values = {creator: 'Jan Friedrich', copyright: 'Public Domain', comment: "This is file number #{i+1}."}
+  batch.write filename, values
+end
+if batch.execute
+  puts 'ok'
+else
+  puts batch.errors
+end
+
+# Functional approach
+
+errors = MultiExiftool.batch do
+  Dir['*.jpg'].each_with_index do |filename, i|
+    values = {creator: 'Jan Friedrich', copyright: 'Public Domain', comment: "This is file number #{i+1}."}
+    write filename, values
+  end
+end
+if errors.empty?
+  puts 'ok'
+else
+  puts errors
+end
+
+# or alternative with block parameter as yielded Batch instance
+
+errors = MultiExiftool.batch do |batch|
+  Dir['*.jpg'].each_with_index do |filename, i|
+    values = {creator: 'Jan Friedrich', copyright: 'Public Domain', comment: "This is file number #{i+1}."}
+    batch.write filename, values
+  end
+end
+if errors.empty?
+  puts 'ok'
+else
+  puts errors
+end
+```
+
+
 ### Deleting
 
 ```ruby
@@ -153,7 +201,7 @@ The method Values#convert is called each time a value is fetched.
 - Ruby 1.9.1 or higher
 - An installation of the ExifTool command-line application (version 7.65 or
 higher). Instructions for installation you can find under
-http://www.sno.phy.queensu.ca/~phil/exiftool/install.html .
+https://exiftool.org/install.html .
 - If you have problems with special characters (like German umlauts) in
 filenames on windows system it is recommended to use exiftool version 9.79
 or higher.
@@ -185,7 +233,7 @@ SemVerTag.
 
 ## Author
 
-Jan Friedrich <janfri26gmail.com>
+Jan Friedrich <janfri26@gmail.com>
 
 ## MIT License
 

data/Rakefile

@@ -11,8 +11,8 @@ Rim.setup do |p|
   p.version = MultiExiftool::VERSION
   p.authors = 'Jan Friedrich'
   p.email = 'janfri26@gmail.com'
-  p.summary = 'This library is a wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
-  p.description = 'This library a is wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results.'
+  p.summary = 'This library is a wrapper for the ExifTool command-line application (https://exiftool.org).'
+  p.description = 'This library is a wrapper for the ExifTool command-line application (https://exiftool.org) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results.'
   p.ruby_version = '>=1.9.1'
   p.license = 'MIT'
   p.homepage = 'https://github.com/janfri/multi_exiftool'
@@ -21,7 +21,7 @@ Rim.setup do |p|
 | Please ensure you have installed exiftool version 7.65 or higher and  |
 | it's found in your PATH (Try "exiftool -ver" on your commandline).    |
 | For more details see                                                  |
-| http://www.sno.phy.queensu.ca/~phil/exiftool/install.html             |
+| https://exiftool.org/install.html             |
 +-----------------------------------------------------------------------+
   }
   p.development_dependencies << %w(contest ~>0.1)

data/lib/multi_exiftool.rb

@@ -4,10 +4,11 @@
 require_relative 'multi_exiftool/values'
 require_relative 'multi_exiftool/reader'
 require_relative 'multi_exiftool/writer'
+require_relative 'multi_exiftool/batch'
 
 module MultiExiftool
 
-  VERSION = '0.12.0'
+  VERSION = '0.16.0'
 
   @exiftool_command = 'exiftool'
 
@@ -25,15 +26,7 @@ module MultiExiftool
     #     # error handling
     #   end
     def read filenames, opts={}
-      reader = Reader.new
-      reader.filenames = filenames
-      if val = opts.delete(:tags)
-        reader.tags = val
-      end
-      if val = opts.delete(:group)
-        reader.group = val
-      end
-      reader.options = opts unless opts.empty?
+      reader = Reader.new(filenames, opts)
       values = reader.read
       [values, reader.errors]
     end
@@ -47,10 +40,7 @@ module MultiExiftool
     #     # do error handling
     #   end
     def write filenames, values, opts={}
-      writer = Writer.new
-      writer.filenames = filenames
-      writer.values = values
-      writer.options = opts unless opts.empty?
+      writer = Writer.new(filenames, values, opts)
       writer.write
       writer.errors
     end
@@ -70,11 +60,35 @@ module MultiExiftool
     #   unless errors.empty?
     #     # do error handling
     #   end
-    def delete_values filenames, tags: :all
+    def delete_values filenames, opts={}
+      tags = opts.fetch(:tags, :all)
       values = Array(tags).inject(Hash.new) {|h,tag| h[tag] = nil; h}
       write(filenames, values)
     end
 
+
+    # Execute a batch of write commands
+    # Returns an array of the error messages
+    #
+    # Example:
+    #   errors = MultiExiftool.batch do
+    #     Dir['*.jpg'].each_with_index do |filename, i|
+    #       write filename, {author: 'Jan Friedrich', comment: "This is file number #{i+1}."}
+    #     end
+    #   unless errors.empty?
+    #     # do error handling
+    #   end
+    def batch &block
+      batch = Batch.new
+      if block.arity == 0
+        batch.instance_exec &block
+      else
+        yield batch
+      end
+      batch.execute
+      batch.errors
+    end
+
     attr_accessor :exiftool_command
     attr_reader :exiftool_version
 

data/lib/multi_exiftool/batch.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'executable'
+
+module MultiExiftool
+
+  # Allow to define a batch for different writing operations as one call of the
+  # ExifTool command-line application
+  class Batch
+
+    include Executable
+
+    # Define batch operation inside a block
+    def initialize &blk
+      @writers = []
+      instance_exec &blk if block_given?
+    end
+
+    # Define a write operation for the batch.
+    def write filenames, values, options={}
+      w = MultiExiftool::Writer.new(filenames, values, options)
+      @writers << w
+    end
+
+    # Getting the command-line arguments which would be executed
+    # when calling #write. It could be useful for logging, debugging or
+    # whatever.
+    def exiftool_args
+      @writers.map {|w| w.exiftool_args + ['-execute']}.flatten
+    end
+
+    private
+
+    def parse_results
+      @errors = @stderr.read.split(/\n/)
+      @errors.empty?
+    end
+
+  end
+
+end

data/lib/multi_exiftool/executable.rb

@@ -9,12 +9,15 @@ module MultiExiftool
   module Executable
 
     attr_reader :errors
-    attr_accessor :filenames, :numerical, :options
+    attr_accessor :config, :filenames, :numerical, :options
 
-    def initialize
-      @options = {}
-      @filenames = []
+    def initialize filenames=[], options={}
+      @options = options
+      @filenames = filenames
       @option_mapping = {numerical: :n}
+      if val = options.delete(:config)
+        @config = val
+      end
     end
 
     def options
@@ -57,7 +60,11 @@ module MultiExiftool
     end
 
     def execute_command
-      stdin, @stdout, @stderr = Open3.popen3(exiftool_command, '-@', '-')
+      args = ['-@', '-']
+      if @config
+        args = ['-config', @config] + args
+      end
+      stdin, @stdout, @stderr = Open3.popen3(exiftool_command, *args)
       exiftool_args.each do |part|
         stdin << part
         stdin << "\n"

data/lib/multi_exiftool/reader.rb

@@ -15,9 +15,17 @@ module MultiExiftool
 
     include Executable
 
-    def initialize
-      super
-      @tags = []
+    def initialize filenames=[], opts={}
+      super(filenames, opts)
+      if val = opts.delete(:tags)
+        @tags = val
+      else
+        @tags = []
+      end
+      if val = opts.delete(:group)
+        @group = val
+      end
+      @options = opts unless opts.empty?
     end
 
     def self.mandatory_args

data/lib/multi_exiftool/writer.rb

@@ -14,9 +14,9 @@ module MultiExiftool
 
     include Executable
 
-    def initialize
-      super
-      @values = {}
+    def initialize filenames=[], values={}, opts={}
+      super(filenames, opts)
+      @values = values
     end
 
     def self.mandatory_args

data/multi_exiftool.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: multi_exiftool 0.12.0 ruby lib
+# stub: multi_exiftool 0.16.0 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,22 +7,22 @@
 
 Gem::Specification.new do |s|
   s.name = "multi_exiftool"
-  s.version = "0.12.0"
+  s.version = "0.16.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jan Friedrich"]
-  s.date = "2020-01-02"
-  s.description = "This library a is wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results."
+  s.date = "2020-10-27"
+  s.description = "This library is a wrapper for the ExifTool command-line application (https://exiftool.org) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results."
   s.email = "janfri26@gmail.com"
-  s.files = ["./.aspell.pws", "Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/multi_exiftool", "lib/multi_exiftool.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb", "multi_exiftool.gemspec", "regtest/read_all_tags.rb", "regtest/read_all_tags.yml", "regtest/test.jpg", "test/data", "test/data/a.jpg", "test/data/b.jpg", "test/data/c.jpg", "test/helper.rb", "test/test_executable.rb", "test/test_exiftool_stuff.rb", "test/test_functional_api.rb", "test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb", "test/test_writer_groups.rb"]
+  s.files = ["./.aspell.pws", "Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "lib/multi_exiftool", "lib/multi_exiftool.rb", "lib/multi_exiftool/batch.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb", "multi_exiftool.gemspec", "regtest/read_all_tags.rb", "regtest/read_all_tags.yml", "regtest/test.jpg", "test/data", "test/data/a.jpg", "test/data/b.jpg", "test/data/c.jpg", "test/data/example.config", "test/helper.rb", "test/test_batch.rb", "test/test_executable.rb", "test/test_exiftool_stuff.rb", "test/test_functional_api.rb", "test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb", "test/test_writer_groups.rb"]
   s.homepage = "https://github.com/janfri/multi_exiftool"
   s.licenses = ["MIT"]
-  s.post_install_message = "\n+-----------------------------------------------------------------------+\n| Please ensure you have installed exiftool version 7.65 or higher and  |\n| it's found in your PATH (Try \"exiftool -ver\" on your commandline).    |\n| For more details see                                                  |\n| http://www.sno.phy.queensu.ca/~phil/exiftool/install.html             |\n+-----------------------------------------------------------------------+\n  "
+  s.post_install_message = "\n+-----------------------------------------------------------------------+\n| Please ensure you have installed exiftool version 7.65 or higher and  |\n| it's found in your PATH (Try \"exiftool -ver\" on your commandline).    |\n| For more details see                                                  |\n| https://exiftool.org/install.html             |\n+-----------------------------------------------------------------------+\n  "
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
   s.requirements = ["exiftool, version 7.65 or higher"]
   s.rubygems_version = "3.1.2"
-  s.summary = "This library is a wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool)."
+  s.summary = "This library is a wrapper for the ExifTool command-line application (https://exiftool.org)."
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/regtest/read_all_tags.yml

@@ -4,7 +4,7 @@ result:
 - - !ruby/object:MultiExiftool::Values
     values:
       sourcefile: regtest/test.jpg
-      exiftoolversion: 11.7
+      exiftoolversion: 12.0
       filename: test.jpg
       directory: regtest
       filesize: 43 kB

data/test/data/example.config

@@ -0,0 +1,363 @@
+# Copied from https://exiftool.org/config.html
+
+#------------------------------------------------------------------------------
+# File:         example.config
+#
+# Description:  Example user configuration file for Image::ExifTool
+#
+# Notes:        This example file shows how to define your own shortcuts and
+#               add new EXIF, IPTC, XMP, PNG, MIE and Composite tags, as well
+#               as how to specify preferred lenses for the LensID tag, and
+#               define new file types and default ExifTool option values.
+#
+#               Note that unknown tags may be extracted even if they aren't
+#               defined, but tags must be defined to be written.  Also note
+#               that it is possible to override an existing tag definition
+#               with a user-defined tag.
+#
+#               To activate this file, rename it to ".ExifTool_config" and
+#               place it in your home directory or the exiftool application
+#               directory.  (On Mac and some Windows systems this must be done
+#               via the command line since the GUI's may not allow filenames to
+#               begin with a dot.  Use the "rename" command in Windows or "mv"
+#               on the Mac.)  This causes ExifTool to automatically load the
+#               file when run.  Your home directory is determined by the first
+#               defined of the following environment variables:
+#
+#                   1.  EXIFTOOL_HOME
+#                   2.  HOME
+#                   3.  HOMEDRIVE + HOMEPATH
+#                   4.  (the current directory)
+#
+#               Alternatively, the -config option of the exiftool application
+#               may be used to load a specific configuration file (note that
+#               this must be the first option on the command line):
+#
+#                   exiftool -config example.config ...
+#
+#               This example file defines the following 16 new tags as well as
+#               a number of Shortcut and Composite tags:
+#
+#                   1.  EXIF:NewEXIFTag
+#                   2.  GPS:GPSPitch
+#                   3.  GPS:GPSRoll
+#                   4.  IPTC:NewIPTCTag
+#                   5.  XMP-xmp:NewXMPxmpTag
+#                   6.  XMP-exif:GPSPitch
+#                   7.  XMP-exif:GPSRoll
+#                   8.  XMP-xxx:NewXMPxxxTag1
+#                   9.  XMP-xxx:NewXMPxxxTag2
+#                  10.  XMP-xxx:NewXMPxxxTag3
+#                  11.  XMP-xxx:NewXMPxxxStruct
+#                  12.  PNG:NewPngTag1
+#                  13.  PNG:NewPngTag2
+#                  14.  PNG:NewPngTag3
+#                  15.  MIE-Meta:NewMieTag1
+#                  16.  MIE-Test:NewMieTag2
+#
+#               For detailed information on the definition of tag tables and
+#               tag information hashes, see lib/Image/ExifTool/README.
+#------------------------------------------------------------------------------
+
+# Shortcut tags are used when extracting information to simplify
+# commonly used commands.  They can be used to represent groups
+# of tags, or to provide an alias for a tag name.
+%Image::ExifTool::UserDefined::Shortcuts = (
+    MyShortcut => ['exif:createdate','exposuretime','aperture'],
+    MyAlias => 'FocalLengthIn35mmFormat',
+);
+
+# NOTE: All tag names used in the following tables are case sensitive.
+
+# The %Image::ExifTool::UserDefined hash defines new tags to be added
+# to existing tables.
+%Image::ExifTool::UserDefined = (
+    # All EXIF tags are added to the Main table, and WriteGroup is used to
+    # specify where the tag is written (default is ExifIFD if not specified):
+    'Image::ExifTool::Exif::Main' => {
+        # Example 1.  EXIF:NewEXIFTag
+        0xd000 => {
+            Name => 'NewEXIFTag',
+            Writable => 'int16u',
+            WriteGroup => 'IFD0',
+        },
+        # add more user-defined EXIF tags here...
+    },
+    # the Geotag feature writes these additional GPS tags if available:
+    'Image::ExifTool::GPS::Main' => {
+        # Example 2.  GPS:GPSPitch
+        0xd000 => {
+            Name => 'GPSPitch',
+            Writable => 'rational64s',
+        },
+        # Example 3.  GPS:GPSRoll
+        0xd001 => {
+            Name => 'GPSRoll',
+            Writable => 'rational64s',
+        },
+    },
+    # IPTC tags are added to a specific record type (eg. application record):
+    # (Note: IPTC tag ID's are limited to the range 0-255)
+    'Image::ExifTool::IPTC::ApplicationRecord' => {
+        # Example 4.  IPTC:NewIPTCTag
+        160 => {
+            Name => 'NewIPTCTag',
+            Format => 'string[0,16]',
+        },
+        # add more user-defined IPTC ApplicationRecord tags here...
+    },
+    # XMP tags may be added to existing namespaces:
+    'Image::ExifTool::XMP::xmp' => {
+        # Example 5.  XMP-xmp:NewXMPxmpTag
+        NewXMPxmpTag => { Groups => { 2 => 'Author' } },
+        # add more user-defined XMP-xmp tags here...
+    },
+    # special Geotag tags for XMP-exif:
+    'Image::ExifTool::XMP::exif' => {
+        # Example 6.  XMP-exif:GPSPitch
+        GPSPitch => { Writable => 'rational', Groups => { 2 => 'Location' } },
+        # Example 7.  XMP-exif:GPSRoll
+        GPSRoll  => { Writable => 'rational', Groups => { 2 => 'Location' } },
+    },
+    # new XMP namespaces (eg. xxx) must be added to the Main XMP table:
+    'Image::ExifTool::XMP::Main' => {
+        # namespace definition for examples 8 to 11
+        xxx => { # <-- must be the same as the NAMESPACE prefix
+            SubDirectory => {
+                TagTable => 'Image::ExifTool::UserDefined::xxx',
+                # (see the definition of this table below)
+            },
+        },
+        # add more user-defined XMP namespaces here...
+    },
+    # new PNG tags are added to the PNG::TextualData table:
+    'Image::ExifTool::PNG::TextualData' => {
+        # Example 12.  PNG:NewPngTag1
+        NewPngTag1 => { },
+        # Example 13.  PNG:NewPngTag2
+        NewPngTag2 => { },
+        # Example 14.  PNG:NewPngTag3
+        NewPngTag3 => { },
+    },
+    # add a new MIE tag (NewMieTag1) and group (MIE-Test) to MIE-Meta
+    # (Note: MIE group names must NOT end with a number)
+    'Image::ExifTool::MIE::Meta' => {
+        # Example 15.  MIE-Meta:NewMieTag1
+        NewMieTag1 => {
+            Writable => 'rational64u',
+            Units => [ 'cm', 'in' ],
+        },
+        # new MIE "Test" group for example 16
+        Test => {
+            SubDirectory => {
+                TagTable => 'Image::ExifTool::UserDefined::MIETest',
+                DirName => 'MIE-Test',
+            },
+        },
+    },
+    # Composite tags are added to the Composite table:
+    'Image::ExifTool::Composite' => {
+        # Composite tags have values that are derived from the values of
+        # other tags.  The Require/Desire elements below specify constituent
+        # tags that must/may exist, and the keys of these hashes are used as
+        # indices in the @val array of the ValueConv expression to access the
+        # numerical (-n) values of these tags.  Print-converted values are
+        # accessed via the @prt array.  All Require'd tags must exist for
+        # the Composite tag to be evaluated.  If no Require'd tags are
+        # specified, then at least one of the Desire'd tags must exist.  See
+        # the Composite table in Image::ExifTool::Exif for more examples,
+        # and lib/Image/ExifTool/README for all of the details.
+        BaseName => {
+            Require => {
+                0 => 'FileName',
+            },
+            # remove the extension from FileName
+            ValueConv => '$val[0] =~ /(.*)\./ ? $1 : $val[0]',
+        },
+        # the next few examples demonstrate simplifications which may be
+        # used if only one tag is Require'd or Desire'd:
+        # 1) the Require lookup may be replaced with a simple tag name
+        # 2) "$val" may be used to represent "$val[0]" in the expression
+        FileExtension => {
+            Require => 'FileName',
+            ValueConv => '$val=~/\.([^.]*)$/; $1',
+        },
+        # override CircleOfConfusion tag to use D/1750 instead of D/1440
+        CircleOfConfusion => {
+            Require => 'ScaleFactor35efl',
+            Groups => { 2 => 'Camera' },
+            ValueConv => 'sqrt(24*24+36*36) / ($val * 1750)',
+            # an optional PrintConv may be used to format the value
+            PrintConv => 'sprintf("%.3f mm",$val)',
+        },
+        # generate a description for this file type
+        FileTypeDescription => {
+            Require => 'FileType',
+            ValueConv => 'GetFileType($val,1) || $val',
+        },
+        # calculate physical image size based on resolution
+        PhysicalImageSize => {
+            Require => {
+                0 => 'ImageWidth',
+                1 => 'ImageHeight',
+                2 => 'XResolution',
+                3 => 'YResolution',
+                4 => 'ResolutionUnit',
+            },
+            ValueConv => '$val[0]/$val[2] . " " . $val[1]/$val[3]',
+            # (the @prt array contains print-formatted values)
+            PrintConv => 'sprintf("%.1fx%.1f $prt[4]", split(" ",$val))',
+        },
+        # [advanced] select largest JPEG preview image
+        BigImage => {
+            Groups => { 2 => 'Preview' },
+            Desire => {
+                0 => 'JpgFromRaw',
+                1 => 'PreviewImage',
+                2 => 'OtherImage',
+                # (DNG and A100 ARW may be have 2 PreviewImage's)
+                3 => 'PreviewImage (1)',
+                # (if the MPF has 2 previews, MPImage3 could be the larger one)
+                4 => 'MPImage3',
+            },
+            # ValueConv may also be a code reference
+            # Inputs: 0) reference to list of values, 1) ExifTool object
+            ValueConv => sub {
+                my $val = shift;
+                my ($image, $bigImage, $len, $bigLen);
+                foreach $image (@$val) {
+                    next unless ref $image eq 'SCALAR';
+                    # check for JPEG image (or "Binary data" if -b not used)
+                    next unless $$image =~ /^(\xff\xd8\xff|Binary data (\d+))/;
+                    $len = $2 || length $$image; # get image length
+                    # save largest image
+                    next if defined $bigLen and $bigLen >= $len;
+                    $bigLen = $len;
+                    $bigImage = $image;
+                }
+                return $bigImage;
+            },
+        },
+        # **** ADD ADDITIONAL COMPOSITE TAG DEFINITIONS HERE ****
+    },
+);
+
+# This is a basic example of the definition for a new XMP namespace.
+# This table is referenced through a SubDirectory tag definition
+# in the %Image::ExifTool::UserDefined definition above.
+# The namespace prefix for these tags is 'xxx', which corresponds to
+# an ExifTool family 1 group name of 'XMP-xxx'.
+%Image::ExifTool::UserDefined::xxx = (
+    GROUPS => { 0 => 'XMP', 1 => 'XMP-xxx', 2 => 'Image' },
+    NAMESPACE => { 'xxx' => 'http://ns.myname.com/xxx/1.0/' },
+    WRITABLE => 'string', # (default to string-type tags)
+    # Example 8.  XMP-xxx:NewXMPxxxTag1 (an alternate-language tag)
+    # - replace "NewXMPxxxTag1" with your own tag name (eg. "MyTag")
+    NewXMPxxxTag1 => { Writable => 'lang-alt' },
+    # Example 9.  XMP-xxx:NewXMPxxxTag2 (a string tag in the Author category)
+    NewXMPxxxTag2 => { Groups => { 2 => 'Author' } },
+    # Example 10.  XMP-xxx:NewXMPxxxTag3 (an unordered List-type tag)
+    NewXMPxxxTag3 => { List => 'Bag' },
+    # Example 11.  XMP-xxx:NewXMPxxxStruct (a structured tag)
+    # - example structured XMP tag
+    NewXMPxxxStruct => {
+        # the "Struct" entry defines the structure fields
+        Struct => {
+            # optional namespace prefix and URI for structure fields
+            # (required only if different than NAMESPACE above)
+            # --> multiple entries may exist in this namespace lookup,
+            # with the last one alphabetically being the default for
+            # the fields, but each field may have a "Namespace"
+            # element to specify which prefix to use
+            NAMESPACE => { 'test' => 'http://x.y.z/test/' },
+            # optional structure name (used for warning messages only)
+            STRUCT_NAME => 'MyStruct',
+            # optional rdf:type property for the structure
+            TYPE => 'http://x.y.z/test/xystruct',
+            # structure fields (very similar to tag definitions)
+            X => { Writable => 'integer' },
+            Y => { Writable => 'integer' },
+            # a nested structure...
+            Things => {
+                List => 'Bag',
+                Struct => {
+                    NAMESPACE => { thing => 'http://x.y.z/thing/' },
+                    What  => { },
+                    Where => { },
+                },
+            },
+        },
+        List => 'Seq', # structures may also be elements of a list
+    },
+    # Each field in the structure has a corresponding flattened tag that is
+    # generated automatically with an ID made from a concatenation of the
+    # original structure tag ID and the field name (after capitalizing the
+    # first letter of the field name if necessary).  The Name and/or
+    # Description of these flattened tags may be changed if desired, but all
+    # other tag properties are taken from the structure field definition.
+    # The "Flat" flag must be used when setting the Name or Description of a
+    # flattened tag.  For example:
+    NewXMPxxxStructX => { Name => 'SomeOtherName', Flat => 1 },
+);
+
+# Adding a new MIE group requires a few extra definitions
+use Image::ExifTool::MIE;
+%Image::ExifTool::UserDefined::MIETest = (
+    %Image::ExifTool::MIE::tableDefaults,   # default MIE table entries
+    GROUPS      => { 0 => 'MIE', 1 => 'MIE-Test', 2 => 'Document' },
+    WRITE_GROUP => 'MIE-Test',
+    # Example 16.  MIE-Test:NewMieTag2
+    NewMieTag2  => { },     # new user-defined tag in MIE-Test group
+);
+
+# A special 'Lenses' list can be defined to give priority to specific lenses
+# in the logic to determine a lens model for the Composite:LensID tag
+@Image::ExifTool::UserDefined::Lenses = (
+    'Sigma AF 10-20mm F4-5.6 EX DC',
+    'Tokina AF193-2 19-35mm f/3.5-4.5',
+);
+
+# User-defined file types to recognize
+%Image::ExifTool::UserDefined::FileTypes = (
+    XXX => { # <-- the extension of the new file type (case insensitive)
+        # BaseType specifies the format upon which this file is based (case
+        # sensitive).  If BaseType is defined, then the file will be fully
+        # supported, and in this case the Magic pattern should not be defined
+        BaseType => 'TIFF',
+        MIMEType => 'image/x-xxx',
+        Description => 'My XXX file type',
+        # if the BaseType is writable by ExifTool, then the new file type
+        # will also be writable unless otherwise specified, like this:
+        Writable => 0,
+    },
+    YYY => {
+        # without BaseType, the file will be recognized but not supported
+        Magic => '0123abcd',    # regular expression to match at start of file
+        MIMEType => 'application/test',
+        Description => 'My YYY file type',
+    },
+    ZZZ => {
+        # if neither BaseType nor Magic are defined, the file will be
+        # recognized by extension only.  MIMEType will be application/unknown
+        # unless otherwise specified
+        Description => 'My ZZZ file type',
+    },
+    # if only BaseType is specified, then the following simplified syntax
+    # may be used.  In this example, files with extension "TTT" will be
+    # processed as JPEG files
+    TTT => 'JPEG',
+);
+
+# Change default location for writing QuickTime tags so Keys is preferred
+# (by default, the PREFERRED levels are: ItemList=2, UserData=1, Keys=0)
+use Image::ExifTool::QuickTime;
+$Image::ExifTool::QuickTime::Keys{PREFERRED} = 3;
+
+# Specify default ExifTool option values
+# (see the Options function documentation for available options)
+%Image::ExifTool::UserDefined::Options = (
+    CoordFormat => '%.6f',  # change default GPS coordinate format
+    Duplicates => 1,        # make -a default for the exiftool app
+    GeoMaxHDOP => 4,        # ignore GPS fixes with HDOP > 4
+    RequestAll => 3,        # request additional tags not normally generated
+);

data/test/test_batch.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class TestBatch < Test::Unit::TestCase
+
+  MANDATORY_WRITER_ARGS = MultiExiftool::Writer.mandatory_args
+
+  context 'exiftool_args method' do
+
+    setup do
+      @filenames = %w(a.jpg b.jpg c.jpg)
+      @multiple_values = @filenames.map do |filename|
+        {author: 'janfri', comment: "Comment for file #{filename}"}
+      end
+    end
+
+    test 'only filenames and values' do
+      batch = MultiExiftool::Batch.new
+      @filenames.zip @multiple_values do |filename, values|
+        batch.write filename, values
+      end
+      exiftool_args = @filenames.zip(@multiple_values).map do |filename, values|
+        [MANDATORY_WRITER_ARGS, '-author=janfri', "-comment=Comment for file #{filename}", filename, '-execute']
+      end.flatten
+      assert_equal exiftool_args, batch.exiftool_args
+    end
+
+    test 'filenames, values and options' do
+      options = {overwrite_original: true}
+      batch = MultiExiftool::Batch.new
+      @filenames.zip @multiple_values do |filename, values|
+        batch.write filename, values, options
+      end
+      exiftool_args = @filenames.zip(@multiple_values).map do |filename, _values|
+        [MANDATORY_WRITER_ARGS, '-overwrite_original', '-author=janfri', "-comment=Comment for file #{filename}", filename, '-execute']
+      end.flatten
+      assert_equal exiftool_args, batch.exiftool_args
+    end
+  end
+end

data/test/test_functional_api.rb

@@ -60,6 +60,18 @@ class TestFunctionalApi < Test::Unit::TestCase
       end
     end
 
+    test 'successful reading with user defined tags in config file' do
+      run_in_temp_dir do
+        values, errors = MultiExiftool.read(%w[a.jpg b.jpg c.jpg], tags: %w[basename fileextension])
+        assert_equal [nil, nil, nil], values.map(&:basename)
+        assert_equal [nil, nil, nil], values.map(&:file_extension)
+        assert_equal [], errors
+        values, errors = MultiExiftool.read(%w[a.jpg b.jpg c.jpg], config: 'example.config', tags: %w[basename fileextension])
+        assert_equal %w[a b c], values.map(&:basename)
+        assert_equal %w[jpg]*3, values.map(&:file_extension)
+        assert_equal [], errors
+      end
+    end
   end
 
   context 'writing' do
@@ -188,4 +200,93 @@ class TestFunctionalApi < Test::Unit::TestCase
 
   end
 
+  context 'batch' do
+
+    setup do
+      @filenames = %w(a.jpg b.jpg c.jpg)
+      @multiple_values = @filenames.map do |fn|
+        {author: 'Jan Friedrich', comment: "Comment for file #{fn}"}
+      end
+    end
+
+    context 'instance_exec' do
+
+      test 'only filenames and values' do
+        run_in_temp_dir do
+          filenames = @filenames
+          multiple_values = @multiple_values
+          errors = MultiExiftool.batch do
+            filenames.zip multiple_values do |filename, values|
+              write filename, values
+            end
+          end
+          assert_equal [], errors
+          values, errors = MultiExiftool.read(@filenames)
+          assert_equal ['Jan Friedrich'] * 3, values.map {|e| e['Author']}
+          assert_equal ['Comment for file a.jpg', 'Comment for file b.jpg', 'Comment for file c.jpg'], values.map {|e| e['Comment']}
+          assert_equal [], errors
+          assert_equal 3, Dir['*_original'].size
+        end
+      end
+
+      test 'options with boolean argument' do
+        run_in_temp_dir do
+          filenames = @filenames
+          multiple_values = @multiple_values
+          options = {overwrite_original: true}
+          errors = MultiExiftool.batch do
+            filenames.zip multiple_values do |filename, values|
+              write filename, values, options
+            end
+          end
+          assert_equal [], errors
+          values, errors = MultiExiftool.read(@filenames)
+          assert_equal ['Jan Friedrich'] * 3, values.map {|e| e['Author']}
+          assert_equal ['Comment for file a.jpg', 'Comment for file b.jpg', 'Comment for file c.jpg'], values.map {|e| e['Comment']}
+          assert_equal [], errors
+          assert_equal [], Dir['*_original']
+        end
+      end
+
+    end
+
+    context 'yield' do
+
+      test 'only filenames and values' do
+        run_in_temp_dir do
+          errors = MultiExiftool.batch do |batch|
+            @filenames.zip @multiple_values do |filename, values|
+              batch.write filename, values
+            end
+          end
+          assert_equal [], errors
+          values, errors = MultiExiftool.read(@filenames)
+          assert_equal ['Jan Friedrich'] * 3, values.map {|e| e['Author']}
+          assert_equal ['Comment for file a.jpg', 'Comment for file b.jpg', 'Comment for file c.jpg'], values.map {|e| e['Comment']}
+          assert_equal [], errors
+          assert_equal 3, Dir['*_original'].size
+        end
+      end
+
+      test 'options with boolean argument' do
+        run_in_temp_dir do
+          options = {overwrite_original: true}
+          errors = MultiExiftool.batch do |batch|
+            @filenames.zip @multiple_values do |filename, values|
+              batch.write filename, values, options
+            end
+          end
+          assert_equal [], errors
+          values, errors = MultiExiftool.read(@filenames)
+          assert_equal ['Jan Friedrich'] * 3, values.map {|e| e['Author']}
+          assert_equal ['Comment for file a.jpg', 'Comment for file b.jpg', 'Comment for file c.jpg'], values.map {|e| e['Comment']}
+          assert_equal [], errors
+          assert_equal [], Dir['*_original']
+        end
+      end
+
+    end
+
+  end
+
 end

data/test/test_reader.rb

@@ -157,6 +157,20 @@ class TestReader < Test::Unit::TestCase
       end
     end
 
+    test 'successful reading with user defined tags in config file' do
+      run_in_temp_dir do
+        @reader.filenames = %w(a.jpg b.jpg c.jpg)
+        @reader.tags = %w[basename]
+        res = @reader.read
+        assert_equal [nil, nil, nil], res.map(&:basename)
+        assert_equal [], @reader.errors
+        @reader.config = 'example.config'
+        res = @reader.read
+        assert_equal %w[a b c], res.map(&:basename)
+        assert_equal [], @reader.errors
+      end
+    end
+
   end
 
 end

data/test/test_values.rb

@@ -137,19 +137,19 @@ class TestValues < Test::Unit::TestCase
 
     test 'different formats as string' do
       @hash.keys.each do |k|
-        assert_true @values.has_tag? k
+        assert_equal true, @values.has_tag?(k)
       end
     end
 
     test 'different formats as symbol' do
       @hash.keys.each do |k|
-        assert_true @values.has_tag? k.to_sym
+        assert_equal true, @values.has_tag?(k.to_sym)
       end
     end
 
     test 'non existent key' do
       ['iso', 'ISO', :iso, :ISO].each do |t|
-        assert_false @values.has_tag? t
+        assert_equal false, @values.has_tag?(t)
       end
     end
   end
@@ -182,13 +182,13 @@ class TestValues < Test::Unit::TestCase
 
     test 'existing keys' do
       [:fnumber, :f_number, :FNumber, 'fnumber', 'f_number', 'FNumber', :author, :Author, 'author', 'Author'].each do |t|
-        assert_true @values.respond_to? t
+        assert_equal true, @values.respond_to?(t)
       end
     end
 
     test 'non existing key' do
       ['iso', 'ISO', :iso, :ISO].each do |t|
-        assert_false @values.respond_to? t
+        assert_equal false, @values.respond_to?(t)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_exiftool
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Jan Friedrich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-description: This library a is wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool)
+description: This library is a wrapper for the ExifTool command-line application (https://exiftool.org)
   written by Phil Harvey. It is designed for dealing with multiple files at once by
   creating commands to call exiftool with various arguments, call it and parsing the
   results.
@@ -96,6 +96,7 @@ files:
 - README.md
 - Rakefile
 - lib/multi_exiftool.rb
+- lib/multi_exiftool/batch.rb
 - lib/multi_exiftool/executable.rb
 - lib/multi_exiftool/reader.rb
 - lib/multi_exiftool/values.rb
@@ -107,7 +108,9 @@ files:
 - test/data/a.jpg
 - test/data/b.jpg
 - test/data/c.jpg
+- test/data/example.config
 - test/helper.rb
+- test/test_batch.rb
 - test/test_executable.rb
 - test/test_exiftool_stuff.rb
 - test/test_functional_api.rb
@@ -123,7 +126,7 @@ metadata: {}
 post_install_message: "\n+-----------------------------------------------------------------------+\n|
   Please ensure you have installed exiftool version 7.65 or higher and  |\n| it's
   found in your PATH (Try \"exiftool -ver\" on your commandline).    |\n| For more
-  details see                                                  |\n| http://www.sno.phy.queensu.ca/~phil/exiftool/install.html
+  details see                                                  |\n| https://exiftool.org/install.html
   \            |\n+-----------------------------------------------------------------------+\n
   \ "
 rdoc_options: []
@@ -142,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - exiftool, version 7.65 or higher
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: This library is a wrapper for the ExifTool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).
+summary: This library is a wrapper for the ExifTool command-line application (https://exiftool.org).
 test_files: []