multi_exiftool 0.1.3 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.2.0 Support writing to specific group with hash hierarchy.
+Support array-like values for tags like keywords.
+
 v0.1.3 Improve README and adapt project url.
 
 v0.1.2 Preserve time zone in time objects (don't convert to local zone).

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009-2010 Jan Friedrich
+Copyright (c) 2009-2012 Jan Friedrich
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Manifest

@@ -6,13 +6,16 @@ Rakefile
 examples/01_simple_reading.rb
 examples/02_simple_writing.rb
 examples/03_reading_using_groups.rb
+examples/04_writing_using_groups.rb
 lib/multi_exiftool.rb
 lib/multi_exiftool/executable.rb
 lib/multi_exiftool/reader.rb
 lib/multi_exiftool/values.rb
 lib/multi_exiftool/writer.rb
 test/helper.rb
+test/test_executable.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/README

@@ -4,7 +4,7 @@
 
 This library 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 
+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.
 
@@ -24,7 +24,7 @@ the results.
 === Writing
 
   require 'multi_exiftool'
-  
+
   writer = MultiExiftool::Writer.new
   writer.filenames = Dir['*.jpg']
   writer.values = {creator: 'Jan Friedrich', copyright: 'Public Domain'}
@@ -67,19 +67,19 @@ Jan Friedrich (janfri26 AT gmail DOT com)
 == Copyright / License
 
   The MIT License
-  
-  Copyright (c) 2009-2010 Jan Friedrich
-  
+
+  Copyright (c) 2009-2012 Jan Friedrich
+
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
-  
+
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
-  
+
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

data/examples/04_writing_using_groups.rb

@@ -0,0 +1,33 @@
+require 'multi_exiftool'
+require 'yaml'
+
+if ARGV.empty?
+  $stderr.puts 'No filenames given.'
+  exit -1
+end
+
+puts 'Please enter a description for the given files:'
+description = $stdin.gets.chomp
+
+puts 'Please enter a caption for the given files:'
+caption = $stdin.gets.chomp
+
+writer = MultiExiftool::Writer.new
+writer.filenames = ARGV
+
+# specifying group by prefix
+writer.values = {'exif:imagedescription' => description, 'xmp:description' => description}
+
+# specifying group hierarchical
+writer.values.merge! YAML.load <<-END
+iptc:
+  caption-abstract: #{caption}
+xmp:
+  caption: #{caption}
+END
+
+if writer.write
+  puts 'ok'
+else
+  puts writer.errors.join
+end

data/lib/multi_exiftool/executable.rb

@@ -7,12 +7,14 @@ module MultiExiftool
   # Mixin for Reader and Writer.
   module Executable
 
+    attr_reader :filenames
     attr_accessor :exiftool_command, :errors, :numerical
-    attr_writer :options, :filenames
+    attr_writer :options
 
     def initialize
       @exiftool_command = 'exiftool'
       @options = {}
+      @filenames = []
     end
 
     def options
@@ -21,8 +23,8 @@ module MultiExiftool
       opts
     end
 
-    def filenames
-      Array(@filenames)
+    def filenames= value
+      @filenames = Array(value)
     end
 
     def execute # :nodoc:
@@ -34,12 +36,12 @@ module MultiExiftool
     private
 
     def escape str
-      Shellwords.escape(str)
+      Shellwords.escape(str.to_s)
     end
 
     def escaped_filenames
       raise MultiExiftool::Error.new('No filenames.') if filenames.empty?
-      @filenames.map { |fn| Shellwords.escape(fn) }
+      filenames.map { |fn| Shellwords.escape(fn) }
     end
 
     def options_args

data/lib/multi_exiftool/reader.rb

@@ -15,6 +15,10 @@ module MultiExiftool
 
     include Executable
 
+    def initialize
+      super
+    end
+
     # Options to use with the exiftool command.
     def options
       opts = super

data/lib/multi_exiftool/writer.rb

@@ -8,13 +8,13 @@ module MultiExiftool
   # possible errors.
   class Writer
 
-    attr_accessor :overwrite_original
-    attr_writer :values
+    attr_accessor :overwrite_original, :values
 
     include Executable
 
-    def values
-      Array(@values)
+    def initialize
+      super
+      @values = {}
     end
 
     # Options to use with the exiftool command.
@@ -42,7 +42,21 @@ module MultiExiftool
 
     def values_args
       raise MultiExiftool::Error.new('No values.') if values.empty?
-      @values.map {|tag, val| "-#{tag}=#{escape(val.to_s)}"}
+      values_to_param_array(@values).map {|arg| "-#{arg}"}
+    end
+
+    def values_to_param_array hash
+      res = []
+      hash.each do |tag, val|
+        if val.respond_to? :to_hash
+          res << values_to_param_array(val.to_hash).map {|arg| "#{tag}:#{arg}"}
+        elsif val.respond_to? :to_ary
+          res << val.map {|v| "#{tag}=#{escape(v)}"}
+        else
+          res << "#{tag}=#{escape(val)}"
+        end
+      end
+      res.flatten
     end
 
     def parse_results

data/multi_exiftool.gemspec

@@ -1,33 +1,26 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{multi_exiftool}
-  s.version = "0.1.3"
+  s.name = "multi_exiftool"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Jan Friedrich}]
-  s.date = %q{2011-09-27}
-  s.description = %q{This library 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 = %q{janfri26@gmail.com}
-  s.extra_rdoc_files = [%q{CHANGELOG}, %q{LICENSE}, %q{README}, %q{lib/multi_exiftool.rb}, %q{lib/multi_exiftool/executable.rb}, %q{lib/multi_exiftool/reader.rb}, %q{lib/multi_exiftool/values.rb}, %q{lib/multi_exiftool/writer.rb}]
-  s.files = [%q{CHANGELOG}, %q{LICENSE}, %q{Manifest}, %q{README}, %q{Rakefile}, %q{examples/01_simple_reading.rb}, %q{examples/02_simple_writing.rb}, %q{examples/03_reading_using_groups.rb}, %q{lib/multi_exiftool.rb}, %q{lib/multi_exiftool/executable.rb}, %q{lib/multi_exiftool/reader.rb}, %q{lib/multi_exiftool/values.rb}, %q{lib/multi_exiftool/writer.rb}, %q{test/helper.rb}, %q{test/test_reader.rb}, %q{test/test_values.rb}, %q{test/test_values_using_groups.rb}, %q{test/test_writer.rb}, %q{multi_exiftool.gemspec}]
-  s.homepage = %q{http://gitorious.org/multi_exiftool}
-  s.post_install_message = %q{
-+-----------------------------------------------------------------------+
-| 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             |
-+-----------------------------------------------------------------------+
-  }
-  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Multi_exiftool}, %q{--main}, %q{README}]
-  s.require_paths = [%q{lib}]
+  s.authors = ["Jan Friedrich"]
+  s.date = "2012-05-11"
+  s.description = "This library 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.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/multi_exiftool.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "examples/01_simple_reading.rb", "examples/02_simple_writing.rb", "examples/03_reading_using_groups.rb", "examples/04_writing_using_groups.rb", "lib/multi_exiftool.rb", "lib/multi_exiftool/executable.rb", "lib/multi_exiftool/reader.rb", "lib/multi_exiftool/values.rb", "lib/multi_exiftool/writer.rb", "test/helper.rb", "test/test_executable.rb", "test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb", "test/test_writer_groups.rb", "multi_exiftool.gemspec"]
+  s.homepage = "http://gitorious.org/multi_exiftool"
+  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.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Multi_exiftool", "--main", "README"]
+  s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
-  s.requirements = [%q{exiftool, version 7.65 or higher}]
-  s.rubyforge_project = %q{multi_exiftool}
-  s.rubygems_version = %q{1.8.6.1}
-  s.summary = %q{This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).}
-  s.test_files = [%q{test/test_reader.rb}, %q{test/test_values.rb}, %q{test/test_values_using_groups.rb}, %q{test/test_writer.rb}]
+  s.requirements = ["exiftool, version 7.65 or higher"]
+  s.rubyforge_project = "multi_exiftool"
+  s.rubygems_version = "1.8.21"
+  s.summary = "This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool)."
+  s.test_files = ["test/test_executable.rb", "test/test_reader.rb", "test/test_values.rb", "test/test_values_using_groups.rb", "test/test_writer.rb", "test/test_writer_groups.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/test/test_executable.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+require_relative 'helper'
+
+class TestExecutable < Test::Unit::TestCase
+
+  class Exec
+    include MultiExiftool::Executable
+    def initialize
+      super
+    end
+  end
+
+  setup do
+    @executable = Exec.new
+  end
+
+  test 'appending to filenames' do
+    @executable.filenames << 'a.jpg'
+    assert_equal %w(a.jpg), @executable.filenames
+    @executable.filenames << 'b.jpg'
+    assert_equal %W(a.jpg b.jpg), @executable.filenames
+  end
+
+end

data/test/test_reader.rb

@@ -25,6 +25,12 @@ class TestReader < Test::Unit::TestCase
       end
     end
 
+    test 'one filename as string' do
+      @reader.filenames = 'a.jpg'
+      command = 'exiftool -J a.jpg'
+      assert_equal command, @reader.command
+    end
+
     test 'filenames with spaces' do
       @reader.filenames = ['one file with spaces.jpg', 'another file with spaces.tif']
       command = 'exiftool -J one\ file\ with\ spaces.jpg another\ file\ with\ spaces.tif'

data/test/test_writer.rb

@@ -27,12 +27,19 @@ class TestWriter < Test::Unit::TestCase
       end
     end
 
+    test 'one filename as string' do
+      @writer.values = {:author => 'janfri'}
+      @writer.filenames = 'a.jpg'
+      command = 'exiftool -author=janfri a.jpg'
+      assert_equal command, @writer.command
+    end
+
     test 'no values set' do
       @writer.filenames = %w(a.jpg b.tif c.bmp)
       assert_raises MultiExiftool::Error do
         @writer.command
       end
-      @writer.values = []
+      @writer.values = {}
       assert_raises MultiExiftool::Error do
         @writer.command
       end
@@ -45,6 +52,20 @@ class TestWriter < Test::Unit::TestCase
       assert_equal command, @writer.command
     end
 
+    test 'tags with rational value' do
+      @writer.filenames = %w(a.jpg b.tif c.bmp)
+      @writer.values ={shutterspeed: Rational(1, 125)}
+      command = 'exiftool -shutterspeed=1/125 a.jpg b.tif c.bmp'
+      assert_equal command, @writer.command
+    end
+
+    test 'tags with array-like values' do
+      @writer.filenames = %w(a.jpg b.tif c.bmp)
+      @writer.values = {keywords: ['one', 'two', 'and three']}
+      command = 'exiftool -keywords=one -keywords=two -keywords=and\ three a.jpg b.tif c.bmp'
+      assert_equal command, @writer.command
+    end
+
     test 'filenames with spaces' do
       @writer.filenames = ['one file with spaces.jpg', 'another file with spaces.tif']
       @writer.values = {:author => 'janfri'}

data/test/test_writer_groups.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+require_relative 'helper'
+require 'yaml'
+
+class TestWriterGroups < Test::Unit::TestCase
+
+  setup do
+    @writer = MultiExiftool::Writer.new
+    @writer.filenames = %w(a.jpg b.bmp c.tif)
+  end
+
+  test 'simple case' do
+    @writer.values = {:exif => {:comment => 'test'}  }
+    command = 'exiftool -exif:comment=test a.jpg b.bmp c.tif'
+    assert_equal command, @writer.command
+  end
+
+  test 'more than one groups and tags' do
+    @writer.values = YAML.load <<-END
+      exif:
+        author: janfri
+        comment: some comment
+      xmp:
+        author: janfri
+        subjectlocation: somewhere else
+    END
+    command = 'exiftool -exif:author=janfri -exif:comment=some\ comment -xmp:author=janfri -xmp:subjectlocation=somewhere\ else a.jpg b.bmp c.tif'
+    assert_equal command, @writer.command
+  end
+
+  test 'tags with array-like values' do
+    @writer.values = YAML.load <<-END
+      exif:
+        keywords:
+          - one
+          - two
+          - and three
+    END
+    command = 'exiftool -exif:keywords=one -exif:keywords=two -exif:keywords=and\ three a.jpg b.bmp c.tif'
+    assert_equal command, @writer.command
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_exiftool
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-27 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contest
-  requirement: &2161611280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161611280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This library 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
@@ -47,16 +52,19 @@ files:
 - examples/01_simple_reading.rb
 - examples/02_simple_writing.rb
 - examples/03_reading_using_groups.rb
+- examples/04_writing_using_groups.rb
 - lib/multi_exiftool.rb
 - lib/multi_exiftool/executable.rb
 - lib/multi_exiftool/reader.rb
 - lib/multi_exiftool/values.rb
 - lib/multi_exiftool/writer.rb
 - test/helper.rb
+- test/test_executable.rb
 - test/test_reader.rb
 - test/test_values.rb
 - test/test_values_using_groups.rb
 - test/test_writer.rb
+- test/test_writer_groups.rb
 - multi_exiftool.gemspec
 homepage: http://gitorious.org/multi_exiftool
 licenses: []
@@ -90,12 +98,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - exiftool, version 7.65 or higher
 rubyforge_project: multi_exiftool
-rubygems_version: 1.8.6.1
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).
 test_files:
+- test/test_executable.rb
 - test/test_reader.rb
 - test/test_values.rb
 - test/test_values_using_groups.rb
 - test/test_writer.rb
+- test/test_writer_groups.rb