assembly-image 1.6.8 → 1.6.9

data/spec/images_spec.rb

@@ -2,40 +2,40 @@ require 'spec_helper'
 
 describe Assembly::Images do
 
-  it "should not run if no input folder is passed in" do
-    lambda{Assembly::Images.batch_generate_jp2('')}.should raise_error
+  it 'should not run if no input folder is passed in' do
+    expect{Assembly::Images.batch_generate_jp2('')}.to raise_error
   end
 
-  it "should not run if a non-existent input folder is passed in" do
-    lambda{Assembly::Images.batch_generate_jp2('/junk/path')}.should raise_error
+  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
   end
 
-  it "should run and batch produe jp2s from input tiffs" do
+  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)
-    File.directory?(TEST_OUTPUT_DIR).should be true
-    ['test1','test2','test3'].each {|image| is_jp2?(File.join(TEST_OUTPUT_DIR,"#{image}.jp2")).should be_true }
+    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 }
   end
 
-  it "should run and batch add color profile descriptions input tiffs with no color profile descriptions" do
+  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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should be nil}    
+    ['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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should == '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
+
+  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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should == 'sRGB IEC61966-2.1'}    
+    ['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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should == '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, not overwriting existing color profile descriptions" do
+  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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should == 'sRGB IEC61966-2.1'}    
+    ['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| Assembly::Image.new(File.join(TEST_INPUT_DIR,"#{image}.tif")).exif.profiledescription.should == 'sRGB IEC61966-2.1'}    
+    ['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
 
 

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ 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"
+TEST_DRUID           = 'nx288wh8889'
 
 # generate a sample image file with a specified profile
 def generate_test_image(file,params={})
@@ -16,22 +16,27 @@ def generate_test_image(file,params={})
   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 += ' -profile ' + File.join(Assembly::PATH_TO_IMAGE_GEM,'profiles',profile+'.icc') + ' ' unless profile == ''
   create_command += " -type #{image_type} " if image_type
   create_command += file
-  system(create_command)
+  create_command += ' 2>&1'
+  output = `#{create_command}`
+  unless $?.success?
+    raise "Failed to create test image #{file} (#{params}): \n#{output}"
+  end
 end
 
 def remove_files(dir)
   Dir.foreach(dir) {|f| fn = File.join(dir, f); File.delete(fn) if !File.directory?(fn) && File.basename(fn) != '.empty'}
 end
 
-# check the existence and mime_type of the supplied file and confirm if it's jp2
-def is_jp2?(file)
-  if File.exists?(file)
-    exif = MiniExiftool.new file
-    return exif['mimetype'] == 'image/jp2'
-  else
-    false
+RSpec::Matchers.define :be_a_jp2 do
+  match do |actual|
+    if File.exists?(actual)
+      exif = MiniExiftool.new actual
+      exif['mimetype'] == 'image/jp2'
+    else
+      false
+    end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-image
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.6.9
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -9,137 +9,117 @@ authors:
 - Monty Hindman
 - Tony Calavano
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: assembly-objectfile
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: mini_exiftool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>'
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+        version: '1.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: lyberteam-gems-devel
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  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'
 description: Contains classes to create derivative image files and perform other image
   operations
 email:
 - pmangiafico@stanford.edu
-executables:
-- console
-- run_all_tests
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc.example
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".rvmrc.example"
+- ".travis.yml"
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - assembly-image.gemspec
 - bin/console
@@ -166,17 +146,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: assembly-image
-rubygems_version: 2.4.2
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Ruby immplementation of image services needed to prepare objects to be accessioned

data/README.rdoc

@@ -1,145 +0,0 @@
-= Assembly Image Gem
-
-==Overview 
-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-1.6.6 fix problem with lack of extension in incoming tif causing a problem when creating jp2
-- 1.6.7-1.6.8 tweaks to gemspec
-==Notes
-
-1. The gem assumes that the user context in which it is executed has write access to the 'tmp' folder.
-This is because color profiles can be extracted from images during the JP2 creation process, and these profiles need to
-be stored as local files, and it is beneficial to cache them for later usage by images with the same color profile.  
-If you know there are color profiles which are commonly used, it is better to capture them in the gem itself in the profile
-folder so they can be re-used and do not need to be extracted.
-
-2. If any errors occur during JP2 generation for any reason, a runtime exception will be thrown with a description of the error.
-
-3. If an image is passed in with a color profile that cannot be determined by examining the exif header data, an exception will be thrown.
-This can commonally occur in basic test TIFs that are black/white and have no profile, so beware during testing.
-
-==Deploy new gem
-
-gem build assembly-image.gemspec
-gem push assembly-image-1.6.8.gem # update version as needed
-
-==Usage
-
-To use the JP2 creation method, you first instantiate the image object with an input image and then operate on it.
-
-	require 'assembly-image'
-	input=Assembly::Image.new('/full/path/to/file.tif')
-	puts input.exif  # this will show you exif header information for the TIF
-	output=input.create_jp2(:output=>'/full/path/to/output.jp2') # this will generate a new JP2 in the output location specified
-	puts output.exif # this will show you exif header information for the JP2
-
-==Running tests
-
-	bundle exec rspec spec
-
-==Generate documentation
-To generate documentation into the "doc" folder:
-
-	yard
-
-To keep a local server running with up to date code documentation that you can view in your browser at http://0.0.0.0:8808:
-
-	yard server --reload
-
-==Prerequisites
-
-1. Perl 
-
-2. Kakadu Software Binaries - for JP2 generation
-
-   Download and install demonstration binaries from Kakadu:
-   http://www.kakadusoftware.com/index.php?option=com_content&task=view&id=26&Itemid=22
-
-   Note: The binaries will not work with RHEL 5.x; an RPM for RHEL 5 with
-   compatible binaries coming soon.
-
-3. Imagemagick 6.5.4 or higher
-            	   		
-   RHEL 6
-   
-   The version of ImageMagick included with RHEL 6 has all of the dependency libraries included: 
-
-       yum install ImageMagick
-           
-   RHEL 5: (RPM to install with included binaries comming soon)
-
-   The version of ImageMagic included with RHEL 5 is too old and does not have all the proper binaries included/built
-
-   Required libraries are:
-
-       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
-
-   Mac users:
-
-		brew install jasper
-		brew install libtiff
-		brew install imagemagick --use-tiff --use-jpeg2000
-
-4. Exiftool
-            
-   RHEL: (RPM to install comming soon)
-   Download latest version from:  http://www.sno.phy.queensu.ca/~phil/exiftool
-
-       tar -xf Image-ExifTool-#.##.tar.gz
-       cd Image-ExifTool-#.##
-       perl Makefile.PL
-       make test
-       sudo make install
-
-   Mac users:
-
-       brew install exiftool
-