multi_exiftool 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b015e9af2e57bc797d737a4dc8d69ad8916eaa5d57a593571674ebcd66bd4bd
-  data.tar.gz: 5d1f4bfd5b5b8673e2bcb5721dac40932229f173688c1cb5e3179dd44d66b19c
+  metadata.gz: 99d1a39d6b7f86838edecca534c52316000eab5672381af22fd1917a0f0db2d5
+  data.tar.gz: bf6f42b5424c6f32c0f1e99b9869185ccb578e936d66df6799d3e24a53b8efc4
 SHA512:
-  metadata.gz: d6d71bd49a05fd9776cc509a897766a1e6c1e8bd2d5f8adf697843b0be65a370fc78d49845aa65e309bb26053d03844b798e72c2cbead89a668dc4fa13fc656c
-  data.tar.gz: 5c96b7c4d26243e2047a85916d6d075f7add191b48edc07d181a8cf89dc42cedbcb005d5665bc10a24904f0bcd8eb36faca5fb71c86e4670f2daaae0835860de
+  metadata.gz: fb7d247b98ca7e00ed5f0380f1780ca91c0792bca46b24756d09984a5852b7fec216da28a960ac7c517593db62537c8f6bee21e228ac1ee4bc3a349de1961937
+  data.tar.gz: 8642935529ad89d65e9dea387b46a0ab340a7ef0ad7a816b18d4ef4d4665b8fe9f1cc2169c7e23f0ea0983c6114ed15d164e3c47fc0457cea71109024f0239ff

data/.aspell.pws

@@ -9,8 +9,8 @@ api
 Gemfile
 sublicense
 tmpdir
-ExifTool
 exiftool
+ExifTool
 gmail
 ok
 timestamps

data/Changelog

@@ -1,3 +1,6 @@
+0.9.0
+Add method MultiExiftool.delete_values.
+
 0.8.0
 Add MultiExiftool::VERSION.
 Rename method Values#parse_value -> convert and add parameter tag to allow tag

data/README.md

