assembly-objectfile 1.8.4 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55d4581c113766a963826ca6e77b15edcab495dfe1a58d029515ac63f71dab61
-  data.tar.gz: 6345774179c1af7b1bb179dcb079c79f0c48d15418d15b6c9a8010d2a81d66a8
+  metadata.gz: 04ee4aa95c21e1ef894bc760f83bf38bc4ce18cb18ca543451fc9645ee43f20b
+  data.tar.gz: e6e6f2a9a6d9e075470f412bcd299d4da9dbeb3e5aa673c6b371e3d20c3e06fc
 SHA512:
-  metadata.gz: 834d7062c0f3ffa547d5c88e051a5148598cbd6ec0debc9b0318da8c97725e9b136ee5cacbd64b49d1cf5e0bd7481ae4eaa5061e9b247772915b821f2af1c0d3
-  data.tar.gz: 3c2b9d1496af4400a57b383de90df51b02775e6f15afb6ca869607a4c890dd489cd932f99f473fb346de7fea81121e731ab1e04fb7c58dd4f6ee77bedda37ae3
+  metadata.gz: 23c5882333d2c6b95eb107672c374986c8b048d9844ed40c8716cae9f1d8ad4a1904c187f0bdc308ac97262010a0e386eaae833524100fd4de7d8f9dcf672c23
+  data.tar.gz: 15114a44a00b614f41d6cb8467c1fbaf16986dc570ed7e4decc574eebfdc1fe52321fc8c87cce37ba45199347860b47044ea8fde6467e4399569ac6c84eafe77

data/.rubocop_todo.yml

@@ -38,7 +38,7 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 107
+  Max: 117
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.

data/lib/assembly-objectfile/content_metadata/file_set.rb

@@ -7,7 +7,7 @@ module Assembly
     # Represents a groups of related Files, such as a single master file and the derivatives
     class FileSet
       # @param [Boolean] dpg (false) is it a dpg bundle?
-      # @param [Array] resource_files
+      # @param [Array<Assembly::ObjectFile>] resource_files
       # @param style
       def initialize(dpg: false, resource_files:, style:)
         @dpg = dpg

data/lib/assembly-objectfile/content_metadata/file_set_builder.rb

@@ -4,6 +4,9 @@ module Assembly
   class ContentMetadata
     # Builds a groups of related Files, based on bundle
     class FileSetBuilder
+      # @param [Symbol] bundle one of: :default, :filename, :dpg or :prebundled
+      # @param [Array<Assembly::ObjectFile>] objects
+      # @param [Symbol] style one of: :simple_image, :file, :simple_book, :book_as_image, :book_with_pdf, :map, or :'3d'
       def self.build(bundle:, objects:, style:)
         new(bundle: bundle, objects: objects, style: style).build
       end
@@ -25,6 +28,7 @@ module Assembly
           build_for_dpg
         when :prebundled
           # if the user specifies this method, they will pass in an array of arrays, indicating resources, so we don't need to bundle in the gem
+          # This is used by the assemblyWF if you have stubContentMetadata.xml
           objects.map { |inner| FileSet.new(resource_files: inner, style: style) }
         else
           raise 'Invalid bundle method'

data/lib/assembly-objectfile/object_fileable.rb

@@ -2,12 +2,12 @@
 
 require 'mini_exiftool'
 require 'mime/types'
-# require 'checksum-tools'
 
 module Assembly
   # Common behaviors we need for other classes in the gem
   module ObjectFileable
-    attr_accessor :file_attributes, :label, :path, :provider_md5, :provider_sha1, :relative_path
+    attr_accessor :file_attributes, :label, :path, :provider_md5, :provider_sha1, :relative_path, :mime_type_order
+    VALID_MIMETYPE_METHODS = %i[exif file extension].freeze
 
     # @param [String] path full path to the file to be worked with
     # @param [Hash<Symbol => Object>] params options used during content metadata generation
@@ -16,6 +16,9 @@ module Assembly
     # @option params [String] :provider_md5 pre-computed MD5 checksum
     # @option params [String] :provider_sha1 pre-computed SHA1 checksum
     # @option params [String] :relative_path if you want the file ids in the content metadata it can be set, otherwise content metadata will get the full path
+    # @option params [Array] :mime_type_order can be set to the order in which you want mimetypes to be determined
+    #                                          options are :exif (from exif if exists), :extension (from file extension), and :file (from unix file system command)
+    #                                          the default is defined in the private `default_mime_type_order` method but you can override to set your own order
     # @example
     #   Assembly::ObjectFile.new('/input/path_to_file.tif')
     def initialize(path, params = {})
