jekyll-brotli 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73109bbbd64c95c1e4faf0942548d26408cf49eae0daf2208889bc347bd09875
-  data.tar.gz: db719fab85a82b51265f2184f5698265b041e321783148446c86109fe8e287a9
+  metadata.gz: 33b59dc1c8f31a07b8775952290fb96e5685595adf2cd66fd49ace40ef8651f6
+  data.tar.gz: 3de63515bffa570a09dc045c9395309f6b38dab6021694aafbdc007599a883a2
 SHA512:
-  metadata.gz: b5ad5ec86cd1b3fae3611f932ca3c66a536d54c061e231a12b4ad72b14b5a6b7db1b307307590f99da07ebffe90f7df797be0daa79ac9467588681d94490c51b
-  data.tar.gz: 5b768f537e61b0e8729e8fe801f55e3ca1d0106a159add09cac7495c19d1e0c3f7eaed99b1b7a6d9578cceb41aed68e55e5bb878e46c187781515771eb69e95a
+  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/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 
-## Ongoing [☰](https://github.com/philnash/jekyll-brotli/compare/v2.2.1...master)
+## 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)
 

data/README.md

@@ -2,7 +2,7 @@
 
 Generate compressed assets and files for your Jekyll site at build time using [Brotli](https://github.com/google/brotli) compression.
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-brotli.svg)](https://rubygems.org/gems/jekyll-brotli) [![Build Status](https://travis-ci.org/philnash/jekyll-brotli.svg?branch=master)](https://travis-ci.org/philnash/jekyll-brotli) [![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=master)](https://inch-ci.org/github/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)
 
@@ -38,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:
@@ -68,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

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "brotli", "~> 0.2.0"
 
   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/brotli.rb

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

data/lib/jekyll/brotli/compressor.rb

@@ -91,7 +91,7 @@ module Jekyll
       end
 
       def self.compressable_extensions(site)
-        site.config['brotli'] && site.config['brotli']['extensions'] || Jekyll::Brotli::DEFAULT_CONFIG['extensions']
+        site.config.dig("brotli", "extensions") || Jekyll::Brotli::DEFAULT_CONFIG.fetch("extensions")
       end
 
       # Compresses the file if the site is built incrementally and the

data/lib/jekyll/brotli/config.rb

@@ -7,6 +7,7 @@ module Jekyll
         '.html',
         '.css',
         '.js',
+        '.json',
         '.txt',
         '.ttf',
         '.atom',
@@ -17,4 +18,4 @@ module Jekyll
       ].freeze
     }.freeze
   end
-end
+end

data/lib/jekyll/brotli/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Brotli
-    VERSION = "2.2.1"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-brotli
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Phil Nash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -70,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
@@ -114,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
@@ -135,7 +136,7 @@ homepage: https://github.com/philnash/jekyll-brotli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,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 brotli compressed assets and files for your Jekyll site at build
   time.

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-  - ruby-head
-env:
-  - 'JEKYLL_VERSION="~> 3.0"'
-  - 'JEKYLL_VERSION="~> 4.0"'
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-script: bundle exec rspec