@@ -60,6 +60,26 @@ else
 end
 ```
 
+### Deleting
+
+```ruby
+# Delete ALL values
+errors = MultiExiftool.delete_values(Dir['*.jpg'])
+if errors.empty?
+  puts 'ok'
+else
+  puts writer.errors
+end
+
+# Delete values for tags Author and Title
+errors = MultiExiftool.delete_values(Dir['*.jpg'], tags: %w(author title))
+if errors.empty?
+  puts 'ok'
+else
+  puts writer.errors
+end
+```
+
 ### Further Examples
 
 See the examples in the examples directory.

data/lib/multi_exiftool.rb

@@ -7,55 +7,73 @@ require_relative 'multi_exiftool/writer'
 
 module MultiExiftool
 
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 
-  # Reading metadata
-  # Be aware: it returns an array of two elements:
-  # values, errors
-  #
-  # Example:
-  #   values, errors = MultiExiftool.read(Dir['*.jpg'])
-  #   if errors.empty?
-  #     values.each {|val| do_something_with(val) }
-  #   else
-  #     # error handling
-  #   end
-  def self.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?
-    values = reader.read
-    [values, reader.errors]
-  end
+  @exiftool_command = 'exiftool'
 
-  # Writing metadata
-  # Returns an array of the error messages
-  #
-  # Example:
-  #   errors = MultiExiftool.write(Dir['*.jpg'], {author: 'Jan Friedrich'})
-  #   unless errors.empty?
-  #     # do error handling
-  #   end
-  def self.write(filenames, values, opts={})
-    writer = Writer.new
-    writer.filenames = filenames
-    writer.values = values
-    writer.options = opts unless opts.empty?
-    writer.write
-    writer.errors
-  end
+  class << self
 
-  class Error < ::StandardError; end
+    # Reading metadata
+    # Be aware: it returns an array of two elements:
+    # values, errors
+    #
+    # Example:
+    #   values, errors = MultiExiftool.read(Dir['*.jpg'])
+    #   if errors.empty?
+    #     values.each {|val| do_something_with(val) }
+    #   else
+    #     # 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?
+      values = reader.read
+      [values, reader.errors]
+    end
 
-  @exiftool_command = 'exiftool'
+    # Writing metadata
+    # Returns an array of the error messages
+    #
+    # Example:
+    #   errors = MultiExiftool.write(Dir['*.jpg'], {author: 'Jan Friedrich'})
+    #   unless errors.empty?
+    #     # 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.write
+      writer.errors
+    end
 
-  class << self
+    # Deleting metadata
+    # Returns an array of the error messages
+    #
+    # Examples:
+    #   # delete values for all tags
+    #   errors = MultiExiftool.delete_values(Dir['*.jpg'])
+    #   unless errors.empty?
+    #     # do error handling
+    #   end
+    #
+    #   # delete values for tags Author and Title
+    #   errors = MultiExiftool.delete_values(Dir['*.jpg'], %w[author title])
+    #   unless errors.empty?
+    #     # do error handling
+    #   end
+    def delete_values filenames, tags: :all
+      values = Array(tags).inject(Hash.new) {|h,tag| h[tag] = nil; h}
+      write(filenames, values)
+    end
 
     attr_accessor :exiftool_command
     attr_reader :exiftool_version
@@ -73,5 +91,7 @@ module MultiExiftool
 
   end
 
+  class Error < ::StandardError; end
+
 end
 

data/multi_exiftool.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: multi_exiftool 0.8.0 ruby lib
+# stub: multi_exiftool 0.9.0 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,12 +7,12 @@
 
 Gem::Specification.new do |s|
   s.name = "multi_exiftool"
-  s.version = "0.8.0"
+  s.version = "0.9.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 = "2018-04-04"
+  s.date = "2018-04-09"
   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.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/temp", "test/temp/a.jpg", "test/temp/a.jpg_original", "test/temp/b.jpg", "test/temp/b.jpg_original", "test/temp/c.jpg", "test/temp/c.jpg_original", "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"]

data/test/test_functional_api.rb

@@ -32,7 +32,7 @@ class TestFunctionalApi < Test::Unit::TestCase
       end
     end
 
-    test 'successful reading of hierarichal data' do
+    test 'successful reading of hierarchical data' do
       run_in_temp_dir do
         values, errors = MultiExiftool.read(%w(a.jpg), group: 0)
         res = values.first
@@ -131,4 +131,61 @@ class TestFunctionalApi < Test::Unit::TestCase
 
   end
 
+  context 'deleting' do
+
+    setup do
+      @filenames = %w(a.jpg b.jpg c.jpg)
+    end
+
+    test 'delete all values' do
+      run_in_temp_dir do
+        errors = MultiExiftool.delete_values(@filenames)
+        assert_equal [], errors
+        values, errors = MultiExiftool.read(@filenames)
+        assert_equal [nil, nil, nil], values.map {|e| e['Author']}
+        assert_equal [nil, nil, nil], values.map {|e| e['FNumber']}
+        assert_equal [nil, nil, nil], values.map {|e| e['Title']}
+        assert_equal [], errors
+      end
+    end
+
+    test 'delete values for some tags' do
+      run_in_temp_dir do
+        errors = MultiExiftool.delete_values(@filenames, tags: %w(author title))
+        assert_equal [], errors
+        values, errors = MultiExiftool.read(@filenames)
+        assert_equal [nil, nil, nil], values.map {|e| e['Author']}
+        assert_equal [5.6, 6.7, 8], values.map {|e| e['FNumber']}
+        assert_equal [nil, nil, nil], values.map {|e| e['Title']}
+        assert_equal [], errors
+      end
+    end
+
+    test 'delete values for one tag' do
+      run_in_temp_dir do
+        errors = MultiExiftool.delete_values(@filenames, tags: :title)
+        assert_equal [], errors
+        values, errors = MultiExiftool.read(@filenames)
+        assert_equal ['Jan Friedrich'] * 3, values.map {|e| e['Author']}
+        assert_equal [5.6, 6.7, 8], values.map {|e| e['FNumber']}
+        assert_equal [nil, nil, nil], values.map {|e| e['Title']}
+        assert_equal [], errors
+      end
+    end
+
+    test 'error if tags do not exist' do
+      run_in_temp_dir do
+        errors = MultiExiftool.delete_values(@filenames, tags: %w[foo bar])
+        err1, err2, err3 = errors
+        expected1 = /^Warning: Tag 'foo' is not (defined|supported)$/
+        expected2 = /^Warning: Tag 'bar' is not (defined|supported)$/
+        expected3 = 'Nothing to do.'
+        assert_match expected1, err1
+        assert_match expected2, err2
+        assert_equal expected3, err3
+      end
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_exiftool
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake