assembly-objectfile 1.10.2 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925ceb88bbc6d965b3ab9be3695e7ec318c65a11716cb5cdb2d1178af1a08174
-  data.tar.gz: bbc6282d8d375dd0cf49a55519563abff44429f012221dfc1b4cf0219de47aa9
+  metadata.gz: 0060fb5fbd2271cc712b63d2d1ff8752c7ab11346f7ee0a43f41fcc48288d805
+  data.tar.gz: 1759dd3e2e5c8ab86333957f30b27468296b53b0f4c7e1607f08e09b4f77da9c
 SHA512:
-  metadata.gz: 997b90f28dd603f11cabc20d2dc598eaf60a5f3c1b3b168b770748f6ce48377e15e8665824976a4838be52e35a54bafb508c42aca6ddaa3c6f8e31c3f627b1b2
-  data.tar.gz: 1033e903f01344e8944ed681e61debb128603b3b3d898269cad582d7a1a0b674fd837e4114a81033b2cbfff97da6c9d9ee17a27cfad606622eacf768436c22fc
+  metadata.gz: a6fa4a4f685bfd3f1c95284b07f8531b1bcdb6330d54b578ad5fefb7e394dd04431bb666930902204b06b44fedeefb9dca0fa9e69939775d27b40df2d41d434a
+  data.tar.gz: ccd72959056a26a186c32247100a86ffc7596ce3ef960800ada4f7c6677da13548b4e54dd5614c015555676d25264e5850d809fab3da7a968312af071654a984

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-16 21:16:42 UTC using RuboCop version 1.11.0.
+# on 2021-04-26 18:43:37 UTC using RuboCop version 1.11.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,7 +14,7 @@ Lint/UselessAssignment:
 # Offense count: 3
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 56
+  Max: 55
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
@@ -35,12 +35,12 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 117
+  Max: 120
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 13
+  Max: 12
 
 # Offense count: 2
 # Configuration parameters: IgnoredMethods.
@@ -79,13 +79,13 @@ RSpec/FilePath:
     - 'spec/content_metadata_spec.rb'
     - 'spec/object_file_spec.rb'
 
-# Offense count: 71
+# Offense count: 74
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Exclude:
     - 'spec/object_file_spec.rb'
 
-# Offense count: 39
+# Offense count: 40
 RSpec/MultipleExpectations:
   Max: 29
 
@@ -110,7 +110,7 @@ Style/CommentedKeyword:
   Exclude:
     - 'lib/assembly-objectfile/content_metadata.rb'
 
-# Offense count: 116
+# Offense count: 122
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

data/lib/assembly-objectfile.rb

@@ -14,6 +14,14 @@ module Assembly
   #  by the file command, then a check will be made to see if exif data exists...if so, the mimetype returned by the exif data will be used
   #  if no exif data exists, then the mimetype returned by the unix file command will be used
   TRUSTED_MIMETYPES = ['text/plain', 'plain/text', 'application/pdf', 'text/html', 'application/xml'].freeze
+
+  # this is a manual override mapping of file extension to mimetype; if a file with the given extension is found, the mapped
+  #  mimetype will be returned and no further methods will be used - this is used to force a specific mimetype to be returned for
+  #  for a given file extension regardless of what exif or the unix file system command returns
+  #  the mapping format is "extension with period: returned mimetype",  e.g. for any .json file, you will always get `application/json`
+  OVERRIDE_MIMETYPES = {
+    '.json': 'application/json'
+  }.freeze
 end
 
 require 'assembly-objectfile/content_metadata'

data/lib/assembly-objectfile/object_fileable.rb

@@ -8,7 +8,7 @@ module Assembly
   module ObjectFileable
     attr_accessor :file_attributes, :label, :path, :provider_md5, :provider_sha1, :relative_path, :mime_type_order
 
-    VALID_MIMETYPE_METHODS = %i[exif file extension].freeze
+    VALID_MIMETYPE_METHODS = %i[override 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
@@ -18,7 +18,8 @@ module Assembly
     # @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)
+    #                                          options are :override (from manual overide mapping if exists), :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')
@@ -127,12 +128,21 @@ module Assembly
         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 != ''
+          break if mimetype.present?
         end
         mimetype
       end
     end
 
+    # Returns mimetype information using the manual override mapping (based on a file extension lookup)
+    # @return [String] mime type for supplied file if a mapping exists for the file's extension
+    # @example
+    #   source_file = Assembly::ObjectFile.new('/input/path_to_file.json')
+    #   puts source_file.override_mimetype # 'application/json'
+    def override_mimetype
+      @override_mimetype ||= Assembly::OVERRIDE_MIMETYPES.fetch(ext.to_sym, '')
+    end
+
     # Returns mimetype information using the mime-types gem (based on a file extension lookup)
     # @return [String] mime type for supplied file
     # @example
@@ -257,7 +267,7 @@ exif&.mimetype && prefer_exif
 
     # prive method defining default preferred ordering of how mimetypes are determined
     def default_mime_type_order
-      %i[exif file extension]
+      %i[override exif file extension]
     end
 
     # private method to check for file existence before operating on it

data/lib/assembly-objectfile/version.rb

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

data/spec/object_file_spec.rb

@@ -70,6 +70,13 @@ describe Assembly::ObjectFile do
     expect(@ai.mimetype).to eq('text/plain')
   end
 
+  it 'overrides the mimetype generators and uses the manual mapping to set the correct mimetype of application/json for a .json file' do
+    @ai = described_class.new(TEST_JSON_FILE)
+    expect(@ai.exif_mimetype).to be_nil # exif returns nil
+    expect(@ai.file_mimetype).to eq('text/plain') # unix file system command returns plain text
+    expect(@ai.mimetype).to eq('application/json') # but our configured mapping overrides both and returns application/json
+  end
+
   it 'sets the correct mimetype of image/tiff for .tif files' do
     @ai = described_class.new(TEST_TIF_INPUT_FILE)
     expect(@ai.mimetype).to eq('image/tiff')

data/spec/spec_helper.rb

@@ -54,6 +54,8 @@ TEST_RES3_TEI = File.join(TEST_INPUT_DIR, 'res3_teifile.txt')
 
 TEST_FILE_NO_EXIF = File.join(TEST_INPUT_DIR, 'file_with_no_exif.xml')
 
+TEST_JSON_FILE = File.join(TEST_INPUT_DIR, 'test.json')
+
 TEST_OBJ_FILE = File.join(TEST_INPUT_DIR, 'someobject.obj')
 TEST_PLY_FILE = File.join(TEST_INPUT_DIR, 'someobject.ply')
 

data/spec/test_data/input/test.json

@@ -0,0 +1 @@
+{some: 'thing'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.10.3
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -263,6 +263,7 @@ files:
 - spec/test_data/input/someobject.obj
 - spec/test_data/input/someobject.ply
 - spec/test_data/input/test.jp2
+- spec/test_data/input/test.json
 - spec/test_data/input/test.pdf
 - spec/test_data/input/test.tif
 - spec/test_data/input/test2.jp2
@@ -287,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Ruby immplementation of file services needed to prepare objects to be accessioned
@@ -326,6 +327,7 @@ test_files:
 - spec/test_data/input/someobject.obj
 - spec/test_data/input/someobject.ply
 - spec/test_data/input/test.jp2
+- spec/test_data/input/test.json
 - spec/test_data/input/test.pdf
 - spec/test_data/input/test.tif
 - spec/test_data/input/test2.jp2