Fix all remaining linting issues

Author: Garanas

.gemspec

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'lib/jekyll-transcode-image-filters/version'
+require_relative 'lib/jekyll_transcode_image_filters/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'jekyll-transcode-image-filters'
   spec.version     = Jekyll::TranscodeImageFilters::VERSION
-  spec.date        = '2024-12-31'
   spec.summary     = <<~SUMMARY
     Adds liquid filters to create responsive images and transcode them to browser-friendly formatspec.
   SUMMARY
@@ -15,12 +14,12 @@ Gem::Specification.new do |spec|
     An optional parameter is available to also resize the image, as an example:
     `{{ imagePath | webp: "480x270" }}`
   DESCRIPTION
-  spec.authors     = ['Willem \'Jip\' Wijnia']
+  spec.authors     = ["Willem 'Jip' Wijnia"]
   spec.files       = Dir['lib/**/*']
   spec.homepage    = 'https://github.com/Garanas/jekyll-transcode-image-filters'
   spec.license     = 'MIT'
 
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.add_dependency 'jekyll', '> 3.3', '< 5.0'
   spec.add_dependency 'mini_magick', '~> 4.8'

.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/MethodLength:
+  Max: 20
+
+AllCops:
+  Exclude:
+    - 'spec/**/*'

.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-03-03 07:37:46 UTC using RuboCop version 1.18.4.
+# 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: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 97
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'spec/transcode-image-filters_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'

lib/jekyll-transcode-image-filters.rb

@@ -4,6 +4,38 @@
 require 'mini_magick'
 
 module Jekyll
+  # Jekyll Image Filters
+  # =========================
+  #
+  # This module provides a set of Liquid filters and tags for creating responsive images in Jekyll.
+  #
+  # It allows you to easily generate multiple versions of an image in different formats and resolutions,
+  # and includes them in your Jekyll site using a simple syntax.
+  #
+  # Usage
+  # -----
+  #
+  # To use this module, simply add the following line to your Jekyll site's `Gemfile`:
+  #
+  #   gem 'jekyll-transcode-image-filters'
+  #
+  # Then, in your Jekyll templates, you can use the following Liquid filters and tags:
+  #
+  #   * `jpg`: Convert an image to JPEG format
+  #   * `webp`: Convert an image to WebP format
+  #   * `avif`: Convert an image to AVIF format
+  #
+  # See the documentation for each filter and tag for more information on usage and options.
+  #
+  # Contributing
+  # ------------
+  #
+  # Contributions to this module are welcome! Please see the CONTRIBUTING file for more information.
+  #
+  # License
+  # -------
+  #
+  # This module is released under the MIT License. See the LICENSE file for more information.
   module TranscodeImageFilters
     # Computes a sanitized name for use as a directory.
     # @param name The (file) name to sanitize.
@@ -30,7 +62,7 @@ def _compute_cache_filename(absolute_path_source, resolution, format)
     end
 
     # Compute all necessary paths for the plugin.
-    # @param absolute_path_site [String] As an example: "C:/jekyll/jekyll-transcode-image-filters"
+    # @param absolute_path_site [String] As an example: "C:/jekyll/jekyll_transcode_image_filters"
     # @param relative_path_source [String] As an example: "/assets/image-a.png" or "/assets/style/main.css"
     # @param relative_cache_dir [String] Directory of the cache folder, as an example: "cache/bmp/"
     # @param resolution [String] As an example: 900x900
