jekyll-gzip 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6c5f628c1b543e3efe2a02b3690eaeb0d03590dbead795bd83ed7a51978b59
-  data.tar.gz: cc72f33252c97c3948c883f39fc12f5dd016ff49403dad6e63137fbfbb25fcb5
+  metadata.gz: 9cd633c28c8cb3598fe2026d582716f6c8dcad49e11886032e1a1860cd540fbd
+  data.tar.gz: 5ca08691643c435a45293869d4964428335de8c3455f8872f96436b93680aabd
 SHA512:
-  metadata.gz: ab402cf215ff857fb4724da88fcfe48327830e208f34033204c17230ded4793f5f77d45bb14e1e10841e3b73373b13dd5cc7d04a1d135c941448f6085085b254
-  data.tar.gz: a2a882cb1d76ac8128069404106fe69b95aceb4698c21c240de29899ff5f8abd475e6efcbf5738f21f8a1d1d0b5af3fbb66902db0251f1636acb9a5e2361de60
+  metadata.gz: c8afea9d74a9c4c419d5b8348d0b383f6dc51ea7dd236f743047376ecd90e57d11f9021cb3c6606f1a5ad0460ca6287454e1d50502f7c6b707f28ec6daba315f
+  data.tar.gz: f4ee3d3febd15c9eea55b34a82ef2d1791baa6a10bf6395867d6543bf63266856d67feff6450c5b3cfa54c43878f3503d5fef0c1bc0b74c102d21d3dc7dee7c5

data/.travis.yml

@@ -1,9 +1,14 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.6
   - 2.5
   - 2.4
   - 2.3
-  - 2.2
-before_install: gem install bundler -v 1.16.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install: gem install bundler
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
-## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v1.1.0...master)
+## Ongoing [☰](https://github.com/philnash/jekyll-gzip/compare/v2.1.0...master)
 
 ...
 
+## 2.1.0 (2019-03-30) [☰](https://github.com/philnash/jekyll-gzip/compare/v2.0.0...v2.1.0)
+
+### Added
+
+* Adds setting to replace original files with gzipped for serving from AWS S3
+
 ## 2.0.0 (2018-11-24) [☰](https://github.com/philnash/jekyll-gzip/compare/v1.1.0...v2.0.0)
 
 ### Added

data/README.md

@@ -63,6 +63,8 @@ In your destination directory (`_site` by default) you will find gzipped version
 
 ### Configuration
 
+#### Extensions
+
 By default, `Jekyll::Gzip` will compress all files with the following extensions:
 
 - '.html'
@@ -86,6 +88,15 @@ gzip:
     - '.js
 ```
 
+#### Replacing the original file
+
+If you host your Jekyll site on AWS S3 you can take advantage of `Jekyll::Gzip` for compressing the whole site. The only difference is that you need to replace the uncompressed file with the gzipped file (that is, without a `.gz` extension). To enable this in `Jekyll::Gzip` turn the `replace_files` setting to `true`.
+
+```yml
+gzip:
+  replace_files: true
+```
+
 ### 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:

data/jekyll-gzip.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", ">= 1.16", "< 3.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov", "~> 0.15.1"

data/lib/jekyll/gzip/compressor.rb

@@ -25,7 +25,11 @@ module Jekyll
       # @return void
       def self.compress_site(site)
         site.each_site_file do |file|
-          compress_file(file.destination(site.dest), zippable_extensions(site))
+          compress_file(
+            file.destination(site.dest),
+            extensions: zippable_extensions(site),
+            replace_file: replace_files(site)
+          )
         end
       end
 
@@ -44,8 +48,9 @@ module Jekyll
       # @return void
       def self.compress_directory(dir, site)
         extensions = zippable_extensions(site).join(',')
+        replace_file = replace_files(site)
         files = Dir.glob(dir + "**/*{#{extensions}}")
-        files.each { |file| compress_file(file, extensions) }
+        files.each { |file| compress_file(file, extensions: extensions, replace_file: replace_file) }
       end
 
       ##
@@ -62,9 +67,9 @@ module Jekyll
       #    compressed.
       #
       # @return void
-      def self.compress_file(file_name, extensions)
+      def self.compress_file(file_name, extensions: [], replace_file: false)
         return unless extensions.include?(File.extname(file_name))
-        zipped = "#{file_name}.gz"
+        zipped = replace_file ? file_name : "#{file_name}.gz"
         Zlib::GzipWriter.open(zipped, Zlib::BEST_COMPRESSION) do |gz|
           gz.mtime = File.mtime(file_name)
           gz.orig_name = file_name
@@ -75,7 +80,12 @@ module Jekyll
       private
 
       def self.zippable_extensions(site)
-        site.config['gzip'] && site.config['gzip']['extensions'] || Jekyll::Gzip::DEFAULT_CONFIG['extensions']
+        site.config.dig('gzip', 'extensions') || Jekyll::Gzip::DEFAULT_CONFIG['extensions']
+      end
+
+      def self.replace_files(site)
+        replace_files = site.config.dig('gzip', 'replace_files')
+        replace_files.nil? ? Jekyll::Gzip::DEFAULT_CONFIG['replace_files'] : replace_files
       end
     end
   end

data/lib/jekyll/gzip/config.rb

@@ -14,7 +14,8 @@ module Jekyll
         '.xml',
         '.svg',
         '.eot'
-      ].freeze
+      ].freeze,
+      'replace_files' => false
     }.freeze
   end
 end

data/lib/jekyll/gzip/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Gzip
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gzip
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,22 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Generate gzipped assets and files for your Jekyll site at build time