jekyll-imagemagick-sutermserv 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be9bb607832a1e23d743d4722e3219dbf5ecdf7ffde0f9c1b4795c2158e57e08
+  data.tar.gz: 619c65ebf36d83be20043ab458ae1f02da121131b8652749836674d7db5f24d6
+SHA512:
+  metadata.gz: 8e0e140c1a85018baeae864902561f849ade4508a4604e808e0cc8aa80467ee9653d6a2ebd93035e05f1b9c7af08bcb6199fcf305999d7e859892673bf25a223
+  data.tar.gz: 6e2566e7dd1017bd1c9e67aa7fa60f0c41eed85f2911696adf6b1097109a2103d70971b8ff07fa21b644f13306c27139ff89ce01e7c78186df77122ee8e5d5c0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-imagemagick-sutermserv.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emilio Del Tessandoro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/jekyll-imagemagick-sutermserv.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-imagemagick-sutermserv"
+  spec.version = Jekyll::Imagemagick::Sutermserv::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ['Emilio Del Tessandoro', 'Joshua Wiedekopf']
+  spec.email         = ['emilio.deltessa@gmail.com', 'j.wiedekopf@uni-luebeck.de']
+  spec.homepage      = 'https://gitlab.com/emmmile/jekyll-imagemagick'
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Image generator for Jekyll 3 websites with changes for SU-TermServ.'
+  spec.description   = 'Image generator for Jekyll 3 websites that automatically ' \
+                       'convert images from one format to another.'
+
+  spec.files         = Dir[
+                         'README.md',
+                         'LICENSE.txt',
+                         'Rakefile',
+                         '*.gemspec',
+                         'Gemfile',
+                         'lib/**/*'
+                       ]
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jekyll', '~> 4.3'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.59.1'
+  spec.add_development_dependency 'test-unit', '~> 3.2'
+
+end

data/lib/convert.rb

@@ -0,0 +1,38 @@
+require 'open3'
+
+module JekyllImagemagickSutermserv
+  # Class used to convert a single image to another format using imagemagick
+  class ImageConvert
+    # Executes a command and wait for the output
+    def self.run_cmd(cmd)
+      exit_code = 0
+      error = ''
+      output = ''
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+        stdin.close # we don't pass any input to the process
+        output = stdout.gets
+        error = stderr.gets
+        exit_code = wait_thr.value
+      end
+
+      if exit_code != 0
+        Jekyll.logger.error(LOG_PREFIX, "Command returned #{exit_code} with error #{error}")
+      end
+
+      # Return any captured return value
+      return [output, error]
+    end
+
+    def self.run(input_file, output_file, flags, long_edge, resize_flags)
+      Jekyll.logger.info(LOG_PREFIX, "Generating image \"#{output_file}\"")
+
+      cmd = "convert \"#{input_file}\" #{flags} "
+      if long_edge != 0
+        cmd += "-resize \"#{long_edge}>\" #{resize_flags} "
+      end
+      cmd += "\"#{output_file}\""
+      Jekyll.logger.debug(LOG_PREFIX, "Running command \"#{cmd}\"")
+      run_cmd(cmd)
+    end
+  end
+end

data/lib/defaults.rb

@@ -0,0 +1,24 @@
+module JekyllImagemagickSutermserv
+  LOG_PREFIX = 'ImagemagickSuts:'.freeze
+
+  # The default configuration for the Imagemagick generator
+  # The values here represent the defaults if nothing is set
+  DEFAULTS = {
+    'enabled'           => false,
+
+    # List of directories containing images to optimize, Nested directories will not be checked
+    'input_directories' => [],
+
+    # List of resolutions to generate, 0 means full size otherwise is the long edge
+    'widths'            => [0],
+
+    'input_formats'     => ['.png', '.tiff'],
+
+    'output_formats'    => [],
+
+    # List of files or directories to exclude
+    'exclude'           => [],
+
+    'skip_languages'    => [],
+  }.freeze
+end

data/lib/generator.rb