@@ -51,25 +83,30 @@ def _compute_paths(absolute_path_site, relative_path_source, relative_cache_dir,
       file_name_destination = _compute_cache_filename(absolute_path_source, resolution, format)
 
       relative_path_cache = File.join(relative_cache_dir, file_name_source_sanitized)
-      absolute_path_cache = File.join(absolute_path_site, relative_cache_dir, file_name_source_sanitized)
+      absolute_path_cache = File.join(absolute_path_site, relative_cache_dir,
+                                      file_name_source_sanitized)
       absolute_path_destination = File.join(absolute_path_cache, file_name_destination)
-      relative_path_destination = File.join(relative_cache_dir, file_name_source_sanitized, file_name_destination)
-
-      [absolute_path_source, absolute_path_destination, absolute_path_cache, file_name_destination,
-       relative_path_destination, relative_path_cache]
+      relative_path_destination = File.join(relative_cache_dir, file_name_source_sanitized,
+                                            file_name_destination)
+
+      [
+        absolute_path_source, absolute_path_destination,
+        absolute_path_cache, file_name_destination,
+        relative_path_destination, relative_path_cache
+      ]
     end
 
     # Determine whether the file exists in the cache.
-    # @param absolute_path_source [String] As an example: "C:/jekyll/jekyll-transcode-image-filters"
+    # @param absolute_path_source [String] As an example: "C:/jekyll"
     # @param absolute_path_destination [String] As an example: "/assets/image-a.png" or "/assets/image-a.bmp"
     # @return [Boolean] If true, the file exists in the cache.
     def _in_cache?(_absolute_path_source, absolute_path_destination)
       File.exist?(absolute_path_destination)
     end
 
     # Read, process, and write the (new) image to disk.
-    # @param absolute_path_source [String] As an example: "C:/jekyll/jekyll-transcode-image-filters/assets/image-a.png"
-    # @param absolute_path_destination [String] As an example: "C:/jekyll/jekyll-transcode-image-filters/assets/image-a-processed.png"
+    # @param absolute_path_source [String] As an example: "C:/jekyll/assets/image-a.png"
+    # @param absolute_path_destination [String] As an example: "C:/jekyll/assets/image-a-processed.png"
     def _process_img(absolute_path_source, absolute_path_destination, resolution, format)
       image = MiniMagick::Image.open(absolute_path_source)
       initial_size = image.size
@@ -86,7 +123,8 @@ def _process_img(absolute_path_source, absolute_path_destination, resolution, fo
 
       image.write absolute_path_destination
 
-      puts "Transcoded image '#{absolute_path_source}' to '#{absolute_path_destination}' (#{initial_size / 1024}kb -> #{image.size / 1024}kb)"
+      statistics = "#{initial_size / 1024}kb -> #{image.size / 1024}kb"
+      puts "Transcoded image '#{absolute_path_source}' to '#{absolute_path_destination}' (#{statistics})"
     end
 
     # Transcodes an image to the given format and resolution. Processed files are cached to speed up builds.
@@ -98,24 +136,24 @@ def _process_img(absolute_path_source, absolute_path_destination, resolution, fo
     def _transcode_image(relative_source_path, cache_dir, resolution, format)
       site = @context.registers[:site]
 
-      absolute_path_source, absolute_path_destination, absolute_path_cache, file_name_destination, relative_path_destination, relative_path_cache = _compute_paths(
+      absolute_path_source,
+      absolute_path_destination,
+      absolute_path_cache,
+      file_name_destination,
+      relative_path_destination,
+      relative_path_cache = _compute_paths(
         site.source, relative_source_path, cache_dir, resolution, format
       )
 
       # Guarantee the existence of the cache directory
       FileUtils.mkdir_p(absolute_path_cache)
 
-      if _in_cache?(absolute_path_source, absolute_path_destination)
-        # if the file is cached and valid we can just return the relative path
-        return relative_path_destination
-      else
-        # otherwise, we process the file and add it to the cache
-
-        _process_img(absolute_path_source, absolute_path_destination, resolution, format)
-        site.static_files << Jekyll::StaticFile.new(site, site.source, relative_path_cache, file_name_destination)
-      end
+      # if the file is cached and valid we can just return the relative path
+      return relative_path_destination if _in_cache?(absolute_path_source, absolute_path_destination)
 
-      relative_path_destination
+      # otherwise, we process the file and add it to the cache
+      _process_img(absolute_path_source, absolute_path_destination, resolution, format)
+      site.static_files << Jekyll::StaticFile.new(site, site.source, relative_path_cache, file_name_destination)
     end
 
     # Transcodes an image to the webp format in the given resolution. Processed files are cached to speed up builds.

lib/jekyll/transcode-image-filters.rb lib/jekyll/transcode_image_filters.rblib/jekyll/transcode-image-filters.rb renamed to lib/jekyll/transcode_image_filters.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'jekyll/transcode_image_filters'

lib/jekyll_transcode_image_filters.rb

@@ -2,10 +2,13 @@
 
 require 'jekyll'
 require 'mini_magick'
-require File.expand_path('../lib/jekyll-transcode-image-filters', __dir__)
+require File.expand_path('../lib/jekyll_transcode_image_filters', __dir__)
 
 Jekyll.logger.log_level = :error
 
+SOURCE_DIR = File.expand_path('fixture', __dir__)
+DEST_DIR   = File.expand_path('dest',     __dir__)
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
@@ -16,9 +19,6 @@
     FileUtils.rm_rf(File.join(SOURCE_DIR, 'cache'))
   end
 
-  SOURCE_DIR = File.expand_path('fixture', __dir__)
-  DEST_DIR   = File.expand_path('dest',     __dir__)
-
   def source_dir(*files)
     File.join(SOURCE_DIR, *files)
   end

…ekyll-transcode-image-filters/version.rb …ekyll_transcode_image_filters/version.rblib/jekyll-transcode-image-filters/version.rb renamed to lib/jekyll_transcode_image_filters/version.rb lib/jekyll-transcode-image-filters/version.rb renamed to lib/jekyll_transcode_image_filters/version.rb

@@ -5,16 +5,20 @@
 describe(Jekyll::TranscodeImageFilters) do
   let(:overrides) { {} }
   let(:config) do
-    Jekyll.configuration(Jekyll::Utils.deep_merge_hashes({
-                                                           'full_rebuild' => true,
-                                                           'source' => source_dir,
-                                                           'destination' => dest_dir,
-                                                           'url' => 'https://jipwijnia.nl',
-                                                           'name' => 'My awesome test',
-                                                           'author' => {
-                                                             'name' => 'Dr. Jekyll'
-                                                           }
-                                                         }, overrides))
+    Jekyll.configuration(
+      Jekyll::Utils.deep_merge_hashes(
+        {
+          'full_rebuild' => true,
+          'source' => source_dir,
+          'destination' => dest_dir,
+          'url' => 'https://jipwijnia.nl',
+          'name' => 'My awesome test',
+          'author' => {
+            'name' => 'Dr. Jekyll'
+          }
+        }, overrides
+      )
+    )
   end
   let(:site) { Jekyll::Site.new(config) }
   let(:jekyll_env) { 'development' }