jekyll-gzip 2.3.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43dc2c3b2573c028bb17d1c303f763a5d244927ceeecde3427359c5144b5bdf4
-  data.tar.gz: 2eee8cc5df31a3e26657bcb48ed8612e0581dfe5025a37ebfb3b2715d604f5c2
+  metadata.gz: 28d480574a2998a3dae5cdfd7f41d0071f9f50989b40b8fdab9cc5a4c8ee780f
+  data.tar.gz: c897d7e9c325aa0780e817525b11d2aea99103590501a30a7e717b79add8dc95
 SHA512:
-  metadata.gz: 2ed3483c621dc9b32d30f41e2a7144685468634fa9680aac2580837c2e0de1e28f8300b755aa64b9a5a8954d51ec0afa929b594a1c9bb636a3ad746888ca9546
-  data.tar.gz: 9e749685bc29ef1833783096ee70d882506acdf7dc5a4a92d9fe46a635657470a4c7d68c73d53f843a4d425ded15ef5eebeb366fcd3b35075dadea0bead8fdb1
+  metadata.gz: 5d60611ffcf9f0143c5ce1a85d8c3941386b39d323b819da6589ed0878979d6ef5c611789f54d86894cca57e8a611d83ad073f2641983356196ed7104a881152
+  data.tar.gz: a2506fb3379771e481fef97acf9354304fba61dc6a45e59286ed46d6b58a4b86372af74d1843395719875edab8280fe4db8b1dc94314020231d727afbd1b6f79

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: philnash

