assembly-image 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 693f1de3f3da7705f8920609b33300286a2bee43
-  data.tar.gz: dd91d143c8cb63df32576df88e8faaf99f75ef6b
+SHA256:
+  metadata.gz: 37d19061d4cdbcf04b0a9dfa0702d9ae68eda22a248daba5284327d4a0a6586b
+  data.tar.gz: 77961e8b421063939c636e20d32ccfc74e7fa334e2229903d3a9da2a37dfcfa2
 SHA512:
-  metadata.gz: c7a36d09fa0326861718e9c99495ce0ffc79ee4cb08b5fe1d9ed4d9eebb5fbf4527b3a0905434dadc4683f6c674f828e85f0dd10dde5a5b486a8a58fdac8da0f
-  data.tar.gz: 11e5bcee0606f7696f0d984b09a8c4aad7a558e2db1aabf2f0d2fdbd55c204c06ebaafde06e72673f5f7668975d99803bb8382699faaa07b4778a50ee324ab67
+  metadata.gz: 0e129b0e5549da1e7c3925cded0ad977bd537a4da8492be152738b26fecd18445c3c29e72a5040865cdabca5ce8fe1e3951805abbc2734b2bc38a1d52831ad75
+  data.tar.gz: 848bdfc0b96d1257371fd8b51589eef953020b5dae43c98068206c96b22472ae27bab0b72fcb51e89a2786f5cbd3cec831ebcf2571a0da737cdad10b8b5cbd78

data/.rubocop.yml

@@ -1,13 +1,21 @@
-inherit_from: .rubocop_todo.yml
-
 # rspec expect{...} is conventional
-Style/SpaceBeforeBlockBraces:
+Layout/SpaceBeforeBlockBraces:
   Exclude:
     - 'spec/**/*_spec.rb'
 
-Style/EmptyLineBetweenDefs:
+Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 200
+
+Naming/FileName:
+  Exclude:
+   - lib/assembly-image.rb
+
+Style/WordArray:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.5.3

data/.travis.yml

@@ -4,6 +4,7 @@ notifications:
 rvm:
   - 2.2.4
   - 2.4.3
+  - 2.5.3
 
 language: ruby
 sudo: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 # Specify your gem's dependencies in assembly-image.gemspec

data/README.md

@@ -50,6 +50,7 @@ perform image operations necessary for accessioning of content.
 * 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 
 
 ## Notes
 
@@ -98,10 +99,9 @@ yard server --reload
 
 ## Prerequisites
 
-1. Perl - you probably already have it
-2. Kakadu Proprietary Software Binaries - for JP2 generation
-3. ImageMagick 6.5.4 or higher
-4. Exiftool
+1. Kakadu Proprietary Software Binaries - for JP2 generation
+1. ImageMagick 6.5.4 or higher
+1. Exiftool
 
 ### Kakadu
 

data/Rakefile

@@ -1,8 +1,19 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
 
+require 'bundler/setup' # Set up gems listed in the Gemfile.
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
 
-desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task ci: [:rubocop] do
+  Rake::Task['spec'].invoke
+end
+
+task default: :ci

data/assembly-image.gemspec

@@ -1,14 +1,16 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# 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.authors     = ['Peter Mangiafico', 'Renzo Sanchez-Silva','Monty Hindman','Tony Calavano']
+  s.authors     = ['Peter Mangiafico', 'Renzo Sanchez-Silva', 'Monty Hindman', 'Tony Calavano']
   s.email       = ['pmangiafico@stanford.edu']
   s.homepage    = ''
-  s.summary     = %q{Ruby immplementation of image services needed to prepare objects to be accessioned in SULAIR digital library}
-  s.description = %q{Contains classes to create derivative image files and perform other image operations}
+  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'
 
@@ -21,8 +23,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'assembly-objectfile', '>= 1.6.4'
   s.add_dependency 'mini_exiftool', '>= 1.6', '< 3'
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'rake'
-
 end

data/bin/console

@@ -1,4 +1,5 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'irb'

data/config/boot.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 
-environment  = ENV['ENVIRONMENT'] ||= 'development'
 project_root = File.expand_path(File.dirname(__FILE__) + '/..')
 
 # Load config for current environment.

data/lib/assembly-image/image.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 require 'assembly-objectfile'
 require 'tempfile'
 
 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
 
@@ -45,7 +46,6 @@ module Assembly
     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')
