assembly-image 1.7.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc5ecaed58333775573f14e2f2895ecc8279ff9b80fc13ca69e927abfd216ef
-  data.tar.gz: 3c9c28f4b3c1a1d170fafbccca2b4b0d518047d8cc6c634716c79efb859876d0
+  metadata.gz: 9379ec53a26a08578c11910512bd73045366fc337fcafb0c7eb1a247370566b1
+  data.tar.gz: 316fbef312cb027f4061bbe74dc2f8dce993a095d6779da100abeeecbf24b9da
 SHA512:
-  metadata.gz: f48ce528fd60e5f9ceac51472811ed1bccaf34cd3d82348520dd75bc94af8c18b760e240fcc5355f452a4edee44fc5f664bdbae9bcd6bfd3ea2c46c1bc1fc6a3
-  data.tar.gz: e2c7963073b4c2975f6e59ee00d8011b04d7bb95f013291d5a48f992a7a801b913fbf8803952d1b133a5d1ac55eba280a9ecd7a38aac1881c53023614fd5582d
+  metadata.gz: 97cc720649bdc6e0bb6d7453afdefc7abe3f0931a45976d397f1f77fd2f2dacbcbd4991e64c0e4849a2ae61efa51d72d428ce9a8a15e9a125abdeefcb17b0d5b
+  data.tar.gz: 8e6580aaade8302319e7cbf41d56d8ac0ebe1a05db5607bed8580cebe8a3c87b5795cb90f50e2b9eb4b081d9048a600799b0e373badf811ff9a084e5f9af3fcc

data/.circleci/config.yml

@@ -12,6 +12,9 @@ workflows:
             - run:
                 name: Install exiftool
                 command: curl -L http://cpanmin.us | perl - --sudo Image::ExifTool
+            - run:
+                name: Install libvips
+                command: sudo apt-get update && sudo apt-get install -y libvips
             - setup_remote_docker
             - run:
                 name: Install Kakadu

data/.gitignore

@@ -14,3 +14,5 @@ tmp
 
 coverage
 spec/examples.txt
+spec/test_data/input/*
+spec/test_data/output/*

data/.rubocop.yml

@@ -22,9 +22,6 @@ Naming/FileName:
   Exclude:
    - lib/assembly-image.rb
 
-RSpec/ExampleLength:
-  Max: 12
-
 Style/WordArray:
   Enabled: false
 
@@ -166,3 +163,6 @@ RSpec/ChangeByZero: # new in 2.11.0
   Enabled: true
 RSpec/VerifiedDoubleReference: # new in 2.10.0
   Enabled: true
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-02-28 19:49:08 UTC using RuboCop version 1.25.1.
+# on 2022-06-16 22:15:07 UTC using RuboCop version 1.30.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
@@ -13,13 +13,23 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'assembly-image.gemspec'
 
-# Offense count: 3
-# Cop supports --auto-correct.
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
 Lint/RedundantCopDisableDirective:
   Exclude:
     - 'lib/assembly-image/image.rb'
     - 'lib/assembly-image/images.rb'
 
+# Offense count: 2
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 14
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 15
+
 # Offense count: 2
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
 # Include: **/*_spec*rb*, **/spec/**/*
@@ -30,7 +40,7 @@ RSpec/FilePath:
 
 # Offense count: 21
 RSpec/MultipleExpectations:
-  Max: 10
+  Max: 13
 
 # Offense count: 5
 RSpec/UnspecifiedException:
@@ -44,7 +54,7 @@ Style/CombinableLoops:
     - 'spec/images_spec.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Style/GlobalStdStream:
   Exclude:
     - 'lib/assembly-image/images.rb'
@@ -56,8 +66,8 @@ Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/assembly-image/image.rb'
 
-# Offense count: 8
-# Cop supports --auto-correct-all.
+# Offense count: 7
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
 Style/StringConcatenation:
   Exclude:

data/README.md

@@ -9,52 +9,7 @@
 This gem contains classes used by the Stanford University Digital Library to
 perform image operations necessary for accessioning of content.
 
-## Releases
-
-* 0.0.1 initial release
-* 0.0.2 small bug fixes
-* 0.0.3 more bug fixes
-* 0.0.4 update jp2 creation method to restrict allowed input types and improve color profile handling
-* 0.0.5 updated documentation to yard format
-* 0.0.6 updated dependency declarations
-* 0.1.0 move color profile extraction to tmp folder instead of gem profiles folder
-* 0.1.1 fix problem with digest require statement
-* 0.1.2 move check for file existence to when an action occurs instead of object initialization; more error checking and messages on command execution
-* 0.1.3 added a filesize attribute to the file object to allow easy access to filesize in bytes
-* 0.1.4 added a new images class that allows you batch create jp2s from an input TIFF directory
-* 0.2.0 added a new method to the image class to handle TIFF "sanity-check" -- can be used to ensure TIFFs are valid before JP2 generation
-* 1.0.0 bump the version number up to an official production level release
-* 1.1.0 remove common object file behaviors to a separate gem and use that gem as a dependency
-* 1.1.1 minor changes to spec tests
-* 1.1.2 remove the addition of 'format' node to file types in content metadata generation
-* 1.1.3 changes to content metadata generation method: change md5 and sha1 computations so that they come from the assembly-objectfile gem,
-    and set preserve/publish/shelve attributes using mimetype defaults
-* 1.2.0 support tiffs that have embedded thumbnails when creating jp2
-* 1.2.1 raise a SecurityError if the user attempts to overwrite an existing jp2 when creating it, to make it easier to catch in assembly
-* 1.2.2 add height and width methods for an image that gets it from exif
-* 1.2.4 prepare for release listing on DLSS release board
-* 1.2.5 small change to use the jp2able method instead of the valid? method when creating jp2s
-* 1.2.6 update how version number is set to make it easier to show
-* 1.3.0 added a new method to the Assembly::Images class to allow for batch adding of color profiles to all tiffs in a directory; allow batch methods to run recursively
-* 1.3.1 remove content metadata generation method and add to assembly-objectfile gem instead
-* 1.3.3 update gemspec to force use of latest assembly-objectfile gem to allow gem to work in Ruby 1.9 projects
-* 1.3.4 update to latest version of lyberteam gems
-* 1.3.5 fix a problem that could occur if there were spaces in input filenames
-* 1.3.6 add new attribute to give you default jp2 filename that will be used
-* 1.3.7 add new attribute to give you default dpg jp2 filename
-* 1.3.8 allow for batch processing of image extensions other than tif
-* 1.3.9 create new methods for getting a color profile from exif and for force adding color profile to a single image
-* 1.4.0 and 1.4.1 set the imagemagick tmp folder location environment variable when creating jp2
-* 1.5.0 allow images with a color profile to have jp2 derivatives generated
-* 1.5.1 relax nokogiri version requirement
-* 1.6.1 bump version number of assembly-objectfile required to fix UTF-8 errors during JP2-create
-* 1.6.2-1.6.3 small change to jp2 generation to try and fix bug with tiffs that have multiple input profile layers
-* 1.6.4 added in some additional checks to try and create jp2s with mismatching exif data
-* 1.6.5 fix problem with lack of extension in incoming tif causing a problem when creating jp2
-* 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
+Requires image processing software - see PreRequisites section below.
 
 ## Notes
 
@@ -114,33 +69,12 @@ http://kakadusoftware.com/downloads/
 
 NOTE: If you have upgrade to El Capitan on OS X, you will need to donwload and re-install the latest version of Kakadu, due to changes made with SIP.  These changes moved the old executable binaries to an inaccessible location.
 
-### Imagemagick
-
-#### RHEL 6
-
-The version of ImageMagick included with RHEL 6 has all of the dependency libraries included:
-
-```bash
-yum install ImageMagick
-```
-#### RHEL 5
-
-The version of ImageMagick included with RHEL 5 is too old and does not have all the proper binaries included/built:
-
-```bash
-yum install lcms lcms-devel libjpeg libjpeg-devel libpng libpng-devel
-```
-Required libraries from source:
-* libtiff (version 3.9.4 or higher)
-
-Build Imagemagick from source:
-http://www.imagemagick.org/download/ImageMagick.tar.gz
+### Libvips
 
 #### Mac
 
 ```bash
-brew install jasper libtiff
-brew install imagemagick --use-tiff --use-jpeg2000
+brew install libvips
 ```
 
 ### Exiftool

data/assembly-image.gemspec

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'assembly-image/version'
 
 Gem::Specification.new do |s|
   s.name        = 'assembly-image'
-  s.version     = Assembly::Image::VERSION
+  s.version     = '2.0.0'
   s.authors     = ['Peter Mangiafico', 'Renzo Sanchez-Silva', 'Monty Hindman', 'Tony Calavano']
   s.email       = ['pmangiafico@stanford.edu']
   s.homepage    = ''
@@ -14,14 +13,15 @@ Gem::Specification.new do |s|
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
   s.add_dependency 'assembly-objectfile', '>= 1.6.4'
   s.add_dependency 'mini_exiftool', '>= 1.6', '< 3'
+  s.add_dependency 'ruby-vips', '>= 2.0'
 
+  s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rubocop'

data/lib/assembly-image/image.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
+require 'ruby-vips'
 require 'assembly-objectfile'
 require_relative 'jp2_creator'
 
 module Assembly
   # The Image class contains methods to operate on an image.
-  class Image
-    # include common behaviors from assembly-objectfile gem
-    include Assembly::ObjectFileable
-
+  class Image < Assembly::ObjectFile
     # 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.
     #
@@ -77,8 +75,7 @@ module Assembly
     def add_exif_profile_description(profile_name, force = false)
       if profile.nil? || force
         input_profile = profile_name.gsub(/[^[:alnum:]]/, '') # remove all non alpha-numeric characters, so we can get to a filename
-        path_to_profiles = File.join(Assembly::PATH_TO_IMAGE_GEM, 'profiles')
-        input_profile_file = File.join(path_to_profiles, "#{input_profile}.icc")
+        input_profile_file = File.join(PATH_TO_PROFILES, "#{input_profile}.icc")
         command = "exiftool '-icc_profile<=#{input_profile_file}' #{path}"
         result = `#{command} 2>&1`
         raise "profile addition command failed: #{command} with result #{result}" unless $CHILD_STATUS.success?
@@ -97,16 +94,6 @@ module Assembly
       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
-    #
-    # @return [string] full DPG equivalent jp2 path and filename
-    # Example:
-    #   source_img=Assembly::Image.new('/input/path_to_file.tif')
-    #   puts source_img.jp2_filename # gives /input/path_to_file.jp2
-    def dpg_jp2_filename
-      jp2_filename.gsub('_00_', '_05_')
-    end
-
     # Create a JP2 file for the current image.
     # Important note: this will not work for multipage TIFFs.
     #

data/lib/assembly-image/images.rb

@@ -37,8 +37,6 @@ module Assembly
 
       raise 'Input path does not exist' unless File.directory?(source)
 
-      logger.debug "Source: #{source}"
-
       # iterate over input directory looking for tifs
       pattern = recursive ? "**/*.#{extension}" : "*.#{extension}*"
       Dir.glob(File.join(source, pattern)).each do |file|
@@ -81,9 +79,6 @@ module Assembly
       Dir.mkdir(output) unless File.directory?(output) # attemp to make output directory
       raise 'Output path does not exist or could not be created' unless File.directory?(output)
 
-      logger.debug "Source: #{source}"
-      logger.debug "Destination: #{output}"
-
       pattern = recursive ? "**/*.#{extension}" : "*.#{extension}*"
 
       # iterate over input directory looking for tifs

data/lib/assembly-image/jp2_creator.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require 'assembly-objectfile'
 require 'tempfile'
 require 'English' # see https://github.com/rubocop-hq/rubocop/issues/1747 (not #MAGA related)
 
 module Assembly
-  class Image
+  class Image < Assembly::ObjectFile
     # Creates jp2 derivatives
-    class Jp2Creator # rubocop:disable  Metrics/ClassLength
+    class Jp2Creator
       # Create a JP2 file for the current image.
       # Important note: this will not work for multipage TIFFs.
       #
@@ -42,6 +43,7 @@ module Assembly
         create_jp2_checks
 
         # Using instance variable so that can check in tests.
+        # We do this because we need to reliably compress the tiff and KDUcompress doesn’t support arbitrary image types
         @tmp_path = make_tmp_tiff(tmp_folder: tmp_folder)
 
         jp2_command = jp2_create_command(source_path: @tmp_path, output: output_path)
@@ -66,6 +68,7 @@ module Assembly
 
       def jp2_create_command(source_path:, output:)
         options = []
+        # TODO: Consider using ruby-vips to determine the colorspace instead of relying on exif (which is done below)
         options << '-jp2_space sRGB' if image.samples_per_pixel == 3
         options += KDU_COMPRESS_DEFAULT_OPTIONS
         options << "Clayers=#{layers}"
@@ -80,20 +83,15 @@ module Assembly
 
       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
+        '-rate -', # Ratio of compressed bits to the image size
         'Clevels=5' # Number of wavelet decomposition levels, or stages
       ].freeze
 
-      # rubocop:disable Metrics/AbcSize
       def create_jp2_checks
         image.send(:check_for_file)
         raise 'input file is not a valid image, or is the wrong mimetype' unless image.jp2able?
@@ -102,45 +100,13 @@ module Assembly
         raise SecurityError, 'cannot recreate jp2 over itself' if overwrite? && image.mimetype == 'image/jp2' && output_path == image.path
       end
 
-      # rubocop:disable Metrics/MethodLength
-      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 image.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 '#{image.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
-
       # Bigtiff needs to be used if size of image exceeds 2^32 bytes.
       def need_bigtiff?
         image.image_data_size >= 2**32
       end
 
+      # We do this because we need to reliably compress the tiff and KDUcompress doesn’t support arbitrary image types
+      # rubocop:disable Metrics/MethodLength
       def make_tmp_tiff(tmp_folder: nil)
         tmp_folder ||= Dir.tmpdir
         raise "tmp_folder #{tmp_folder} does not exists" unless File.exist?(tmp_folder)
@@ -148,35 +114,20 @@ module Assembly
         # make temp tiff filename
         tmp_tiff_file = Tempfile.new(['assembly-image', '.tif'], tmp_folder)
         tmp_path = tmp_tiff_file.path
+        vips_image = Vips::Image.new_from_file image.path
 
-        options = []
-
-        # Limit the amount of memory ImageMagick is able to use.
-        options << '-limit memory 1GiB -limit map 1GiB'
-
-        case image.samples_per_pixel
-        when 3
-          options << '-type TrueColor'
-        when 1
-          options << '-depth 8' # force the production of a grayscale access derivative
-          options << '-type Grayscale'
-        end
-
-        options << profile_conversion_switch(image.profile, tmp_folder: tmp_folder)
-
-        # The output in the covnert command needs to be prefixed by the image type. By default ImageMagick
-        # will assume TIFF: when the file extension is .tif/.tiff. TIFF64: Needs to be forced when image will
-        # exceed 2^32 bytes in size
-        tiff_type = need_bigtiff? ? 'TIFF64:' : ''
-
-        tiff_command = "MAGICK_TEMPORARY_PATH=#{tmp_folder} convert -quiet -compress none #{options.join(' ')} '#{image.path}[0]' #{tiff_type}'#{tmp_path}'"
-        result = `#{tiff_command} 2>&1`
-        raise "tiff convert command failed: #{tiff_command} with result #{result}" unless $CHILD_STATUS.success?
+        vips_image = if vips_image.interpretation.eql?(:cmyk)
+                       vips_image.icc_transform(SRGB_ICC, input_profile: CMYK_ICC)
+                     elsif !image.profile.nil?
+                       vips_image.icc_transform(SRGB_ICC, embedded: true)
+                     else
+                       vips_image
+                     end
 
+        vips_image.tiffsave(tmp_path, bigtiff: need_bigtiff?)
         tmp_path
       end
       # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/assembly-image.rb

@@ -3,6 +3,9 @@
 module Assembly
   # the path to the gem, used to access profiles stored with the gem
   PATH_TO_IMAGE_GEM = File.expand_path(File.dirname(__FILE__) + '/..')
+  PATH_TO_PROFILES = File.join(Assembly::PATH_TO_IMAGE_GEM, 'profiles')
+  SRGB_ICC = File.join(PATH_TO_PROFILES, 'sRGBIEC6196621.icc')
+  CMYK_ICC = File.join(PATH_TO_PROFILES, 'cmyk.icc')
 end
 
 require 'assembly-image/image'

data/spec/assembly/image/jp2_creator_spec.rb

@@ -9,11 +9,7 @@ RSpec.describe Assembly::Image::Jp2Creator do
   let(:input_path) { TEST_TIF_INPUT_FILE }
   let(:creator) { described_class.new(ai, output: TEST_JP2_OUTPUT_FILE) }
 
-  after do
-    # after each test, empty out the input and output test directories
-    remove_files(TEST_INPUT_DIR)
-    remove_files(TEST_OUTPUT_DIR)
-  end
+  before { cleanup }
 
   context 'when given an LZW compressed RGB tif' do
     before do
@@ -31,8 +27,8 @@ RSpec.describe Assembly::Image::Jp2Creator do
       expect(creator.tmp_path).not_to be_nil
       expect(result.exif.colorspace).to eq 'sRGB'
       jp2 = Assembly::Image.new(TEST_JP2_OUTPUT_FILE)
-      expect(jp2.height).to eq 100
-      expect(jp2.width).to eq 100
+      expect(jp2.height).to eq 36
+      expect(jp2.width).to eq 43
     end
   end