jekyll-gzip 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d86e365ec93b205a8c49378bf879c2331cb87a1f49152a5bee66f98c86c6eb22
-  data.tar.gz: 1c907018e1dca4314bfaf82ed2ad030260d27f0a278688af76409bf151a0a7c6
+  metadata.gz: 0e6c5f628c1b543e3efe2a02b3690eaeb0d03590dbead795bd83ed7a51978b59
+  data.tar.gz: cc72f33252c97c3948c883f39fc12f5dd016ff49403dad6e63137fbfbb25fcb5
 SHA512:
-  metadata.gz: 18fa320d5ae950b63597c6f3a84e8d1799b9342b3d47777e94dce6d8805b328bc749a774a45cedc43f93a91b9e461c30e1a8e5d0f5a21756097fe2f25d7e76ad
-  data.tar.gz: ebd5c9f90b6f3bed402113d833fe62fd6dc97b92f5de9b264984f44da24b04bbaf6b674963085160d5807a724647a9175cd1f0ad15c68b984af1352c6a09efcc
+  metadata.gz: ab402cf215ff857fb4724da88fcfe48327830e208f34033204c17230ded4793f5f77d45bb14e1e10841e3b73373b13dd5cc7d04a1d135c941448f6085085b254
+  data.tar.gz: a2a882cb1d76ac8128069404106fe69b95aceb4698c21c240de29899ff5f8abd475e6efcbf5738f21f8a1d1d0b5af3fbb66902db0251f1636acb9a5e2361de60

data/CHANGELOG.md

@@ -1,12 +1,29 @@
 # Changelog
 
-## 1.1.0 / 2018-01-03
+## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v1.1.0...master)
+
+...
+
+## 2.0.0 (2018-11-24) [☰](https://github.com/philnash/jekyll-gzip/compare/v1.1.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::Gzip::Compressor` to a module and implements a `compress_directory` method
+* Moves Jekyll::Gzip::ZIPPABLE_EXTENSIONS into plugin config that can overwritten in the site config
+
+## 1.1.0 (2018-01-03) [☰](https://github.com/philnash/jekyll-gzip/compare/v1.0.0...v1.1.0)
 
 ### Changed
 
 * Only run the post write hook when the environment variable `JEKYLL_ENV` is `production`
 
-## 1.0.0 / 2018-01-01
+## 1.0.0 (2018-01-01) [☰](https://github.com/philnash/jekyll-gzip/commits/v1.0.0)
 
 ### Added
 

data/README.md

@@ -2,7 +2,11 @@
 
 Generate gzipped assets and files for your Jekyll site at build time.
 