@@ -67,19 +67,17 @@ module Assembly
     # 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)
-      begin
-        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 $?.success?
-        end
-      rescue Exception => e
-        puts "** Error for #{filename}: #{e.message}"
+    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
@@ -89,7 +87,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
@@ -99,7 +97,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 dpg_jp2_filename
-      jp2_filename.gsub('_00_','_05_')
+      jp2_filename.gsub('_00_', '_05_')
     end
 
     # Create a JP2 file for the current image.
@@ -118,65 +116,52 @@ module Assembly
     #   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
     def create_jp2(params = {})
+      output = params[:output] || jp2_filename
+      create_jp2_checks(output: output, overwrite: params[:overwrite])
 
-      check_for_file
+      # Using instance variable so that can check in tests.
+      source_path = if mimetype != 'image/tiff'
+                      @tmp_path = make_tmp_tiff(tmp_folder: params[:tmp_folder])
+                    else
+                      @path
+                    end
 
-      raise 'input file is not a valid image, or is the wrong mimetype' if !self.jp2able?
+      result = `#{jp2_create_command(source_path: source_path, output: output)}`
+      raise "JP2 creation command failed: #{jp2_command} with result #{result}" unless $CHILD_STATUS.success?
 
-      output    = params[:output] || jp2_filename
-      overwrite = params[:overwrite] || false
+      File.delete(source_path) unless @tmp_path.nil? || params[:preserve_tmp_source]
 
-      raise SecurityError,"output #{output} exists, cannot overwrite" if !overwrite && File.exists?(output)
-
-      raise SecurityError,'cannot recreate jp2 over itself' if overwrite && mimetype=='image/jp2' && output == @path
-
-      tmp_folder = params[:tmp_folder] || Dir.tmpdir
-      raise "tmp_folder #{tmp_folder} does not exists" unless File.exists?(tmp_folder)
-
-      preserve_tmp_source = params[:preserve_tmp_source] || false
-
-      # make temp tiff filename
-      tmp_tiff_file = Tempfile.new(['assembly-image', '.tif'], tmp_folder)
-      @tmp_path = tmp_tiff_file.path
+      # create output response object, which is an Assembly::Image type object
+      Assembly::Image.new(output)
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
-      options    =  []
-      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
+    private
 
-      options << profile_conversion_switch(profile, tmp_folder: tmp_folder)
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def create_jp2_checks(output:, overwrite:)
+      check_for_file
+      raise 'input file is not a valid image, or is the wrong mimetype' unless jp2able?
 
-      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 $?.success?
+      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
 
-      # jp2 creation command
+    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.to_s}"
-      jp2_command = "#{kdu_bin} #{options.join(' ')} -i '#{@tmp_path}' -o '#{output}'"
-      result=`#{jp2_command} 2>&1`
-      raise "JP2 creation command failed: #{jp2_command} with result #{result}" unless $?.success?
-
-      tmp_tiff_file.delete unless preserve_tmp_source
-
-      # create output response object, which is an Assembly::Image type object
-      Assembly::Image.new(output)
+      options << "Clayers=#{layers}"
+      "#{kdu_bin} #{options.join(' ')} -i '#{source_path}' -o '#{output}' 2>&1"
     end
 
-    private
-
+    # rubocop:disable Metrics/MethodLength
     def kdu_compress_default_options
       [
         '-precise', # forces the use of 32-bit representations
@@ -192,6 +177,7 @@ module Assembly
         'Clevels=5' # Number of wavelet decomposition levels, or stages
       ]
     end
+    # rubocop:enable Metrics/MethodLength
 
     def samples_per_pixel
       if exif['samplesperpixel']
@@ -218,37 +204,77 @@ module Assembly
     # 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
