jekyll-brotli 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd14849e1f513842567d342b744f99ace866d1dcdaa41a599b24158f0c3fc802
-  data.tar.gz: e51a6bdc41376a8f74e82bf4375fb34e87a1c46c68e1ba6c9fe21282f9ebb8fd
+  metadata.gz: e258a9af9ac7724c0d5f8c94b7a887a8c00c034500932c5c70e59b48e9335198
+  data.tar.gz: 7e79bf93c991886027600ffa5aa7160ce26298b01c0c2d5d6cf3efaf04182b17
 SHA512:
-  metadata.gz: cef9b2cb82419a5731176fb20ee9a0a9b653908c798dda732998b8af90598e2e946589a911151487130abe70a28d80abe19b83fa4db3a595d082ceb336d7f3d3
-  data.tar.gz: 37e61722a6497d82c7c37cd172251331ac308486142f1604e7577f4194e2d8014d681d6991040d9b2053d1c31c029b63f31dcc4582d229e11028f12d2d31181d
+  metadata.gz: b25959e083aafbe1495a362d56f6e284a189ca9817b2bc0476b3eec7cdae339ba9b59407a4342e5f431d6cf5fe24e99a8783d79a9782b2dfb3ec25cdcbb71644
+  data.tar.gz: ae0ae4eb22939055d3cfd7db6c1e9b5f04b32c75b709d60fdf0c90a795407a46f924c735c5e192bcf5c8da27718a960e0687b0e955a51c8b43219dc14cfc6910

data/.gitignore

@@ -7,7 +7,6 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
-spec
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -6,4 +6,4 @@ rvm:
   - 2.3
   - 2.2
 before_install: gem install bundler -v 1.16.1
-script: bundle exec rake
+script: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 
-## 1.0.0 / 2018-01-03
+## Ongoing [☰](https://github.com/philnash/jekyll-brotli/compare/v1.1.0...master)
+
+...
+
+## 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
 

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://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)
+
+[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?
 

data/lib/jekyll/brotli.rb

@@ -1,13 +1,34 @@
-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
   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|
-  if ENV["JEKYLL_ENV"] == "production"
-    Jekyll::Brotli::Compressor.new(site).compress
+  Jekyll::Brotli::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::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,29 +1,72 @@
-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
+    ##
+    # 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|
+          compress_file(
+            file.destination(site.dest),
+            compressable_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::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(dir + "**/*{#{extensions}}")
+        files.each { |file| compress_file(file, compressable_extensions(site)) }
       end
 
-      def compress_file(file_name)
-        return unless COMPRESSABLE_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 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 = "#{file_name}.br"
         contents = ::Brotli.deflate(File.read(file_name), quality: 11)
         File.open(compressed, "w+") do |file|
@@ -32,11 +75,11 @@ module Jekyll
         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.compressable_extensions(site)
+        site.config['brotli'] && site.config['brotli']['extensions'] || Jekyll::Brotli::DEFAULT_CONFIG['extensions']
       end
     end
   end
-end 
+end

data/lib/jekyll/brotli/config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Brotli
+    DEFAULT_CONFIG = {
+      'extensions' => [
+        '.html',
+        '.css',
+        '.js',
+        '.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.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-brotli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -117,6 +117,7 @@ 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:
@@ -138,7 +139,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 brotli compressed assets and files for your Jekyll site at build