jekyll-imagemagick 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab97d0f5267dd7ce7bb9d6859f12a7de84cce8b4c4b38d562426dae64eb0de6f
-  data.tar.gz: a0c4e7591b5a7ac5f08ed42adbbed195f5735f5f31e73ed1ba8707e181fba961
+  metadata.gz: fec8d2d5542a1e4437e3f7a08021c6813ac5e9ff91ce89566b289f965c122ea2
+  data.tar.gz: 52185f33db67cdb82031ae92f257301e420c3b32478585488bc17f34c6126937
 SHA512:
-  metadata.gz: 817f60857a32fafcf88a226fe699de4e0504d1a79b72aaa101c862b345d58a738d60fe89484fa5bce1225fa93bb20f4ea4f7a81bc5038b26420396dbf4731328
-  data.tar.gz: 9c6151f2ac1e8e2d9564f593ac5d7c82226e258d332ae377094edb153ec51597e7aa90df8200e8da760378249620c837ec018115d7d1e5c383cc3e72b4617732
+  metadata.gz: f0246d18157fdafea6f9055e83bd50c15f2f2eb8c1d42bfd706af8e7782d62f812dbf9ac4d234cc31dea0ada13dcdc99f08f9c97de1a52aa3a9aaf7c4e17eb9e
+  data.tar.gz: af18d65199a58f4aa10ae9cc1af533b4cef3fa1d7e1e11a16c1c658b060b3074f1e5cc19f4e176096957c2a4796e92757c143f8ca1792e3609b87e61fbbf11b4

data/Gemfile

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

data/README.md

