multi_exiftool 0.0.1 → 0.1.0

data/CHANGELOG

@@ -1 +1 @@
-v0.0.1 experimental
+v0.1.0 First public release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009-2010 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
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -1,25 +1,18 @@
-Rakefile
+CHANGELOG
+LICENSE
 Manifest
-test/test_command_generator.rb
-test/test_helper.rb
-test/test_parser.rb
-test/test_read_object.rb
-lib/multi_exiftool.rb
-lib/multi_exiftool/parser.rb
-lib/multi_exiftool/command_generator.rb
-lib/multi_exiftool/read_object.rb
 README
-data/fixtures/read_non_existing_file.stderr
-data/fixtures/read_non_existing_file.stdout
-data/fixtures/read_two_files.stderr
-data/fixtures/read_one_file.stderr
-data/fixtures/read_one_file.stdout
-data/fixtures/read_two_files.stdout
-data/regression/read_command.rb
-data/regression/read_command.rb.out
-data/regression/write_command.rb
-data/regression/write_command.rb.out
-script/generate_fixture.rb
-script/colorize.rb
-CHANGELOG
-COPYING
+Rakefile
+examples/01_simple_reading.rb
+examples/02_simple_writing.rb
+examples/03_reading_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_reader.rb
+test/test_values.rb
+test/test_values_using_groups.rb
+test/test_writer.rb

data/README

@@ -1,29 +1,90 @@
-= MULTI EXIFTOOL
-    Jan Friedrich
-    http://multi_exiftool.rubyforge.org
+= MultiExiftool
 
-== DESCRIPTION:
+== Description
 
-FIXME (describe your package)
+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.
 
-== FEATURES/PROBLEMS:
+== Examples
 
-* FIXME (list of features or problems)
+=== Reading
 
-== SYNOPSIS:
+  require 'multi_exiftool'
 
-  FIXME (code sample of usage)
+  reader = MultiExiftool::Reader.new
+  reader.filenames = Dir['*.jpg']
+  results = reader.read
+  results.each do |values|
+   puts "#{values.file_name}: #{values.comment}"
+  end
 
-== REQUIREMENTS:
+=== Writing
 
-* FIXME (list of requirements)
+  require 'multi_exiftool'
+  
+  writer = MultiExiftool::Writer.new
+  writer.filenames = Dir['*.jpg']
+  writer.values = {creator: 'Jan Friedrich', copyright: 'Public Domain'}
+  if writer.write
+    puts 'ok'
+  else
+    puts writer.errors.join
+  end
 
-== INSTALL:
+=== Further Examples
 
-* FIXME (sudo gem install, anything else)
+See the examples in the examples directory.
 
-== LICENSE:
 
-GNU Lesser General Public License (LGPL)
+== Requirements
+
+- Ruby 1.9.1 or higher
+- An installation of the Exiftool command-line application.
+  Instructions for installation you can find under
+  http://www.sno.phy.queensu.ca/~phil/exiftool/install.html .
+
+== Installation
+
+First you need Exiftool (see under Requirements above). Then you can simply
+install the gem with
+ gem install multi_exiftool
+
+== Contribution
+
+The code is also hostet in a git repository on Gitorious at
+http://gitorious.org/multi_exiftool
+or
+http://github.com/janfri/multi_exiftool-redesign
+feel free to contribute!
+
+== Author
+
+Jan Friedrich (janfri26 AT gmail DOT com)
+
+== Copyright / License
+
+  The MIT License
+  
+  Copyright (c) 2009-2010 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
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
 
-See file COPYING.txt for more details.

data/Rakefile

@@ -1,43 +1,22 @@
 require 'echoe'
 
-Echoe.new 'multi_exiftool' do |p|
+Echoe.new('multi_exiftool') do |p|
   p.author = 'Jan Friedrich'
-  p.email = 'janfri.rubyforge@gmail.com'
-  p.project = 'multiexiftool'
-  p.url = 'http://multiexiftool.rubyforge.org'
-  p.development_dependencies = ['yact']
-end
-
-namespace :reg do
-
-  ROOT_DIR = File.dirname(__FILE__)
-  SCRIPT_DIR = File.join(ROOT_DIR, 'script')
-  DATA_DIR = File.join(ROOT_DIR, %w(data regression))
-  RB_FILES = File.join(DATA_DIR, '*.rb')
-
-  desc 'Generate regression data'
-  task :generate
-
-  def target src
-    src + '.out'
+  p.email = 'janfri26@gmail.com'
+  p.summary = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
+  p.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.'
+  p.ruby_version = '>=1.9.1'
+  p.url = 'http://rubyforge.org/projects/multiexiftool'
+  p.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             |
++-----------------------------------------------------------------------+
+  }
+  p.development_dependencies = ['contest']
+  p.eval = proc do
+    self.requirements << 'exiftool, version 7.65 or higher'
   end
-
-  FileList[RB_FILES].each do |src|
-    target = target(src)
-    file target => src do |t|
-      sh "ruby #{t.prerequisites.first} > #{t.name}"
-    end
-
-    task :generate => target
-  end
-
-  desc 'Running regression tests'
-  task :test => :generate do
-    FileList[RB_FILES].each do |src|
-      target = target(src)
-      puts '-' * 8 << File.basename(src)
-      sh "ruby #{src} | wdiff -n #{target} - | #{File.join(SCRIPT_DIR, 'colorize.rb')}"# ; echo x >/dev/null"
-    end
-  end
-
 end

data/examples/01_simple_reading.rb

@@ -0,0 +1,13 @@
+require 'multi_exiftool'
+
+if ARGV.empty?
+  $stderr.puts 'No filenames given.'
+  exit -1
+end
+
+reader = MultiExiftool::Reader.new
+reader.filenames = ARGV
+results = reader.read
+results.each do |values|
+ puts "#{values.file_name}: #{values.comment}"
+end