data/.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, 3.0, head]
+        jekyll: ["3.0", "4.0"]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
+    env:
+      JEKYLL_VERSION: ~> ${{ matrix.jekyll }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: "Install dependencies"
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,9 +1,42 @@
 # Changelog
 
-## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v2.1.1...master)
+## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v2.5.0...master)
 
 ...
 
+## 2.5.1 (2021-02-13) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.5.0...v2.5.1)
+
+### Fixed
+
+- Stop overwriting Jekyll config, which invalidates the Jekyll cache (see https://github.com/jekyll/jekyll/issues/8551)
+
+## 2.5.0 (2021-02-09) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.4.2...v2.5.0)
+
+### Changed
+
+- Added JSON files to compressable extensions
+- Moved from Travis CI to GitHub Actions
+
+## 2.4.2 (2020-01-30) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.4.1...v2.4.2)
+
+### Changed
+
+- Fixes the path handed to `Dir.glob` by using `File.join` instead of string concatenation
+
+
+## 2.4.1 (2019-12-31) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.4.0...v2.4.1)
+
+### Changed
+
+- Extends regeneration logic to files compressed by directory, not just site.
+- Fixes tests that were just wrong for quite a long time.
+
+## 2.4.0 (2019-12-31) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.3.0...v2.4.0)
+
+### Changed
+
+- Doesn't regenerate files that haven't changed in incremental builds (thanks [@fauno](https://github.com/fauno))
+
 ## 2.3.0 (2019-08-26) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.1.1...v2.3.0)
 
 ### Changed

data/README.md

@@ -2,7 +2,7 @@
 
 Generate gzipped assets and files for your Jekyll site at build time.
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-gzip.svg)](https://rubygems.org/gems/jekyll-gzip) [![Build Status](https://travis-ci.org/philnash/jekyll-gzip.svg?branch=master)](https://travis-ci.org/philnash/jekyll-gzip) [![Maintainability](https://api.codeclimate.com/v1/badges/895369c1c7a17f879b00/maintainability)](https://codeclimate.com/github/philnash/jekyll-gzip/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/jekyll-gzip.svg?branch=master)](https://inch-ci.org/github/philnash/jekyll-gzip)
+[![Gem Version](https://badge.fury.io/rb/jekyll-gzip.svg)](https://rubygems.org/gems/jekyll-gzip) [![Build status](https://github.com/philnash/jekyll-gzip/workflows/tests/badge.svg)](https://github.com/philnash/jekyll-gzip/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/895369c1c7a17f879b00/maintainability)](https://codeclimate.com/github/philnash/jekyll-gzip/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/jekyll-gzip.svg?branch=master)](https://inch-ci.org/github/philnash/jekyll-gzip)
 
 [API docs](http://www.rubydoc.info/gems/jekyll-gzip/) | [GitHub repo](https://github.com/philnash/jekyll-gzip)
 
@@ -70,6 +70,7 @@ By default, `Jekyll::Gzip` will compress all files with the following extensions
 - '.html'
 - '.css'
 - '.js'
+- '.json'
 - '.txt'
 - '.ttf'
 - '.atom'

data/jekyll-gzip.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
 
   spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.15.1"
 end

data/lib/jekyll/gzip.rb

@@ -10,15 +10,16 @@ module Jekyll
   end
 end
 
-Jekyll::Hooks.register :site, :after_init do |site|
-  config = site.config['gzip'] || {}
-  site.config['gzip'] = Jekyll::Gzip::DEFAULT_CONFIG.merge(config) || {}
-end
-
 Jekyll::Hooks.register :site, :post_write do |site|
   Jekyll::Gzip::Compressor.compress_site(site) if Jekyll.env == 'production'
 end
 
+Jekyll::Hooks.register :clean, :on_obsolete do |obsolete|
+  obsolete.delete_if do |path|
+    path.end_with? '.gz'
+  end
+end
+
 begin
   require 'jekyll-assets'
 

data/lib/jekyll/gzip/compressor.rb

@@ -25,6 +25,8 @@ module Jekyll
       # @return void
       def self.compress_site(site)
         site.each_site_file do |file|
+          next unless regenerate? file.destination(site.dest), site
+
           compress_file(
             file.destination(site.dest),
             extensions: zippable_extensions(site),
@@ -49,8 +51,16 @@ module Jekyll
       def self.compress_directory(dir, site)
         extensions = zippable_extensions(site).join(',')
         replace_file = replace_files(site)
-        files = Dir.glob(dir + "**/*{#{extensions}}")
-        files.each { |file| compress_file(file, extensions: extensions, replace_file: replace_file) }
+        files = Dir.glob(File.join(dir, "**", "*{#{extensions}}"))
+        files.each do |file|
+          next unless regenerate?(file, site)
+
+          compress_file(
+            file,
+            extensions: extensions,
+            replace_file: replace_file
+          )
+        end
       end
 
       ##
@@ -71,8 +81,11 @@ module Jekyll
       # @return void
       def self.compress_file(file_name, extensions: [], replace_file: false)
         return unless extensions.include?(File.extname(file_name))
-        zipped = replace_file ? file_name : "#{file_name}.gz"
+        zipped = zipped(file_name, replace_file)
         file_content = IO.binread(file_name)
+
+        Jekyll.logger.debug "Gzip: #{zipped}"
+
         Zlib::GzipWriter.open(zipped, Zlib::BEST_COMPRESSION) do |gz|
           gz.mtime = File.mtime(file_name)
           gz.orig_name = file_name
@@ -82,13 +95,38 @@ module Jekyll
 
       private
 
+      def self.zipped(file_name, replace_file)
+        replace_file ? file_name : "#{file_name}.gz"
+      end
+
       def self.zippable_extensions(site)
-        site.config.dig('gzip', 'extensions') || Jekyll::Gzip::DEFAULT_CONFIG['extensions']
+        site.config.dig("gzip", "extensions") || Jekyll::Gzip::DEFAULT_CONFIG.fetch("extensions")
       end
 
       def self.replace_files(site)
-        replace_files = site.config.dig('gzip', 'replace_files')
-        replace_files.nil? ? Jekyll::Gzip::DEFAULT_CONFIG['replace_files'] : replace_files
+        site.config.dig("gzip", "replace_files") || Jekyll::Gzip::DEFAULT_CONFIG.fetch("replace_files")
+      end
+
+      # Compresses the file if the site is built incrementally and the
+      # source was modified or the compressed file doesn't exist
+      def self.regenerate?(file, site)
+        zipped = zipped(file, replace_files(site))
+
+        # Definitely generate the file if it doesn't exist yet.
+        return true unless File.exist? zipped
+        # If we are replacing files and this file is not a gzip file, then it
+        # has been edited so we need to re-gzip it in place.
+        return !is_already_gzipped?(file) if replace_files(site)
+
+        # If the modified time of the new file is greater than the modified time
+        # of the old file, then we need to regenerate.
+        File.mtime(file) > File.mtime(zipped)
+      end
+
+      # First two bytes of a gzipped file are 1f and 8b. This tests for those
+      # bytes.
+      def self.is_already_gzipped?(file)
+        ["1f", "8b"] == File.read(file, 2).unpack("H2H2")
       end
     end
   end

data/lib/jekyll/gzip/config.rb

@@ -7,6 +7,7 @@ module Jekyll
         '.html',
         '.css',
         '.js',
+        '.json',
         '.txt',
         '.ttf',
         '.atom',
@@ -18,4 +19,4 @@ module Jekyll
       'replace_files' => false
     }.freeze
   end
-end
+end

data/lib/jekyll/gzip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Gzip
-    VERSION = "2.3.0"
+    VERSION = "2.5.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gzip
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,9 +99,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -120,7 +121,7 @@ homepage: https://github.com/philnash/jekyll-gzip
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Generate gzipped assets and files for your Jekyll site at build time
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
-  - ruby-head
-env:
-  - 'JEKYLL_VERSION="~> 3.0"'
-  - 'JEKYLL_VERSION="~> 4.0"'
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-  exclude:
-    - rvm: 2.3
-      env: 'JEKYLL_VERSION="~> 4.0"'
-before_install: gem install bundler
-script: bundle exec rspec