jekyll-brotli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd14849e1f513842567d342b744f99ace866d1dcdaa41a599b24158f0c3fc802
+  data.tar.gz: e51a6bdc41376a8f74e82bf4375fb34e87a1c46c68e1ba6c9fe21282f9ebb8fd
+SHA512:
+  metadata.gz: cef9b2cb82419a5731176fb20ee9a0a9b653908c798dda732998b8af90598e2e946589a911151487130abe70a28d80abe19b83fa4db3a595d082ceb336d7f3d3
+  data.tar.gz: 37e61722a6497d82c7c37cd172251331ac308486142f1604e7577f4194e2d8014d681d6991040d9b2053d1c31c029b63f31dcc4582d229e11028f12d2d31181d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+spec
+
+# rspec failure tracking
+.rspec_status
+
+.sass-cache/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 / 2018-01-03
+
+### Added
+
+* Methods to Gzip compress text files throughout a Jekyll site using Brotli
+* Site post write hook to trigger compression

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at philnash@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-brotli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Phil Nash
+
+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,67 @@
+# Jekyll::Brotli
+
+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)
+
+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?
+
+Google's Brotli compressor is a new format with better compression than Zlib's gzip or Zopfli and is supported in [all major modern browsers](https://caniuse.com/#feat=brotli). Compressing files at build time means you can use the highest compression levels with no penalty for dynamically generating the files, so if you're building your site with Jekyll, why not generate the files at the same time?
+
+`Jekyll::Brotli` does just that. Add the gem to your Jekyll application and when you build your site it will generate brotli files for all text based files (HTML, CSS, JavaScript, etc).
+
+### Warning
+
+Brotli is not supported everywhere, so you may want to also gzip your files too. Check out [`Jekyll::Gzip`](https://github.com/philnash/jekyll-gzip) and [`Jekyll::Zopfli`](https://github.com/philnash/jekyll-zopfli) for options there.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-brotli'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+## 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 brotli files.
+
+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.
+
+### 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:
+
+#### nginx
+
+For nginx, you need to compile nginx with Google's `ngx_brotli` module. Follow [the steps in this blog post](https://ethitter.com/2016/12/adding-brotli-support-to-nginx/) for more detail.
+
+#### Other web servers
+
+TODO: instructions for other web servers like Apache, HAProxy, etc.
+
+Do you know how to do this for a different server? Please open a [pull request](https://github.com/philnash/jekyll-brotli/pulls) or an [issue](https://github.com/philnash/jekyll-brotli/issues) with the details!
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/philnash/jekyll-brotli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/brotli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-brotli.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/brotli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-brotli"
+  spec.version       = Jekyll::Brotli::VERSION
+  spec.authors       = ["Phil Nash"]
+  spec.email         = ["philnash@gmail.com"]
+
+  spec.summary       = "Generate brotli compressed assets and files for your Jekyll site at build time."
+  spec.description   = "Generate brotli compressed assets and files for your Jekyll site at build time."
+  spec.homepage      = "https://github.com/philnash/jekyll-brotli"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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 "brotli", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.15.1"
+end

data/lib/jekyll/brotli/compressor.rb

@@ -0,0 +1,42 @@
+require "brotli"
+
+module Jekyll
+  module Brotli
+    class Compressor
+      COMPRESSABLE_EXTENSIONS = [
+        '.html',
+        '.css',
+        '.js',
+        '.txt',
+        '.ttf',
+        '.atom',
+        '.stl',
+        '.xml',
+        '.svg',
+        '.eot'
+      ]
+
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+      end
+
+      def compress_file(file_name)
+        return unless COMPRESSABLE_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|
+          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
+      end
+    end
+  end
+end 

data/lib/jekyll/brotli/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Brotli
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll/brotli.rb

@@ -0,0 +1,13 @@
+require "jekyll/brotli/version"
+require "jekyll/brotli/compressor"
+
+module Jekyll
+  module Brotli
+  end
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  if ENV["JEKYLL_ENV"] == "production"
+    Jekyll::Brotli::Compressor.new(site).compress
+  end
+end

data/lib/jekyll-brotli.rb

@@ -0,0 +1 @@
+require "jekyll/brotli"

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-brotli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phil Nash
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-03 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: Generate brotli compressed assets and files for your Jekyll site at build
+  time.
+email:
+- philnash@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-brotli.gemspec
+- lib/jekyll-brotli.rb
+- lib/jekyll/brotli.rb
+- lib/jekyll/brotli/compressor.rb
+- lib/jekyll/brotli/version.rb
+homepage: https://github.com/philnash/jekyll-brotli
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Generate brotli compressed assets and files for your Jekyll site at build
+  time.
+test_files: []