hydra-derivatives 3.8.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b9642a74101fb1b816e9b1a6e994065991930c6d3fe51a48f698275b11291c8
-  data.tar.gz: 3b4f2505d50372b3d52318deefaab4586028e48d3f6820c9179c1c747a7e4c2b
+  metadata.gz: d57cbceda9c0d06164a39a9d02c08f87d3595d2c7e4b651c45febd2b1f170304
+  data.tar.gz: 335f28d6f50ca793f9209cc0d178333958fe0900885dd60db887ee1d7967da39
 SHA512:
-  metadata.gz: e9cdbf207aca051db6a3d281e7e019df5be05f4fa0b5f6e1c65b64cb6e3388c8838d9cd13991e7b1f740b1c79dbbd65b782dea3d7e5661a5bcdcd07c40bd540b
-  data.tar.gz: d96492b3804b2f19effc7aa5c0de247080324c036efea58e34c7db7e1888ff14af9010654da8afd0ffbf9b62262359f208cb1458faef18785f40f9fbc9d25758
+  metadata.gz: 6f9a349b34da727f960c055363c6c49d82d1606e2f5679bf75c6c5d476493cc966f6257e74c171736e0ecacf28a8d997e20381b098844380d7a6deed24db54e9
+  data.tar.gz: 54834ba67208b3345c030b068ebe67c6b831e3541d9632973c91930c5b27a6e9025ca009fca5abec3313692062c0928131bcfbf1f924afd0345f20cbec739767

data/.circleci/config.yml

@@ -27,8 +27,9 @@ jobs:
       - run:
           name: Install dependencies
           command: |
+            wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
             sudo apt-get update
-            sudo apt-get install ghostscript libpng-dev imagemagick ffmpeg libreoffice dcraw
+            sudo apt-get install ghostscript libpng-dev imagemagick graphicsmagick libvips libvips-dev libvips-tools ffmpeg libreoffice dcraw
       - restore_cache:
           name: Restore Kakadu Cache
           keys:
@@ -38,7 +39,7 @@ jobs:
           command: |
             if [ ! -f ~/downloads/kakadu.zip ]; then
               mkdir -p ~/downloads
-              wget http://kakadusoftware.com/wp-content/uploads/KDU805_Demo_Apps_for_Linux-x86-64_200602.zip -O ~/downloads/kakadu.zip
+              wget http://kakadusoftware.com/wp-content/uploads/KDU841_Demo_Apps_for_Linux-x86-64_231117.zip -O ~/downloads/kakadu.zip
             fi
       - save_cache:
           name: Save Kakadu Cache
@@ -49,7 +50,7 @@ jobs:
           name: Install Kakadu
           command: |
             unzip ~/downloads/kakadu.zip
