jekyll-haml-markup 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa5a1c4f4f6de2b2eec2d73b30f7710c06a68267
-  data.tar.gz: 73420ab7f89c64063b39c47269b367e2b5b3a5a7
+  metadata.gz: 9259c1159a8de7d6fca744c0315d319a05f373bd
+  data.tar.gz: 7fa0e7d351b574d01b63da17c876609afd0b1914
 SHA512:
-  metadata.gz: 49f3975c43de103b7073005b5834b17c132a9080378359f58605161ae2eeef454e55115d8edb15b33ef6e3d45b88c8b8f399f2832ac13f69c0ad2a1d711da80b
-  data.tar.gz: f77d17ed31f404a31160a548edb0f6f2b383b366971d653363df80b95b3cd795189b01b039ba76148c5a5aaf66308d8ca05fcf23514969ae96d44905c554e11f
+  metadata.gz: cd80d195acde91bb5f3b7be39801c8fcc8f6cb4324ff72960aea27d1112da2850a2a4c4cc0fa82dd1da73f76b38f67813812e07711e22c35e9103754fdd06f62
+  data.tar.gz: 8348ab98a42d8fecade22d853fa20088be0e2f2578b94955d7ea749dc389aba81ac10a1e7a08b6a7660b6ea17c3ccf1e49674eb6a6a31e2e19747f5bfa6e6953

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-haml-markup (0.1.0)
+    jekyll-haml-markup (0.1.1)
       haml (~> 5.0)
       jekyll (~> 3.7)
 

data/README.md

@@ -1,7 +1,9 @@
-# JEKYLL-HAML-MARKUP
+# Jekyll Haml Markup
 
 [Jekyll](https://jekyllrb.com) plugin that enables [Haml](http://haml.info) as a markup option for layouts and partials.
 
+**Note**: This gem overrides a few jekyll methods and it lacks of testing.
+
 ## Installation
 
 Add it to your Gemfile:
@@ -14,17 +16,24 @@ gem 'jekyll-haml-markup', group: :jekyll_plugins
 
 You just need to save your layout or template with extension `.haml`, replacing any other extension.
 
-The haml markup will be rendered before the [Liquid](http://shopify.github.io/liquid/) parsing, that means that you will need to escape with `\` any line that doesn't match haml syntax. For example:
+The layout haml markup is rendered with hooks before the [Liquid](http://shopify.github.io/liquid/) render phase and modify version of the `include` tag is in charge of the partials.
 
 ```haml
 !!!
 %html
   %head
-    \{% asset style.css %}
+    {% assets style.css  %}
   %body
-    \{{ content }}
+    %head
+      {% include head.haml  %}
+    %main
+      {{ content }}
+    %footer
+      {% include footer.haml  %}
 ```
 
+Front-matter headers are not working on partials.
+
 ## Development
 
 I started this gem because I couldn't make work the gem [jekyll-haml](https://github.com/samvincent/jekyll-haml).

data/lib/jekyll/converters/haml.rb

@@ -25,7 +25,7 @@ module Jekyll
         when "lib-haml" then return Jekyll::Haml::Parser.new(@config)
         end
       end
-
+      
       def convert(content)
         get_processor.convert content
       end

data/lib/jekyll/tags/include.rb

@@ -1,7 +1,5 @@
 require 'jekyll/tags/include'
 
-# frozen_string_literal: true
-
 module Jekyll
   module Tags
     class IncludeTag < Liquid::Tag

data/lib/jekyll-haml-markup/version.rb

@@ -1,7 +1,7 @@
 module Jekyll
   module Haml
     module Markup
-      VERSION = "0.1.0"
+      VERSION = '0.1.1'
     end
   end
 end

data/lib/jekyll-haml-markup.rb

@@ -1,13 +1,28 @@
 require 'jekyll-haml-markup/version'
 
 require 'jekyll'
+require 'haml'
 
 require_relative 'jekyll/converters/haml'
 require_relative 'jekyll/haml/parser'
-require_relative 'jekyll/tags/include'
 require_relative 'jekyll/configuration'
-require_relative 'jekyll/convertible'
-require_relative 'jekyll/excerpt'
-require_relative 'jekyll/haml_renderer'
-require_relative 'jekyll/renderer'
-require_relative 'jekyll/site'
+require_relative 'jekyll/tags/include'
+
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  site.layouts.each do |name, layout|
+    layout.content = ::Haml::Engine.new(layout.content).render if ['.haml'].include? layout.ext
+  end
+end
+
+Jekyll::Hooks.register :pages, :pre_render do |page|
+  page.content = ::Haml::Engine.new(page.content).render if ['.haml'].include? page.ext
+end
+
+Jekyll::Hooks.register :posts, :pre_render do |post|
+  post.content = ::Haml::Engine.new(post.content).render if ['.haml'].include? post.ext
+end
+
+Jekyll::Hooks.register :documents, :pre_render do |document|
+  document.content = ::Haml::Engine.new(document.content).render if ['.haml'].include? document.ext
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-haml-markup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alvaro Faundez
@@ -102,16 +102,9 @@ files:
 - lib/jekyll-haml-markup/version.rb
 - lib/jekyll/configuration.rb
 - lib/jekyll/converters/haml.rb
-- lib/jekyll/convertible.rb
-- lib/jekyll/excerpt.rb
 - lib/jekyll/haml.rb
-- lib/jekyll/haml/include.rb
 - lib/jekyll/haml/parser.rb
 - lib/jekyll/haml_renderer.rb
-- lib/jekyll/haml_renderer/file.rb
-- lib/jekyll/haml_renderer/table.rb
-- lib/jekyll/renderer.rb
-- lib/jekyll/site.rb
 - lib/jekyll/tags/include.rb
 homepage: https://github.com/afaundez/jekyll-haml
 licenses:

data/lib/jekyll/convertible.rb

@@ -1,15 +0,0 @@
-require 'jekyll/convertible'
-
-module Jekyll
-  module Convertible
-
-    def haml_file?
-      %w(.haml).include?(ext)
-    end
-
-    def render_with_haml?
-      haml_file?
-    end
-
-  end
-end

data/lib/jekyll/excerpt.rb

@@ -1,9 +0,0 @@
-require 'jekyll/excerpt'
-
-module Jekyll
-  class Excerpt
-
-    def_delegators :render_with_haml?
-
-  end
-end

data/lib/jekyll/haml/include.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Tags
-    class IncludeTagError < StandardError
-      attr_accessor :path
-
-      def initialize(msg, path)
-        super(msg)
-        @path = path
-      end
-    end
-
-    class IncludeTag < Liquid::Tag
-      VALID_SYNTAX = %r!
-        ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
-      !x
-      VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
-        (?<params>.*)
-      !x
-
-      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
-        validate_params if @params
-        @tag_name = tag_name
-      end
-
-      def syntax_example
-        "{% #{@tag_name} file.ext param='value' param2='value' %}"
-      end
-
-      def parse_params(context)
-        params = {}
-        markup = @params
-
-        while (match = VALID_SYNTAX.match(markup))
-          markup = markup[match.end(0)..-1]
-
-          value = if match[2]
-                    match[2].gsub(%r!\\"!, '"')
-                  elsif match[3]
-                    match[3].gsub(%r!\\'!, "'")
-                  elsif match[4]
-                    context[match[4]]
-                  end
-
-          params[match[1]] = value
-        end
-        params
-      end
-
-      def validate_file_name(file)
-        if file !~ %r!^[a-zA-Z0-9_/\.-]+$! || file =~ %r!\./! || file =~ %r!/\.!
-          raise ArgumentError, <<-MSG
-Invalid syntax for include tag. File contains invalid characters or sequences:
-
-  #{file}
-
-Valid syntax:
-
-  #{syntax_example}
-
-MSG
-        end
-      end
-
-      def validate_params
-        full_valid_syntax = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
-        unless @params =~ full_valid_syntax
-          raise ArgumentError, <<-MSG
-Invalid syntax for include tag:
-
-  #{@params}
-
-Valid syntax:
-
-  #{syntax_example}
-
-MSG
-        end
-      end
-
-      # Grab file read opts in the context
-      def file_read_opts(context)
-        context.registers[:site].file_read_opts
-      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 tag_includes_dirs(context)
-        context.registers[:site].includes_load_paths.freeze
-      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_message(file, includes_dirs, safe)
-      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
-
-      def add_include_to_dependency(site, path, context)
-        if context.registers[:page] && context.registers[:page].key?("path")
-          site.regenerator.add_dependency(
-            site.in_source_dir(context.registers[:page]["path"]),
-            path
-          )
-        end
-      end
-
-      def load_cached_partial(path, context)
-        context.registers[:cached_partials] ||= {}
-        cached_partial = context.registers[:cached_partials]
-
-        if cached_partial.key?(path)
-          cached_partial[path]
-        else
-          unparsed_file = context.registers[:site]
-            .liquid_renderer
-            .file(path)
-          begin
-            cached_partial[path] = unparsed_file.parse(read_file(path, context))
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def valid_include_file?(path, dir, safe)
-        !outside_site_source?(path, dir, safe) && File.file?(path)
-      end
-
-      def outside_site_source?(path, dir, safe)
-        safe && !realpath_prefixed_with?(path, dir)
-      end
-
-      def realpath_prefixed_with?(path, dir)
-        File.exist?(path) && File.realpath(path).start_with?(dir)
-      rescue StandardError
-        false
-      end
-
-      # This method allows to modify the file content by inheriting from the class.
-      def read_file(file, context)
-        File.read(file, file_read_opts(context))
-      end
-
-      private
-
-      def could_not_locate_message(file, includes_dirs, safe)
-        message = "Could not locate the included file '#{file}' in any of "\
-          "#{includes_dirs}. Ensure it exists in one of those directories and"
-        message + if safe
-                    " is not a symlink as those are not allowed in safe mode."
-                  else
-                    ", if it is a symlink, does not point outside your site source."
-                  end
-      end
-    end
-
-    class 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::IncludeTag)
-Liquid::Template.register_tag("include_relative", Jekyll::Tags::IncludeRelativeTag)

data/lib/jekyll/haml_renderer/file.rb

@@ -1,54 +0,0 @@
-module Jekyll
-  class HamlRenderer
-    class File
-      def initialize(renderer, filename)
-        @renderer = renderer
-        @filename = filename
-      end
-
-      def parse(content)
-        measure_time do
-          @template = ::Haml::Engine.new(content) #, :line_numbers => true)
-        end
-
-        self
-      end
-
-      def render(*args)
-        measure_time do
-          measure_bytes do
-            @template.render(*args)
-          end
-        end
-      end
-
-      def render!(*args)
-        measure_time do
-          measure_bytes do
-            @template = @template.render(*args)
-          end
-        end
-      end
-
-      def warnings
-        [] # @template.warnings
-      end
-
-      private
-
-      def measure_bytes
-        yield.tap do |str|
-          @renderer.increment_bytes(@filename, str.bytesize)
-        end
-      end
-
-      def measure_time
-        before = Time.now
-        yield
-      ensure
-        after = Time.now
-        @renderer.increment_time(@filename, after - before)
-      end
-    end
-  end
-end

data/lib/jekyll/haml_renderer/table.rb

@@ -1,94 +0,0 @@
-module Jekyll
-  class HamlRenderer::Table
-    def initialize(stats)
-      @stats = stats
-    end
-
-    def to_s(n = 50)
-      data = data_for_table(n)
-      widths = table_widths(data)
-      generate_table(data, widths)
-    end
-
-    private
-
-    def generate_table(data, widths)
-      str = String.new("\n")
-
-      table_head = data.shift
-      str << generate_row(table_head, widths)
-      str << generate_table_head_border(table_head, widths)
-
-      data.each do |row_data|
-        str << generate_row(row_data, widths)
-      end
-
-      str << "\n"
-      str
-    end
-
-    def generate_table_head_border(row_data, widths)
-      str = String.new("")
-
-      row_data.each_index do |cell_index|
-        str << "-" * widths[cell_index]
-        str << "-+-" unless cell_index == row_data.length - 1
-      end
-
-      str << "\n"
-      str
-    end
-
-    def generate_row(row_data, widths)
-      str = String.new("")
-
-      row_data.each_with_index do |cell_data, cell_index|
-        str << if cell_index.zero?
-                 cell_data.ljust(widths[cell_index], " ")
-               else
-                 cell_data.rjust(widths[cell_index], " ")
-               end
-
-        str << " | " unless cell_index == row_data.length - 1
-      end
-
-      str << "\n"
-      str
-    end
-
-    def table_widths(data)
-      widths = []
-
-      data.each do |row|
-        row.each_with_index do |cell, index|
-          widths[index] = [ cell.length, widths[index] ].compact.max
-        end
-      end
-
-      widths
-    end
-
-    def data_for_table(n)
-      sorted = @stats.sort_by { |_, file_stats| -file_stats[:time] }
-      sorted = sorted.slice(0, n)
-
-      table = [%w(Filename Count Bytes Time)]
-
-      sorted.each do |filename, file_stats|
-        row = []
-        row << filename
-        row << file_stats[:count].to_s
-        row << format_bytes(file_stats[:bytes])
-        row << format("%.3f", file_stats[:time])
-        table << row
-      end
-
-      table
-    end
-
-    def format_bytes(bytes)
-      bytes /= 1024.0
-      format("%.2fK", bytes)
-    end
-  end
-end

data/lib/jekyll/renderer.rb

@@ -1,60 +0,0 @@
-require 'jekyll/renderer'
-
-module Jekyll
-  class Renderer
-    def render_document
-      info = {
-        :registers => { :site => site, :page => payload["page"] },
-      }
-      output = document.content
-
-      if document.render_with_haml?
-        Jekyll.logger.debug "Rendering Haml:", document.relative_path
-        output = render_haml(output, payload, info, document.path)
-      end
-
-      if document.render_with_liquid?
-        Jekyll.logger.debug "Rendering Liquid:", document.relative_path
-        output = render_liquid(output, payload, info, document.path)
-      end
-
-      Jekyll.logger.debug "Rendering Markup:", document.relative_path
-      output = convert(output)
-      document.content = output
-
-      if document.place_in_layout?
-        Jekyll.logger.debug "Rendering Layout:", document.relative_path
-        output = place_in_layouts(output, payload, info)
-      end
-
-      output
-    end
-
-    def render_haml(content, payload, info, path = nil)
-      template = site.haml_renderer.file(path).parse(content)
-      template.warnings.each do |e|
-        Jekyll.logger.warn "Haml Warning:",
-          HamlRenderer.format_error(e, path || document.relative_path)
-      end
-      template.render!(payload, info)
-    end
-
-    private
-    def render_layout(output, layout, info)
-      payload["content"] = output
-      payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
-
-      if layout.render_with_haml?
-        Jekyll.logger.debug "Rendering Haml:", layout.relative_path
-        layout.content = ::Haml::Engine.new(layout.content).render
-      end
-
-      render_liquid(
-        layout.content,
-        payload,
-        info,
-        layout.relative_path
-      )
-    end
-  end
-end

data/lib/jekyll/site.rb

@@ -1,14 +0,0 @@
-require 'jekyll/site'
-
-module Jekyll
-  class Site
-    attr_reader :haml_renderer
-
-    alias_method :pre_haml_initialize, :initialize
-
-    def initialize(config)
-      pre_haml_initialize(config)
-      @haml_renderer = HamlRenderer.new(self)
-    end
-  end
-end