+      ((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')
-      output_profile      = 'sRGBIEC6196621' # params[:output_profile] || 'sRGBIEC6196621'  # 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_file = File.join(path_to_profiles,"#{output_profile}.icc")
+      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.exists?(output_profile_file)
+      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
+      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.exists?(input_profile_file_gem) ? input_profile_file_gem : input_profile_file_tmp
+      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.exists?(input_profile_file)
-        input_profile_extraction_command = "MAGICK_TEMPORARY_PATH=#{tmp_folder} convert '#{@path}'[0] #{input_profile_file}" # extract profile from input image
-        result=`#{input_profile_extraction_command} 2>&1`
-        raise "input profile extraction command failed: #{input_profile_extraction_command} with result #{result}" unless $?.success?
-        raise 'input profile is not a known profile and could not be extracted from input file' unless File.exists?(input_profile_file) # if extraction failed or we cannot write the file, throw exception
+      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 = []
+      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

data/lib/assembly-image/images.rb

@@ -1,15 +1,15 @@
+# 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
 
-    def self.logger= logger
-      @logger = logger
+    class << self
+      attr_writer :logger
     end
 
     # Pass in a source path and have exif color profile descriptions added to all images contained.
@@ -28,8 +28,9 @@ module Assembly
     #
     # Example:
     #  Assembly::Images.batch_add_exif_profile_description('/full_path_to_tifs','Adobe RGB 1998')
-    def self.batch_add_exif_profile_description(source,profile_name,params={})
-
+    # 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
@@ -40,13 +41,15 @@ module Assembly
 
       # 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)
+      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)
+        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
     #
@@ -63,35 +66,42 @@ module Assembly
     #
     # Example:
     #  Assembly::Images.batch_generate_jp2('/full_path_to_tifs')
-    def self.batch_generate_jp2(source,params={})
+    # 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)
 
-        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
+      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)
+      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}"
+      logger.debug "Source: #{source}"
+      logger.debug "Destination: #{output}"
 
-        pattern = recursive ? "**/*.#{extension}" : "*.#{extension}*"
+      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
-            derivative_img=source_img.create_jp2(:overwrite=>overwrite,:output=>output_img)
-            logger.debug "Generated jp2 for #{File.basename(file)}"
-          rescue Exception => e
-            logger.debug "** Error for #{File.basename(file)}: #{e.message}"
-          end
+      # 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
-        'Complete'
-
+      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/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # Main Assembly namespace
 module Assembly
   # Main Image class
   class Image
     # Project version number
-    VERSION = '1.7.0'
+    VERSION = '1.7.1'
   end
 end

data/lib/assembly-image.rb

@@ -1,8 +1,8 @@
-module Assembly
+# frozen_string_literal: true
 
+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__) + '/..')
-
 end
 
 require 'assembly-image/image'

data/spec/image_spec.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe Assembly::Image do
-
   it 'should not run if no input file is passed in' do
-    @ai=Assembly::Image.new('')
-    expect{@ai.create_jp2}.to raise_error
+    @ai = Assembly::Image.new('')
+    expect{ @ai.create_jp2 }.to raise_error
   end
 
   it 'should indicate the default jp2 filename' do
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    expect(@ai.jp2_filename).to eq TEST_TIF_INPUT_FILE.gsub('.tif','.jp2')
+    expect(@ai.jp2_filename).to eq TEST_TIF_INPUT_FILE.gsub('.tif', '.jp2')
   end
 
   it 'should indicate the default jp2 filename' do
@@ -19,7 +21,7 @@ describe Assembly::Image do
 
   it 'should indicate the default DPG jp2 filename' do
     @ai = Assembly::Image.new(TEST_DPG_TIF_INPUT_FILE)
-    expect(@ai.dpg_jp2_filename).to eq TEST_DPG_TIF_INPUT_FILE.gsub('.tif','.jp2').gsub('_00_','_05_')
+    expect(@ai.dpg_jp2_filename).to eq TEST_DPG_TIF_INPUT_FILE.gsub('.tif', '.jp2').gsub('_00_', '_05_')
   end
 
   it 'should indicate the default jp2 filename' do
@@ -32,77 +34,92 @@ describe Assembly::Image do
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(result).to be_a_kind_of Assembly::Image
     expect(result.path).to eq TEST_JP2_OUTPUT_FILE
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'sRGB'
-    @jp2=Assembly::Image.new(TEST_JP2_OUTPUT_FILE)
+    @jp2 = Assembly::Image.new(TEST_JP2_OUTPUT_FILE)
     expect(@jp2.height).to eq 100
     expect(@jp2.width).to eq 100
   end
 
   it 'should create grayscale jp2 when given a bitonal tif' do
     skip 'The latest version of Kakadu may require some changes for this work correctly'
