jekyll-pug 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f797b15de38684188dd3e881bbb882b0c5bfffab
-  data.tar.gz: 6972df5f89bb45d524afebfe277062051e650481
+  metadata.gz: 25bfef7691615e1ab72b0a410561f5817d1be190
+  data.tar.gz: fdb7cb4a43a15bde3042e8f3f683e93b77453818
 SHA512:
-  metadata.gz: e261fdbf0ba394a9282cfe1c3a0bd777efb8eeefa6cb67e1fc3340a6a21c64314cd57a04dff3db1c2915868403d554978ee8d50da1f2276b67078b4eb0b35a94
-  data.tar.gz: c22559b5080567e8d3a2e0ecd8b5312e481a409d8c9268ea67ff46305a4c5cdf47be34dccbe6777a0c37b16532ed7eaff21dc7253626fcb1c99f9a8fa1add729
+  metadata.gz: e3ceaf10e1a88c1ffe3d87a69ba2a50ca1523eb2f24d649ac86fb997a4440c4583f5f14c3430bd9d8ef8d549716cf71b4d077689e008c057b4739db22c44e740
+  data.tar.gz: 32e6c7c592ac5faf5c7e59c6ab61fdfccc937c090c3cc807c4870420a6958c8edbaaba5ede1ab64620a9ab3d7f2a5e6e4b330600bab1d66f2353136b1f890c63

data/lib/jekyll-pug.rb

@@ -1,23 +1,17 @@
 require "pug-ruby"
+require "jekyll-pug/pug-renderer"
+require "jekyll-pug/include-tag"
 
-require "jekyll-pug/tags/pug_partial"
-require "jekyll-pug/ext/convertible"
-
-module Jekyll
-	class PugConverter < Converter
-		safe true
-		priority :low
-
-		def matches(ext)
-			ext =~ /^\.pug$/i
-		end
-
-		def output_ext(ext)
-			".html"
-		end
-
-		def convert(content)
-			return Pug.compile(content, {"filename"=>"./_includes/."})
-		end
-	end
+# Enable/Disable Minfify based on the user's config file.
+if Jekyll.configuration({})['jekyll-pug']
+  if Jekyll.configuration({})['jekyll-pug']['minify']
+    # Minify is enabled - pretty disabled
+    Pug.config.pretty = false
+  else
+    # Minify is disabled - pretty enabled
+    Pug.config.pretty = true
+  end
+else
+  # Enable pretty by default
+  Pug.config.pretty = true
 end

data/lib/jekyll-pug/include-tag.rb

@@ -0,0 +1,92 @@
+require 'pug-ruby'
+
+module Jekyll
+  module Tags
+    class JekyllPug_IncludeTag  < IncludeTag
+      def initialize(tag_name, markup, tokens)
+        super
+        matched = markup.strip.match(VARIABLE_SYNTAX)
+        if matched
+          @file = matched["variable"].strip
+          @params = matched["params"].strip
+        else
+          @file, @params = markup.strip.split(%r!\s+!, 2)
+        end
+        # If file does not have an extension...
+        if @file !~ /\.\w+$/
+          # ...add a .pug
+          # "navigation" -> "navigation.pug"
+          @file = @file + ".pug"
+          @isPug = true
+        else
+          @isPug = false
+        end
+        validate_params if @params
+        @tag_name = tag_name
+      end
+      # Render the variable if required
+      def render_variable(context)
+        if @file.match(VARIABLE_SYNTAX)
+          partial = context.registers[:site]
+            .liquid_renderer
+            .file("(variable)")
+            .parse(@file)
+          partial.render!(context)
+        end
+      end
+
+      def locate_include_file(context, file, safe)
+        includes_dirs = tag_includes_dirs(context)
+        includes_dirs.each do |dir|
+          path = File.join(dir.to_s, file.to_s)
+          return path if valid_include_file?(path, dir.to_s, safe)
+        end
+        raise IOError, "Could not locate the included file '#{file}' in any of "\
+          "#{includes_dirs}. Ensure it exists in one of those directories and, "\
+          "if it is a symlink, does not point outside your site source."
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        file = render_variable(context) || @file
+        validate_file_name(file)
+
+        path = locate_include_file(context, file, site.safe)
+        return unless path
+
+
+        add_include_to_dependency(site, path, context)
+
+        partial = load_cached_partial(path, context)
+        context.stack do
+          context["include"] = parse_params(context) if @params
+          begin
+            partial.render!(context)
+          rescue Liquid::Error => e
+            e.template_name = path
+            e.markup_context = "included " if e.markup_context.nil?
+            raise e
+          end
+        end
+      end
+    end
+
+    class JekyllPug_IncludeRelativeTag < IncludeTag
+      def tag_includes_dirs(context)
+        Array(page_path(context)).freeze
+      end
+
+      def page_path(context)
+        if context.registers[:page].nil?
+          context.registers[:site].source
+        else
+          current_doc_dir = File.dirname(context.registers[:page]["path"])
+          context.registers[:site].in_source_dir current_doc_dir
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("include", Jekyll::Tags::JekyllPug_IncludeTag)
+Liquid::Template.register_tag("include_relative", Jekyll::Tags::JekyllPug_IncludeRelativeTag)

