assembly-image 1.7.5 → 1.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dee27ed2f2ed8bf8a3878bac7a41448a8f7a54fbdd8e1800434ce0af812bf1aa
-  data.tar.gz: 8ff1e21029d7b8c4bbc045522a3d2e7fdc06c9940cc09c73287e1bf15e60a11f
+  metadata.gz: efc5ecaed58333775573f14e2f2895ecc8279ff9b80fc13ca69e927abfd216ef
+  data.tar.gz: 3c9c28f4b3c1a1d170fafbccca2b4b0d518047d8cc6c634716c79efb859876d0
 SHA512:
-  metadata.gz: edf348cb16c843850f0a496be66ec2db8e21587970caadf72b31b2ecddeb2387ab69e0c6b308e5c30d02a2e66dd4de67e01f260985ed238a546448b4aacf9667
-  data.tar.gz: 27072b70647d8a657885f74ce952210efa0c070c10597ee4c7480029e845b78549c33478a5f503ebabc70e8d9c870e7376620d173e04b27eba31f0342517dca6
+  metadata.gz: f48ce528fd60e5f9ceac51472811ed1bccaf34cd3d82348520dd75bc94af8c18b760e240fcc5355f452a4edee44fc5f664bdbae9bcd6bfd3ea2c46c1bc1fc6a3
+  data.tar.gz: e2c7963073b4c2975f6e59ee00d8011b04d7bb95f013291d5a48f992a7a801b913fbf8803952d1b133a5d1ac55eba280a9ecd7a38aac1881c53023614fd5582d

data/.circleci/config.yml