@@ -25,6 +28,7 @@ module Assembly
       @relative_path = params[:relative_path]
       @provider_md5 = params[:provider_md5]
       @provider_sha1 = params[:provider_sha1]
+      @mime_type_order = params[:mime_type_order] || default_mime_type_order
     end
 
     # @return [String] DPG base filename, removing the extension and the '00','05', etc. placeholders
@@ -110,22 +114,33 @@ module Assembly
       @sha1 ||= Digest::SHA1.file(path).hexdigest
     end
 
-    # Returns mimetype information for the current file based on
-    #   (1) exifdata (if available), (2) unix file type or (3) file extension using the mimetypes gem, in this priority order
+    # Returns mimetype information for the current file based on the ordering set in default_mime_type_order
+    #   We stop computing mimetypes as soon as we have a method that returns a value
     # @return [String] mime type
     # @example
     #   source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
     #   puts source_file.mimetype # 'text/plain'
     def mimetype
       @mimetype ||= begin
-        if exif_mimetype # first, try the exif data
-          exif_mimetype
-        elsif file_mimetype # next, try exif/unix file system command
-          file_mimetype
-        else # finally, get it from the mime-types gem (using the file extension) if both of those failed for some reason
-          mtype = MIME::Types.type_for(path).first
-          mtype ? mtype.content_type : ''
+        check_for_file
+        mimetype = ''
+        mime_type_order.each do |mime_type_method|
+          mimetype = public_send("#{mime_type_method}_mimetype") if VALID_MIMETYPE_METHODS.include?(mime_type_method)
+          break if !mimetype.nil? && mimetype != ''
         end
+        mimetype
+      end
+    end
+
+    # Returns mimetype information using the mime-types gem (based on a file extension lookup)
+    # @return [String] mime type for supplied file
+    # @example
+    #   source_file = Assembly::ObjectFile.new('/input/path_to_file.txt')
+    #   puts source_file.extension_mimetype # 'text/plain'
+    def extension_mimetype
+      @extension_mimetype ||= begin
+        mtype = MIME::Types.type_for(path).first
+        mtype ? mtype.content_type : ''
       end
     end
 
@@ -234,11 +249,16 @@ exif&.mimetype && prefer_exif
     #   source_file = Assembly::ObjectFile.new('/input/path_to_file.tif')
     #   puts source_file.file_exists? # true
     def file_exists?
-      File.exist?(path) && !File.directory?(path)
+      @file_exists ||= (File.exist?(path) && !File.directory?(path))
     end
 
     private
 
+    # prive method defining default preferred ordering of how mimetypes are determined
+    def default_mime_type_order
+      %i[exif file extension]
+    end
+
     # private method to check for file existence before operating on it
     def check_for_file
       raise "input file #{path} does not exist" unless file_exists?

data/lib/assembly-objectfile/version.rb

@@ -4,6 +4,6 @@
 module Assembly
   class ObjectFile
     # Project version number
-    VERSION = '1.8.4'
+    VERSION = '1.9.0'
   end
 end

data/spec/object_file_spec.rb

@@ -25,6 +25,8 @@ describe Assembly::ObjectFile do
     expect(@ai.exif).not_to be nil
     expect(@ai.mimetype).to eq('image/tiff')
     expect(@ai.file_mimetype).to eq('image/tiff')
+    expect(@ai.extension_mimetype).to eq('image/tiff')
+    expect(@ai.exif_mimetype).to eq('image/tiff')
     expect(@ai.object_type).to eq(:image)
     expect(@ai.valid_image?).to eq(true)
     expect(@ai.jp2able?).to eq(true)
@@ -53,6 +55,16 @@ describe Assembly::ObjectFile do
     expect(@ai.mimetype).to eq('text/plain')
   end
 
+  it 'sets a mimetype of application/x-tgif for .obj 3d files if we prefer the mimetype extension gem over unix file system command' do
+    @ai = described_class.new(TEST_OBJ_FILE, mime_type_order: %i[extension file exif])
+    expect(@ai.mimetype).to eq('application/x-tgif')
+  end
+
+  it 'ignores invald mimetype generation methods and still sets a mimetype of application/x-tgif for .obj 3d files if we prefer the mimetype extension gem over unix file system command' do
+    @ai = described_class.new(TEST_OBJ_FILE, mime_type_order: %i[bogus extension file])
+    expect(@ai.mimetype).to eq('application/x-tgif')
+  end
+
   it 'sets the correct mimetype of plain/text for .ply 3d files' do
     @ai = described_class.new(TEST_PLY_FILE)
     expect(@ai.mimetype).to eq('text/plain')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.9.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby immplementation of file services needed to prepare objects to be accessioned