@@ -0,0 +1,151 @@
+require 'jekyll/document'
+require 'fileutils'
+
+module JekyllImagemagickSutermserv
+  # A static file to hold the generated webp image after generation
+  # so that Jekyll will copy it into the site output directory
+  class ImageFile < Jekyll::StaticFile
+    def write(_dest)
+      true # Recover from strange exception when starting server without --auto
+    end
+  end
+
+  # Go through a set of directories and convert files
+  class ImageGenerator < Jekyll::Generator
+    # This generator is safe from arbitrary code execution.
+    safe true
+
+    # This generator should be passive with regard to its execution
+    priority :lowest
+
+    # Main function, called by Jekyll-core. Do the transformations...
+    def generate(site)
+      # Retrieve and merge the configuration from the site yml file
+      @config = DEFAULTS.merge(site.config['imagemagick'] || {})
+
+      # If disabled then simply quit
+      unless @config['enabled']
+        Jekyll.logger.info(LOG_PREFIX, 'Disabled in site.config')
+        return
+      end
+
+      # If the site destination directory has not yet been created then create it now.
+      # Otherwise, we cannot write our file there.
+      unless File.directory? site.dest
+        Dir.mkdir(site.dest)
+      end
+
+      files = get_files_to_transform(site, @config['input_directories'], @config['input_formats'])
+      tuples = compute_transformations(site, files, @config['output_formats'], @config['widths'])
+      generate_output_paths(site, tuples)
+      generated_files = generate_files(site, tuples, @config['output_formats'])
+
+      Jekyll.logger.info(LOG_PREFIX, "Generated #{generated_files} file(s)")
+    end
+
+    private
+
+    # Return all the files to convert
+    def get_files_to_transform(site, directories, input_formats)
+      files = []
+
+      directories.each do |directory|
+        directory_full_path = File.join(site.source, directory)
+        Jekyll.logger.info(LOG_PREFIX, "Searching files in #{directory_full_path}")
+
+        Dir[directory_full_path + '**/*.*'].each do |file_full_path|
+          # If the file_full_path is not one of the supported formats, exit early
+          extension = File.extname(file_full_path).downcase
+          next unless input_formats.include? extension
+
+          files.push(file_full_path)
+        end
+      end
+
+      return files
+    end
+
+    # Returns a list (input, output, edge)
+    def compute_transformations(site, input_files_full_path, formats, edges)
+      output = []
+
+      site_match = /_site\/?(?<lang>.*)$/.match(site.dest)
+      skip_lang = @config['skip_languages']
+      this_lang = site_match.named_captures["lang"]
+
+      if skip_lang.include?(this_lang)
+        Jekyll.logger.info(LOG_PREFIX, "skipping image generation for language '#{this_lang}'")
+        return output
+      end
+
+      if formats.length.zero?
+        Jekyll.logger.warn(LOG_PREFIX, 'No output formats found!')
+        return output
+      end
+
+      input_files_full_path.each do |input_file_full_path|
+        formats.each do |format_extension, _flags|
+          edges.each do |edge|
+            extension = File.extname(input_file_full_path)
+            prefix = File.dirname(input_file_full_path.sub(site.source, ''))
+            suffix = ''
+            unless edge.zero?
+              suffix = '-' + edge.to_s
+            end
+            filename = File.basename(input_file_full_path, extension) +
+                       suffix + '.' + format_extension.to_s
+            output_file_full_path = File.join(site.dest + prefix, filename)
+            output.push([input_file_full_path, output_file_full_path, edge])
+          end
+        end
+      end
+
+      return output
+    end
+
+    def generate_output_paths(_site, tuples)
+      tuples.each do |tuple|
+        _input, output, _edge = tuple
+        directory = File.dirname(output)
+        FileUtils.mkdir_p(directory)
+      end
+    end
+
+    def generate_files(site, tuples, formats)
+      generated_files = 0
+
+      tuples.each do |tuple|
+        input_file_full_path, output_file_full_path, edge = tuple
+        # Check if the file already has a webp alternative?
+        # If we're force rebuilding all webp files then ignore the check
+        # also check the modified time on the files to ensure that the webp file
+        # is newer than the source file, if not then regenerate
+        
+        if !File.file?(output_file_full_path) ||
+           (File.mtime(output_file_full_path) <= File.mtime(input_file_full_path))
+          # Generate the file
+          extension = File.extname(output_file_full_path).sub('.', '')
+          ImageConvert.run(input_file_full_path,
+                           output_file_full_path,
+                           formats[extension],
+                           edge,
+                           @config['resize_flags'])
+          generated_files += 1
+        end
+
+        next unless File.file?(output_file_full_path)
+
+        # Keep the webp file from being cleaned by Jekyll
+        prefix = File.dirname(input_file_full_path.sub(site.source, ''))
+        file_path = site.dest + prefix + '/' + File.basename(output_file_full_path)
+        Jekyll.logger.info(LOG_PREFIX, "Adding static file #{file_path}")
+        site.static_files << ImageFile.new(site,
+                                           site.dest,
+                                           prefix,
+                                           File.basename(output_file_full_path))
+      end
+
+      return generated_files
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Imagemagick
+    module Sutermserv
+      VERSION = "1.4.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-imagemagick-sutermserv
+version: !ruby/object:Gem::Version
+  version: 1.4.1
+platform: ruby
+authors:
+- Emilio Del Tessandoro
+- Joshua Wiedekopf
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Image generator for Jekyll 3 websites that automatically convert images
+  from one format to another.
+email:
+- emilio.deltessa@gmail.com
+- j.wiedekopf@uni-luebeck.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- jekyll-imagemagick-sutermserv.gemspec
+- lib/convert.rb
+- lib/defaults.rb
+- lib/generator.rb
+- lib/version.rb
+homepage: https://gitlab.com/emmmile/jekyll-imagemagick
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+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: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Image generator for Jekyll 3 websites with changes for SU-TermServ.
+test_files: []