data/lib/jekyll-pug/pug-renderer.rb

@@ -0,0 +1,40 @@
+# This is where the magic happens
+module Jekyll
+  class LiquidRenderer
+    File.class_eval do
+      def parse(content)        
+        measure_time do
+            if @filename =~ /\.pug$/
+                content = Pug.compile(content, {"filename"=>"./_includes/."})
+            end
+            # if content.lines.first =~ /^$/
+            # content = content.sub(/^$\n/, "")
+            # end
+            @template = Liquid::Template.parse(content, :line_numbers => true)
+        end
+
+        self
+      end
+    end
+  end
+end
+
+# This section ensures that Pug files are compiled as HTML.
+module Jekyll
+  class PugConverter < Converter
+      safe true
+      priority :low
+
+      def matches(ext)
+          ext =~ /^\.pug$/i
+      end
+
+      def output_ext(ext)
+          ".html"
+      end
+
+      def convert(content)
+          return content
+      end
+  end
+end

metadata

@@ -1,75 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pug
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Doug Beney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pug-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Pug to HTML converter for Jekyll
+description: Flawlessly use Pug with Jekyll to convert Pug files into HTMl
 email:
-- work@dougbeney.com
+- work@dougie.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- jekyll-pug.gemspec
-- lib/.DS_Store
 - lib/jekyll-pug.rb
-- lib/jekyll-pug/.DS_Store
-- lib/jekyll-pug/ext/convertible.rb
-- lib/jekyll-pug/tags/pug_partial.rb
-- test-site/Gemfile
-- test-site/_includes/footer.pug
-- test-site/_includes/nav.pug
-- test-site/_includes/variables_and_mixins.pug
-- test-site/_layouts/default.pug
-- test-site/_site/index.html
-- test-site/_site/main.css
-- test-site/_site/readme.md
-- test-site/index.pug
-- test-site/main.css
-- test-site/readme.md
-homepage: https://github.com/DougBeney/jekyll-pug
-licenses: []
+- lib/jekyll-pug/include-tag.rb
+- lib/jekyll-pug/pug-renderer.rb
+homepage: http://jekyll-pug.dougie.io/
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -87,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Convert Pug files to standard HTML files as part of your Jekyll build.
+summary: Use Pug with Jekyll.
 test_files: []

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2017 Doug Beney
-
-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