-    # error message is        
-      #  JP2 creation command failed: kdu_compress   -precise -no_weights -quiet Creversible=no Cmodes=BYPASS Corder=RPCL Cblk=\{64,64\} Cprecincts=\{256,256\},\{256,256\},\{128,128\} ORGgen_plt=yes -rate 1.5 Clevels=5  Clayers=2 -i '/tmp/408d3740-e25f-4c1b-889f-3f138d088fe4.tif' -o '/home/travis/build/sul-dlss/assembly-image/spec/test_data/output/test.jp2' with result Kakadu Error:
-      #  The number of colours associated with the colour space identified by the source
-      #  file (possible from an embedded ICC profile) is not consistent with the number
-      #  of supplied image components and/or colour palette.  You can address this
-      #  problem by supplying a `-jp2_space' or `-jpx_space' argument to explicitly
-      #  identify a colour space that has anywhere from 1 to 1 colour components.
-    generate_test_image(TEST_TIF_INPUT_FILE,:color=>'white',:image_type=>'Bilevel')
+    # error message is
+    #  JP2 creation command failed: kdu_compress   -precise -no_weights -quiet Creversible=no Cmodes=BYPASS
+    # Corder=RPCL Cblk=\{64,64\} Cprecincts=\{256,256\},\{256,256\},\{128,128\} ORGgen_plt=yes -rate 1.5 Clevels=5
+    # Clayers=2 -i '/tmp/408d3740-e25f-4c1b-889f-3f138d088fe4.tif' -o '/home/travis/build/sul-dlss/assembly-image/spec/test_data/output/test.jp2'
+    # with result Kakadu Error:
+    #  The number of colours associated with the colour space identified by the source
+    #  file (possible from an embedded ICC profile) is not consistent with the number
+    #  of supplied image components and/or colour palette.  You can address this
+    #  problem by supplying a `-jp2_space' or `-jpx_space' argument to explicitly
+    #  identify a colour space that has anywhere from 1 to 1 colour components.
+    generate_test_image(TEST_TIF_INPUT_FILE, color: 'white', image_type: 'Bilevel')
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
     expect(@ai).to have_color_profile
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'Grayscale'
   end
 
   it 'should create color jp2 when given a color tif but bitonal image data (1 channels and 1 bits per pixel)' do
-    generate_test_image(TEST_TIF_INPUT_FILE,:color=>'white',:image_type=>'TrueColor',:profile=>'')
+    generate_test_image(TEST_TIF_INPUT_FILE, color: 'white', image_type: 'TrueColor', profile: '')
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
     expect(@ai).to_not have_color_profile
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'sRGB'
   end
 
   it 'should create grayscale jp2 when given a graycale tif but with bitonal image data (1 channel and 1 bits per pixel)' do
-    generate_test_image(TEST_TIF_INPUT_FILE,:color=>'white',:image_type=>'Grayscale',:profile=>'')
+    generate_test_image(TEST_TIF_INPUT_FILE, color: 'white', image_type: 'Grayscale', profile: '')
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(@ai).to_not have_color_profile
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'Grayscale'
   end
 
   it 'should create color jp2 when given a color tif but with greyscale image data (1 channel and 8 bits per pixel)' do
-    generate_test_image(TEST_TIF_INPUT_FILE,:color=>'gray',:image_type=>'TrueColor',:profile=>'')
+    generate_test_image(TEST_TIF_INPUT_FILE, color: 'gray', image_type: 'TrueColor', profile: '')
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(@ai).to_not have_color_profile
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'sRGB'
   end
 
   it 'should create a jp2 when the source image has no profile' do
-    generate_test_image(TEST_TIF_INPUT_FILE,:profile=>'') # generate a test input with no profile
+    generate_test_image(TEST_TIF_INPUT_FILE, profile: '') # generate a test input with no profile
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to_not exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
+    # Indicates a temp tiff was not created.
+    expect(@ai.tmp_path).to be_nil
     expect(@ai).to_not have_color_profile
     expect(@ai).to be_a_valid_image
     expect(@ai).to be_jp2able
-    @ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)
+    @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
   end
 
@@ -112,7 +129,7 @@ describe Assembly::Image do
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    expect{@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE)}.to raise_error(SecurityError)
+    expect{ @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE) }.to raise_error(SecurityError)
   end
 
   it 'should get the correct image height and width' do
@@ -135,57 +152,61 @@ describe Assembly::Image do
     generate_test_image(TEST_TIF_INPUT_FILE)
     expect(File).to exist TEST_TIF_INPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    result=@ai.create_jp2(:output_profile=>'bogusness')
