middleman-brotli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6aac27e574c55f66b3d57c8ddefd04222991625f49deb95e280edc5286891112
+  data.tar.gz: 500d8731091523ed5c6a68e61849132ed9922de8a11af935eae632cdc8253e5e
+SHA512:
+  metadata.gz: cb0227c4b028db975deec31335b028ba9ee0c9bb2b01275628aa6b678153d183b1af2befd56a7e329f5430dcc68b75eefd4f07c6689c73d7f7212ca4e844af25
+  data.tar.gz: e517f3a068e0178654b8125aa16723ea9476366a38ddb53a813ff3d7dbf493297ad2a164f181ba134f1318f52de2d6114a2cfa1910ba2ab39c320e8b8819a7b7

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-brotli.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daan van Vugt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Middleman-brotli extension
+
+This extension compresses assets with brotli for maximum shrinkage.
+Based on the gzip compressor from middleman core.
+
+## Installation 
+Add the gem to your `.gemrc`
+
+```ruby
+gem 'middleman-brotli', git: 'https://github.com/exteris/middleman-brotli', branch: 'master'
+```
+
+and activate it in your `config.rb`:
+
+```ruby
+configure :build do
+  activate :brotli
+end
+```
+
+You might need to apply some other settings to your web server and CDN.
+See for instance [This page](https://afasterweb.com/2016/03/15/serving-up-brotli-with-nginx-and-jekyll/).
+
+## Options
+The files to compress can be selected by extension, with an optional ignore list.
+Default options are:
+
+```ruby
+  option :exts, %w(.css .htm .html .js .svg .xhtml .otf .woff .ttf .woff2), 'File extensions to compress when building.'
+  option :ignore, [], 'Patterns to avoid compressing'
+  option :overwrite, false, 'Overwrite original files instead of adding .br extension.'
+```
+
+They can be set as:
+```ruby
+configure :build do
+  activate :brotli, ignore: 'tinyfile.js'
+end
+```
+
+## Improvements
+* Detect filetype and apply font, text or generic compression types (Brotli comes with different default dictionaries for these types of files)
+* We could generalize the gzip plugin to just use multiple compression commands
+
+# LICENSE
+This project is released under the MIT license.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-brotli')

data/lib/middleman-brotli/extension.rb

@@ -0,0 +1,104 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+class Middleman::Brotli < ::Middleman::Extension
+  option :exts, %w(.css .htm .html .js .svg .xhtml .otf .woff .ttf .woff2), 'File extensions to compress when building.'
+  option :ignore, [], 'Patterns to avoid compressing'
+  option :overwrite, false, 'Overwrite original files instead of adding .br extension.'
+
+  class NumberHelpers
+    include ::Padrino::Helpers::NumberHelpers
+  end
+
+  def initialize(app, options_hash={})
+    super
+
+    require 'brotli'
+    require 'stringio'
+    require 'find'
+    require 'thread'
+  end
+
+  def after_build(builder)
+    num_threads = 4
+    paths = ::Middleman::Util.all_files_under(app.config[:build_dir])
+    total_savings = 0
+
+    # Fill a queue with inputs
+    in_queue = Queue.new
+    paths.each do |path|
+      in_queue << path if should_brotli?(path)
+    end
+    num_paths = in_queue.size
+
+    # Farm out compression tasks to threads and put the results in in_queue
+    out_queue = Queue.new
+    num_threads.times.each do
+      Thread.new do
+        while path = in_queue.pop
+          out_queue << brotli_file(path.to_s)
+        end
+      end
+    end
+
+    # Insert a nil for each thread to stop it
+    num_threads.times do
+      in_queue << nil
+    end
+
+    old_locale = I18n.locale
+    I18n.locale = :en # use the english localizations for printing out file sizes to make sure the localizations exist
+
+    num_paths.times do
+      output_filename, old_size, new_size = out_queue.pop
+
+      next unless output_filename
+
+      total_savings += (old_size - new_size)
+      size_change_word = (old_size - new_size) > 0 ? 'smaller' : 'larger'
+      builder.trigger :created, "#{output_filename} (#{NumberHelpers.new.number_to_human_size((old_size - new_size).abs)} #{size_change_word})"
+    end
+
+    builder.trigger :brotli, '', "Total brotli savings: #{NumberHelpers.new.number_to_human_size(total_savings)}"
+    I18n.locale = old_locale
+  end
+
+  Contract String => [Maybe[String], Maybe[Num], Maybe[Num]]
+  def brotli_file(path)
+    input_file = File.open(path, 'rb').read
+    output_filename = options.overwrite ? path : path + '.br'
+    input_file_time = File.mtime(path)
+
+    # Check if the right file's already there
+    if !options.overwrite && File.exist?(output_filename) && File.mtime(output_filename) == input_file_time
+      return [nil, nil, nil]
+    end
+
+    File.open(output_filename, 'wb') do |f|
+      f.write(Brotli.deflate(input_file, quality: 11))
+    end
+
+    # Make the file times match, both for Nginx's brotli_static extension
+    # and so we can ID existing files. Also, so even if the br files are
+    # wiped out by build --clean and recreated, we won't rsync them over
+    # again because they'll end up with the same mtime.
+    File.utime(File.atime(output_filename), input_file_time, output_filename)
+
+    old_size = File.size(path)
+    new_size = File.size(output_filename)
+
+    [output_filename, old_size, new_size]
+  end
+
+  private
+
+  # Whether a path should be brotli'd
+  # @param [Pathname] path A destination path
+  # @return [Boolean]
+  Contract Pathname => Bool
+  def should_brotli?(path)
+    path = path.sub app.config[:build_dir] + '/', ''
+    options.exts.include?(path.extname) && options.ignore.none? { |ignore| Middleman::Util.path_match(ignore, path.to_s) }
+  end
+end

data/lib/middleman-brotli.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+Middleman::Extensions.register :brotli do
+  require "middleman-brotli/extension.rb"
+  Middleman::Brotli
+end

data/middleman-brotli.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-brotli"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daan van Vugt"]
+  s.email       = ["daanvanvugt@gmail.com"]
+  # s.homepage    = "http://example.com"
+  s.summary     = %q{Compresses middleman outputs with brotli}
+  s.description = %q{This Middleman extension writes brotli-compressed output files (.br) for your pages, js and css.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+  
+  # Additional dependencies
+  s.add_runtime_dependency("brotli", ">= 0.2.0")
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: middleman-brotli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daan van Vugt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: This Middleman extension writes brotli-compressed output files (.br)
+  for your pages, js and css.
+email:
+- daanvanvugt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-brotli.rb
+- lib/middleman-brotli/extension.rb
+- middleman-brotli.gemspec
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Compresses middleman outputs with brotli
+test_files:
+- features/support/env.rb