jekyll-haml-markup 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffe7f40f363076b9072ea42681b637314ec63601
-  data.tar.gz: 62e5c1c47e6e76ce2dd69380ef4169ecf03c685c
+  metadata.gz: 821c7c0980785943787df8b85194fe5b9f8823fa
+  data.tar.gz: c43cb3af2ecb83ba4cb4d487a43bb26101fbedd0
 SHA512:
-  metadata.gz: 9b9e757eee1034eff6500a89d408c2085bdcde03cda0c8f0cf82eb5ec320c40e28cb62244485bb77c83ffff61d9f8c3d0da46e45c992b6817d1de3f6b1ec64e2
-  data.tar.gz: 13e1a4c26b4ef0faedd93b0da7e8eae4915855545bd0f3617f727d7dedb7cd811b14a692cb802a4e2d13463176a3faa433472aaaf36baa6eb8c18856bc49addd
+  metadata.gz: c3015ac642fe044e4d6cec1a10f0839b09a15039a76cda73fe3504895bb951db4b7f78f5c8c2725d89580214e123ee43f3fa042ce865d340dfec3c7a374fceb5
+  data.tar.gz: 8fde2e4f7de96bd7cf2102de808a0a8ac36cc24f5469dc6914bcb33fd39afbf2b0d925b0e69014dded705e97e49c9734f31ef0c48aeea386317463f9ae217785

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jekyll-haml-markup.gemspec
 gemspec

data/Gemfile.lock

@@ -1,29 +1,32 @@
 PATH
   remote: .
   specs:
-    jekyll-haml-markup (0.1.3)
-      haml (~> 4)
-      jekyll (~> 3.0)
+    jekyll-haml-markup (0.1.5)
+      haml (~> 5.0, >= 5.0.0)
+      jekyll (>= 3.0, < 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
     colorator (1.1.0)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
-    ffi (1.9.25)
+    ffi (1.11.2)
     forwardable-extended (2.6.0)
-    haml (4.0.7)
+    haml (5.1.2)
+      temple (>= 0.8.0)
       tilt
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.4)
+    jaro_winkler (1.5.4)
+    jekyll (3.8.6)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -41,7 +44,7 @@ GEM
     jekyll-watch (2.0.0)
       listen (~> 3.0)
     kramdown (1.17.0)
-    liquid (4.0.0)
+    liquid (4.0.3)
     listen (3.0.8)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -50,21 +53,37 @@ GEM
     minitest (5.11.3)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