+    result = @ai.create_jp2(output_profile: 'bogusness')
     expect(result).to be_a_kind_of Assembly::Image
     expect(result.path).to eq TEST_JP2_INPUT_FILE
     expect(TEST_JP2_INPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'sRGB'
   end
 
+  it 'should create jp2 when given a JPEG' do
+    generate_test_image(TEST_JPEG_INPUT_FILE)
+    expect(File).to exist TEST_JPEG_INPUT_FILE
+    expect(File).to_not exist TEST_JP2_OUTPUT_FILE
+    @ai = Assembly::Image.new(TEST_JPEG_INPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE)
+    # Indicates a temp tiff was created.
+    expect(@ai.tmp_path).not_to be_nil
+    expect(File).not_to exist @ai.tmp_path
+    expect(result).to be_a_kind_of Assembly::Image
+    expect(result.path).to eq TEST_JP2_OUTPUT_FILE
+    expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
+  end
+
   it 'should not run if you specify a bogus tmp folder' do
-    generate_test_image(TEST_TIF_INPUT_FILE)
-    bogus_folder='/crapsticks'
-    expect(File).to exist TEST_TIF_INPUT_FILE
+    generate_test_image(TEST_JPEG_INPUT_FILE)
+    bogus_folder = '/crapsticks'
+    expect(File).to exist TEST_JPEG_INPUT_FILE
     expect(File).to_not exist bogus_folder
-    @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    expect { @ai.create_jp2(:tmp_folder=>bogus_folder) }.to raise_error
+    @ai = Assembly::Image.new(TEST_JPEG_INPUT_FILE)
+    expect { @ai.create_jp2(tmp_folder: bogus_folder) }.to raise_error
   end
 
   it 'should create a jp2 and preserve the temporary file if specified' do
-    generate_test_image(TEST_TIF_INPUT_FILE)
-    expect(File).to exist TEST_TIF_INPUT_FILE
-    @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE, :preserve_tmp_source=>true)
+    generate_test_image(TEST_JPEG_INPUT_FILE)
+    expect(File).to exist TEST_JPEG_INPUT_FILE
+    @ai = Assembly::Image.new(TEST_JPEG_INPUT_FILE)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE, preserve_tmp_source: true)
+    # Indicates a temp tiff was created.
+    expect(@ai.tmp_path).not_to be_nil
+    expect(File).to exist @ai.tmp_path
     expect(result).to be_a_kind_of Assembly::Image
     expect(result.path).to eq TEST_JP2_OUTPUT_FILE
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
-    expect(result.exif.colorspace).to eq 'sRGB'
-    expect(File.exists?(@ai.tmp_path)).to be true
+    expect(File.exist?(@ai.tmp_path)).to be true
   end
 
   it 'should create jp2 of the same filename and in the same location as the input if no output file is specified, and should cleanup tmp file' do
     generate_test_image(TEST_TIF_INPUT_FILE)
     expect(File).to exist TEST_TIF_INPUT_FILE
-    expect(File.exists?(TEST_JP2_INPUT_FILE)).to be false
+    expect(File.exist?(TEST_JP2_INPUT_FILE)).to be false
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    result=@ai.create_jp2
+    result = @ai.create_jp2
     expect(result).to be_a_kind_of Assembly::Image
     expect(result.path).to eq TEST_JP2_INPUT_FILE
     expect(TEST_JP2_INPUT_FILE).to be_a_jp2
     expect(result.exif.colorspace).to eq 'sRGB'
-    expect(File.exists?(@ai.tmp_path)).to be false
-  end
-
-  it 'should create jp2 from input JPEG of the same filename and in the same location as the input if no output file is specified, and should cleanup tmp file' do
-    generate_test_image(TEST_JPEG_INPUT_FILE)
-    expect(File).to exist TEST_JPEG_INPUT_FILE
-    expect(File).to_not exist TEST_JP2_INPUT_FILE
-    @ai = Assembly::Image.new(TEST_JPEG_INPUT_FILE)
-    result=@ai.create_jp2
-    expect(result).to be_a_kind_of Assembly::Image
-    expect(result.path).to eq TEST_JP2_INPUT_FILE
-    expect(TEST_JP2_INPUT_FILE).to be_a_jp2
-    expect(File.exists?(@ai.tmp_path)).to be false
+    expect(@ai.tmp_path).to be_nil
   end
 
   it 'should recreate jp2 if the output file exists and if you allow overwriting' do
