jekyll-zopfli 2.1.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3d94f9c2b739da1bd99584f6168c3efa2eec8f89e8be2e62f0ba76ebc0622c
-  data.tar.gz: 1d44e3cca0978864069f10c6c629b3a5967a95f7da4f841bbd3423cc624da87a
+  metadata.gz: 69d64e88350322aa287a04de9c9dba6d60b1588f21973a3a1f5e40b37fd6265c
+  data.tar.gz: cfb0d765560b20803e39f42f8e194d3f7a5e0f68fc0290b3357947c284cb3488
 SHA512:
-  metadata.gz: c198291793271662d43d26ba5fca15014c9ee33fdbf9676eb5711fd08a757daf6d8ff281fdb436a577059bcdf92ddbbc1a58880e7ba54bdfbb5870385d5c9940
-  data.tar.gz: db7c122bbb10cb6ecd8d2bad9eef1ae2b2e682422b97ca3324ec157a41bd5e47b7827befffd24da1e33764a1d4a4034ec97211ce9efcd98f1d426952ec02ee10
+  metadata.gz: 2a5cbdf255e010eaacecf8b3795ab98c1ce2cac6cb8ef603b452632823f0988498acfd036298a876fdf5fd4b3da127153d8d581e2e2e35fe062f5523f61af1b7
+  data.tar.gz: 908118206b320010b26e51d399dd62eab09b571c6d97347f5417641872723b0f2766e3209a1656b72f3c4b41135691634ff5fc3b294956fc58c57d51d3eec8e5

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/.gitignore

@@ -11,4 +11,5 @@ Gemfile.lock
 # rspec failure tracking
 .rspec_status
 
-.sass-cache/
+.sass-cache/
+.jekyll-cache/

data/CHANGELOG.md

@@ -1,37 +1,72 @@
 # Changelog
 
-## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v2.1.0...master)
+## Ongoing [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.4.1...main)
 
 ...
 
