jekyll-brotli 1.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd14849e1f513842567d342b744f99ace866d1dcdaa41a599b24158f0c3fc802
-  data.tar.gz: e51a6bdc41376a8f74e82bf4375fb34e87a1c46c68e1ba6c9fe21282f9ebb8fd
+  metadata.gz: 33b59dc1c8f31a07b8775952290fb96e5685595adf2cd66fd49ace40ef8651f6
+  data.tar.gz: 3de63515bffa570a09dc045c9395309f6b38dab6021694aafbdc007599a883a2
 SHA512:
-  metadata.gz: cef9b2cb82419a5731176fb20ee9a0a9b653908c798dda732998b8af90598e2e946589a911151487130abe70a28d80abe19b83fa4db3a595d082ceb336d7f3d3
-  data.tar.gz: 37e61722a6497d82c7c37cd172251331ac308486142f1604e7577f4194e2d8014d681d6991040d9b2053d1c31c029b63f31dcc4582d229e11028f12d2d31181d
+  metadata.gz: 61fcaa61cc32ed1fa008ea36752ddb3a0d86be1353e60c79c4812fad81d06d33bda20f57aa4052d37cfcd901ec866af36367ed38fec1af06a284e6bd1e2a87ea
+  data.tar.gz: 4c2b873ed1072ab6d2aa693fc1ec7ef77860acc68ca2a985e17407b0e2b72c82b71494b6e0f1702c4d62930b6278e6be29a5196e6522c8c14b8cf3123829b638

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

@@ -7,9 +7,9 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
-spec
 
 # rspec failure tracking
 .rspec_status
 
-.sass-cache/
+.sass-cache/
+.jekyll-cache/

data/CHANGELOG.md

@@ -1,8 +1,54 @@
 # Changelog
 
