exiftoolr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd656c3093b0eb6f3f94cc402bf5ee14a9b13ba
-  data.tar.gz: a8129d314f15fe908720f07393581b251ae95bfa
+  metadata.gz: 86c98c6b3dee0ab28c3ca8f2d5a5707abceb771a
+  data.tar.gz: 0e3a10c593d43ad8a1eac4cad6e2771f3adb82d8
 SHA512:
-  metadata.gz: d8bcb6cc7a2dce7917f64c00e616f2493662562ff11ecfbc1bc49665311fd372c6ce057db7e343d45e7cd09e815cdf1ea3dd1f0bed395e086e57c17bbb62c685
-  data.tar.gz: 051740e233bd226e7293e4dd332bd22f1de4cc785f670bd3f43b324481d958c75f7ae515199bb8e654f58bd7c002ac3e8a2487b46dbc8f32068909b5d892d9e4
+  metadata.gz: 9bfcc98ac2e68a9d958d1879170ab6adae73e026239f5978c1db7d0fd887f25796dda5b30cb3d94f270deb4b1f056aee62166295978eebeee6672fe8588da130
+  data.tar.gz: 232d3ac4d5d4f0993d6801a7ce16ff6681185be71bc2ca6a9306cfe35e95666e419e667da6b7c95c2264e8e30f2152b7a53be1ac9d9f4b88066fa44add6846dc

data/README.md