@@ -1,77 +0,0 @@
-# Jekyll::Haml
-
-This gem provides a [Jekyll](http://github.com/mojombo/jekyll) converter for
-[Haml](http://haml.info) files.
-
-## Installation
-
-If using [Bundler](http://gembundler.com), add these lines to your application's Gemfile:
-
-```rb
-group :jekyll_plugins do
-  gem 'jekyll-pug'
-end
-```
-
-Alternatively, if you don't use Bundler, just update your Jekyll project's `_config.yml`:
-
-```yml
-gems:
-- jekyll-pug
-```
-
-## Usage
-
-You'll be able to use all of Haml's tricks to write some really clean markup. You can use liquid filters easily by just rendering the liquid tags as shown below. Have fun!
-
-```haml
----
-title: Story Time
-permalink: page/
----
-.container
-  %h3= "{% title %}"
-  
-:javascript
-  $(document).ready(function(){});
-```
-
-### Markdown blocks
-
-For clean content blocks, I find it helps to use Haml's `:markdown` filter if I can get away with it.
-
-```haml
-.content
-  :markdown
-    *Dec 4, 2012* - [Author](http://github.com)
-
-    Once upon a time, in a village by the sea...
-```
-    
-### Partials
-
-The gem adds the liquid filter `haml` so you can render `_includes` that are written in Haml as well. 
-
-```liquid
-{% haml comments.haml %}
-```
-
- ```haml
--# _includes/meta.haml
-%meta{property: 'og:type', content: 'website'}
-%meta{name: 'viewport', content: 'width=device-width'}
- ```
- 
-## About
-
-I originally searched around the internet for a quick way to integrate HAML into my jekyll workflow and found a few around the internet to convert haml in different cases (layouts, partials, and posts). This gem is really just a collection of those techniques so they're easy to find and you can get back to creating your site using the slickest markup. It's made to drop in to your `Gemfile` just as easily as [jekyll-sass](https://github.com/noct/jekyll-sass).
-
-If you're using this stuff, you may also be interested in [Octopress](http://octopress.org). I believe it includes support for Haml/Sass out of the gate.
-
-## Contributing
-
-1. Fork it
-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 new Pull Request

data/Rakefile

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

data/jekyll-pug.gemspec

@@ -1,21 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |gem|
-  gem.name          = "jekyll-pug"
-  gem.version       = "0.0.1"
-  gem.authors       = ["Doug Beney"]
-  gem.email         = ["work@dougbeney.com"]
-  gem.description   = %q{Pug to HTML converter for Jekyll}
-  gem.summary       = %q{Convert Pug files to standard HTML files as part of your Jekyll build.}
-  gem.homepage      = "https://github.com/DougBeney/jekyll-pug"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_runtime_dependency 'jekyll', '>= 3.3.0'
-  gem.add_runtime_dependency 'pug-ruby',   '>= 1.0'
-end

data/lib/jekyll-pug/ext/convertible.rb

@@ -1,19 +0,0 @@
-# Re-open Layout class to convert our Pug Layout content.
-module Jekyll
-  class Layout
-    alias old_initialize initialize
-
-    def initialize(*args)
-      old_initialize(*args)
-      self.content = transform
-    end
-
-    def transform
-      _renderer.convert(content)
-    end
-
-    def extname
-      ext
-    end
-  end
-end

data/lib/jekyll-pug/tags/pug_partial.rb

@@ -1,67 +0,0 @@
-require 'pug-ruby'
-require 'open3'
-
-module Jekyll
-    class PugPartialTag < Liquid::Tag
-        isHTML = false
-
-        def initialize(tag_name, file, tokens)
-            super
-            @file = file.strip
-        end
-
-        def render(context)
-            includes_dir = File.join(context.registers[:site].source, '_includes')
-
-            if File.symlink?(includes_dir)
-                return "Includes directory '#{includes_dir}' cannot be a symlink"
-            end
-
-            if @file !~ /^[a-zA-Z0-9_\/\.-]+$/ || @file =~ /\.\// || @file =~ /\/\./
-                return "Include file '#{@file}' contains invalid characters or sequences"
-            end
-
-            if @file !~ /\.html$/
-                isHTML = false
-            else
-                isHTML = true
-            end
-
-            if @file !~ /\.pug$/
-                if !isHTML
-                    @file << ".pug"
-                end
-            end
-
-            Dir.chdir(includes_dir) do
-                choices = Dir['**/*'].reject { |x| File.symlink?(x) }
-                if choices.include?(@file)
-                    source     = File.read(@file)
-                    if !isHTML
-                        conversion = Pug.compile(source, {"filename" => includes_dir + "/."})
-                    else
-                        conversion = source
-                    end
-                    partial    = Liquid::Template.parse(conversion)
-                    begin
-                    return partial.render!(context)
-                rescue => e
-                    puts "Liquid Exception: #{e.message} in #{data['layout']}"
-                    e.backtrace.each do |backtrace|
-                        puts backtrace
-                    end
-                    abort('Build Failed')
-                end
-
-                    context.stack do
-                        return partial.render(context)
-                    end
-                else
-                    "Included file '#{@file}' not found in _includes directory"
-                end
-            end
-            end
-    end
-end
-
-Liquid::Template.register_tag('include', Jekyll::PugPartialTag)

data/test-site/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-group :jekyll_plugins do
-  gem "jekyll-pug", :path => "../"
-end

data/test-site/_includes/footer.pug

@@ -1 +0,0 @@
-p Copyright 2017 - All Rights Reserved. - (Just kidding! Open-Source, baby!)

data/test-site/_includes/nav.pug

@@ -1,5 +0,0 @@
-nav
-    ul
-        li Home
-        li About
-        li: a(href="https://dougbeney.com/contact/") Contact

data/test-site/_includes/variables_and_mixins.pug

@@ -1,8 +0,0 @@
-- var cool_variable = "I am a cool variable!!";
-
-mixin list_stuff
-    h1 This list is generated with a Pug mixin
-    ul
-        li One
-        li Two
-        li Three

data/test-site/_layouts/default.pug

@@ -1,19 +0,0 @@
-include variables_and_mixins
-
-doctype
-html
-    head
-        title {{page.title}}
-        link(rel="stylesheet", href="/main.css")
-    body
-        .container
-            h1 {{page.title}}
-            | {% include nav %}
-            .content {{content}}
-
-            +list_stuff
-
-            h1 Check out this Pug variable:
-            p= cool_variable
-
-            | {% include footer %}

data/test-site/_site/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html><head><title>Welcome To The Jekyll-Pug Example Site!</title><link rel="stylesheet" href="/main.css"></head><body><div class="container"><h1>Welcome To The Jekyll-Pug Example Site!</h1><nav><ul><li>Home</li><li>About</li><li><a href="https://dougbeney.com/contact/">Contact</a></li></ul></nav><div class="content"><p><strong>If you're interested in contributing to Jekyll-Pug, use this sample site to help you debug.</strong></p><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p></div><h1>This list is generated with a Pug mixin</h1><ul><li>One</li><li>Two</li><li>Three</li></ul><h1>Check out this Pug variable:</h1><p>I am a cool variable!!</p><p>Copyright 2017 - All Rights Reserved. - (Just kidding! Open-Source, baby!)</p></div></body></html>

data/test-site/_site/main.css

@@ -1,27 +0,0 @@
-html, body{
-    font-family: sans-serif;
-    line-height: 1.9;
-    margin: 0;
-}
-
-.container{
-    max-width: 750px;
-    margin: 0 auto;
-}
-
-p, h1, h2, ul{
-    margin-top: 30px;
-}
-
-nav ul {
-    padding: 0;
-    display: block;
-    width: auto;
-    margin: 0 auto;
-    background: #ccc;
-    text-align: center;
-}
-nav li{
-    display: inline;
-    margin: 10px 20px;
-}

data/test-site/_site/readme.md

@@ -1 +0,0 @@
-This is a test Jekyll site - How I debug this plugin.

data/test-site/index.pug

@@ -1,8 +0,0 @@
----
-title: Welcome To The Jekyll-Pug Example Site!
-layout: default
----
-
-p: strong If you're interested in contributing to Jekyll-Pug, use this sample site to help you debug.
-
-p Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test-site/main.css

@@ -1,27 +0,0 @@
-html, body{
-    font-family: sans-serif;
-    line-height: 1.9;
-    margin: 0;
-}
-
-.container{
-    max-width: 750px;
-    margin: 0 auto;
-}
-
-p, h1, h2, ul{
-    margin-top: 30px;
-}
-
-nav ul {
-    padding: 0;
-    display: block;
-    width: auto;
-    margin: 0 auto;
-    background: #ccc;
-    text-align: center;
-}
-nav li{
-    display: inline;
-    margin: 10px 20px;
-}

data/test-site/readme.md

@@ -1 +0,0 @@
-This is a test Jekyll site - How I debug this plugin.