-## 1.0.0 / 2018-01-03
+## Ongoing [☰](https://github.com/philnash/jekyll-brotli/compare/v2.3.0...main)
+
+...
+
+## 2.3.0 (2021-02-13) [☰](https://github.com/philnash/jekyll-brotli/compare/v2.2.1...v2.3.0)
+
+### Fixed
+
+- Stop overwriting Jekyll config, which invalidates the Jekyll cache (see https://github.com/jekyll/jekyll/issues/8551)
+
+### Changed
+
+- Added JSON files to compressable extensions
+- Moved from Travis CI to GitHub Actions
+
+## 2.2.1 (2020-01-30) [☰](https://github.com/philnash/jekyll-brotli/compare/v2.2.0...v2.2.1)
+
+### Changed
+
+- Fixes the path handed to `Dir.glob` by using `File.join` instead of string concatenation
+
+## 2.2.0 (2019-12-31) [☰](https://github.com/philnash/jekyll-brotli/compare/v2.1.0...v2.2.0)
+
+### Changed
+
+- - Doesn't regenerate files that haven't changed in incremental builds (thanks [@fauno](https://github.com/fauno))
+
+## 2.1.0 (2019-08-26) [☰](https://github.com/philnash/jekyll-brotli/compare/v2.0.0...v2.1.0)
+
+### Changed
+
+- Opens up version support for Jekyll 4 (thanks [@thedanbob](https://github.com/thedanbob))
+
+## 2.0.0 (2018-11-24) [☰](https://github.com/philnash/jekyll-brotli/compare/v1.0.0...v2.0.0)
+
+### Added
+
+- Adds frozen string literal comments
+- Tries to hook into Jekyll::Assets if available
+
+### Changed
+
+- Uses built in `Jekyll.env` instead of `ENV["JEKYLL_ENV"]`
+- Changes `Jekyll::Brotli::Compressor` to a module and implements a `compress_directory` method
+- Moves Jekyll::Brotli::COMPRESSABLE_EXTENSIONS into plugin config that can overwritten in the site config
+
+## 1.0.0 (2018-01-03) [☰](https://github.com/philnash/jekyll-brotli/commits/v1.0.0)
 
 ### Added
 
-* Methods to Gzip compress text files throughout a Jekyll site using Brotli
-* Site post write hook to trigger compression
+- Methods to Gzip compress text files throughout a Jekyll site using Brotli
+- 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-brotli.gemspec
 gemspec
+
+jekyll_version = ENV["JEKYLL_VERSION"] || "~> 4.0"
+
+gem "jekyll", jekyll_version

data/README.md

@@ -2,7 +2,11 @@
 
 Generate compressed assets and files for your Jekyll site at build time using [Brotli](https://github.com/google/brotli) compression.
 
-[![Build Status](https://travis-ci.org/philnash/jekyll-brotli.svg?branch=master)](https://travis-ci.org/philnash/jekyll-brotli)
+[![Gem Version](https://badge.fury.io/rb/jekyll-brotli.svg)](https://rubygems.org/gems/jekyll-brotli) [![Build status](https://github.com/philnash/jekyll-brotli/workflows/tests/badge.svg)](https://github.com/philnash/jekyll-brotli/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/9deb43d992a0c47a55e4/maintainability)](https://codeclimate.com/github/philnash/jekyll-brotli/maintainability) [![Inline docs](https://inch-ci.org/github/philnash/jekyll-brotli.svg?branch=main)](https://inch-ci.org/github/philnash/jekyll-brotli)
+
+[API docs](http://www.rubydoc.info/gems/jekyll-brotli/) | [GitHub repo](https://github.com/philnash/jekyll-brotli)
+
+## Why?
 
 Performance in web applications is important. You know that, which is why you have created a static site using Jekyll. But you want a bit more performance. You're serving your assets and files gzipped, but could it be better?
 
@@ -34,6 +38,34 @@ Once you have the gem installed, run `JEKYLL_ENV=production bundle exec jekyll b
 
 Jekyll::Brotli only runs when the environment variable `JEKYLL_ENV` is set to `production` as dealing with compressing files is unnecessary in development mode and just slows down the site build.
 
+### Configuration
+
+#### Extensions
+
+By default, `Jekyll::Brotli` will compress all files with the following extensions:
+
+- '.html'
+- '.css'
+- '.js'
+- '.json'
+- '.txt'
+- '.ttf'
+- '.atom'
+- '.stl'
+- '.xml'
+- '.svg'
+- '.eot'
+
+You can supply your own extensions by adding a `brotli` key to your site's `_config.yml` listing the extensions that you want to compress. For example to only compress HTML, CSS and JavaScript files, add the following to `_config.yml`:
+
+```yml
+brotli:
+  extensions:
+    - '.html'
+    - '.css'
+    - '.js
+```
+
 ### Serving pre-compiled gzip files
 
 You will likely need to adjust your web server config to serve these precomputed gzip files. See below for common server configurations:
@@ -64,4 +96,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Brotli 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::Brotli 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/main/CODE_OF_CONDUCT.md).

data/jekyll-brotli.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   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 "brotli", "~> 0.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.16", "< 3.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/brotli.rb

@@ -1,5 +1,9 @@
-require "jekyll/brotli/version"
-require "jekyll/brotli/compressor"
+# frozen_string_literal: true
+
+require 'jekyll/brotli/version'
+require 'jekyll/brotli/config'
+require 'jekyll/brotli/compressor'
+require 'pathname'
 
 module Jekyll
   module Brotli
@@ -7,7 +11,25 @@ module Jekyll
 end
 
 Jekyll::Hooks.register :site, :post_write do |site|
-  if ENV["JEKYLL_ENV"] == "production"
-    Jekyll::Brotli::Compressor.new(site).compress
+  Jekyll::Brotli::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? '.br'
+  end
+end
+
+begin
+  require 'jekyll-assets'
+
+  Jekyll::Assets::Hook.register :env, :after_write do |env|
+    if Jekyll.env == 'production'
+      path = Pathname.new("#{env.jekyll.config['destination']}#{env.prefix_url}")
+      Jekyll::Brotli::Compressor.compress_directory(path, env.jekyll)
+    end
   end
-end
+rescue LoadError
+  # The Jekyll site doesn't use Jekyll::Assets, so no need to compress those
+  # files.
+end

data/lib/jekyll/brotli/compressor.rb

@@ -1,42 +1,108 @@
-require "brotli"
+# frozen_string_literal: true
+
+require 'jekyll/brotli/config'
+require 'brotli'
 
 module Jekyll
+  ##
+  # The main namespace for +Jekyll::Brotli+. Includes the +Compressor+ module
+  # which is used to map over files, either using an instance of +Jekyll::Site+
+  # or a directory path, and compress them using Brotli.
   module Brotli
-    class Compressor
-      COMPRESSABLE_EXTENSIONS = [
-        '.html',
-        '.css',
-        '.js',
-        '.txt',
-        '.ttf',
-        '.atom',
-        '.stl',
-        '.xml',
-        '.svg',
-        '.eot'
-      ]
-
-      attr_reader :site
-
-      def initialize(site)
-        @site = site
+    ##
+    # The module that does the compressing using Brotli.
+    module Compressor
+      ##
+      # Takes an instance of +Jekyll::Site+ and maps over the site files,
+      # compressing them in the destination directory.
+      # @example
+      #     site = Jekyll::Site.new(site_config)
+      #     Jekyll::Brotli::Compressor.compress_site(site)
+      #
+      # @param site [Jekyll::Site] A Jekyll::Site object that has generated its
+      #   site files ready for compression.
+      #
+      # @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),
+            compressable_extensions(site)
+          )
+        end
+      end
+
+      ##
+      # Takes a directory path and maps over the files within compressing them
+      # in place.
+      #
+      # @example
+      #     Jekyll::Brotli::Compressor.compress_directory("~/blog/_site", site)
+      #
+      # @param dir [Pathname, String] The path to a directory of files ready for
+      #   compression.
+      # @param site [Jekyll::Site] An instance of the `Jekyll::Site` used for
+      #   config.
+      #
+      # @return void
+      def self.compress_directory(dir, site)
+        extensions = compressable_extensions(site).join(',')
+        files = Dir.glob(File.join(dir, "**", "*{#{extensions}}"))
+        files.each do |file|
+          next unless regenerate? file, site
+
+          compress_file(file, compressable_extensions(site))
+        end
       end
 
-      def compress_file(file_name)
-        return unless COMPRESSABLE_EXTENSIONS.include?(File.extname(file_name))
-        compressed = "#{file_name}.br"
+      ##
+      # Takes a file name and an array of extensions. If the file name extension
+      # matches one of the extensions in the array then the file is loaded and
+      # compressed using Brotli, outputting the compressed file under the name
+      # of the original file with an extra .br extension.
+      #
+      # @example
+      #     Jekyll::Brotli::Compressor.compress_file("~/blog/_site/index.html")
+      #
+      # @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.
+      #
+      # @return void
+      def self.compress_file(file_name, extensions)
+        return unless extensions.include?(File.extname(file_name))
+        compressed = compressed(file_name)
         contents = ::Brotli.deflate(File.read(file_name), quality: 11)
+
+        Jekyll.logger.debug "Brotli: #{compressed}"
+
         File.open(compressed, "w+") do |file|
           file << contents
         end
         File.utime(File.atime(file_name), File.mtime(file_name), compressed)
       end
 
-      def compress
-        site.each_site_file do |file|
-          compress_file(file.destination(site.dest))
-        end
+      private
+
+      def self.compressed(file_name)
+        "#{file_name}.br"
+      end
+
+      def self.compressable_extensions(site)
+        site.config.dig("brotli", "extensions") || Jekyll::Brotli::DEFAULT_CONFIG.fetch("extensions")
+      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)
+        compressed = compressed(file)
+
+        return true unless File.exist? compressed
+
+        File.mtime(file) > File.mtime(compressed)
       end
     end
   end
-end 
+end

data/lib/jekyll/brotli/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Brotli
+    DEFAULT_CONFIG = {
+      'extensions' => [
+        '.html',
+        '.css',
+        '.js',
+        '.json',
+        '.txt',
+        '.ttf',
+        '.atom',
+        '.stl',
+        '.xml',
+        '.svg',
+        '.eot'
+      ].freeze
+    }.freeze
+  end
+end

data/lib/jekyll/brotli/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Brotli
-    VERSION = "1.0.0"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-brotli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-03 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: brotli
   requirement: !ruby/object:Gem::Requirement
@@ -42,30 +48,36 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
@@ -102,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
@@ -117,12 +130,13 @@ files:
 - lib/jekyll-brotli.rb
 - lib/jekyll/brotli.rb
 - lib/jekyll/brotli/compressor.rb
+- lib/jekyll/brotli/config.rb
 - lib/jekyll/brotli/version.rb
 homepage: https://github.com/philnash/jekyll-brotli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,9 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Generate brotli compressed assets and files for your Jekyll site at build
   time.

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5
-  - 2.4
-  - 2.3
-  - 2.2
-before_install: gem install bundler -v 1.16.1
-script: bundle exec rake