@@ -194,7 +215,7 @@ describe Assembly::Image do
     expect(File).to exist TEST_TIF_INPUT_FILE
     expect(File).to exist TEST_JP2_OUTPUT_FILE
     @ai = Assembly::Image.new(TEST_TIF_INPUT_FILE)
-    result=@ai.create_jp2(:output => TEST_JP2_OUTPUT_FILE,:overwrite => true)
+    result = @ai.create_jp2(output: TEST_JP2_OUTPUT_FILE, overwrite: true)
     expect(result).to be_a_kind_of Assembly::Image
     expect(result.path).to eq TEST_JP2_OUTPUT_FILE
     expect(TEST_JP2_OUTPUT_FILE).to be_a_jp2
@@ -206,5 +227,5 @@ describe Assembly::Image do
     remove_files(TEST_INPUT_DIR)
     remove_files(TEST_OUTPUT_DIR)
   end
-
 end
+# rubocop:enable Metrics/BlockLength

data/spec/images_spec.rb

@@ -1,48 +1,49 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe Assembly::Images do
-
   it 'should not run if no input folder is passed in' do
-    expect{Assembly::Images.batch_generate_jp2('')}.to raise_error
+    expect{ Assembly::Images.batch_generate_jp2('') }.to raise_error
   end
 
   it 'should not run if a non-existent input folder is passed in' do
-    expect{Assembly::Images.batch_generate_jp2('/junk/path')}.to raise_error
+    expect{ Assembly::Images.batch_generate_jp2('/junk/path') }.to raise_error
   end
 
   it 'should run and batch produe jp2s from input tiffs' do
-    ['test1','test2','test3'].each {|image| generate_test_image(File.join(TEST_INPUT_DIR,"#{image}.tif")) }
-    Assembly::Images.batch_generate_jp2(TEST_INPUT_DIR,:output=>TEST_OUTPUT_DIR)
+    ['test1', 'test2', 'test3'].each { |image| generate_test_image(File.join(TEST_INPUT_DIR, "#{image}.tif")) }
+    Assembly::Images.batch_generate_jp2(TEST_INPUT_DIR, output: TEST_OUTPUT_DIR)
     expect(File.directory?(TEST_OUTPUT_DIR)).to be true
-    ['test1','test2','test3'].each {|image| expect(File.join(TEST_OUTPUT_DIR,"#{image}.jp2")).to be_a_jp2 }
+    ['test1', 'test2', 'test3'].each { |image| expect(File.join(TEST_OUTPUT_DIR, "#{image}.jp2")).to be_a_jp2 }
   end
 
   it 'should run and batch add color profile descriptions input tiffs with no color profile descriptions' do
-    ['test1','test2','test3'].each {|image| generate_test_image(File.join(TEST_INPUT_DIR,"#{image}.tif"),:profile=>'') }
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to be nil}
-    Assembly::Images.batch_add_exif_profile_description(TEST_INPUT_DIR,'Adobe RGB 1998')
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to eq 'Adobe RGB (1998)'}
+    ['test1', 'test2', 'test3'].each { |image| generate_test_image(File.join(TEST_INPUT_DIR, "#{image}.tif"), profile: '') }
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to be nil }
+    Assembly::Images.batch_add_exif_profile_descr(TEST_INPUT_DIR, 'Adobe RGB 1998')
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to eq 'Adobe RGB (1998)' }
   end
 
   it 'should run and batch add color profile descriptions input tiffs, forcing over existing color profile descriptions' do
-    ['test1','test2','test3'].each {|image| generate_test_image(File.join(TEST_INPUT_DIR,"#{image}.tif")) }
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to eq  'sRGB IEC61966-2.1'}
-    Assembly::Images.batch_add_exif_profile_description(TEST_INPUT_DIR,'Adobe RGB 1998',:force=>true) # force overwrite
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to eq  'Adobe RGB (1998)'}
+    ['test1', 'test2', 'test3'].each { |image| generate_test_image(File.join(TEST_INPUT_DIR, "#{image}.tif")) }
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to eq 'sRGB IEC61966-2.1' }
+    Assembly::Images.batch_add_exif_profile_descr(TEST_INPUT_DIR, 'Adobe RGB 1998', force: true) # force overwrite
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to eq 'Adobe RGB (1998)' }
   end
 
   it 'should run and batch add color profile descriptions input tiffs, not overwriting existing color profile descriptions' do