@@ -8,77 +8,19 @@ This gem is the simplest thing that could possibly work that
 reads the output of [exiftool](http://www.sno.phy.queensu.ca/~phil/exiftool)
 and renders it into a ruby hash, with correctly typed values and symbolized keys.
 
-Rubies 1.9 and later are supported.
+Note that this gem was renamed from 'exiftoolr' to the less-ungainly 'exiftool'
+as of version 0.2.0. This gem simply adds a "class alias" from Exiftoolr to Exiftool,
+and is dependant on that new gem.
 
-## What constitutes "correct values"?
+Consumers should switch to the new gem's namespace as soon as possible.
 
-* GPS latitude and longitude are rendered as signed floats,
-  where north and east are positive, and west and south are negative.
-* Values like shutter speed and exposure time are rendered as Rationals,
-  which lets the caller show them as fractions (1/250) or as comparable numeric instances.
-* String values like "interop" and "serial number" are kept as strings
-  (which preserves zero prefixes)
-* Timestamps are attempted to be interpreted with correct timezones and sub-second resolution, if
-  the header contains that data.
-  Please note that EXIF headers don't always include a timezone offset, so we just adopt the system
-  timezone, which may, of course, be wrong.
+Go to [exiftool](https://github.com/mceachen/exiftool) for more information!
 
-## Usage
-
-```ruby
-require 'exiftoolr'
-e = Exiftoolr.new("path/to/iPhone 4S.jpg")
-e.to_hash
-# => {:make => "Apple", :gps_longitude => -122.47566667, …
-e.to_display_hash
-# => {"Make" => "Apple", "GPS Longitude" => -122.47566667, …
-```
-
-### Multiple file support
-
-This gem supports Exiftool's multiget, which lets you fetch metadata for many files at once.
-
-This can be dramatically more efficient (like, 60x faster) than spinning up the ```exiftool```
-process for each file.
-
-Supply an array to the Exiftoolr initializer, then use ```.result_for```:
-
-```ruby
-require 'exiftoolr'
-e = Exiftoolr.new(Dir["**/*.jpg"])
-result = e.result_for("path/to/iPhone 4S.jpg")
-result.to_hash
-# => {:make => "Apple", :gps_longitude => -122.47566667, …
-result[:gps_longitude]
-# => -122.47566667
-
-e.files_with_results
-# => ["path/to/iPhone 4S.jpg", "path/to/Droid X.jpg", …
-```
-
-### When things go wrong
-
-* ```Exiftoolr::NoSuchFile``` is raised if the provided filename doesn't exist.
-* ```Exiftoolr::ExiftoolNotInstalled``` is raised if ```exiftool``` isn't in your ```PATH```.
-* If ExifTool has a problem reading EXIF data, no exception is raised, but ```#errors?``` will return true:
-
-```ruby
-Exiftoolr.new("Gemfile").errors?
-#=> true
-```
-
-
-## Installation
-
-First [install ExifTool](http://www.sno.phy.queensu.ca/~phil/exiftool/install.html).
-
-Then, add this your Gemfile:
-
-    gem 'exiftoolr'
+## Change history
 
-and then run ```bundle```.
+### 0.2.0
 
-## Change history
+* Renamed to 'exiftool' (but kept backward compatibility)
 
 ### 0.1.0
 

data/exiftoolr.gemspec

@@ -1,11 +1,10 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'exiftoolr/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'exiftoolr'
-  spec.version     = Exiftoolr::VERSION
+  spec.version     = Gem::Version.new('0.2.0')
   spec.authors     = ['Matthew McEachen']
   spec.email       = %w(matthew-github@mceachen.org)
   spec.homepage    = 'https://github.com/mceachen/exiftoolr'
@@ -21,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.requirements << 'ExifTool (see http://www.sno.phy.queensu.ca/~phil/exiftool/)'
 
   spec.add_dependency 'json'
+  spec.add_dependency 'exiftool'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'yard'

data/lib/exiftoolr.rb

@@ -1,73 +1,3 @@
-require 'json'
-require 'shellwords'
-require 'exiftoolr/result'
+require 'exiftool'
 
-class Exiftoolr
-  class NoSuchFile < StandardError ; end
-  class NotAFile < StandardError ; end
-  class ExiftoolNotInstalled < StandardError ; end
-
-  def self.exiftool_installed?
-    exiftool_version > 0
-  end
-
-  def self.exiftool_version
-    @@exiftool_version ||= `exiftool -ver 2> /dev/null`.to_f
-  end
-
-  def self.expand_path(filename)
-    raise(NoSuchFile, filename) unless File.exist?(filename)
-    raise(NotAFile, filename) unless File.file?(filename)
-    File.expand_path(filename)
-  end
-
-  def initialize(filenames, exiftool_opts = '')
-    @file2result = {}
-    filenames = [filenames] if filenames.is_a?(String)
-    unless filenames.empty?
-      escaped_filenames = filenames.collect do |f|
-        Shellwords.escape(self.class.expand_path(f.to_s))
-      end.join(" ")
-      # I'd like to use -dateformat, but it doesn't support timezone offsets properly,
-      # nor sub-second timestamps.
-      cmd = "exiftool #{exiftool_opts} -j -coordFormat \"%.8f\" #{escaped_filenames} 2> /dev/null"
-      json = `#{cmd}`
-      raise ExiftoolNotInstalled if json == ""
-      JSON.parse(json).each do |raw|
-        result = Result.new(raw)
-        @file2result[result.source_file] = result
-      end
-    end
-  end
-
-  def result_for(filename)
-    @file2result[self.class.expand_path(filename)]
-  end
-
-  def files_with_results
-    @file2result.values.collect { |r| r.source_file unless r.errors? }.compact
-  end
-
-  def to_hash
-    first.to_hash
-  end
-
-  def to_display_hash
-    first.to_display_hash
-  end
-
-  def symbol_display_hash
-    first.symbol_display_hash
-  end
-
-  def errors?
-    @file2result.values.any? { |ea| ea.errors? }
-  end
-
-  private
-
-  def first
-    raise InvalidArgument, 'use #result_for when multiple filenames are used' if @file2result.size > 1
-    @file2result.values.first
-  end
-end
+Exiftoolr = Exiftool

data/test/exiftoolr_test.rb

@@ -18,7 +18,7 @@ describe Exiftoolr do
   end
 
   it 'has errors with files without EXIF headers' do
-    e = Exiftoolr.new("Gemfile")
+    e = Exiftoolr.new('Gemfile')
     e.errors?.must_be_true
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exiftoolr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: exiftool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,9 +136,6 @@ files:
 - Rakefile
 - exiftoolr.gemspec
 - lib/exiftoolr.rb
-- lib/exiftoolr/parser.rb
-- lib/exiftoolr/result.rb
-- lib/exiftoolr/version.rb
 - test/Canon 20D.jpg
 - test/Canon 20D.jpg.yaml
 - test/Droid X.jpg

data/lib/exiftoolr/parser.rb

@@ -1,63 +0,0 @@
-require 'time'
-require 'date'
-require 'rational'
-
-class Exiftoolr
-  class Parser
-
-    WORD_BOUNDARY_RES = [/([A-Z\d]+)([A-Z][a-z])/, /([a-z\d])([A-Z])/]
-    FRACTION_RE = /^(\d+)\/(\d+)$/
-
-    attr_reader :key, :display_key, :sym_key, :raw_value
-
-    def initialize(key, raw_value)
-      @key = key
-      @display_key = WORD_BOUNDARY_RES.inject(key) { |k, regex| k.gsub(regex, '\1 \2') }
-      @sym_key = display_key.downcase.gsub(' ', '_').to_sym
-      @raw_value = raw_value
-    end
-
-    def value
-      for_lat_long ||
-        for_date ||
-        for_fraction ||
-        raw_value
-    rescue StandardError => e
-      "Warning: Parsing '#{raw_value}' for attribute '#{key}' raised #{e.message}"
-    end
-
-    private
-
-    def for_lat_long
-      if sym_key == :gps_latitude || sym_key == :gps_longitude
-        value, direction = raw_value.split(" ")
-        if value =~ /\A\d+\.?\d*\z/
-          value.to_f * (['S', 'W'].include?(direction) ? -1 : 1)
-        end
-      end
-    end
-
-    def for_date
-      if raw_value.is_a?(String) && display_key =~ /\bdate\b/i
-        try_parse { Time.strptime(raw_value, '%Y:%m:%d %H:%M:%S%z') } ||
-          try_parse { Time.strptime(raw_value, '%Y:%m:%d %H:%M:%S') } ||
-          try_parse { Time.strptime(raw_value, '%Y:%m:%d %H:%M:%S.%L%z') } ||
-          try_parse { Time.strptime(raw_value, '%Y:%m:%d %H:%M:%S.%L') } ||
-          try_parse { Time.parse(raw_value) }
-      end
-    end
-
-    def try_parse
-      yield
-    rescue ArgumentError
-      nil
-    end
-
-    def for_fraction
-      if raw_value.is_a?(String)
-        scan = raw_value.scan(FRACTION_RE).first
-        v = Rational(*scan.map { |ea| ea.to_i }) unless scan.nil?
-      end
-    end
-  end
-end

data/lib/exiftoolr/result.rb

@@ -1,32 +0,0 @@
-require 'exiftoolr/parser'
-
-class Exiftoolr
-  class Result
-    attr_reader :to_hash, :to_display_hash, :symbol_display_hash
-
-    def initialize(raw_hash)
-      @raw_hash = raw_hash
-      @to_hash = {}
-      @to_display_hash = {}
-      @symbol_display_hash = {}
-      @raw_hash.each do |key, raw_value|
-        p = Parser.new(key, raw_value)
-        @to_hash[p.sym_key] = p.value
-        @to_display_hash[p.display_key] = p.value
-        @symbol_display_hash[p.sym_key] = p.display_key
-      end
-    end
-
-    def [](key)
-      @to_hash[key]
-    end
-
-    def source_file
-      self[:source_file]
-    end
-
-    def errors?
-      self[:error] == 'Unknown file type' || self[:warning] == 'Unsupported file type'
-    end
-  end
-end

data/lib/exiftoolr/version.rb

@@ -1,3 +0,0 @@
-class Exiftoolr
-  VERSION = Gem::Version.new('0.1.0')
-end