jekyll-tidy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58967e88bfd942d10fab9105034ef701b6d1d1b3
+  data.tar.gz: 048887c85e9b68f6d605ae08e8e630f3db951f04
+SHA512:
+  metadata.gz: 727a0f0223cdd15260c3c8578a7977f55c0ffce6547637ba0ae06395cf87890760f7c570ed985f955f5afd7b7274de9ee25c7dbd7237fa2aae7e45903ba43b1c
+  data.tar.gz: 74ceaebe678217e8a5d091d08649de94ddb01c062a75b1dd1a0a3b7e368564c6a59a3d3c403aa1fd14b114088f16964d4c225dc6ad77f31c4bec8b973bf55767

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-tidy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Wyatt Kirby
+
+MIT License
+
+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,37 @@
+# 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'
+```
+
+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]
+```
+
+**Note**: if you set the `compress_html` option to `true` and your templates have inline CSS or javascript, it will not be minified.
+
+## Configuration
+
+`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
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jekyll-tidy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/tidy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-tidy"
+  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.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll"
+  spec.add_dependency "htmlbeautifier"
+  spec.add_dependency "htmlcompressor"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/jekyll-tidy.rb

@@ -0,0 +1,7 @@
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016 - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+
+require "jekyll/tidy"

data/lib/jekyll/tidy.rb

@@ -0,0 +1,45 @@
+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
+    end
+end
+
+Jekyll::Hooks.register :posts, :post_render do |post|
+    unless Jekyll::Tidy::exclude?(post.path)
+        post.output = Jekyll::Tidy::output_clean(post.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
+end

data/lib/jekyll/tidy/version.rb

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

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-tidy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wyatt Kirby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlcompressor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- wyatt@apsis.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-tidy.gemspec
+- lib/jekyll-tidy.rb
+- lib/jekyll/tidy.rb
+- lib/jekyll/tidy/version.rb
+homepage: http://www.apsis.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sanitize and Tidy HTML Output for Jekyll
+test_files: []