-    pathutil (0.16.1)
+    parallel (1.13.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (3.0.3)
+    powerpack (0.1.2)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    rouge (3.2.1)
-    safe_yaml (1.0.4)
-    sass (3.6.0)
+    rouge (3.13.0)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    tilt (2.0.8)
+    temple (0.8.2)
+    tilt (2.0.10)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -75,6 +94,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   nokogiri (~> 1.6, >= 1.6.8)
   rake (~> 10.0)
+  rubocop (~> 0.57, >= 0.57.2)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -1,12 +1,10 @@
 # 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 overwrites the `include` jekyll tag.
+[Jekyll](https://jekyllrb.com) plugin that enables [Haml](http://haml.info) as a markup option for layouts, partials, and pages.
 
 ## Installation
 
-Add it to your Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'jekyll-haml-markup', group: :jekyll_plugins
@@ -14,34 +12,14 @@ gem 'jekyll-haml-markup', group: :jekyll_plugins
 
 ## Usage
 
-You just need to save your layout or template with extension `.haml`, replacing any other extension.
-
-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
-    %title Fake title
-    %link{href: "{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}", rel: "stylesheet", type: 'text/css'}
-    %link(href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" rel="stylesheet" type='text/css')
-  %body
-    %header
-      {% include header.haml  %}
-    %main
-      {{ content }}
-    %footer
-      {% include footer.html  %}
-    %script{src: "{{ '/assets/javascript/script.css?v=' | append: site.github.build_revision | relative_url }}"}
-```
-
-Front-matter headers are not working on partials.
+Name your layouts, partials, and pages with the `.haml` extension. This plugin intercepts the default `include` and compile your Haml template to HTML.
 
 ## Development
+This gem uses a hook for Haml layouts compiling, modifies the `include` tag, and add a Haml converter.
 
-I started this gem because I couldn't make work the gem [jekyll-haml](https://github.com/samvincent/jekyll-haml).
+There are lots of border cases that have to be tested before production use.
 
-At this moment, this gem just works overriding [Jekyll](https://github.com/jekyll/jekyll) classes and methods. It's not a stable option and it has to be reviewed. If you want to help, just email me.
+I started this gem because I couldn't make work the [jekyll-haml](https://github.com/samvincent/jekyll-haml) gem, which seems inactive.
 
 ## Contributing
 
@@ -49,8 +27,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/afaund
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Haml::Markup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-haml-markup/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Haml::Markup project’s codebases, issue trackers, chat rooms, and mailing lists are expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-haml-markup/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+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"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/jekyll-haml-markup.gemspec

@@ -1,33 +1,34 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jekyll/haml/markup/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jekyll-haml-markup"
+  spec.name          = 'jekyll-haml-markup'
   spec.version       = Jekyll::Haml::Markup::VERSION
-  spec.authors       = ["Alvaro Faundez"]
-  spec.email         = ["alvaro@faundez.net"]
+  spec.authors       = ['Alvaro Faundez']
+  spec.email         = ['alvaro@faundez.net']
 
-  spec.summary       = %q{Jekyll plugin to use Haml on templates.}
-  spec.description   = %q{Jekyll plugin that add the option to write layouts and partials in Haml.}
+  spec.summary       = 'Jekyll plugin to use Haml on templates.'
+  spec.description   = 'Jekyll plugin that add the option to write layouts' \
+                       ' and partials in Haml.'
   spec.homepage      = 'https://github.com/afaundez/jekyll-haml-markup'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.57', '>= 0.57.2'
 
-  spec.add_runtime_dependency 'jekyll', '~> 3.0'
-  spec.add_runtime_dependency 'haml', '~> 4'
+  spec.add_runtime_dependency 'haml', '~> 5.0', '>= 5.0.0'
+  spec.add_runtime_dependency 'jekyll', '>= 3.0', '< 5.0'
 end

data/lib/jekyll/haml/markup.rb

@@ -6,9 +6,10 @@ require_relative 'markup/hooks'
 
 module Jekyll
   module Haml
+    # markup module
     module Markup
       def self.root
-        Pathname.new File.expand_path('../../../..', __FILE__)
+        Pathname.new File.expand_path('../../..', __dir__)
       end
     end
   end

data/lib/jekyll/haml/markup/converter.rb

@@ -2,41 +2,18 @@ require 'jekyll'
 
 module Jekyll
   module Converters
+    # haml converter
     class Haml < Converter
-
-      def extname_list
-        @extname_list ||= haml_conf["haml_ext"].split(",").map do |e|
-          ".#{e.downcase}"
-        end
-      end
-
       def matches(ext)
-        extname_list.include?(ext.downcase)
+        Jekyll::Haml::Parser.matches ext
       end
 
-      def output_ext(ext)
+      def output_ext(_ext)
         '.html'
       end
 
-      def get_processor
-        case haml_conf['haml'].downcase
-        when 'lib-haml' then return Jekyll::Haml::Parser.new haml_conf
-        end
-      end
-
       def convert(content)
-        get_processor.convert content
-      end
-
-      def haml_conf
-        {
-          'haml_ext' => 'haml',
-          'haml' => 'lib-haml',
-          'lib-haml' => {
-            attr_wrapper: '"',
-            escape_attrs: false
-          }
-        }
+        Jekyll::Haml::Parser.compile content
       end
     end
   end

data/lib/jekyll/haml/markup/hooks.rb

@@ -2,10 +2,9 @@ require 'jekyll'
 
 Jekyll::Hooks.register :site, :post_read do |site|
   haml_converter = Jekyll::Converters::Haml.new site.config
-  site.layouts.each do |name, layout|
+  site.layouts.each do |_, layout|
     if haml_converter.matches layout.ext
-      parsed_content = haml_converter.convert layout.content
-      layout.content = parsed_content
+      layout.content = Jekyll::Haml::Parser.compile layout.content
     end
   end
 end

data/lib/jekyll/haml/markup/include.rb

@@ -3,18 +3,33 @@ require 'liquid'
 
 module Jekyll
   module Tags
+    # include module
     class HamlInclude < IncludeTag
-
       def read_file(file, context)
-        content = File.read file, file_read_opts(context)
+        return super file, context unless matches_a_haml_template file
+        file_content = read_file_with_context file, context
+        template = split_frontmatter_and_template file_content
+        compile_haml_to_html template
+      end
 
-        config = context.registers[:site].config
-        haml_converter = Jekyll::Converters::Haml.new config
-        content = haml_converter.convert(content) if haml_converter.matches File.extname(file)
+      private
+
+      def matches_a_haml_template(file)
+        Jekyll::Haml::Parser.matches File.extname file
+      end
 
-        content
+      def read_file_with_context(file, context)
+        File.read file, file_read_opts(context)
       end
 
+      def split_frontmatter_and_template(file_content)
+        return $POSTMATCH if file_content =~ Document::YAML_FRONT_MATTER_REGEXP
+        file_content
+      end
+
+      def compile_haml_to_html(template)
+        Jekyll::Haml::Parser.compile template
+      end
     end
   end
 end

data/lib/jekyll/haml/markup/parser.rb

@@ -2,39 +2,18 @@ require 'haml'
 
 module Jekyll
   module Haml
+    # parse module
     class Parser
+      CONFIG = { attr_wrapper: '"', escape_attrs: false }.freeze
 
-      def initialize(config)
-        unless defined?(Haml)
-          Jekyll::External.require_with_graceful_fail "haml"
-        end
-        @config = config["lib-haml"] || {}
-        setup
+      def self.matches(ext)
+        ext =~ /^\.haml$/i
       end
 
-      def setup
-        make_accessible
+      def self.compile(content)
+        template = ::Haml::Engine.new content, CONFIG
+        template.render.split("\n").join
       end
-
-      def convert(content)
-        document = ::Haml::Engine.new(content, @config)
-        html_output = document.render.split("\n").join
-        if @config["show_warnings"]
-          document.warnings.each do |warning|
-            Jekyll.logger.warn "Haml warning:", warning
-          end
-        end
-        html_output
-      end
-
-      private
-      def make_accessible(hash = @config)
-        hash.keys.each do |key|
-          hash[key.to_sym] = hash[key]
-          make_accessible(hash[key]) if hash[key].is_a?(Hash)
-        end
-      end
-
     end
   end
 end

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

@@ -1,7 +1,7 @@
 module Jekyll
   module Haml
     module Markup
-      VERSION = '0.1.3'
+      VERSION = '0.1.5'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-haml-markup
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Alvaro Faundez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2019-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,81 +25,113 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 0.57.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.57'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: haml
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Jekyll plugin that add the option to write layouts and partials in Haml.
 email:
 - alvaro@faundez.net