jekyll-imagemagick 1.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2159dfe9bd500b484cc07f0c7ad1dc795b9a846a
+  data.tar.gz: 3855494993f5b50b6e41a051f6a5ea1c7975ef53
+SHA512:
+  metadata.gz: e43bbe9fdc39016b4e846758f75be696aa27d2c31764fc764a036306b593fc87a53ec5bc4ba101ca90d6d3cde381d3b0cf73dd5a1d4ae40921e823f97c304a38
+  data.tar.gz: d1b53da7e61f493a86665484451b9255cb55f74654bbe4e9a732a2e6cef2f831f12f014ba71b2caa3a49d4fc65651a2c124766b2b453afef9567f4133972a350

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [jekyll@sverrirs.com](mailto:jekyll@sverrirs.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-imagemagick.gemspec
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sverrir Sigmundarson
+
+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/README.md

@@ -0,0 +1,11 @@
+
+# Image Generator for Jekyll
+Image Generator for Jekyll Sites can automatically generate images for all images on your static site and serve them when possible.
+
+It uses Imagemagick so it must be installed on the system.
+
+## Installation
+
+```
+gem install jekyll-imagemagick
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'specs'
+  t.verbose = true
+  t.pattern = "spec/*_spec.rb"
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+desc "Run tests"
+task :default => [:test]

data/jekyll-imagemagick.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+require_relative 'lib/jekyll-imagemagick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-imagemagick"
+  spec.version       = Jekyll::Imagemagick::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.date          = DateTime.now.strftime('%Y-%m-%d')
+  spec.authors       = ["Emilio Del Tessandoro"]
+  spec.email         = ["emilio.deltessa@gmail.com"]
+  spec.homepage      = "https://github.com/emmmile/jekyll-imagemagick"
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Image generator for Jekyll 3 websites}
+  spec.description   = %q{Image Generator for Jekyll 3 Sites that automatically generate images for all images on your static site and serves them when possible.}
+
+  spec.files         = Dir['CODE_OF_CONDUCT.md', 'README.md', 'LICENSE', 'Rakefile', '*.gemspec', 'Gemfile', 'lib/**/*', 'spec/**/*', 'bin/**/*']
+  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_development_dependency "jekyll", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 1.5"
+  spec.add_development_dependency "minitest", '~> 5.4', '>= 5.4.3'
+  spec.add_runtime_dependency "fastimage", '~> 2.1'
+end

data/lib/jekyll-imagemagick.rb

@@ -0,0 +1,9 @@
+require "jekyll-imagemagick/version"
+require "jekyll-imagemagick/defaults"
+require "jekyll-imagemagick/imageConvert"
+require "jekyll-imagemagick/imageGenerator"
+
+module Jekyll
+  module Imagemagick
+  end
+end

data/lib/jekyll-imagemagick/defaults.rb

@@ -0,0 +1,35 @@
+module Jekyll
+  module Imagemagick
+    # The default configuration for the Imagemagick generator
+    # The values here represent the defaults if nothing is set
+    # TODO
+    DEFAULT = {
+      'enabled'           => false,
+
+      # The flags to pass to the convert binary.
+      'flags'             => "-q 75",
+
+      # List of directories containing images to optimize, Nested directories will not be checked
+      'input_directories' => ["/img"],
+
+      # List of resolutions to generate, 0 means full size otherwise is the long edge
+      'edges'             => [0, 1024, 512],
+
+      # Flags for resizing
+      'resize_flags'      => '-filter Lanczos',
+
+      # add ".gif" to the format list to generate images for animated gifs as well
+      'input_formats'     => [".png", ".tiff"],
+
+      # Local path to the WebP utilities to use (relative or absolute)
+      'webp_path'         => nil,
+
+      # List of files or directories to exclude
+      'exclude'           => [],
+
+      # List of files or directories to explicitly include
+      # e.g. single files outside of the main image directories
+      'include'           => []
+    }
+  end
+end

data/lib/jekyll-imagemagick/imageConvert.rb

@@ -0,0 +1,42 @@
+require 'open3'
+require 'fastimage'
+
+module Jekyll
+  module 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("Imagemagick:", "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)
+        width, height = FastImage.size(input_file)
+
+        Jekyll.logger.info("Imagemagick:", "Generating image \"#{output_file}\"")
+        cmd = "convert \"#{input_file}\" #{flags} "
+        if long_edge != 0
+          cmd += "-resize \"#{long_edge.to_s}>\" #{resize_flags} "
+        end
+        cmd += "\"#{output_file}\""
+        Jekyll.logger.debug("Imagemagick:", "Running command \"#{cmd}\"")
+        run_cmd(cmd)
+      end
+    end
+  end
+end

data/lib/jekyll-imagemagick/imageGenerator.rb

@@ -0,0 +1,127 @@
+require 'jekyll/document'
+require 'fileutils'
+
+module Jekyll
+  module Imagemagick
+    # A static file to hold the generated webp image after generation
+    # so that Jekyll will copy it into the site output directory
+    class ImageFile < StaticFile
+      def write(dest)
+        true # Recover from strange exception when starting server without --auto
+      end
+    end
+
+    class ImageGenerator < Generator
+      # This generator is safe from arbitrary code execution.
+      safe true
+
+      # This generator should be passive with regard to its execution
+      priority :lowest
+
+      # Return all the files to convert
+      def get_files_to_transform(site, directories, input_formats)
+        files = []
+
+        for directory in directories
+          directory_full_path = File.join(site.source, directory)
+          Jekyll.logger.info("Imagemagick:", "Searching files in #{directory_full_path}")
+
+          for file_full_path in Dir[directory_full_path + "**/*.*"]
+            # If the file_full_path is not one of the supported formats, exit early
+            extension = File.extname(file_full_path).downcase
+            next if !input_formats.include? extension
+
+            files.push(file_full_path)
+          end
+        end
+
+        return files
+      end
+
+      # Returns a list (input, output, edge)
+      def compute_file_transformations(site, input_files_full_path, formats, edges)
+        output = []
+
+        if formats.length == 0
+            Jekyll.logger.error("Imagemagick:", "No output formats found")
+            return output
+        end
+
+        for input_file_full_path in input_files_full_path
+          formats.each do |format_extension, flags|
+            for edge in edges
+              extension = File.extname(input_file_full_path)
+              prefix = File.dirname(input_file_full_path.sub(site.source, ""))
+              suffix = ""
+              if edge != 0
+                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)
+        for tuple in tuples
+          input, output, edge = tuple
+          directory = File.dirname(output)
+          FileUtils::mkdir_p(directory)
+        end
+      end
+
+      def generate_files(site, tuples, formats)
+        generated_files = 0
+
+        for tuple in tuples
+          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
+          if 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, ""))
+            Jekyll.logger.info("Imagemagick:", "Adding static file #{site.dest + prefix + "/" + File.basename(output_file_full_path)}")
+            site.static_files << ImageFile.new(site, site.dest, prefix, File.basename(output_file_full_path))
+          end
+        end
+
+        return generated_files
+      end
+
+      # Do the transformations
+      def generate(site)
+        # Retrieve and merge the configuration from the site yml file
+        @config = DEFAULT.merge(site.config['imagemagick'] || {})
+
+        # If disabled then simply quit
+        if !@config['enabled']
+          Jekyll.logger.info("Imagemagick:", "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.
+        Dir::mkdir(site.dest) if !File.directory? site.dest
+
+        files = get_files_to_transform(site, @config['input_directories'], @config['input_formats'])
+        tuples = compute_file_transformations(site, files, @config['output_formats'], @config['edges'])
+        generate_output_paths(site, tuples)
+        generated_files = generate_files(site, tuples, @config['output_formats'])
+
+        Jekyll.logger.info("Imagemagick:", "Generated #{generated_files} file(s)")
+      end
+    end
+  end
+end

data/lib/jekyll-imagemagick/version.rb

@@ -0,0 +1,8 @@
+module Jekyll
+  module Imagemagick
+    VERSION = "1.1.7"
+    # When modifying remember to issue a new tag command in git before committing, then push the new tag
+    # git tag -a v0.1.0 -m "Gem v0.1.0"
+    # git push origin --tags
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-imagemagick
+version: !ruby/object:Gem::Version
+  version: 1.1.7
+platform: ruby
+authors:
+- Emilio Del Tessandoro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.3
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Image Generator for Jekyll 3 Sites that automatically generate images
+  for all images on your static site and serves them when possible.
+email:
+- emilio.deltessa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-imagemagick.gemspec
+- lib/jekyll-imagemagick.rb
+- lib/jekyll-imagemagick/defaults.rb
+- lib/jekyll-imagemagick/imageConvert.rb
+- lib/jekyll-imagemagick/imageGenerator.rb
+- lib/jekyll-imagemagick/version.rb
+homepage: https://github.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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Image generator for Jekyll 3 websites
+test_files: []