file_data 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 008003613bb4284356911dcc023da0a9190f9787
-  data.tar.gz: 95cfd92bf198612c9e20796577809f507cd866ab
+  metadata.gz: d38cf3da31fc0fc355f64228574f06888f52563e
+  data.tar.gz: 6babcaa52b7fe146f4a310eb2eb34868522edd2b
 SHA512:
-  metadata.gz: fd9ae2b5d47292ee6a0318dce866f97fa4d42ad812de9e05e5e1c18e140fa0186ab93045af8a7c0c8fafc01b9ad5d9e2e0fd7b77fee2d86d9de873d2fbe29274
-  data.tar.gz: 759531661d30f168362e75494e2dff6c003cefc3dd6819d6875882df32280aa617e00f98d16648f003633a80ba173c9610d40ddb20ab6648bcbbc65bc2bc17ab
+  metadata.gz: f537057f31aa2f9021cdf9f9d75a94fb03024f2e9b796f99c56a26c3826a7b801931771e73ffecdee4492050eb57fc320403b8007dbda3403317af577b95428b
+  data.tar.gz: 4ffd9045d319937d8b2561ee046eca8e6a08ca6cadcf938f4a3a132ec872aca310645c8b7a517ef6ed7e8f4f1793e9736fc3483010fd9a18ddaf87ab4635e596

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    file_data (4.0.0)
+    file_data (5.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -53,4 +53,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.14.3
+   1.14.6

data/README.md

@@ -20,40 +20,42 @@ To read exif data a stream of the jpeg data should be used as input. For perform
 Examples:
 
 ```ruby
-# Get Exif data from a file path or stream
+## Get Exif data from a file path or stream
 
-# Complete example with file path...
-tag_value = FileData::Exif.new.image_data_only('/path/to/file.jpg')
+# The file path or stream is passed as a parameter to class methods on FileData::Exif
+# rather than having the file path or stream set in the constructor and the methods
+# be instance methods to ensure that the user falls into a "pit of success" by only
+# opening the file once to get tag values rather than potentially multiple times
 
-# Complete example with a file stream... 
+# Get image exif data from a file path...
+hash = FileData::Exif.image_data_only('/path/to/file.jpg')
+
+# Get thumbnail exif data from a file stream... 
 File.open('/path/to/file.jpg', 'rb') do |f|
-  hash = FileData::Exif.new.image_data_only(f)
+  hash = FileData::Exif.thumbnail_data_only(f)
 end
 
-# Examples for all commands
-
-## Commands that get multiple tag values
-
-# Get only the image Exif data
-hash = FileData::Exif.new.image_data_only(file_path_or_stream)
-
-# Get only the thumbnail Exif data
-hash = FileData::Exif.new.thumbnail_data_only(file_path_or_stream)
+## Extract values depending on how much data is returned
 
-# Get all data (image and thumbnail)
-# Use result.image or result.thumbnail to get value hashes
-result = FileData::Exif.new.all_data(file_path_or_stream)
+# Image and thumbnail data are returned as a hash with keys
+# being the full tag name if it exists in FileData::ExifTags (see below listing)
+# or "#{ifd_id}-#{tag_id}" if there is no existing name for the tag in FileData::ExifTags
+image_hash = FileData::Exif.image_data_only(file_path_or_stream)
+image_description_value = image_hash[:Other_ImageDescription]
+unknown_gps_tag_value = image_hash["34853-99999"]
 
-## Commands that get a single tag value
-# tag_key is section/tag_id from the description in the first paragraph
-# tag_key values can be taken from the hash keys in FileData::ExifTags.tag_groups
-# all FileData::ExifTags.tag_groups keys are given after the examples
+thumbnail_hash = FileData::Exif.thumbnail_data_only(file_path_or_stream)
+image_width_tag_value = thumbnail_hash[:Image_Structure_Width]
+unknown_gps_tag_value = thumbnail_hash["Tiff-99999"]
 
-# Image example
-tag_value = FileData::Exif.new.only_image_tag(file_path_or_stream, tag_id)
+all_data = FileData::Exif.all_data(file_path_or_stream)
+image_hash = all_data.image
+thumbnail_hash = all_data.thumbnail
 
-# Thumbnail example
-tag_value = FileData::Exif.new.only_thumbnail_tag(file_path_or_stream, tag_id)
+# For extracting only a specific tag the value is returned and the search key must be
+# an array matching the keys needed to get traverse FileData:ExifTags (see below listing)
+image_description_value = FileData::Exif.only_image_tag(file_path_or_stream, [:Tiff, 270])
+unknown_exif_tag_value = FileData::Exif.only_thumbnail_tag(file_path_or_stream, [34665, 2])
 ```
 
 ## Known Tag Keys

data/lib/file_data/formats/exif/exif.rb

@@ -5,22 +5,23 @@ module FileData
   # Convenience class for extracting exif data from a file or stream
   class Exif
     # Create methods that forward to ExifReader
-    ExifReader.public_instance_methods.each do |method_name|
-      define_method(method_name) do |input, *other_args|
+    # Each method requires the stream as a parameter to help the user
+    # fall into a "pit of success" by only opening and closing
+    # the stream once to get data
+    ExifReader.public_instance_methods(false).each do |method_name|
+      define_singleton_method(method_name) do |input, *other_args|
         delegate_to_exif_reader(input, method_name, other_args)
       end
     end
 
-    private
-
-    def delegate_to_exif_reader(input, name, other_args)
+    def self.delegate_to_exif_reader(input, name, other_args)
       streamify(input) do |stream|
         exif = ExifJpeg.new(stream).exif
-        ExifReader.new.send(name, exif, *other_args)
+        ExifReader.new(exif).send(name, *other_args)
       end
     end
 
-    def streamify(input)
+    def self.streamify(input)
       if input.is_a?(String)
         File.open(input, 'rb') { |f| yield f }
       else

data/lib/file_data/formats/exif/exif_reader.rb

@@ -6,47 +6,51 @@ require_relative 'exif_data'
 module FileData
   # Returns the exif data from a jpeg file
   class ExifReader
-    def image_data_only(exif_stream)
-      exif_tags_internal(exif_stream, 0).image
+    def initialize(exif_stream)
+      @exif_stream = exif_stream
     end
 
-    def thumbnail_data_only(exif_stream)
-      exif_tags_internal(exif_stream, 1).thumbnail
+    def image_data_only
+      exif_tags_internal(0).image
     end
 
-    def all_data(exif_stream)
-      exif_tags_internal(exif_stream, 0, 1)
+    def thumbnail_data_only
+      exif_tags_internal(1).thumbnail
     end
 
-    def only_image_tag(exif_stream, tag_id)
-      exif_tag_internal(exif_stream, 0, tag_id)
+    def all_data
+      exif_tags_internal(0, 1)
     end
 
-    def only_thumbnail_tag(exif_stream, tag_id)
-      exif_tag_internal(exif_stream, 1, tag_id)
+    def only_image_tag(tag_id)
+      exif_tag_internal(0, tag_id)
     end
 
-    def tags(exif_stream, *ifds_to_include)
-      return [] if exif_stream.nil?
+    def only_thumbnail_tag(tag_id)
+      exif_tag_internal(1, tag_id)
+    end
+
+    def tags(*ifds_to_include)
+      return [] if @exif_stream.nil?
 
-      exif_stream.read_header
-      ExifTagReader.new(exif_stream, *ifds_to_include).tags
+      @exif_stream.read_header
+      ExifTagReader.new(@exif_stream, *ifds_to_include).tags
     end
 
     private
 
-    def exif_tags_internal(exif_stream, *ifds_to_include)
-      tags(exif_stream, *ifds_to_include).each_with_object(ExifData.new) do |tag_info, data|
-        data.add_tag(*tag_info, exif_stream.read_tag_value)
+    def exif_tags_internal(*ifds_to_include)
+      tags(@exif_stream, *ifds_to_include).each_with_object(ExifData.new) do |tag_info, data|
+        data.add_tag(*tag_info, @exif_stream.read_tag_value)
       end
     end
 
-    def exif_tag_internal(exif_stream, ifd_index, tag_to_find)
-      exif_stream.read_tag_value if find_tag(exif_stream, ifd_index, tag_to_find)
+    def exif_tag_internal(ifd_index, tag_to_find)
+      @exif_stream.read_tag_value if find_tag(ifd_index, tag_to_find)
     end
 
-    def find_tag(exif_stream, ifd_index, tag_to_find)
-      tags(exif_stream, ifd_index).find do |_, ifd_id, tag_num|
+    def find_tag(ifd_index, tag_to_find)
+      tags(@exif_stream, ifd_index).find do |_, ifd_id, tag_num|
         tag_to_find == [ifd_id, tag_num]
       end
     end

data/lib/file_data/version.rb

@@ -1,3 +1,3 @@
 module FileData
-  VERSION = '4.0.0'.freeze
+  VERSION = '5.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_data
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler