assembly-image 1.8.0 → 2.1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-image
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,8 +11,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: assembly-objectfile
   requirement: !ruby/object:Gem::Requirement
@@ -28,25 +42,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
-  name: mini_exiftool
+  name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,20 +139,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Contains classes to create derivative image files and perform other image
   operations
 email:
@@ -147,25 +155,24 @@ files:
 - ".rubocop_todo.yml"
 - ".rvmrc.example"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - assembly-image.gemspec
 - bin/console
-- bin/run_all_tests
 - config/boot.rb
 - lib/assembly-image.rb
-- lib/assembly-image/image.rb
-- lib/assembly-image/images.rb
-- lib/assembly-image/jp2_creator.rb
-- lib/assembly-image/version.rb
+- lib/assembly/image.rb
+- lib/assembly/image/jp2_creator.rb
 - profiles/AdobeRGB1998.icc
 - profiles/DotGain20.icc
+- profiles/cmyk.icc
 - profiles/sRGBIEC6196621.icc
 - spec/assembly/image/jp2_creator_spec.rb
-- spec/image_spec.rb
-- spec/images_spec.rb
+- spec/assembly/image_spec.rb
 - spec/spec_helper.rb
+- spec/test_data/color_rgb_srgb_rot90cw.tif
 - spec/test_data/input/.empty
 - spec/test_data/output/.empty
 homepage: ''
@@ -192,10 +199,4 @@ signing_key:
 specification_version: 4
 summary: Ruby immplementation of image services needed to prepare objects to be accessioned
   in SULAIR digital library
-test_files:
-- spec/assembly/image/jp2_creator_spec.rb
-- spec/image_spec.rb
-- spec/images_spec.rb
-- spec/spec_helper.rb
-- spec/test_data/input/.empty
-- spec/test_data/output/.empty
+test_files: []

data/bin/run_all_tests

@@ -1,3 +0,0 @@
-#! /bin/bash
-
-bundle exec rspec spec

data/lib/assembly-image/image.rb

@@ -1,162 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-    # 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.
-    #
-    # @return [boolean] true if image is valid, false if not.
-    #
-    # Example:
-    #   source_img=Assembly::ObjectFile.new('/input/path_to_file.tif')
-    #   puts source_img.valid? # gives true
-    def valid?
-      valid_image? # behavior is defined in assembly-objectfile gem
-    end
-
-    # Get the image color profile
-    #
-    # @return [string] image color profile
-    # Example:
-    #   source_img=Assembly::Image.new('/input/path_to_file.tif')
-    #   puts source_img.profile # gives 'Adobe RGB 1998'
-    def profile
-      exif.nil? ? nil : exif['profiledescription']
-    end
-
-    # Get the image height from exif data
-    #
-    # @return [integer] image height in pixels
-    # Example:
-    #   source_img=Assembly::Image.new('/input/path_to_file.tif')
-    #   puts source_img.height # gives 100
-    def height
-      exif.imageheight
-    end
-
-    # Get the image width from exif data
-    # @return [integer] image height in pixels
-    # Example:
-    #   source_img=Assembly::Image.new('/input/path_to_file.tif')
-    #   puts source_img.width # gives 100
-    def width
-      exif.imagewidth
-    end
-
-    # Examines the input image to determine if it is compressed.
-    #
-    # @return [boolean] true if image is compressed, false if not.
-    #
-    # Example:
-    #   source_img=Assembly::ObjectFile.new('/input/path_to_file.tif')
-    #   puts source_img.compressed? # gives true
-    # 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.
-    # This will allow the images to pass the validaty check and have JP2s created successfully.
-    #
-    # Note you will need full read/write access to the source path so that new EXIF data can be saved.
-    #
-    # @param [String] profile_name profile name to be added, current options are 'Adobe RBG 1998','Dot Gain 20%','sRGB IEC61966-2.1'
-    #
-    # @param [String] force if set to true, force overwrite a color profile description even if it already exists (default: false)
-    #
-    # Example:
-    #  source_img=Assembly::Image.new('/input/path_to_file.tif')
-    #  source_img.add_exif_profile_description('Adobe RGB 1998')
-    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")
-        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?
-      end
-    rescue StandardError => e
-      puts "** Error for #{filename}: #{e.message}"
-    end
-
-    # Returns the full default jp2 path and filename that will be created from the given image
-    #
-    # @return [string] full default jp2 path and filename that will be created from the given image
-    # Example:
-    #   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')
-    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.
-    #
-    # @return [Assembly::Image] object containing the generated JP2 file
-    #
-    # @param [Hash] params Optional parameters specified as a hash, using symbols for options:
-    #   * :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
-    #
-    # 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/CyclomaticComplexity:
-    def create_jp2(params = {})
-      Jp2Creator.create(self, params)
-    end
-
-    def samples_per_pixel
-      if exif['samplesperpixel']
-        exif['samplesperpixel'].to_i
-      else
-        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
-      else
-        case mimetype
-        when 'image/tiff'
-          1
-        end
-      end
-    end
-  end
-end

data/lib/assembly-image/images.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-module Assembly
-  # The Images class contains methods to operate on multiple images in batch.
-  class Images
-    def self.logger
-      @logger ||= Logger.new(STDERR)
-    end
-
-    class << self
-      attr_writer :logger
-    end
-
-    # Pass in a source path and have exif color profile descriptions added to all images contained.
-    # This is useful if your source TIFFs do not have color profile descriptions in the EXIF data, but you know what it should be.
-    # This will allow the images to pass the validty check and have JP2s created successfully.
-    #
-    # Note you will need full read/write access to the source path so that new EXIF data can be saved.
-    #
-    # @param [String] source path full path to the directory containing TIFFs
-    # @param [String] profile_name profile name to be added, current options are 'Adobe RBG 1998','Dot Gain 20%','sRGB IEC61966-2.1'
-    #
-    # @param [Hash] params Optional parameters specified as a hash, using symbols for options:
-    #   * :force => if set to true, force overwrite a color profile description even if it already exists (default: false)
-    #   * :recusrive => if set to true, directories will be searched recursively for TIFFs from the source specified, false searches the top level only (default: false)
-    #   * :extension => defines the types of files that will be processed (default '.tif')
-    #
-    # Example:
-    #  Assembly::Images.batch_add_exif_profile_description('/full_path_to_tifs','Adobe RGB 1998')
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def self.batch_add_exif_profile_descr(source, profile_name, params = {})
-      extension = params[:extension] || 'tif'
-      recursive = params[:recursive] || false
-      force = params[:force] || false
-
-      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|
-        img = Assembly::Image.new(file)
-        logger.debug "Processing #{file}"
-        img.add_exif_profile_description(profile_name, force)
-      end
-      'Complete'
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-
-    # Pass in a source path and get JP2s generate for each tiff that is in the source path
-    #
-    # If not passed in, the destination will be a "jp2" subfolder within the source folder.
-    # Note you will need read access to the source path, and write access to the destination path.
-    #
-    # @param [String] source path full path to the directory containing TIFFs to be converted to JP2
-    #
-    # @param [Hash] params Optional parameters specified as a hash, using symbols for options:
-    #   * :output=>'/full/path_to_jp2' # specifies full path to folder where jp2s will be created (default: jp2 subdirectory from source path)
-    #   * :overwrite => if set to false, an existing JP2 file with the same name won't be overwritten (default: false)
-    #   * :recursive => if set to true, directories will be searched recursively for TIFFs from the source specified, false searches the top level only (default: false)
-    #   * :extension => defines the types of files that will be processed (default '.tif')
-    #
-    # Example:
-    #  Assembly::Images.batch_generate_jp2('/full_path_to_tifs')
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    def self.batch_generate_jp2(source, params = {})
-      raise 'Input path does not exist' unless File.directory?(source)
-
-      output = params[:output] || File.join(source, 'jp2') # default output directgory is jp2 sub-directory from source
-      extension = params[:extension] || 'tif'
-      overwrite = params[:overwrite] || false
-      recursive = params[:recursive] || false
-
-      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
-      Dir.glob(File.join(source, pattern)).each do |file|
-        source_img = Assembly::Image.new(file)
-        output_img = File.join(output, File.basename(file, File.extname(file)) + '.jp2') # output image gets same file name as source, but with a jp2 extension and in the correct output directory
-        begin
-          source_img.create_jp2(overwrite: overwrite, output: output_img)
-          logger.debug "Generated jp2 for #{File.basename(file)}"
-        rescue StandardError => e
-          logger.debug "** Error for #{File.basename(file)}: #{e.message}"
-        end
-      end
-      'Complete'
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
-  end
-end

