Repository files navigation

This gem is the simplest thing that could possibly work thatreads the output ofexiftooland renders it into a ruby hash, withcorrectly typed values and symbolized keys.

Ruby 3.1 through 3.3 are supported.

Future releases ofexiftool Gem will no longer support followingRuby Versions due to theirEnd Of Life announcements:

• Ruby 2.4 (EOL 2020-03-31)
• Ruby 2.5 (EOL 2021-03-31)
• Ruby 2.6 (EOL 2022-04-12)
• Ruby 2.7 (EOL 2023-03-31)
• Ruby 3.0 (EOL 2024-04-23)

The latest Exiftool is recommended, but you'll get that automatically by using theexiftool_vendored gem!

• Multiget support
• GPS latitude and longitude values are parsed 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, ifthe header contains that data.If the timestamp doesn't include a timezone offset, we leave it as a string, rather than inferringthe current system timezone which might not be applicable to the image. We add a decimal yyyymmddkey for these problematic fields.
• Nomethod_missing madness
• Excellent test coverage
• Clean, readable code
• MIT license

require'exiftool'e=Exiftool.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, …

This gem supports Exiftool's multiget, which lets you fetch metadata for many files at once.

This can be dramatically more efficient than spinning up theexiftoolprocess for each file due to the cost of spinning up perl.

Supply an array to the Exiftool initializer, then use.result_for:

require'exiftool'e=Exiftool.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

Or iterate through files_with_results:

e.files_with_results# => ["path/to/iPhone 4S.jpg", "path/to/Droid X.jpg", …

It seems that most exif dates don't include timezone offsets, without which forces us to assume thecurrent timezone is applicable to the image, which isn't necessarily correct.

To be correct, we punt and return the exiftool-formatted string, which will be something like%Y:%m:%d %H:%M:%S.

If the clock was set correctly on your camera, the date will be the correct calendar dayas far as you were concerned when you took the photo. Given that, weadd a_civil key associated to just the calendar date of the field, which should be safe-ish.

require'exiftool'e=Exiftool.new("test/IMG_2452.jpg")e[:date_time_original]=>"2011:07:06 09:46:45"e[:date_time_original_civil]=>#<Date: 2011-07-06 ((2455749j,0s,0n),+0s,2299161j)>

• Exiftool::NoSuchFile is raised if the provided filename doesn't exist.
• Exiftool::ExiftoolNotInstalled is raised ifexiftool isn't in yourPATH.
• If ExifTool has a problem reading EXIF data, no exception is raised, but#errors? will return true:

Exiftool.new("Gemfile").errors?#=> true

The easiest way is to use the "vendored" exiftool in theexiftool_vendored gem. Just add

gem 'exiftool_vendored'

to your Gemfile, runbundle, and you're done. (Note that it depends on theexiftool gem,so really, you're done! Skip step 2!)

If you want to install exiftool on your system yourself:

• MacOS withhomebrew?brew install exiftool
• Debian or Ubuntu?sudo apt-get install libimage-exiftool-perl
• Something else?RTFM!

If you didn't useexiftool_vendored, then add this your Gemfile:

gem 'exiftool'

and then runbundle.

If you have exiftool installed outside of ruby'sPATH, add an initializer that points the gemto the tool, like this:Exiftool.command = '/home/ruby/Image-ExifTool-9.33/exiftool'. You don't need to dothis if you've installed added the exiftool directory to the PATH of the shell that runs ruby.

• Moved from travis-ci.org to travis-ci.com
• Updated Ruby versions for Travis CI runs. Running on 2.6.8, 2.7.4 and 3.0.2
• Updated simplecov version for test coverage reporting
• MergedPR #23 byurtabajev that fixesNameError related topathname standard library when multiget is used

• Added Ruby 3.0.0 to Travis CI tests and updated config to Ruby 2.7.2
• Added Ruby Deprecation note to README.md about dropping support for Ruby 2.4 and 2.5 starting March 31, 2021
• rubocop fixes
• Addedrubocop-minitest andrubocop-rake for better styleguide coverage

• Code is following rubocop style guide (mostly)
• Improved tests and code coverage

• Fixedexiftool_installed?, referenced byissue #11.

• Add check for valid civil date. Addressesissue#10). Thanks for theassist,Victor Bogado da Silva Lins!

• SupportPathname instances as constructor args.Addressesissue #8

• Dropped official support for jruby due to CI failures.

• Updates fromSergey Morozov to addressissue #7,which allows for-n (force numeric values)

• Updates fromSergey Morozov to support newerrubies, and validate UTF field parsing was handled correctly

• Added zero-date parsing to addressissue #2.Thanks for the pull request,Sergey Morozov!
• Updated Travis configuration (RIP 1.9.x).

• Introduced YMD parsing for all date columns, even if they don't specify timezone offsets.

• Added#raw_hash toExiftool::Result to support columns that can have parsing issues,like dates that don't include timezone offsets.

• .exiftool_version is now a string rather than a float,which didn't work so well with version numbers like "9.40"

• Support for explicitly setting the path to exiftool withExiftool.command
• Removed the test directory from the gem contents, as it included the testimages and made the gem ginormous.

• Renamed from exiftoolr to exiftool

• Better timestamp parsing—now both sub-second and timezone offsets are handledcorrectly
• Switched to minitest-spec
• Ruby 1.8.7 is no longer supported, hence the minor version uptick.

• Explicitly added MIT licensing to the gemspec.

• Extracted methods in parsing to make the code complexity lower. FOUR DOT OH GPA

• Added warning values for EXIF headers that are corrupt
• Made initialize gracefully accept an empty array, or an array of Pathnameinstances
• Added support for ruby 1.9.3 and exiftool v8.15 (Ubuntu Natty) and v8.85(current stable version)

Fixed homepage URL in gemspec

Added support for multiple file fetching (which ismuch faster for large directories)