@@ -0,0 +1,22 @@
+version: 2.1
+orbs:
+  ruby-rails: sul-dlss/ruby-rails@3.0.1
+workflows:
+  build:
+    jobs:
+      - ruby-rails/lint-gem:
+          name: lint
+      - ruby-rails/test-gem:
+          name: test
+          before-test:
+            - run:
+                name: Install exiftool
+                command: curl -L http://cpanmin.us | perl - --sudo Image::ExifTool
+            - setup_remote_docker
+            - run:
+                name: Install Kakadu
+                command: |
+                  docker create --name kakadu josejuansanchez/kakadu:1.0
+                  docker cp kakadu:/kakadu kakadu
+                  sudo cp kakadu/*.so /usr/lib
+                  sudo cp kakadu/* /usr/bin

data/.github/pull_request_template.md

@@ -0,0 +1,10 @@
+## Why was this change made? 🤔
+
+
+
+## How was this change tested? 🤨
+
+⚡ ⚠ If this change has cross service impact, ***run [integration tests](https://github.com/sul-dlss/infrastructure-integration-test) that do IMAGE ACCESSIONING*** (e.g. create_preassembly_image_spec) and/or test in [stage|qa] environment, in addition to specs. ⚡
+
+
+

data/.gitignore

@@ -10,4 +10,7 @@ log/*
 pkg/*
 tags
 tmp
-.yardoc/*
+.yardoc/*
+
+coverage
+spec/examples.txt

data/.rubocop.yml

@@ -1,3 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+
 # rspec expect{...} is conventional
 Layout/SpaceBeforeBlockBraces:
   Exclude:
@@ -7,15 +15,154 @@ Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
 # Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 200
 
 Naming/FileName:
   Exclude:
    - lib/assembly-image.rb
 
+RSpec/ExampleLength:
+  Max: 12
+
 Style/WordArray:
   Enabled: false
 
-AllCops:
-  TargetRubyVersion: 2.5.3
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ExcessiveDocstringSpacing: # new in 2.5
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+RSpec/SubjectDeclaration: # new in 2.5
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true
+
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11.0
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,68 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-02-28 19:49:08 UTC using RuboCop version 1.25.1.
+# 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'assembly-image.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/assembly-image/image.rb'
+    - 'lib/assembly-image/images.rb'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/image_spec.rb'
+    - 'spec/images_spec.rb'
+
+# Offense count: 21
+RSpec/MultipleExpectations:
+  Max: 10
+
+# Offense count: 5
+RSpec/UnspecifiedException:
+  Exclude:
+    - 'spec/image_spec.rb'
+    - 'spec/images_spec.rb'
+
+# Offense count: 3
+Style/CombinableLoops:
+  Exclude:
+    - 'spec/images_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/assembly-image/images.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/assembly-image/image.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct-all.
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'bin/console'
+    - 'config/boot.rb'
+    - 'lib/assembly-image.rb'
+    - 'lib/assembly-image/images.rb'
+    - 'spec/spec_helper.rb'

data/README.md

@@ -1,4 +1,7 @@
-[![Build Status](https://travis-ci.org/sul-dlss/assembly-image.svg?branch=master)](https://travis-ci.org/sul-dlss/assembly-image)
+[![CircleCI](https://circleci.com/gh/sul-dlss/assembly-image/tree/main.svg?style=svg)](https://circleci.com/gh/sul-dlss/assembly-image/tree/main)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/5bcd886bed28b1979ac0/test_coverage)](https://codeclimate.com/github/sul-dlss/assembly-image/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5bcd886bed28b1979ac0/maintainability)](https://codeclimate.com/github/sul-dlss/assembly-image/maintainability)
+[![Gem Version](https://badge.fury.io/rb/assembly-image.svg)](https://badge.fury.io/rb/assembly-image)
 
 # Assembly Image Gem
 
@@ -51,7 +54,7 @@ perform image operations necessary for accessioning of content.
 * 1.6.7 release to github/rubygems
 * 1.6.9 update mini_exiftool
 * 1.7.1 for jp2, only transcode to tiff if not a tiff
-* 1.7.3 for jp2, only transcode to tiff if not an uncompressed tiff 
+* 1.7.3 for jp2, only transcode to tiff if not an uncompressed tiff
 
 ## Notes
 

data/assembly-image.gemspec

@@ -11,8 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = ''
   s.summary     = 'Ruby immplementation of image services needed to prepare objects to be accessioned in SULAIR digital library'
   s.description = 'Contains classes to create derivative image files and perform other image operations'
-
-  s.rubyforge_project = 'assembly-image'
+  s.metadata['rubygems_mfa_required'] = 'true'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -26,5 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
 end

data/lib/assembly-image/image.rb

@@ -1,19 +1,14 @@
 # frozen_string_literal: true
 
 require 'assembly-objectfile'
-require 'tempfile'
-require 'English' # see https://github.com/rubocop-hq/rubocop/issues/1747 (not #MAGA related)
+require_relative 'jp2_creator'
 
 module Assembly
   # The Image class contains methods to operate on an image.
-  # rubocop:disable Metrics/ClassLength
   class Image
     # include common behaviors from assembly-objectfile gem
     include Assembly::ObjectFileable
 
-    # stores the path to the tmp file generated during the JP2 creation process
-    attr_accessor :tmp_path
-
     # Examines the input image for validity.  Used to determine if image is correct and if JP2 generation is likely to succeed.
     #  This method is automatically called before you create a jp2 but it can be called separately earlier as a sanity check.
     #
@@ -62,9 +57,9 @@ module Assembly
     # Example:
     #   source_img=Assembly::ObjectFile.new('/input/path_to_file.tif')
     #   puts source_img.compressed? # gives true
-    def compressed?
-      exif.compression != 'Uncompressed'
-    end
+    # def compressed?
+    #   exif.compression != 'Uncompressed'
+    # end
 
     # Add an exif color profile descriptions to the image.
     # This is useful if your source TIFFs do not have color profile descriptions in the EXIF data, but you know what it should be.
@@ -99,7 +94,7 @@ module Assembly
     #   source_img=Assembly::Image.new('/input/path_to_file.tif')
     #   puts source_img.jp2_filename # gives /input/path_to_file.jp2
     def jp2_filename
-      File.extname(@path).empty? ? "#{@path}.jp2" : @path.gsub(File.extname(@path), '.jp2')
+      File.extname(path).empty? ? "#{path}.jp2" : path.gsub(File.extname(path), '.jp2')
     end
 
     # Returns the full DPG equivalent jp2 path and filename that would match with the given image
@@ -121,81 +116,16 @@ module Assembly
     #   * :output => path to the output JP2 file (default: mirrors the source file name and path, but with a .jp2 extension)
     #   * :overwrite => if set to false, an existing JP2 file with the same name won't be overwritten (default: false)
     #   * :tmp_folder =>  the temporary folder to use when creating the jp2 (default: '/tmp'); also used by imagemagick
-    #   * :preserve_tmp_source => if set to true, preserve the temporary file generated during the creation process and store path in 'tmp_path' attribute (default: false)
     #
     # Example:
     #   source_img=Assembly::Image.new('/input/path_to_file.tif')
     #   derivative_img=source_img.create_jp2(:overwrite=>true)
     #   puts derivative_img.mimetype # 'image/jp2'
     #   puts derivative_image.path # '/input/path_to_file.jp2'
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
     # rubocop:disable Metrics/CyclomaticComplexity:
     def create_jp2(params = {})
-      output = params[:output] || jp2_filename
-      create_jp2_checks(output: output, overwrite: params[:overwrite])
-
-      # Using instance variable so that can check in tests.
-      source_path = if create_temp_tiff?
-                      @tmp_path = make_tmp_tiff(tmp_folder: params[:tmp_folder])
-                    else
-                      @path
-                    end
-
-      jp2_command = jp2_create_command(source_path: source_path, output: output)
-      result = `#{jp2_command}`
-      raise "JP2 creation command failed: #{jp2_command} with result #{result}" unless $CHILD_STATUS.success?
-
-      File.delete(source_path) unless @tmp_path.nil? || params[:preserve_tmp_source]
-
-      # create output response object, which is an Assembly::Image type object
-      Assembly::Image.new(output)
-    end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
-
-    private
-
-    def create_temp_tiff?
-      mimetype != 'image/tiff' || compressed?
-    end
-
-    def create_jp2_checks(output:, overwrite:)
-      check_for_file
-      raise 'input file is not a valid image, or is the wrong mimetype' unless jp2able?
-
-      raise SecurityError, "output #{output} exists, cannot overwrite" if !overwrite && File.exist?(output)
-      raise SecurityError, 'cannot recreate jp2 over itself' if overwrite && mimetype == 'image/jp2' && output == @path
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity
-
-    def jp2_create_command(source_path:, output:)
-      kdu_bin = 'kdu_compress'
-      options = []
-      options << '-jp2_space sRGB' if samples_per_pixel == 3
-      options += kdu_compress_default_options
-      options << "Clayers=#{layers}"
-      "#{kdu_bin} #{options.join(' ')} -i '#{source_path}' -o '#{output}' 2>&1"
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    def kdu_compress_default_options
-      [
-        '-num_threads 2', # forces Kakadu to only use 2 threads
-        '-precise', # forces the use of 32-bit representations
-        '-no_weights', # minimization of the MSE over all reconstructed colour components
-        '-quiet', # suppress informative messages.
-        'Creversible=no', # Disable reversible compression
-        'Cmodes=BYPASS', #
-        'Corder=RPCL', # R=resolution P=position C=component L=layer
-        'Cblk=\\{64,64\\}', # code-block dimensions; 64x64 happens to also be the default
-        'Cprecincts=\\{256,256\\},\\{256,256\\},\\{128,128\\}', # Precinct dimensions; 256x256 for the 2 highest resolution levels, defaults to 128x128 for the rest
-        'ORGgen_plt=yes', # Insert packet length information
-        '-rate 1.5', # Ratio of compressed bits to the image size
-        'Clevels=5' # Number of wavelet decomposition levels, or stages
-      ]
+      Jp2Creator.create(self, params)
     end
-    # rubocop:enable Metrics/MethodLength
 
     def samples_per_pixel
       if exif['samplesperpixel']
@@ -204,10 +134,20 @@ module Assembly
         case mimetype
         when 'image/tiff'
           1
+        when 'image/jpeg'
+          3
         end
       end
     end
 
+    # Get size of image data in bytes
+    def image_data_size
+      (samples_per_pixel * height * width * bits_per_sample) / 8
+    end
+
+    private
+
+    # rubocop:enable Metrics/CyclomaticComplexity
     def bits_per_sample
       if exif['bitspersample']
         exif['bitspersample'].to_i
@@ -218,85 +158,5 @@ module Assembly
         end
       end
     end
-
-    # Get the number of JP2 layers to generate
-    def layers
-      pixdem = [width, height].max
-      ((Math.log(pixdem) / Math.log(2)) - (Math.log(96) / Math.log(2))).ceil + 1
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def profile_conversion_switch(profile, tmp_folder:)
-      path_to_profiles = File.join(Assembly::PATH_TO_IMAGE_GEM, 'profiles')
-      # eventually we may allow the user to specify the output_profile...when we do, you can just uncomment this code
-      # and update the tests that check for this
-      output_profile = 'sRGBIEC6196621' # params[:output_profile] || 'sRGBIEC6196621'
-      output_profile_file = File.join(path_to_profiles, "#{output_profile}.icc")
-
-      raise "output profile #{output_profile} invalid" unless File.exist?(output_profile_file)
-
-      return '' if profile.nil?
-
-      # if the input color profile exists, contract paths to the profile and setup the command
-
-      input_profile = profile.gsub(/[^[:alnum:]]/, '') # remove all non alpha-numeric characters, so we can get to a filename
-
-      # construct a path to the input profile, which might exist either in the gem itself or in the tmp folder
-      input_profile_file_gem = File.join(path_to_profiles, "#{input_profile}.icc")
-      input_profile_file_tmp = File.join(tmp_folder, "#{input_profile}.icc")
-      input_profile_file = File.exist?(input_profile_file_gem) ? input_profile_file_gem : input_profile_file_tmp
-
-      # if input profile was extracted and does not matches an existing known profile either in the gem or in the tmp folder,
-      # we'll issue an imagicmagick command to extract the profile to the tmp folder
-      unless File.exist?(input_profile_file)
-        input_profile_extract_command = "MAGICK_TEMPORARY_PATH=#{tmp_folder} convert '#{@path}'[0] #{input_profile_file}" # extract profile from input image
-        result = `#{input_profile_extract_command} 2>&1`
-        raise "input profile extraction command failed: #{input_profile_extract_command} with result #{result}" unless $CHILD_STATUS.success?
-        # if extraction failed or we cannot write the file, throw exception
-        raise 'input profile is not a known profile and could not be extracted from input file' unless File.exist?(input_profile_file)
-      end
-
-      "-profile #{input_profile_file} -profile #{output_profile_file}"
-    end
-
-    def make_tmp_tiff(tmp_folder: nil)
-      tmp_folder ||= Dir.tmpdir
-      raise "tmp_folder #{tmp_folder} does not exists" unless File.exist?(tmp_folder)
-
-      # make temp tiff filename
-      tmp_tiff_file = Tempfile.new(['assembly-image', '.tif'], tmp_folder)
-      tmp_path = tmp_tiff_file.path
-
-      options = []
-
-      # Limit the amount of memory ImageMagick is able to use.
-      options << '-limit memory 1GiB -limit map 1GiB'
-
-      case samples_per_pixel
-      when 3
-        options << '-type TrueColor'
-      when 1
-        if bits_per_sample == 1
-          options << '-type Bilevel'
-          options << '-depth 8' # force the production of a grayscale access derivative
-        elsif bits_per_sample > 1
-          options << '-type Grayscale'
-        end
-      end
-
-      options << profile_conversion_switch(profile, tmp_folder: tmp_folder)
-
-      tiff_command = "MAGICK_TEMPORARY_PATH=#{tmp_folder} convert -quiet -compress none #{options.join(' ')} '#{@path}[0]' '#{tmp_path}'"
-      result = `#{tiff_command} 2>&1`
-      raise "tiff convert command failed: #{tiff_command} with result #{result}" unless $CHILD_STATUS.success?
-
-      tmp_path
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
   end
-  # rubocop:enable Metrics/ClassLength
 end