-            mv KDU805_Demo_Apps_for_Linux-x86-64_200602 kakadu
+            mv KDU841_Demo_Apps_for_Linux-x86-64_231117 kakadu
             sudo cp kakadu/*.so /usr/lib
             sudo cp kakadu/* /usr/bin
             kdu_compress -version
@@ -63,7 +64,7 @@ jobs:
       - samvera/bundle:
           ruby_version: << parameters.ruby_version >>
           bundler_version: << parameters.bundler_version >>
-          cache_version: "2"
+          cache_version: "3"
 
       - samvera/install_solr_core
 
@@ -74,18 +75,15 @@ jobs:
 workflows:
   ci:
     jobs:
+      - bundle_lint_test:
+          name: ruby3-3
+          ruby_version: 3.3.5
       - bundle_lint_test:
           name: ruby3-2
-          ruby_version: 3.2.0
+          ruby_version: 3.2.5
       - bundle_lint_test:
           name: ruby3-1
-          ruby_version: 3.1.3
-      - bundle_lint_test:
-          name: ruby3-0
-          ruby_version: 3.0.3
-      - bundle_lint_test:
-          name: ruby2-7
-          ruby_version: 2.7.7
+          ruby_version: 3.1.6
 
   nightly:
     triggers:
@@ -96,15 +94,12 @@ workflows:
               only:
                 - main
     jobs:
+      - bundle_lint_test:
+          name: ruby3-3
+          ruby_version: 3.3.5
       - bundle_lint_test:
           name: ruby3-2
-          ruby_version: 3.2.0
+          ruby_version: 3.2.5
       - bundle_lint_test:
           name: ruby3-1
-          ruby_version: 3.1.3
-      - bundle_lint_test:
-          name: ruby3-0
-          ruby_version: 3.0.3
-      - bundle_lint_test:
-          name: ruby2-7
-          ruby_version: 2.7.7
+          ruby_version: 3.1.6

data/.rubocop_todo.yml

@@ -8,6 +8,7 @@ Layout/SpaceBeforeBlockBraces:
 Metrics/ClassLength:
   Exclude:
     - lib/hydra/derivatives/processors/jpeg2k_image.rb
+    - lib/hydra/derivatives/processors/image.rb
 
 Metrics/CyclomaticComplexity:
   Exclude:

data/Dockerfile

@@ -0,0 +1,37 @@
+ARG RUBY_VERSION=3.2.2
+
+FROM rubylang/ruby:$RUBY_VERSION-dev-jammy
+
+RUN apt update && apt -y install \
+  imagemagick \
+  zip \
+  ghostscript \
+  libpng-dev \
+  libvips \
+  libvips-dev \
+  libvips-tools \
+  graphicsmagick \
+  ffmpeg \
+  libreoffice \
+  git \
+  dcraw \
+  libyaml-dev
+
+ARG KAKADU_ZIP
+RUN mkdir -p /opt/kakadu
+COPY $KAKADU_ZIP.zip /opt/kakadu/downloads/kakadu.zip
+RUN unzip /opt/kakadu/downloads/kakadu.zip \
+    && mv $KAKADU_ZIP kakadu \
+    && cp kakadu/*.so /usr/lib \
+    && cp kakadu/* /usr/bin
+
+RUN sed -i 's/policy domain="coder" rights="none" pattern="PDF"/policy domain="coder" rights="read|write" pattern="PDF"/' /etc/ImageMagick-6/policy.xml
+RUN sed -i 's/decode="dng:decode" command=".*"\/>$/decode="dng:decode" command="\&quot\;dcraw\&quot\; -c -q 3 -H 5 -w \&quot\;\%i\&quot\; \| \&quot\;convert\&quot\; - \&quot\;\%u\.png\&quot\;"\/>/' /etc/ImageMagick-6/delegates.xml
+
+RUN addgroup --system --gid 1001 app && \
+  adduser --system --ingroup app --uid 1001 --shell /bin/sh --home /app app
+
+RUN mkdir -p /app/samvera/hydra-derviatives
+WORKDIR /app/samvera/hydra-derivatives
+COPY ./ /app/samvera/hydra-derivatives
+RUN gem install bundler && bundle install --jobs=3 --retry=3 

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 # Please see hydra-derivatives.gemspec for dependency information.
 gemspec
 
-gem 'sprockets', '~> 3.7'
-
 group :development, :test do
   gem 'bixby'
   gem 'rspec_junit_formatter'

data/README.md

@@ -253,6 +253,40 @@ If you don't want to run the whole suite all at once like CI, do the following:
 1. Run the test servers with `rake derivatives:test_server`
 2. Run the tests.
 
+## Running tests with Docker
+
+First, make sure you have installed [Docker](https://www.docker.com/).
+
+Download the most recent version of the Linux Kakadu demo from [the downloads page](https://kakadusoftware.com/documentation-downloads/downloads/)
+and place it in your cloned repository. (This requires signing up with an email address.)
+
+Note the name of the zip file without the .zip extension. We will pass this name as an argument when building 
+the docker container. For example, if the name of the zip file is `KDU841_Demo_Apps_for_Linux-x86-64_231117.zip`, 
+we will pass `KDU841_Demo_Apps_for_Linux-x86-64_231117` to `docker compose build`.
+
+Within your cloned repository, tell Docker to get started installing your development environment, replacing 
+`<name of zip file>` with the name of your downloaded file above.
+
+```sh
+docker compose build --build-arg KAKADU_ZIP=<name of zip file>
+docker compose up
+```
+
+This starts containers for:
+
+  - Fedora
+  - Solr
+
+It also builds an image containing all dependencies needed for the tests.
+
+To stop the containers, type <kbd>Ctrl</kbd>+<kbd>c</kbd>. To restart the containers you need only run `docker compose up`.
+
+You can run the full test suite using the following command:
+
+```sh
+docker compose run -w /app/samvera/hydra-derivatives test sh -c "bundle exec rspec"
+```
+
 # Acknowledgments
 
 This software has been developed by and is brought to you by the Samvera community.  Learn more at the

data/VERSION

@@ -1 +1 @@
-3.8.0
+4.1.0

data/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '2.2'
+
+volumes:
+  solr:
+  fcrepo:
+
+networks:
+  internal:
+
+services:
+
+  solr:
+    image: solr:8
+    ports:
+      - 8985:8983
+    command: 
+      - bash
+      - "-c"
+      - "precreate-core hydra-test /opt/solr/server/configsets/hydra-test; exec solr -f"
+    volumes:
+      - .:/app
+      - ./solr/config:/opt/solr/server/configsets/hydra-test
+      - solr:/opt/solr/server/solr
+    networks:
+      internal:
+
+  fcrepo:
+    image: ghcr.io/samvera/fcrepo4:4.7.5
+    volumes:
+      - fcrepo:/data:cached
+    ports:
+      - 8986:8080
+    networks:
+      internal:
+
+  test:
+    build: .
+    env_file:
+      - test.env
+    volumes:
+      - .:/app/samvera/hydra-derivatives # Volume mounted
+    networks:
+      internal:
+    depends_on:
+      - fcrepo
+      - solr

data/hydra-derivatives.gemspec

@@ -18,17 +18,18 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'fcrepo_wrapper', '~> 0.2'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rails', '> 5.1', '< 7.1'
+  spec.add_development_dependency 'rails', '> 5.1', '< 9.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency "solr_wrapper"
 
-  spec.add_dependency 'active_encode', '~> 0.1'
+  spec.add_dependency 'active_encode', '~> 1.2'
   spec.add_dependency 'active-fedora', '>= 14.0'
   spec.add_dependency 'active-triples', '>= 1.2'
-  spec.add_dependency 'activesupport', '>= 4.0', '< 7.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 9.0'
   spec.add_dependency 'addressable', '~> 2.5'
   spec.add_dependency 'deprecation'
   spec.add_dependency 'mime-types', '> 2.0', '< 4.0'
   spec.add_dependency 'mini_magick', '>= 3.2', '< 5'
+  spec.add_dependency 'ruby-vips'
 end

data/lib/hydra/derivatives/processors/image.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'mini_magick'
+require 'ruby-vips'
 
 module Hydra::Derivatives::Processors
   class Image < Processor
@@ -20,22 +21,72 @@ module Hydra::Derivatives::Processors
       # When resizing images, it is necessary to flatten any layers, otherwise the background
       # may be completely black. This happens especially with PDFs. See #110
       def create_resized_image
-        create_image do |xfrm|
+        if Hydra::Derivatives::ImageService.processor == :graphicsmagick
+          create_resized_image_with_graphicsmagick
+        elsif Hydra::Derivatives::ImageService.processor == :libvips
+          create_resized_image_with_libvips
+        else
+          create_resized_image_with_imagemagick
+        end
+      end
+
+      def create_resized_image_with_graphicsmagick
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using GraphicsMagick image resize method')
+        create_image do |temp_file|
           if size
-            xfrm.combine_options do |i|
-              i.flatten
-              i.resize(size)
+            # remove layers and resize using convert instead of mogrify
+            MiniMagick::Tool::Convert.new do |cmd|
+              cmd << temp_file.path # input
+              cmd.flatten
+              cmd.resize(size)
+              cmd << temp_file.path # output
             end
           end
         end
       end
 
+      def create_resized_image_with_imagemagick
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using ImageMagick image resize method')
+        create_image do |temp_file|
+          if size
+            temp_file.flatten
+            temp_file.resize(size)
+          end
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def create_resized_image_with_libvips
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using libvips resize method')
+        create_image do |temp_file|
+          if size
+            width, height, option = size.match(/(\d+)x(\d+)(.)?/).captures
+            # Translate imagemagick resize syntax into ruby-vips
+            size_option = case option
+                          when '>'
+                            :down
+                          when '<'
+                            :up
+                          when '!'
+                            :force
+                          end
+            temp_file.thumbnail_image(width.to_i, height: height.to_i, size: size_option)
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
       def create_image
-        xfrm = selected_layers(load_image_transformer)
-        yield(xfrm) if block_given?
-        xfrm.format(directives.fetch(:format))
-        xfrm.quality(quality.to_s) if quality
-        write_image(xfrm)
+        if Hydra::Derivatives::ImageService.processor == :libvips
+          image = block_given? ? yield(load_image_transformer) : load_image_transformer
+          write_image_with_vips(image, directives)
+        else
+          xfrm = selected_layers(load_image_transformer)
+          yield(xfrm) if block_given?
+          xfrm.format(directives.fetch(:format))
+          xfrm.quality(quality.to_s) if quality
+          write_image(xfrm)
+        end
       end
 
       def write_image(xfrm)
@@ -45,10 +96,24 @@ module Hydra::Derivatives::Processors
         output_file_service.call(output_io, directives)
       end
 
+      def write_image_with_vips(image, directives)
+        output_io = StringIO.new
+        format = directives.fetch(:format, "jpg")
+        format_string = ".#{format}#{"[Q=#{quality}]" if quality}"
+        output_io.write(image.write_to_buffer(format_string))
+        output_io.rewind
+        output_file_service.call(output_io, directives)
+      end
+
       # Override this method if you want a different transformer, or need to load the
       # raw image from a different source (e.g. external file)
       def load_image_transformer
-        MiniMagick::Image.open(source_path)
+        if Hydra::Derivatives::ImageService.processor == :libvips
+          # Vips specifies pdf layers at load time
+          selected_vips_layers(source_path)
+        else
+          MiniMagick::Image.open(source_path)
+        end
       end
 
     private
@@ -70,5 +135,13 @@ module Hydra::Derivatives::Processors
           image
         end
       end
+
+      def selected_vips_layers(source_path)
+        if `vipsheader #{Shellwords.escape(source_path)}` =~ /pdfload/i && directives.fetch(:layer, false)
+          Vips::Image.new_from_file(source_path, page: directives.fetch(:layer))
+        else
+          Vips::Image.new_from_file(source_path)
+        end
+      end
   end
 end

data/lib/hydra/derivatives/processors/video/config.rb

@@ -21,7 +21,7 @@ module Hydra::Derivatives::Processors::Video
 
     def mpeg4
       audio_encoder = Hydra::Derivatives::AudioEncoder.new
-      @mpeg4 ||= CodecConfig.new("-vcodec libx264 -acodec #{audio_encoder.audio_encoder}")
+      @mpeg4 ||= CodecConfig.new("-vcodec libx264 -profile:v high -pix_fmt yuv420p -acodec #{audio_encoder.audio_encoder}")
     end
 
     def webm

data/lib/hydra/derivatives/services/image_service.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Hydra::Derivatives
+  module ImageService
+    def self.default_processor
+      :imagemagick
+    end
+
+    def self.processor
+      case ENV['IMAGE_PROCESSOR']
+      when 'imagemagick'
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using ImageMagick as image processor')
+        :imagemagick
+      when 'graphicsmagick'
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using GraphicsMagick as image processor')
+        :graphicsmagick
+      when 'libvips'
+        Hydra::Derivatives::Logger.debug('[ImageProcessor] Using libvips as image processor')
+        :libvips
+      else
+        Hydra::Derivatives::Logger.debug("[ImageProcessor] The environment variable IMAGE_PROCESSOR should be set to 'imagemagick','graphicsmagick' or 'libvips'. It is currently set to: #{ENV['IMAGE_PROCESSOR']}. Defaulting to using #{default_processor}")
+        default_processor
+      end
+    end
+  end
+end

data/lib/hydra/derivatives.rb

@@ -38,6 +38,7 @@ module Hydra
       autoload :PersistExternalFileOutputFileService
       autoload :TempfileService
       autoload :MimeTypeService
+      autoload :ImageService
     end
 
     # Raised if the timout elapses

data/test.env

@@ -0,0 +1,9 @@
+FCREPO_HOST=fcrepo
+FCREPO_PORT=8080
+FCREPO_REST_PATH=rest
+FCREPO_TEST_BASE_PATH=/test
+SOLR_HOST=solr
+SOLR_PORT=8983
+SOLR_TEST_URL=http://solr:8983/solr/hydra-test
+SOLR_URL=http://solr:8983/solr/
+FCREPO_CONFIG_PATH=spec/support/config/fedora.yml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-derivatives
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2025-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +165,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -175,7 +175,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +244,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  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'
 description: Derivative generation plugin for hydra
 email:
 - jenlindner@gmail.com
@@ -261,6 +275,7 @@ files:
 - ".solr_wrapper"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - History.md
 - LICENSE.txt
@@ -273,6 +288,7 @@ files:
 - config/jetty.yml
 - config/solr_wrapper_test.yml
 - doc/amazon_elastic_transcoder.md
+- docker-compose.yml
 - hydra-derivatives.gemspec
 - lib/color_profiles/license.txt
 - lib/color_profiles/sRGB_IEC61966-2-1_no_black_scaling.icc
@@ -305,6 +321,7 @@ files:
 - lib/hydra/derivatives/runners/runner.rb
 - lib/hydra/derivatives/runners/video_derivatives.rb
 - lib/hydra/derivatives/services/capability_service.rb
+- lib/hydra/derivatives/services/image_service.rb
 - lib/hydra/derivatives/services/mime_type_service.rb
 - lib/hydra/derivatives/services/persist_basic_contained_output_file_service.rb
 - lib/hydra/derivatives/services/persist_external_file_output_file_service.rb
@@ -328,6 +345,7 @@ files:
 - solr/config/xslt/example_atom.xsl
 - solr/config/xslt/example_rss.xsl
 - solr/config/xslt/luke.xsl
+- test.env
 homepage: https://github.com/projecthydra/hydra-derivatives
 licenses:
 - APACHE2
@@ -348,7 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Derivative generation plugin for hydra