jekyll-haml-markup 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa5a1c4f4f6de2b2eec2d73b30f7710c06a68267
-  data.tar.gz: 73420ab7f89c64063b39c47269b367e2b5b3a5a7
+SHA256:
+  metadata.gz: 2b5ff16e78888c7aa674dfc1e95f756e811dc79fed9197394d78ec5f5ea54fcc
+  data.tar.gz: f1da06d1c3ba77e425e65252072f47fbecafa361ef2cbd6747d5ca973287f2a7
 SHA512:
-  metadata.gz: 49f3975c43de103b7073005b5834b17c132a9080378359f58605161ae2eeef454e55115d8edb15b33ef6e3d45b88c8b8f399f2832ac13f69c0ad2a1d711da80b
-  data.tar.gz: f77d17ed31f404a31160a548edb0f6f2b383b366971d653363df80b95b3cd795189b01b039ba76148c5a5aaf66308d8ca05fcf23514969ae96d44905c554e11f
+  metadata.gz: c212d037005abf104dccd46686968179ffa460cad2b6779c4e381900fb080d355ee8789ae08646069103bba7aedaa6f48bd6b5a0607bcaa0b6c9a787f0a68cfa
+  data.tar.gz: a222f997d1a6d6c3a15c4ac83c4e029d8a68e7c279fe688d020cab3b2842f38580669783ea4181196b7cf42933578d677d5012106e1cff121a9766d46d84ceef

data/.github/workflows/gem-push.yml

@@ -0,0 +1,40 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+/Gemfile.lock
+.jekyll-cache

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.3
-before_install: gem install bundler -v 1.16.1
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10
+  - 2.3.8
+  - 2.2.10
+  - 2.1.10
+  - 2.1.0

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/README.md

@@ -1,10 +1,10 @@
-# 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.
+[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
@@ -12,24 +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 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:
-
-```haml
-!!!
-%html
-  %head
-    \{% asset style.css %}
-  %body
-    \{{ content }}
-```
+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
 
@@ -37,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,30 +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'
+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.homepage      = 'https://github.com/afaundez/jekyll-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', '< 3.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.57', '>= 0.57.2'
 
-  spec.add_runtime_dependency 'jekyll', '~> 3.7'
-  spec.add_runtime_dependency 'haml', '~> 5.0'
+  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

@@ -1,13 +1 @@
-require 'jekyll-haml-markup/version'
-
-require 'jekyll'
-
-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/haml/markup'

data/lib/jekyll/haml/markup.rb

@@ -0,0 +1,16 @@
+require_relative 'markup/version'
+require_relative 'markup/parser'
+require_relative 'markup/converter'
+require_relative 'markup/include'
+require_relative 'markup/hooks'
+
+module Jekyll
+  module Haml
+    # markup module
+    module Markup
+      def self.root
+        Pathname.new File.expand_path('../../..', __dir__)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'jekyll'
+
+module Jekyll
+  module Converters
+    # haml converter
+    class Haml < Converter
+      def matches(ext)
+        Jekyll::Haml::Parser.matches ext
+      end
+
+      def output_ext(_ext)
+        '.html'
+      end
+
+      def convert(content)
+        Jekyll::Haml::Parser.compile content
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+require 'jekyll'
+require 'liquid'
+
+module Jekyll
+  module Tags
+    # include module
+    class HamlInclude < IncludeTag
+      def read_file(file, 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
+
+      private
+
+      def matches_a_haml_template(file)
+        Jekyll::Haml::Parser.matches File.extname file
+      end
+
+      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
+
+Liquid::Template.register_tag 'include', Jekyll::Tags::HamlInclude

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

@@ -0,0 +1,19 @@
+require 'haml'
+
+module Jekyll
+  module Haml
+    # parse module
+    class Parser
+      CONFIG = { attr_wrapper: '"', escape_attrs: false }.freeze
+
+      def self.matches(ext)
+        ext =~ /^\.haml$/i
+      end
+
+      def self.compile(content)
+        template = ::Haml::Engine.new content, CONFIG
+        template.render.split("\n").join
+      end
+    end
+  end
+end

data/lib/{jekyll-haml-markup → jekyll/haml/markup}/version.rb

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

metadata

@@ -1,75 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-haml-markup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - Alvaro Faundez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !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: jekyll
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :runtime
+        version: 12.3.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -77,9 +112,32 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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
@@ -87,11 +145,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -99,21 +157,13 @@ files:
 - bin/setup
 - jekyll-haml-markup.gemspec
 - lib/jekyll-haml-markup.rb
-- 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
+- lib/jekyll/haml/markup.rb
+- lib/jekyll/haml/markup/converter.rb
+- lib/jekyll/haml/markup/hooks.rb
+- lib/jekyll/haml/markup/include.rb
+- lib/jekyll/haml/markup/parser.rb
+- lib/jekyll/haml/markup/version.rb
+homepage: https://github.com/afaundez/jekyll-haml-markup
 licenses:
 - MIT
 metadata: {}
@@ -125,15 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin to use Haml on templates.