jekyll-hash-file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbdfaa0a4c60cff8f5a30edf36edcd389ea83027cbbd51ef8b589c87c8bc75e1
+  data.tar.gz: c7210ac987887948c115942d46584e47d211cf9ccb99d71ea1269d3879a6b9ac
+SHA512:
+  metadata.gz: dc7b46eff4d9e71519eaf6c46706b13c8186e873bf64d9d751b4f7db301ecf434e4fac8325d14cada97626b0b339cc8e6a05ae76a8e815c1682353fcb57b88c7
+  data.tar.gz: 751ff9ea0654477a8ab61cfe20f51a92fefea8e1b18f589017de8e4dc91a8428e193102e576dddcb06b790dea6fa64e8bc5064918110ef1515a06197c8fded96

data/lib/jekyll/hash-file.rb

@@ -0,0 +1,84 @@
+require "digest"
+
+module Jekyll
+  module HashFile
+    CACHE_DIR = "cache/hashed-files/"
+    HASH_LENGTH = 32
+
+    # Defines the hashes file name.
+    # @param absolute_path_source [String] Full path to the source file
+    # @return [String]
+    def _compute_filename(absolute_path_source)
+      hash = Digest::SHA256.file(absolute_path_source)
+      short_hash = hash.hexdigest()[0, HASH_LENGTH]
+      extension = File.extname(absolute_path_source)
+
+      "#{short_hash}#{extension}"
+    end
+
+    # Compute all necessary paths for the plugin.
+    # @param absolute_path_site [String] As an example: "C:/jekyll/jekyll-hash-file"
+    # @param relative_path_source [String] As an example: "/assets/image-a.png" or "/assets/style/main.css"
+    # @return [Array(String, String, String, String, String)]
+    # * [String] absolute_path_source - Full path to the source file
+    # * [String] absolute_path_destination - Full path to the destination file
+    # * [String] absolute_path_cache - Full path to the cache directory
+    # * [String] file_name_destination - Name of the destination file
+    # * [String] relative_path_destination - Relative path to the destination file
+    def _compute_paths(absolute_path_site, relative_path_source)
+      absolute_path_source = File.join(absolute_path_site, relative_path_source)
+      raise "No file found at #{absolute_path_source}" unless File.readable?(absolute_path_source)
+
+      file_name_destination = _compute_filename(absolute_path_source)
+
+      absolute_path_cache = File.join(absolute_path_site, CACHE_DIR)
+      absolute_path_destination = File.join(absolute_path_cache, file_name_destination)
+      relative_path_destination = File.join(CACHE_DIR, file_name_destination)
+
+      [absolute_path_source, absolute_path_destination, absolute_path_cache, file_name_destination, relative_path_destination]
+    end
+
+    # Determine whether the file exists in the cache.
+    # @param absolute_path_source [String] As an example: "C:/jekyll/jekyll-hash-file"
+    # @param absolute_path_destination [String] As an example: "/assets/image-a.png" or "/assets/style/main.css"
+    # @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
+
+    # Determine whether the file in the cache is still valid. It does so by comparing the modification times of the files.
+    # @param absolute_path_source [String] As an example: "C:/jekyll/jekyll-hash-file"
+    # @param absolute_path_destination [String] As an example: "/assets/image-a.png" or "/assets/style/main.css"
+    # @return [Boolean] If true, the file should be skipped.
+    def _valid_cache? (absolute_path_source, absolute_path_destination)
+      File.mtime(absolute_path_destination) >= File.mtime(absolute_path_source)
+    end
+
+    # Creates a copy of the source file with a hashed name to for cache busting. Processed files are cached to speed up builds.
+    # @param relative_source_path [String] As an example: "/assets/image-a.png" or "/assets/style/main.css"
+    # @return [String] As an example: "f69a4d50f20bb781f908db2b2b2c7739.js"
+    def hash_file(relative_source_path)
+
+      site = @context.registers[:site]
+
+      absolute_path_source, absolute_path_destination, absolute_path_cache, file_name_destination, relative_path_destination = _compute_paths(site.source, relative_source_path)
+
+      # Create the cache directory
+      FileUtils.mkdir_p(absolute_path_cache)
+
+      if _in_cache?(absolute_path_source, absolute_path_destination) && _valid_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
+        puts "Hashing '#{relative_source_path}' to '#{relative_path_destination}'"
+        FileUtils.cp(absolute_path_source, absolute_path_destination)
+        site.static_files << Jekyll::StaticFile.new(site, site.source, CACHE_DIR, file_name_destination)
+      end
+
+      relative_path_destination
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::HashFile)

data/lib/jekyll-hash-file/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module HashFile
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll-hash-file.rb

@@ -0,0 +1 @@
+require "jekyll/hash-file.rb"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-hash-file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Willem 'Jip' Wijnia
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: ''
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-hash-file.rb
+- lib/jekyll-hash-file/version.rb
+- lib/jekyll/hash-file.rb
+homepage: https://github.com/Garanas/jekyll-hash-file
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Liquid filter to hash file references to bust the browser cache in Jekyll
+  3 and 4
+test_files: []