assembly-image 1.6.8 → 1.6.9

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OGE0YzJiODk5NThlM2U1OTU1YjM2N2VhMzY1MTFiNmZhZWI2ZTBkNA==
-  data.tar.gz: !binary |-
-    OWE0YzZiMDMyNDM0MDc4NTM5NzNjNzdiYWQ5YzQwZjQ5ZWFkZDE4Ng==
+SHA1:
+  metadata.gz: 6d66d9eec1f29d5bd46dc1d0b56e5dabedc9bdb7
+  data.tar.gz: e1ca05e2d6fc53ab1d636693eff5adc5c904f2e8
 SHA512:
-  metadata.gz: !binary |-
-    ZjlhNmFiMmQxNDdlMjc2NTgzMTIzYmYxMWRlNGExZTQwNzY2NzI2ZGQwMzEx
-    ZWU5ZjRjNzMxZmIzODBkYWY1NzM1NTg5ZDJkMWFlMTRmYjliNmZhMTVhNmJl
-    OTQ0ZWY1YTBhYzQ2ZTgwNGZjYzU5ODgwNGNmZGUyNWMyNDI4MzE=
-  data.tar.gz: !binary |-
-    ODQxM2Y0ODBhNzk2YTkwZDA2NTIyZWIxMzlkNTQ4ZDdhN2VhZmVkZTY2MTdh
-    NDljNGI5MDk0YjI4OTQ2MmRkM2I1YzJhMDg2YTJiNzI1OWE2NWViMGI4MjBj
-    MmRhYjJlMDcyOTZkNTVkZGE1YWYwY2Q1NTg3MjRkMmY2ZjNkNDA=
+  metadata.gz: 8cee672d311df902bf6a6f922c6f0d34836970eef4df48cd6535f9533ad5dfe22c198fcac8d6ea6d2549d64d8a33010752bf7e2ddc903dd264a801627ac66c47
+  data.tar.gz: 6ef377f1d9135287313582ffdbbe7daa605a18a3ff4a8e4efe5b1025fbb239db5d0c1545ba72a508d0f242fb9a28d26f37e332210c11fe3cf58694f14d07c621

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+# rspec expect{...} is conventional
+Style/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 200

data/.rubocop_todo.yml

@@ -0,0 +1,263 @@
+# 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

data/.travis.yml

@@ -0,0 +1,26 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.2.4
+
+language: ruby
+sudo: false
+
+before_install:
+  - cmake --version
+  - wget -q http://kakadusoftware.com/wp-content/uploads/2014/06/KDU77_Demo_Apps_for_Linux-x86-64_150710.zip
+install:
+  - cmake -E tar -xf KDU77_Demo_Apps_for_Linux-x86-64_150710.zip
+  - export LD_LIBRARY_PATH=${PWD}/KDU77_Demo_Apps_for_Linux-x86-64_150710:${LD_LIBRARY_PATH}
+  - export PATH=${PWD}/KDU77_Demo_Apps_for_Linux-x86-64_150710:${PATH}
+  - bundle install --jobs=3 --retry=3
+
+addons:
+  apt:
+    packages:
+    - libimage-exiftool-perl
+    
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -1,5 +1,4 @@
-source "http://rubygems.org"
-source "http://sul-gems.stanford.edu"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in assembly-image.gemspec
 gemspec

data/README.md

@@ -0,0 +1,158 @@
+[![Build Status](https://travis-ci.org/sul-dlss/assembly-image.svg?branch=master)](https://travis-ci.org/sul-dlss/assembly-image)
+
+# 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 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
+
+## 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.
+1. If any errors occur during JP2 generation for any reason, a runtime exception will be thrown with a description of the error.
+2. 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 commonly occur in basic test TIFs that are black/white and have no profile, so beware during testing.
+
+## Usage
+
+To use the JP2 creation method, you first instantiate the image object with an input image and then operate on it.
+
+```ruby
+require 'assembly-image'
+input = Assembly::Image.new('/full/path/to/file.tif')
+puts input.exif   # show exif header information for the TIF
+output = input.create_jp2(:output=>'/full/path/to/output.jp2') # generate a new JP2 in the specified location
+puts output.exif  # show exif header information for the JP2
+```
+
+## Running tests
+
+```bash
+bundle exec rake
+```
+
+## Generate documentation
+To generate documentation into the "doc" folder:
+
+```bash
+yard
+```
+
+To keep a local server running with up to date code documentation that you can view in your browser:
+
+```bash
+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
+
+### Kakadu
+
+Download and install demonstration binaries from Kakadu:
+http://kakadusoftware.com/downloads/
+
+NOTE: If you have upgrade to El Capitan on OS X, you will need to donwload and re-install the latest version of Kakadu, due to changes made with SIP.  These changes moved the old executable binaries to an inaccessible location.
+
+### Imagemagick
+
+#### RHEL 6
+
+The version of ImageMagick included with RHEL 6 has all of the dependency libraries included:
+
+```bash
+yum install ImageMagick
+```
+#### RHEL 5
+
+The version of ImageMagick included with RHEL 5 is too old and does not have all the proper binaries included/built:
+
+```bash
+yum install lcms lcms-devel libjpeg libjpeg-devel libpng libpng-devel
+```
+Required libraries from source:
+* libtiff (version 3.9.4 or higher)
+
+Build Imagemagick from source:
+http://www.imagemagick.org/download/ImageMagick.tar.gz
+
+#### Mac
+
+```bash
+brew install jasper libtiff
+brew install imagemagick --use-tiff --use-jpeg2000
+```
+
+### Exiftool
+
+#### RHEL
+Download latest version from: http://www.sno.phy.queensu.ca/~phil/exiftool
+
+```bash
+tar -xf Image-ExifTool-#.##.tar.gz
+cd Image-ExifTool-#.##
+perl Makefile.PL
+make test
+sudo make install
+```
+
+#### Mac
+```bash
+brew install exiftool
+```