Add a test suite through RSpec (#1)

Author: Garanas

.gemspec

@@ -1,18 +1,34 @@
-require_relative "lib/jekyll-transcode-image-filters/version"
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name        = 'jekyll-transcode-image-filters'
-  s.version     = Jekyll::TranscodeImageFilters::VERSION
-  s.date        = '2024-12-31'
-  s.summary     = 'Adds liquid filters to create responsive images and transcode them to browser-friendly formats.'
-  s.description = 'Adds the liquid filters `jpg` and `webp` to create responsive images and transcode them to browser-friendly formats. An optional parameter is available to also resize the image, as an example: `{{ imagePath | webp: "480x270" }}`'
-  s.authors     = ['Willem \'Jip\' Wijnia']
-  s.files       = Dir["lib/**/*"]
-  s.homepage    = 'https://github.com/Garanas/jekyll-transcode-image-filters'
-  s.license     = 'MIT'
+require_relative 'lib/jekyll_transcode_image_filters/version'
 
-  s.required_ruby_version = ">= 3.0.0"
+Gem::Specification.new do |spec|
+  spec.name        = 'jekyll-transcode-image-filters'
+  spec.version     = Jekyll::TranscodeImageFilters::VERSION
+  spec.summary     = <<~SUMMARY
+    Adds liquid filters to create responsive images and transcode them to browser-friendly formatspec.
+  SUMMARY
 
-  s.add_dependency 'jekyll', '> 3.3', '< 5.0'
-  s.add_dependency 'mini_magick', '~> 4.8'
+  spec.description = <<~DESCRIPTION
+    Adds the liquid filters `jpg` and `webp` to create responsive images and transcode them to browser-friendly formatspec.
+    An optional parameter is available to also resize the image, as an example:
+    `{{ imagePath | webp: "480x270" }}`
+  DESCRIPTION
+  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 = '>= 2.5.0'
+
+  spec.add_dependency 'jekyll', '> 3.3', '< 5.0'
+  spec.add_dependency 'mini_magick', '~> 4.8'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-jekyll', '~> 0.12.0'
+  spec.add_development_dependency 'typhoeus', '>= 0.7', '< 2.0'
 end

.github/workflows/build.yaml

@@ -1,6 +1,8 @@
 name: Build
 
 on:
+  workflow_call:
+  workflow_dispatch:
   push:
     branches: ["main"]
   pull_request:
@@ -10,6 +12,8 @@ permissions:
   contents: read
 
 jobs:
+  test:
+    uses: ./.github/workflows/ci.yaml
   build:
     runs-on: ubuntu-latest
     strategy:
@@ -26,8 +30,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
-      - name: Run tests
-        run: rake build
+
+      - name: Build gem
+        run: rake test
 
       # https://github.com/actions/upload-artifact
       - name: Upload artifacts

.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+name: Continuous Integration
+
+on:
+  workflow_call:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.2"]
+
+    steps:
+      # https://github.com/actions/checkout
+      - uses: actions/checkout@v4
+
+      # https://github.com/ruby/setup-ruby
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      # - name: Run linter
+      #   run: |
+      #     bundle exec rubocop
+
+      - name: Run tests
+        run: rake test

.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/**/*'

Gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
 
-gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]
+gem 'jekyll', ENV['JEKYLL_VERSION'] if ENV['JEKYLL_VERSION']

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-transcode-image-filters (0.0.1)
+    jekyll-transcode-image-filters (0.0.2)
       jekyll (> 3.3, < 5.0)
       mini_magick (~> 4.8)
 
@@ -10,18 +10,26 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
     bigdecimal (3.1.9)
     colorator (1.1.0)
     concurrent-ruby (1.3.4)
+    diff-lcs (1.6.0)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     ffi (1.17.1-x64-mingw-ucrt)
+    ffi (1.17.1-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
     google-protobuf (4.29.2-x64-mingw-ucrt)
       bigdecimal
       rake (>= 13)
+    google-protobuf (4.29.2-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
     http_parser.rb (0.8.0)
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
@@ -55,20 +63,66 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     mini_magick (4.13.2)
+    nokogiri (1.18.3-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.18.3-x86_64-linux-gnu)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
+    regexp_parser (2.10.0)
     rexml (3.4.0)
     rouge (4.5.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-jekyll (0.12.0)
+      rubocop (~> 1.18.0)
+      rubocop-performance (~> 1.2)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
     safe_yaml (1.0.5)
     sass-embedded (1.83.0-x64-mingw-ucrt)
       google-protobuf (~> 4.28)
+    sass-embedded (1.83.0-x86_64-linux-gnu)
+      google-protobuf (~> 4.28)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
     unicode-display_width (2.6.0)
     webrick (1.9.1)
 
@@ -77,7 +131,14 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  bundler
   jekyll-transcode-image-filters!
+  nokogiri (~> 1.6)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-jekyll (~> 0.12.0)
+  typhoeus (>= 0.7, < 2.0)
 
 BUNDLED WITH
    2.5.22

Rakefile

@@ -1,5 +1,7 @@
-BIN_FOLDER = "bin"
-GEMSPEC = ".gemspec"
+# frozen_string_literal: true
+
+BIN_FOLDER = 'bin'
+GEMSPEC = '.gemspec'
 
 def _package_name(spec)
   package_name = spec.name
@@ -16,25 +18,30 @@ task :build do
 
   # Build the gem
   system("gem build #{GEMSPEC}")
-  spec = Gem::Specification::load(GEMSPEC)
+  spec = Gem::Specification.load(GEMSPEC)
 
   # Move the artifact into the bin folder
   package_name = _package_name(spec)
   File.rename("#{package_name}.gem", "#{BIN_FOLDER}/#{package_name}.gem")
 end
 
-task :install => :build do
+task :test do
+  # Test the gem
+  system('bundle exec rspec .')
+end
+
+task install: :build do
   # Uninstall and install the gem
-  spec = Gem::Specification::load(GEMSPEC)
+  spec = Gem::Specification.load(GEMSPEC)
   package_name = _package_name(spec)
   system("gem uninstall #{package_name}")
   system("gem install #{BIN_FOLDER}/#{package_name}.gem")
 end
 
-task :publish => :build do
+task publish: :build do
   # Build and push the gem
-  spec = Gem::Specification::load(GEMSPEC)
+  spec = Gem::Specification.load(GEMSPEC)
   package_name = _package_name(spec)
   puts(package_name)
   system("gem push #{BIN_FOLDER}/#{package_name}.gem")
-end
+end