+## 2.5.0 (2021-02-13) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.4.1...v2.5.0)
+
+### Changed
+
+- Added JSON files to compressable extensions
+- Moved from Travis CI to GitHub Actions
+
+### Fixed
+
+- Stop overwriting Jekyll config, which invalidates the Jekyll cache (see https://github.com/jekyll/jekyll/issues/8551)
+
+## 2.4.1 (2020-01-30) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.4.0...v2.4.1)
+
+### Changed
+
+- Fixes the path handed to `Dir.glob` by using `File.join` instead of string concatenation
+
+## 2.4.0 (2019-12-31) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.3.0...v2.4.0)
+
+### Changed
+
+- Doesn't regenerate files that haven't changed in incremental builds.
+
+## 2.3.0 (2019-10-23) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.2.0...v2.3.0)
+
+### Changed
+
+- Fixed tests and actually replaces files when it is supposed to. Thanks @pat!
+
+## 2.2.0 (2019-08-26) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.1.0...v2.2.0)
+
+### Changed
+
+- Opens up version support for Jekyll 4 (thanks [@thedanbob](https://github.com/thedanbob))
+
 ## 2.1.0 (2019-03-30) [☰](https://github.com/philnash/jekyll-zopfli/compare/v2.0.0...v2.1.0)
 
 ### Added
 
-* Adds setting to replace original files with gzipped for serving from AWS S3
+- Adds setting to replace original files with gzipped for serving from AWS S3
 
 ## 2.0.0 (2018-11-24) [☰](https://github.com/philnash/jekyll-zopfli/compare/v1.1.0...v2.0.0)
 
 ### Added
 
-* Hooks into Jekyll::Assets if available
-* Adds frozen string literal comment
+- Hooks into Jekyll::Assets if available
+- Adds frozen string literal comment
 
 ### Changed
 
-* Uses built in `Jekyll.env` instead of `ENV["JEKYLL_ENV"]`
-* Changes `Jekyll::Zopfli::Compressor` to a module and implements a `compress_directory` method
-* Moves Jekyll::Zopfli::ZIPPABLE_EXTENSIONS into plugin config that can overwritten in the site config
+- Uses built in `Jekyll.env` instead of `ENV["JEKYLL_ENV"]`
+- Changes `Jekyll::Zopfli::Compressor` to a module and implements a `compress_directory` method
+- Moves Jekyll::Zopfli::ZIPPABLE_EXTENSIONS into plugin config that can overwritten in the site config
 
 ## 1.1.0 (2018-01-03) [☰](https://github.com/philnash/jekyll-zopfli/compare/v1.0.0...v1.1.0)
 
 ### Changed
 
-* Only run the post write hook when the environment variable `JEKYLL_ENV` is `production`
+- Only run the post write hook when the environment variable `JEKYLL_ENV` is `production`
 
 ## 1.0.0 (2018-01-02) [☰](https://github.com/philnash/jekyll-zopfli/commits/v1.0.0)
 
 ### Added
 
-* Methods to Gzip compress text files throughout a Jekyll site using Zopfli
-* Site post write hook to trigger compression
+- Methods to Gzip compress text files throughout a Jekyll site using Zopfli
+- Site post write hook to trigger compression

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jekyll-zopfli.gemspec
 gemspec
+
+jekyll_version = ENV["JEKYLL_VERSION"] || "~> 4.0"
+
+gem "jekyll", jekyll_version

data/README.md

@@ -2,7 +2,7 @@
 
 Generate gzipped assets and files for your Jekyll site at build time using [Zopfli](https://github.com/google/zopfli) compression.
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-zopfli.svg)](https://rubygems.org/gems/jekyll-zopfli) [![Build Status](https://travis-ci.org/philnash/jekyll-zopfli.svg?branch=master)](https://travis-ci.org/philnash/jekyll-zopfli) [![Maintainability](https://api.codeclimate.com/v1/badges/177f76759bc3b996e9e2/maintainability)](https://codeclimate.com/github/philnash/jekyll-zopfli/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/jekyll-zopfli.svg?branch=master)](https://inch-ci.org/github/philnash/jekyll-zopfli)
+[![Gem Version](https://badge.fury.io/rb/jekyll-zopfli.svg)](https://rubygems.org/gems/jekyll-zopfli) [![Build status](https://github.com/philnash/jekyll-zopfli/workflows/tests/badge.svg)](https://github.com/philnash/jekyll-zopfli/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/177f76759bc3b996e9e2/maintainability)](https://codeclimate.com/github/philnash/jekyll-zopfli/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/jekyll-zopfli.svg?branch=main)](https://inch-ci.org/github/philnash/jekyll-zopfli)
 
 [API docs](http://www.rubydoc.info/gems/jekyll-zopfli/) | [GitHub repo](https://github.com/philnash/jekyll-zopfli)
 
@@ -72,6 +72,7 @@ By default, `Jekyll::Zopfli` will compress all files with the following extensio
 - '.html'
 - '.css'
 - '.js'
+- '.json'
 - '.txt'
 - '.ttf'
 - '.atom'
@@ -146,4 +147,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Zopfli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/philnash/jekyll-gzip/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Zopfli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/philnash/jekyll-zopfli/blob/main/CODE_OF_CONDUCT.md).

data/jekyll-zopfli.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", "~> 3.0"
+  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
   spec.add_dependency "zopfli", "~> 0.0.7"
 
   spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.15.1"
 end

data/lib/jekyll/zopfli.rb

@@ -10,11 +10,6 @@ module Jekyll
   end
 end
 
-Jekyll::Hooks.register :site, :after_init do |site|
-  config = site.config['zopfli'] || {}
-  site.config['zopfli'] = Jekyll::Zopfli::DEFAULT_CONFIG.merge(config) || {}
-end
-
 Jekyll::Hooks.register :site, :post_write do |site|
   Jekyll::Zopfli::Compressor.compress_site(site) if Jekyll.env == 'production'
 end

data/lib/jekyll/zopfli/compressor.rb

@@ -25,7 +25,13 @@ module Jekyll
       # @return void
       def self.compress_site(site)
         site.each_site_file do |file|
-          compress_file(file.destination(site.dest), extensions: zippable_extensions(site))
+          next unless regenerate? file.destination(site.dest), site
+
+          compress_file(
+            file.destination(site.dest),
+            extensions: zippable_extensions(site),
+            replace_file: replace_files(site)
+          )
         end
       end
 
@@ -44,8 +50,16 @@ module Jekyll
       # @return void
       def self.compress_directory(dir, site)
         extensions = zippable_extensions(site).join(',')
-        files = Dir.glob(dir + "**/*{#{extensions}}")
-        files.each { |file| compress_file(file, extensions: zippable_extensions(site)) }
+        files = Dir.glob(File.join(dir, "**", "*{#{extensions}}"))
+        files.each do |file|
+          next unless regenerate? file, site
+
+          compress_file(
+            file,
+            extensions: zippable_extensions(site),
+            replace_file: replace_files(site)
+          )
+        end
       end
 
       ##
@@ -60,14 +74,14 @@ module Jekyll
       # @param file_name [String] The file name of the file we want to compress
       # @param extensions [Array<String>] The extensions of files that will be
       #    compressed.
-      # @param replace_file [Boolean] Whether the origina file should be
+      # @param replace_file [Boolean] Whether the original file should be
       #    replaced or written alongside the original with a `.gz` extension
       #
       # @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"
-        contents = ::Zopfli.deflate(File.read(file_name), format: :gzip)
+        contents = ::Zopfli.deflate(File.binread(file_name), format: :gzip)
         File.open(zipped, "w+") do |file|
           file << contents
         end
@@ -77,8 +91,38 @@ module Jekyll
       private
 
       def self.zippable_extensions(site)
-        site.config['zopfli'] && site.config['zopfli']['extensions'] || Jekyll::Zopfli::DEFAULT_CONFIG['extensions']
+        site.config.dig("zopfli", "extensions") || Jekyll::Zopfli::DEFAULT_CONFIG.fetch("extensions")
+      end
+
+      def self.replace_files(site)
+        site.config.dig("zopfli", "replace_files") || Jekyll::Zopfli::DEFAULT_CONFIG.fetch("replace_files")
+      end
+
+      def self.zipped(file_name, replace_file)
+        replace_file ? file_name : "#{file_name}.gz"
+      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
-end
+end

data/lib/jekyll/zopfli/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/zopfli/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Zopfli
-    VERSION = "2.1.0"
+    VERSION = "2.5.0"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zopfli
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-30 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: zopfli
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +114,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
@@ -129,7 +136,7 @@ homepage: https://github.com/philnash/jekyll-zopfli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +151,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 using
   Zopfli compression.

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-before_install: gem install bundler
-script: bundle exec rspec