jekyll-tidy 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58967e88bfd942d10fab9105034ef701b6d1d1b3
-  data.tar.gz: 048887c85e9b68f6d605ae08e8e630f3db951f04
+  metadata.gz: c805bb34d487c1a46119f92371bebe325adc9832
+  data.tar.gz: fb1e1beb9d82ddab33e6b47996689d09ca264483
 SHA512:
-  metadata.gz: 727a0f0223cdd15260c3c8578a7977f55c0ffce6547637ba0ae06395cf87890760f7c570ed985f955f5afd7b7274de9ee25c7dbd7237fa2aae7e45903ba43b1c
-  data.tar.gz: 74ceaebe678217e8a5d091d08649de94ddb01c062a75b1dd1a0a3b7e368564c6a59a3d3c403aa1fd14b114088f16964d4c225dc6ad77f31c4bec8b973bf55767
+  metadata.gz: ad9d1ddccf895a04e817699c37597340d4c756eaa49825be958b3250289cdee1f4f6dd2049ed10ccef1a4c7bf816477270a5e39b051f39e7df95fb46bfd42a42
+  data.tar.gz: 415b64fbbdd4f2035061c5208bfd86fc9f756623880e8fca26b386d7e4ea9ba2e3799ce346496ea4ab77abb1ea1fcd782aa6f2bf5656a1443771336984fbe39b

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2016 Wyatt Kirby
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2017 Wyatt Kirby
 
-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:
+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 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.
+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

@@ -1,19 +1,21 @@
 # Jekyll::Tidy
 
+[![Build Status](https://travis-ci.org/apsislabs/jekyll-tidy.svg?branch=master)](https://travis-ci.org/apsislabs/jekyll-tidy)
+
 `jekyll-tidy` is a plugin for tidying the HTML output of your Jekyll website, using either `htmlbeautifier` or `htmlcompressor`.
 
 ## Usage
 
 Usage is straightforward. Simply include the gem in your `Gemfile` with:
 
-```
-    gem 'jekyll-tidy'
+```ruby
+  gem 'jekyll-tidy'
 ```
 
 And then include the plugin in a file located in your `_plugins` directory. You can also include the plugin using the `gems` option in your `_config.yml` file, like so:
 
 ```
-    gems: [jekyll-tidy]
+  gems: [jekyll-tidy]
 ```
 
 **Note**: if you set the `compress_html` option to `true` and your templates have inline CSS or javascript, it will not be minified.
@@ -23,15 +25,58 @@ And then include the plugin in a file located in your `_plugins` directory. You
 `jekyll-tidy` takes two configuration settings, an array of files to exclude, and a flag for whether or not to compress the HTML output.
 
 ```
-    jekyll_tidy:
-        exclude: [index.html]
-        compress_html: true
+  jekyll_tidy:
+    exclude: ["index.html"]
+    compress_html: true
+    ignore_env: development
+```
+
+### exclude (default: [])
+
+`exclude` is an array of relative file paths that will be ignored by `jekyll-tidy`. Exclude must be set as an array, or it will cause errors.
+
+```
+  exclude: ["index.html"] # excludes only index.html
 ```
 
+`exclude` can also take a glob of file paths. *Note:* File globs must be wrapped with `""`.
+
+```
+  exclude: ["_posts/*.md"] # excludes all markdown files directly within the posts directory.
+  exclude: ["_posts/**/*.md"]  # excludes all markdown files anywhere within the _posts directory
+```
+
+### compress_html (default: false)
+
+If `compress_html` is set to `true` then `htmlcompressor` will be used to tidy the markup. If it
+is set to `false` then `htmlbeautifier` will be used to tidy the markup.
+
+### ignore_env (default: nil)
+
+If `ignore_env` is set to a string, we will check the `JEKYLL_ENV` environment variable and skip tidying if it matches. Setting `_config.yml` with:
+
+```
+ignore_env: development
+```
+
+And then running jekyll with:
+
+```sh
+$ JEKYLL_ENV=development jekyll serve
+```
+
+Will skip all tidying.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
 
-1. Fork it ( https://github.com/[my-github-username]/jekyll-tidy/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/apsislabs/jekyll-tidy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/tidy"
+
+# 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-tidy.gemspec

@@ -8,19 +8,23 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Tidy::VERSION
   spec.authors       = ["Wyatt Kirby"]
   spec.email         = ["wyatt@apsis.io"]
+
   spec.summary       = %q{Sanitize and Tidy HTML Output for Jekyll}
   spec.homepage      = "http://www.apsis.io"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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"
-  spec.add_dependency "htmlbeautifier"
-  spec.add_dependency "htmlcompressor"
+  spec.add_runtime_dependency "jekyll"
+  spec.add_runtime_dependency "htmlbeautifier"
+  spec.add_runtime_dependency "htmlcompressor"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/jekyll/tidy.rb

@@ -1,45 +1,59 @@
+require "jekyll/tidy/version"
+
 require "jekyll"
 require "htmlbeautifier"
 require "htmlcompressor"
 
-JEKYLL_CONFIG = Jekyll.configuration({})
-
 module Jekyll
-    module Tidy
-        def self.exclude?(path)
-            res = false
-            exclude = JEKYLL_CONFIG['jekyll_tidy'] && JEKYLL_CONFIG['jekyll_tidy']['exclude']
-
-            if exclude
-                res = exclude.to_a.include? path
-            end
-
-            return res
-        end
-
-        def self.compress_html?
-            JEKYLL_CONFIG['jekyll_tidy'] && JEKYLL_CONFIG['jekyll_tidy']['compress_html']
-        end
-
-        def self.output_clean(output)
-            if compress_html?
-                compressor = HtmlCompressor::Compressor.new
-                return compressor.compress output
-            else
-                return HtmlBeautifier.beautify output
-            end
-        end
+  module Tidy
+    def self.init(site)
+      @JEKYLL_CONFIG = site.config
+    end
+
+    def self.jekyll_config
+      @JEKYLL_CONFIG || Jekyll.configuration({})
+    end
+
+    def self.exclude?(path, override = {})
+      exclude_paths = jekyll_config.merge(override).dig("jekyll_tidy", "exclude").to_a
+      exclude_paths.any? { |exclude| File.fnmatch(exclude, path) }
+    end
+
+    def self.compress_output?
+      jekyll_config.dig("jekyll_tidy", "compress_html")
     end
-end
 
-Jekyll::Hooks.register :posts, :post_render do |post|
-    unless Jekyll::Tidy::exclude?(post.path)
-        post.output = Jekyll::Tidy::output_clean(post.output)
+    def self.output_clean(output, compress = false)
+      if compress
+        return HtmlCompressor::Compressor.new.compress output
+      else
+        return HtmlBeautifier.beautify output
+      end
     end
+
+    def self.ignore_env?
+      Jekyll.env == jekyll_config.dig("jekyll_tidy", "ignore_env")
+    end
+  end
+end
+
+# Jekyll Hooks
+# -------------------------------------
+
+Jekyll::Hooks.register :site, :after_reset do |jekyll|
+  Jekyll::Tidy.init(jekyll)
+end
+
+Jekyll::Hooks.register :documents, :post_render do |doc|
+  next if Jekyll::Tidy.ignore_env?
+  unless Jekyll::Tidy::exclude?(doc.relative_path)
+    doc.output = Jekyll::Tidy::output_clean(doc.output, Jekyll::Tidy.compress_output?)
+  end
 end
 
 Jekyll::Hooks.register :pages, :post_render do |page|
-    unless Jekyll::Tidy::exclude?(page.path)
-        page.output = Jekyll::Tidy::output_clean(page.output)
-    end
+  next if Jekyll::Tidy.ignore_env?
+  unless Jekyll::Tidy::exclude?(page.relative_path)
+    page.output = Jekyll::Tidy::output_clean(page.output, Jekyll::Tidy.compress_output?)
+  end
 end

data/lib/jekyll/tidy/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Tidy
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tidy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Wyatt Kirby
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2017-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,28 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 
 email:
 - wyatt@apsis.io
@@ -88,10 +102,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - jekyll-tidy.gemspec
 - lib/jekyll-tidy.rb
 - lib/jekyll/tidy.rb
@@ -116,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Sanitize and Tidy HTML Output for Jekyll