data/examples/02_simple_writing.rb

@@ -0,0 +1,19 @@
+require 'multi_exiftool'
+
+if ARGV.empty?
+  $stderr.puts 'No filenames given.'
+  exit -1
+end
+
+puts 'Please enter a comment for the given files:'
+comment = $stdin.gets.chomp
+
+writer = MultiExiftool::Writer.new
+writer.filenames = ARGV
+writer.overwrite_original = true
+writer.values = {comment: comment}
+if writer.write
+  puts 'ok'
+else
+  puts writer.errors.join
+end

data/examples/03_reading_using_groups.rb

@@ -0,0 +1,28 @@
+require 'multi_exiftool'
+
+if ARGV.empty?
+  $stderr.puts 'No filenames given.'
+  exit -1
+end
+
+reader = MultiExiftool::Reader.new
+reader.filenames = ARGV
+reader.group = 0
+results = reader.read
+results.each do |values|
+  # direct access
+  puts values.file.filename
+  # access via block without parameter
+  values.iptc do
+    self.keywords do
+      puts "  Keywords (IPCT): #{Array(self).join(', ')}"
+    end
+  end
+  # access via block with parameter
+  values.xmp do |xmp|
+    xmp.keywords do |kw|
+      puts "  Keywords (XMP): #{Array(kw).join(', ')}"
+    end
+  end
+end
+

data/lib/multi_exiftool.rb

@@ -1,43 +1,11 @@
-require 'multi_exiftool/command_generator'
-require 'multi_exiftool/parser'
-require 'multi_exiftool/read_object'
-require 'open3'
-require 'ostruct'
-require 'logger'
-
-# monkey patching --- the save way :D
-class OpenStruct
-  unless self.new.respond_to? :to_hash
-    def to_hash
-      @table
-    end
-  end
-end
+# coding: utf-8
+require_relative 'multi_exiftool/values'
+require_relative 'multi_exiftool/reader'
+require_relative 'multi_exiftool/writer'
 
 module MultiExiftool
 
-  class << self
-
-    attr_accessor :logger
-
-    def read *filenames
-      cmd = CommandGenerator.read_command *filenames
-      stdin, stdout, stderr = Open3.popen3(cmd)
-      result = Parser.parse(stdout, stderr)
-      result.map {|r| ReadObject.new(r.data)}
-    end
-
-
-    def write change_set, *filenames
-      cmd = CommandGenerator.write_command change_set, *filenames
-      @logger.debug cmd
-      stdin, stdout, stderr = Open3.popen3(cmd)
-      result = Parser.parse(stdout, stderr)
-      result.inject(true) {|r| r.errors.empty?}
-    end
-
-  end
-  
-  @logger = Logger.new nil
+  class Error < ::StandardError; end
 
 end
+

data/lib/multi_exiftool/executable.rb

@@ -0,0 +1,67 @@
+# coding: utf-8
+require 'open3'
+require 'shellwords'
+
+module MultiExiftool
+
+  # Mixin for Reader and Writer.
+  module Executable
+
+    attr_accessor :exiftool_command, :errors, :numerical
+    attr_writer :options, :filenames
+
+    def initialize
+      @exiftool_command = 'exiftool'
+      @options = {}
+    end
+
+    def options
+      opts = @options.dup
+      opts[:n] = true if @numerical
+      opts
+    end
+
+    def filenames
+      Array(@filenames)
+    end
+
+    def execute # :nodoc:
+      prepare_execution
+      execute_command
+      parse_results
+    end
+
+    private
+
+    def escape str
+      Shellwords.escape(str)
+    end
+
+    def escaped_filenames
+      raise MultiExiftool::Error.new('No filenames.') if filenames.empty?
+      @filenames.map { |fn| Shellwords.escape(fn) }
+    end
+
+    def options_args
+      opts = options
+      return [] if opts.empty?
+      opts.map do |opt, val|
+        if val == true
+          "-#{opt}"
+        else
+          "-#{opt} #{val}"
+        end
+      end
+    end
+
+    def prepare_execution
+      @errors = []
+    end
+
+    def execute_command
+      stdin, @stdout, @stderr = Open3.popen3(command)
+    end
+
+  end
+
+end

data/lib/multi_exiftool/reader.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+require_relative 'executable'
+require 'json'
+
+module MultiExiftool
+
+  # Handle reading of metadata via exiftool.
+  # Composing the command for the command-line executing it and parsing
+  # the results as well as possible errors.
+  class Reader
+
+    MANDATORY_ARGS = %w(-J)
+
+    attr_accessor :tags, :group
+
+    include Executable
+
+    # Options to use with the exiftool command.
+    def options
+      opts = super
+      if @group
+        opts["g#{@group}"] = true
+      end
+      opts
+    end
+
+    # Getting the command for the command-line which would be executed
+    # when calling #read. It could be useful for logging, debugging or
+    # maybe even for creating a batch-file with exiftool command to be
+    # processed.
+    def command
+      cmd = [exiftool_command]
+      cmd << MANDATORY_ARGS
+      cmd << options_args
+      cmd << tags_args
+      cmd << escaped_filenames
+      cmd.flatten.join(' ')
+    end
+
+    alias read execute # :nodoc:
+
+    private
+
+    def tags_args
+      return [] unless @tags
+      @tags.map {|tag| "-#{tag}"}
+    end
+
+    def parse_results
+      stdout = @stdout.read
+      @errors = @stderr.readlines
+      json = JSON.parse(stdout)
+      json.map {|values| Values.new(values)}
+    rescue JSON::ParserError
+      return []
+    end
+
+  end
+
+end