-[![Build Status](https://travis-ci.org/philnash/jekyll-gzip.svg?branch=master)](https://travis-ci.org/philnash/jekyll-gzip)
+[![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)
+
+[API docs](http://www.rubydoc.info/gems/jekyll-gzip/) | [GitHub repo](https://github.com/philnash/jekyll-gzip)
+
+## 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 you're making your webserver do it?
 
@@ -10,16 +14,20 @@ Why not just generate those gzip files at build time? And with the maximum compr
 
 `Jekyll::Gzip` does just that. Add the gem to your Jekyll application and when you build your site it will generate gzip files for all text based files (HTML, CSS, JavaScript, etc).
 
-## Want even more compression?
+### Want even more compression?
 
 Zlib's gzipping capabilities don't quite squeeze all the compression out of our files that we could want. If you want a slower but better compression algorithm, check out [Jekyll::Zopfli](https://github.com/philnash/jekyll-zopfli).
 
+Zopfli is about the best compression we can get out of the gzip format, but there's more! [Brotli](https://en.wikipedia.org/wiki/Brotli) is a relatively new compression format that is now [supported by many browsers](https://caniuse.com/#search=brotli) and can produce even smaller files. You can use brotli compression alongside gzip in your Sinatra app with [`Jekyll::Brotli`](http://github.com/philnash/jekyll-brotli).
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `Jekyll::Gzip` to your application's dependencies:
 
 ```ruby
-gem 'jekyll-gzip'
+group :jekyll_plugins do
+  gem 'jekyll-gzip'
+end
 ```
 
 And then execute:
@@ -28,12 +36,56 @@ And then execute:
 bundle install
 ```
 
+Then add the plugin to the `plugins` key in your `_config.yml`
+
+```yml
+plugins:
+  - jekyll-gzip
+```
+
 ## Usage
 
-Once you have the gem installed, run `JEKYLL_ENV=production bundle exec jekyll build`. In your destination directory (`_site` by default) you will find gzipped files.
+Once you have the gem installed, build your Jekyll site in production mode. On Mac/Linux you can run
+
+```bash
+JEKYLL_ENV=production bundle exec jekyll build
+```
+
+On Windows, set the `JEKYLL_ENV` environment variable to `"production"`. Check out [this blog post on setting environment variables on Windows](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html). Then run:
+
+```bash
+bundle exec jekyll build
+```
+
+In your destination directory (`_site` by default) you will find gzipped versions of all your text files.
 
 `Jekyll::Gzip` only runs when the environment variable `JEKYLL_ENV` is set to `production` as dealing with gzipping files is unnecessary in development mode and just slows down the site build.
 
+### Configuration
+
+By default, `Jekyll::Gzip` will compress all files with the following extensions:
+
+- '.html'
+- '.css'
+- '.js'
+- '.txt'
+- '.ttf'
+- '.atom'
+- '.stl'
+- '.xml'
+- '.svg'
+- '.eot'
+
+You can supply your own extensions by adding a `gzip` 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
+gzip:
+  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:
@@ -48,9 +100,20 @@ gzip_static on;
 
 The `ngx_http_gzip_static_module` module is not built by default, so you may need to enable using the `--with-http_gzip_static_module` configuration parameter.
 
+#### Apache
+
+In either a `<Directory>` section in your Apache config or in an `.htaccess` file, add the following:
+
+```
+AddEncoding gzip .gz
+RewriteCond %{HTTP:Accept-encoding} gzip
+RewriteCond %{REQUEST_FILENAME}.gz -f
+RewriteRule ^(.*)$ $1.gz [QSA,L]
+```
+
 #### Other web servers
 
-TODO: instructions for other web servers like Apache, HAProxy, etc.
+TODO: instructions for other web servers like HAProxy, h2o etc.
 
 Do you know how to do this for a different server? Please open a [pull request](https://github.com/philnash/jekyll-gzip/pulls) or an [issue](https://github.com/philnash/jekyll-gzip/issues) with the details!
 

data/lib/jekyll-gzip.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "jekyll/gzip"

data/lib/jekyll/gzip.rb

@@ -1,13 +1,34 @@
-require "jekyll/gzip/version"
-require "jekyll/gzip/compressor"
+# frozen_string_literal: true
+
+require 'jekyll/gzip/version'
+require 'jekyll/gzip/config'
+require 'jekyll/gzip/compressor'
+require 'pathname'
 
 module Jekyll
   module Gzip
   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|
-  if ENV["JEKYLL_ENV"] == "production"
-    Jekyll::Gzip::Compressor.new(site).compress
+  Jekyll::Gzip::Compressor.compress_site(site) if Jekyll.env == 'production'
+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::Gzip::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/gzip/compressor.rb

@@ -1,29 +1,69 @@
-require "zlib"
+# frozen_string_literal: true
+
+require 'jekyll/gzip/config'
+require 'zlib'
 
 module Jekyll
+  ##
+  # The main namespace for +Jekyll::Gzip+. 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 Zlib.
   module Gzip
-    class Compressor
-      ZIPPABLE_EXTENSIONS = [
-        '.html',
-        '.css',
-        '.js',
-        '.txt',
-        '.ttf',
-        '.atom',
-        '.stl',
-        '.xml',
-        '.svg',
-        '.eot'
-      ]
-
-      attr_reader :site
+    ##
+    # The module that does the compressing using Zlib.
+    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::Gzip::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|
+          compress_file(file.destination(site.dest), zippable_extensions(site))
+        end
+      end
 
-      def initialize(site)
-        @site = site
+      ##
+      # Takes a directory path and maps over the files within compressing them
+      # in place.
+      #
+      # @example
+      #     Jekyll::Gzip::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 = zippable_extensions(site).join(',')
+        files = Dir.glob(dir + "**/*{#{extensions}}")
+        files.each { |file| compress_file(file, extensions) }
       end
 
-      def compress_file(file_name)
-        return unless ZIPPABLE_EXTENSIONS.include?(File.extname(file_name))
+      ##
+      # 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 Zlib, outputting the gzipped file under the name of
+      # the original file with an extra .gz extension.
+      #
+      # @example
+      #     Jekyll::Gzip::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))
         zipped = "#{file_name}.gz"
         Zlib::GzipWriter.open(zipped, Zlib::BEST_COMPRESSION) do |gz|
           gz.mtime = File.mtime(file_name)
@@ -32,11 +72,11 @@ module Jekyll
         end
       end
 
-      def compress
-        site.each_site_file do |file|
-          compress_file(file.destination(site.dest))
-        end
+      private
+
+      def self.zippable_extensions(site)
+        site.config['gzip'] && site.config['gzip']['extensions'] || Jekyll::Gzip::DEFAULT_CONFIG['extensions']
       end
     end
   end
-end 
+end

data/lib/jekyll/gzip/config.rb

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

data/lib/jekyll/gzip/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Gzip
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gzip
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -102,6 +102,7 @@ files:
 - lib/jekyll-gzip.rb
 - lib/jekyll/gzip.rb
 - lib/jekyll/gzip/compressor.rb
+- lib/jekyll/gzip/config.rb
 - lib/jekyll/gzip/version.rb
 homepage: https://github.com/philnash/jekyll-gzip
 licenses:
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Generate gzipped assets and files for your Jekyll site at build time