data/lib/assembly-image/jp2_creator.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-require 'tempfile'
-require 'English' # see https://github.com/rubocop-hq/rubocop/issues/1747 (not #MAGA related)
-
-module Assembly
-  class Image
-    # Creates jp2 derivatives
-    class Jp2Creator # rubocop:disable  Metrics/ClassLength
-      # Create a JP2 file for the current image.
-      # Important note: this will not work for multipage TIFFs.
-      #
-      # @return [Assembly::Image] object containing the generated JP2 file
-      #
-      # @param [Assembly::Image] the image file
-      # @param [Hash] params Optional parameters specified as a hash, using symbols for options:
-      #   * :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
-      #
-      # 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'
-      def self.create(image, params = {})
-        new(image, params).create
-      end
-
-      def initialize(image, params)
-        @image = image
-        @output_path = params.fetch(:output, image.jp2_filename)
-        @tmp_folder = params[:tmp_folder]
-        @overwrite = params[:overwrite]
-        @params = params
-      end
-
-      attr_reader :image, :output_path, :tmp_folder, :tmp_path
-
-      # @return [Assembly::Image] object containing the generated JP2 file
-      def create
-        create_jp2_checks
-
-        # Using instance variable so that can check in tests.
-        @tmp_path = make_tmp_tiff(tmp_folder: tmp_folder)
-
-        jp2_command = jp2_create_command(source_path: @tmp_path, output: output_path)
-        result = `#{jp2_command}`
-        unless $CHILD_STATUS.success?
-          # Clean up any partial result
-          File.delete(output_path) if File.exist?(output_path)
-          raise "JP2 creation command failed: #{jp2_command} with result #{result}"
-        end
-
-        File.delete(@tmp_path) unless @tmp_path.nil?
-
-        # create output response object, which is an Assembly::Image type object
-        Image.new(output_path)
-      end
-
-      private
-
-      def overwrite?
-        @overwrite
-      end
-
-      def jp2_create_command(source_path:, output:)
-        options = []
-        options << '-jp2_space sRGB' if image.samples_per_pixel == 3
-        options += KDU_COMPRESS_DEFAULT_OPTIONS
-        options << "Clayers=#{layers}"
-        "kdu_compress #{options.join(' ')} -i '#{source_path}' -o '#{output}' 2>&1"
-      end
-
-      # Get the number of JP2 layers to generate
-      def layers
-        pixdem = [image.width, image.height].max
-        ((Math.log(pixdem) / Math.log(2)) - (Math.log(96) / Math.log(2))).ceil + 1
-      end
-
-      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
-      ].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?
-
-        raise SecurityError, "output #{output_path} exists, cannot overwrite" if !overwrite? && File.exist?(output_path)
-        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
-
-      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 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?
-
-        tmp_path
-      end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-    end
-  end
-end

data/lib/assembly-image/version.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# Main Assembly namespace
-module Assembly
-  # Main Image class
-  class Image
-    # Gem version
-    VERSION = '1.8.0'
-  end
-end