@@ -1,4 +1,3 @@
-
 [![Gem Version](https://img.shields.io/gem/v/jekyll-imagemagick.svg)](https://rubygems.org/gems/jekyll-imagemagick)
 [![Gem](https://img.shields.io/gem/dt/jekyll-imagemagick.svg)](https://rubygems.org/gems/jekyll-imagemagick)
 [![Join the chat at https://gitter.im/jekyll-imagemagick/Lobby](https://badges.gitter.im/jekyll-imagemagick/Lobby.svg)](https://gitter.im/jekyll-imagemagick/Lobby)
@@ -7,9 +6,9 @@
 
 # Image Generator for Jekyll
 
-Image Generator for Jekyll Sites can automatically convert images from one format to another.
+`jekyll-imagemagick` is a plugin for Jekyll that can automatically convert images from one format to another.
 
-Typical usecase is having a directory of original file or RAW images (say in PNG or other lossless formats) and convert them automatically to responsive JPG/WEBP format.
+Typical usecase is having a directory full of original files or RAW images (say in PNG or other lossless formats) and convert them automatically to responsive JPG/WEBP format.
 
 ## Installation
 
@@ -35,17 +34,22 @@ imagemagick:
   input_directories:
     - assets/img/blog
     - assets/img/pages
-  output_formats:
-    jpg: "-quality 93% -define jpeg:dct-method=float -strip -interlace Plane"
-    webp: "-quality 100%"
   input_formats:
     - ".png"
     - ".tiff"
+  output_formats:
+    jpg: "-quality 93% -define jpeg:dct-method=float -strip -interlace Plane"
+    webp: "-quality 100%"
 ```
 
-This example configuration searches for images in format PNG/TIFF in the directories `assets/img/blog` and `assets/img/pages`. For each image it generates a JPG and WEBP version
-with resolutions 512, 1024 and "untouched" (meaning it just keep the resolution of the input image). Notice that you can specify some fancy options for the `imagemagick` command line,
-like `-define jpeg:dct-method=float -strip -interlace Plane` that is supposed to produce more efficiently progressive-compressed images.
+This example configuration will:
+
+- Recursively search for input images with format PNG/TIFF in the directories `assets/img/blog` and `assets/img/pages`.
+- For each input image it generates a JPG and WEBP output.
+- Output images will be generated with resolutions 512x, 1024x and "untouched" (meaning it just keep the resolution of the original input image).
+
+Notice that you can specify some fancy options for the `imagemagick` command line, like `-define jpeg:dct-method=float -strip -interlace Plane`
+that is supposed to produce more efficiently progressive-compressed images.
 
 ### How to use WEBP in HTML
 
@@ -58,6 +62,14 @@ Not all browsers are compatible with WEBP. Using the `<picture>` element and spe
 </picture>
 ```
 
+## Development
+
+```bash
+bundle install --path vendor/bundle
+bundle exec rake test
+bundle exec rake codestyle
+```
+
 ## Known issues
 
 So far so good.

data/Rakefile

@@ -1,13 +1,17 @@
 require 'rake'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-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']
+Rake::TestTask.new do |task|
+  task.libs.push 'lib'
+  task.libs.push 'test'
+  task.verbose = true
+  task.pattern = 'test/*_test.rb'
 end
 
-desc "Run tests"
-task :default => [:test]
+RuboCop::RakeTask.new(:codestyle) do |task|
+  task.options = [
+    '--display-cop-names',
+    '--fail-fast'
+  ]
+end

data/jekyll-imagemagick.gemspec

@@ -1,29 +1,37 @@
-# coding: utf-8
-
 require 'date'
 require_relative 'lib/jekyll-imagemagick/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jekyll-imagemagick"
+  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://gitlab.com/emmmile/jekyll-imagemagick"
-  spec.license       = "MIT"
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ['Emilio Del Tessandoro']
+  spec.email         = ['emilio.deltessa@gmail.com']
+  spec.homepage      = 'https://gitlab.com/emmmile/jekyll-imagemagick'
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Image generator for Jekyll 3 websites'
+  spec.description   = 'Image generator for Jekyll 3 wesites that automatically ' \
+                       'convert images from one format to another'
 
-  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.files         = Dir['CODE_OF_CONDUCT.md', 'README.md', 'LICENSE', 'Rakefile', '*.gemspec', 'Gemfile', 'lib/**/*', 'spec/**/*']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
+  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'
+  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 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'test-unit', '~> 3.2'
 end

data/lib/jekyll-imagemagick.rb

@@ -1,9 +1,10 @@
-require "jekyll-imagemagick/version"
-require "jekyll-imagemagick/defaults"
-require "jekyll-imagemagick/imageConvert"
-require "jekyll-imagemagick/imageGenerator"
+require 'jekyll-imagemagick/version'
+require 'jekyll-imagemagick/defaults'
+require 'jekyll-imagemagick/imageConvert'
+require 'jekyll-imagemagick/imageGenerator'
 
 module Jekyll
+  # not sure this is needed
   module Imagemagick
   end
 end

data/lib/jekyll-imagemagick/defaults.rb

@@ -7,10 +7,10 @@ module Jekyll
       'enabled'           => false,
 
       # The flags to pass to the convert binary.
-      'flags'             => "-q 75",
+      'flags'             => '-q 75',
 
       # List of directories containing images to optimize, Nested directories will not be checked
-      'input_directories' => ["/img"],
+      'input_directories' => ['/img'],
 
       # List of resolutions to generate, 0 means full size otherwise is the long edge
       'edges'             => [0, 1024, 512],
@@ -18,8 +18,8 @@ module Jekyll
       # 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"],
+      # add '.gif' to the format list to generate images for animated gifs as well
+      'input_formats'     => ['.png', '.tiff'],
 
       # List of files or directories to exclude
       'exclude'           => [],
@@ -27,6 +27,6 @@ module Jekyll
       # List of files or directories to explicitly include
       # e.g. single files outside of the main image directories
       'include'           => []
-    }
+    }.freeze
   end
 end

data/lib/jekyll-imagemagick/imageConvert.rb

@@ -1,14 +1,14 @@
 require 'open3'
-require 'fastimage'
 
 module Jekyll
   module Imagemagick
+    # 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 = ""
+        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
@@ -17,24 +17,23 @@ module Jekyll
         end
 
         if exit_code != 0
-          Jekyll.logger.error("Imagemagick:", "Command returned #{exit_code} with error #{error}")
+          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)
+        # width, height = FastImage.size(input_file)
 
-        Jekyll.logger.info("Imagemagick:", "Generating image \"#{output_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} "
+          cmd += "-resize \"#{long_edge}>\" #{resize_flags} "
         end
         cmd += "\"#{output_file}\""
-        Jekyll.logger.debug("Imagemagick:", "Running command \"#{cmd}\"")
+        Jekyll.logger.debug('Imagemagick:', "Running command \"#{cmd}\"")
         run_cmd(cmd)
       end
     end

data/lib/jekyll-imagemagick/imageGenerator.rb

@@ -6,11 +6,12 @@ module Jekyll
     # 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)
+      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 < Generator
       # This generator is safe from arbitrary code execution.
       safe true
@@ -22,14 +23,14 @@ module Jekyll
       def get_files_to_transform(site, directories, input_formats)
         files = []
 
-        for directory in directories
+        directories.each do |directory|
           directory_full_path = File.join(site.source, directory)
-          Jekyll.logger.info("Imagemagick:", "Searching files in #{directory_full_path}")
+          Jekyll.logger.info('Imagemagick:', "Searching files in #{directory_full_path}")
 
-          for file_full_path in Dir[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 if !input_formats.include? extension
+            next unless input_formats.include? extension
 
             files.push(file_full_path)
           end
@@ -39,24 +40,25 @@ module Jekyll
       end
 
       # Returns a list (input, output, edge)
-      def compute_file_transformations(site, input_files_full_path, formats, edges)
+      def compute_transformations(site, input_files_full_path, formats, edges)
         output = []
 
-        if formats.length == 0
-            Jekyll.logger.error("Imagemagick:", "No output formats found")
-            return output
+        if formats.length.zero?
+          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
+        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 = ""
-              if edge != 0
-                suffix = "-" + edge.to_s
+              prefix = File.dirname(input_file_full_path.sub(site.source, ''))
+              suffix = ''
+              if edge.zero?
+                suffix = '-' + edge.to_s
               end
-              filename = File.basename(input_file_full_path, extension) + suffix + "." + format_extension.to_s
+              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
@@ -66,18 +68,18 @@ module Jekyll
         return output
       end
 
-      def generate_output_paths(site, tuples)
-        for tuple in tuples
-          input, output, edge = tuple
+      def generate_output_paths(_site, tuples)
+        tuples.each do |tuple|
+          _input, output, _edge = tuple
           directory = File.dirname(output)
-          FileUtils::mkdir_p(directory)
+          FileUtil.mkdir_p(directory)
         end
       end
 
       def generate_files(site, tuples, formats)
         generated_files = 0
 
-        for tuple in tuples
+        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
@@ -87,15 +89,23 @@ module Jekyll
              (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'])
+            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
+
+          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('Imagemagick:', "Adding static file #{file_path}")
+          site.static_files << ImageFile.new(site,
+                                             site.dest,
+                                             prefix,
+                                             File.basename(output_file_full_path))
         end
 
         return generated_files
@@ -107,20 +117,23 @@ module Jekyll
         @config = DEFAULT.merge(site.config['imagemagick'] || {})
 
         # If disabled then simply quit
-        if !@config['enabled']
-          Jekyll.logger.info("Imagemagick:", "Disabled in site.config.")
+        unless @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
+        # 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_file_transformations(site, files, @config['output_formats'], @config['edges'])
+        tuples = compute_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)")
+        Jekyll.logger.info('Imagemagick:', "Generated #{generated_files} file(s)")
       end
     end
   end

data/lib/jekyll-imagemagick/version.rb

@@ -1,8 +1,9 @@
 module Jekyll
   module Imagemagick
-    VERSION = "1.2.1"
-    # 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"
+    VERSION = '1.3.0'.freeze
+    # 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

@@ -1,93 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-imagemagick
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Emilio Del Tessandoro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.4.3
+        version: '0.58'
   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
+        version: '0.58'
 - !ruby/object:Gem::Dependency
-  name: fastimage
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+        version: '3.2'
+  type: :development
   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.
+        version: '3.2'
+description: Image generator for Jekyll 3 wesites that automatically convert images
+  from one format to another
 email:
 - emilio.deltessa@gmail.com
 executables: []
@@ -125,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Image generator for Jekyll 3 websites