multi_exiftool 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 317f91ac28f2791341c7c6354e996545c80f08fb7100607460295ae55c38d463
-  data.tar.gz: d98f7b7a4a0cca8e0ce2e18f1b718ef7227412a31ff5e9b8f3d4685077d97221
+  metadata.gz: ae8854c3ecd3b7d994ee26ac7ec90fdac4611143fd50fba1d96d1557a4e4ff2c
+  data.tar.gz: 66714930cb460368f930dbc655c4dfbd502d0e45b371f21786fe3d4c6c124e0c
 SHA512:
-  metadata.gz: 292b732d0940abb55c9dccebadfb8976767891ad33fb865e982689fd0b4a617590b95b195d1144831d073374357f68823dd51a4875962ef0374b0803753adf46
-  data.tar.gz: b1d1c48bfdf082f7f79ebf5f5b2feefd0e661fcfb2aebc23b73cfec25606e195b2c989c5e36b05e57257e56ddbb0b0b5fef452ed3a07cb7479508062bc302fbe
+  metadata.gz: a0783ca4711efe4a88dd30a23a10ab357d250ada9d8fae6474cbe5356d6fc59e88743868449495bb36efaf8f65d4db1eaff889b07903fdb4fc5f64d3b2813866
+  data.tar.gz: 9c91eb43576561b7dc712f3d0b05bda741fd2c4fb6f3542d7a56204cec09d2543e4d301060b66f3deb5a1b07c49537f32dcb4d0c5b869ec91b695b1409c035db

data/Changelog

@@ -1,3 +1,8 @@
+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,39 @@ 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 = Batch.new 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 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 batch.errors
+end
+```
+
+
 ### Deleting
 
 ```ruby
@@ -153,7 +186,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.

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 a is 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.13.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
@@ -75,6 +65,24 @@ module MultiExiftool
       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 &block
+      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
+    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

@@ -11,9 +11,9 @@ module MultiExiftool
     attr_reader :errors
     attr_accessor :filenames, :numerical, :options
 
-    def initialize
-      @options = {}
-      @filenames = []
+    def initialize filenames=[], options={}
+      @options = options
+      @filenames = filenames
       @option_mapping = {numerical: :n}
     end
 

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.13.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.13.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-02-03"
+  s.description = "This library a is 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/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/test/test_batch.rb

@@ -0,0 +1,48 @@
+# 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
+      filenames = @filenames
+      multiple_values = @multiple_values
+      batch = MultiExiftool::Batch.new do
+        filenames.zip multiple_values do |filename, values|
+          write filename, values
+        end
+      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
+      filenames = @filenames
+      multiple_values = @multiple_values
+      options = {overwrite_original: true}
+      batch = MultiExiftool::Batch.new do
+        filenames.zip multiple_values do |filename, values|
+          write filename, values, options
+        end
+      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

@@ -188,4 +188,51 @@ 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
+
+    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
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_exiftool
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-02-03 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 a is 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
@@ -108,6 +109,7 @@ files:
 - test/data/b.jpg
 - test/data/c.jpg
 - test/helper.rb
+- test/test_batch.rb
 - test/test_executable.rb
 - test/test_exiftool_stuff.rb
 - test/test_functional_api.rb
@@ -123,7 +125,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: []
@@ -144,5 +146,5 @@ requirements:
 rubygems_version: 3.1.2
 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: []