-    ['test1','test2','test3'].each {|image| generate_test_image(File.join(TEST_INPUT_DIR,"#{image}.tif")) }
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to eq  'sRGB IEC61966-2.1'}
-    Assembly::Images.batch_add_exif_profile_description(TEST_INPUT_DIR,'Adobe RGB 1998') # do not force overwrite
-    ['test1','test2','test3'].each {|image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription).to eq  'sRGB IEC61966-2.1'}
+    ['test1', 'test2', 'test3'].each { |image| generate_test_image(File.join(TEST_INPUT_DIR, "#{image}.tif")) }
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to eq 'sRGB IEC61966-2.1' }
+    Assembly::Images.batch_add_exif_profile_descr(TEST_INPUT_DIR, 'Adobe RGB 1998') # do not force overwrite
+    ['test1', 'test2', 'test3'].each { |image| expect(Assembly::Image.new(File.join(TEST_INPUT_DIR, "#{image}.tif")).exif.profiledescription).to eq 'sRGB IEC61966-2.1' }
   end
 
-
   after(:each) do
     # after each test, empty out the input and output test directories
     remove_files(TEST_INPUT_DIR)
     remove_files(TEST_OUTPUT_DIR)
   end
-
 end
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -1,38 +1,44 @@
+# frozen_string_literal: true
+
 bootfile = File.expand_path(File.dirname(__FILE__) + '/../config/boot')
 require bootfile
+require 'English'
 
-TEST_INPUT_DIR       = File.join(Assembly::PATH_TO_IMAGE_GEM,'spec','test_data','input')
-TEST_OUTPUT_DIR      = File.join(Assembly::PATH_TO_IMAGE_GEM,'spec','test_data','output')
-TEST_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR,'test.tif')
-TEST_DPG_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR,'oo000oo0001_00_01.tif')
-TEST_JPEG_INPUT_FILE  = File.join(TEST_INPUT_DIR,'test.jpg')
-TEST_JP2_INPUT_FILE  = File.join(TEST_INPUT_DIR,'test.jp2')
-TEST_JP2_OUTPUT_FILE = File.join(TEST_OUTPUT_DIR,'test.jp2')
+TEST_INPUT_DIR       = File.join(Assembly::PATH_TO_IMAGE_GEM, 'spec', 'test_data', 'input')
+TEST_OUTPUT_DIR      = File.join(Assembly::PATH_TO_IMAGE_GEM, 'spec', 'test_data', 'output')
+TEST_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.tif')
+TEST_DPG_TIF_INPUT_FILE = File.join(TEST_INPUT_DIR, 'oo000oo0001_00_01.tif')
+TEST_JPEG_INPUT_FILE = File.join(TEST_INPUT_DIR, 'test.jpg')
+TEST_JP2_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.jp2')
+TEST_JP2_OUTPUT_FILE = File.join(TEST_OUTPUT_DIR, 'test.jp2')
 TEST_DRUID           = 'nx288wh8889'
 
 # generate a sample image file with a specified profile
-def generate_test_image(file,params={})
-  color=params[:color] || 'red'
-  profile=params[:profile] || 'sRGBIEC6196621'
-  image_type=params[:image_type]
-  create_command="convert -size 100x100 xc:#{color} "
-  create_command += ' -profile ' + File.join(Assembly::PATH_TO_IMAGE_GEM,'profiles',profile+'.icc') + ' ' unless profile == ''
+# rubocop:disable Metrics/AbcSize
+def generate_test_image(file, params = {})
+  color = params[:color] || 'red'
+  profile = params[:profile] || 'sRGBIEC6196621'
+  image_type = params[:image_type]
+  create_command = "convert -size 100x100 xc:#{color} "
+  create_command += ' -profile ' + File.join(Assembly::PATH_TO_IMAGE_GEM, 'profiles', profile + '.icc') + ' ' unless profile == ''
   create_command += " -type #{image_type} " if image_type
   create_command += file
   create_command += ' 2>&1'
-  output = `#{create_command}`
-  unless $?.success?
-    raise "Failed to create test image #{file} (#{params}): \n#{output}"
-  end
+  output = `#{ create_command }`
+  raise "Failed to create test image #{file} (#{params}): \n#{output}" unless $CHILD_STATUS.success?
 end
+# rubocop:enable Metrics/AbcSize
 
 def remove_files(dir)
-  Dir.foreach(dir) {|f| fn = File.join(dir, f); File.delete(fn) if !File.directory?(fn) && File.basename(fn) != '.empty'}
+  Dir.foreach(dir) do |f|
+    fn = File.join(dir, f)
+    File.delete(fn) if !File.directory?(fn) && File.basename(fn) != '.empty'
+  end
 end
 
 RSpec::Matchers.define :be_a_jp2 do
   match do |actual|
-    if File.exists?(actual)
+    if File.exist?(actual)
       exif = MiniExiftool.new actual
       exif['mimetype'] == 'image/jp2'
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-image
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: assembly-objectfile
@@ -47,6 +47,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,7 +90,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,7 +114,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".rvmrc.example"
 - ".travis.yml"
 - Gemfile
@@ -142,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: assembly-image
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby immplementation of image services needed to prepare objects to be accessioned

data/.rubocop_todo.yml

@@ -1,263 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2015-12-15 16:19:20 -0800 using RuboCop version 0.35.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: 11
-# Cop supports --auto-correct.
-Lint/DeprecatedClassMethods:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'spec/image_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
-Lint/RescueException:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'lib/assembly-image/images.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Lint/StringConversionInInterpolation:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 2
-Lint/UselessAssignment:
-  Exclude:
-    - 'config/boot.rb'
-    - 'lib/assembly-image/images.rb'
-
-# Offense count: 4
-Metrics/AbcSize:
-  Max: 87
-
-# Offense count: 2
-Metrics/CyclomaticComplexity:
-  Max: 29
-
-# Offense count: 2
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 244
-
-# Offense count: 5
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 59
-
-# Offense count: 2
-Metrics/PerceivedComplexity:
-  Max: 30
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: Exclude.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/assembly-image.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/EmptyLines:
-  Exclude:
-    - 'spec/images_spec.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundBlockBody:
-  Exclude:
-    - 'spec/image_spec.rb'
-    - 'spec/images_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/EmptyLinesAroundClassBody:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/EmptyLinesAroundMethodBody:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'lib/assembly-image/images.rb'
-
-# Offense count: 13
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Style/ExtraSpacing:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'spec/images_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Configuration parameters: Exclude.
-Style/FileName:
-  Exclude:
-    - 'lib/assembly-image.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'spec/spec_helper.rb'
-
-# Offense count: 31
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues.
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Width.
-Style/IndentationWidth:
-  Exclude:
-    - 'lib/assembly-image/images.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/LineEndConcatenation:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodDefParentheses:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/NegatedIf:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'assembly-image.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantBegin:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAsExpressionSeparator.
-Style/Semicolon:
-  Exclude:
-    - 'spec/spec_helper.rb'
-
-# Offense count: 14
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SignalException:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'lib/assembly-image/images.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/SingleSpaceBeforeFirstArg:
-  Exclude:
-    - 'spec/images_spec.rb'
-
-# Offense count: 93
-# Cop supports --auto-correct.
-Style/SpaceAfterComma:
-  Exclude:
-    - 'assembly-image.gemspec'
-    - 'lib/assembly-image/image.rb'
-    - 'lib/assembly-image/images.rb'
-    - 'spec/image_spec.rb'
-    - 'spec/images_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceAroundEqualsInParameterDefault:
-  Enabled: false
-
-# Offense count: 54
-# Cop supports --auto-correct.
-# Configuration parameters: MultiSpaceAllowedForOperators.
-Style/SpaceAroundOperators:
-  Exclude:
-    - 'lib/assembly-image.rb'
-    - 'lib/assembly-image/image.rb'
-    - 'lib/assembly-image/images.rb'
-    - 'spec/image_spec.rb'
-    - 'spec/images_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceBeforeBlockBraces:
-  Enabled: false
-
-# Offense count: 29
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-Style/SpaceInsideBlockBraces:
-  Enabled: false
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/SpaceInsideParens:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'lib/assembly-image/image.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 87
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
-Style/TrivialAccessors:
-  Exclude:
-    - 'lib/assembly-image/images.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-    - 'assembly-image.gemspec'
-
-# Offense count: 11
-# Cop supports --auto-correct.
-# Configuration parameters: WordRegex.
-Style/WordArray:
-  MinSize: 3