jekyll-slim 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95e61d06b10c362d79ec9608ebafbc3aa3021643
-  data.tar.gz: 7016aa481b50a1970eb220134927d838e6dfb00f
+  metadata.gz: 863f6d69a418a8703b17f0e0c6f467d77a23742b
+  data.tar.gz: f53d213471c0db4fb81483e4df87fe1f600a678b
 SHA512:
-  metadata.gz: 070cfe05b5497d9507ded44cdfe199e62145953f59c9e16eeb5bfe7cb9f1eae01a334ce808690eda1e7886743e32317a30d45f74ef6687540977450878ddf7a0
-  data.tar.gz: 362f4652cb8fb40ff9c454d05363d0d5e41557a50f0872e67a6f490db53f96a31c3680a3ed60db9747db390f3597fe4a69cfb9f256b8d14e6e7760ba019bc4d3
+  metadata.gz: dc5ac134af12be7e853de51338113344da7a51e3f619e32b19f96748f58bc66d6faed03c948fe0a06f23b0da370904d0ced7a244432a8d0dccba56f7470253ae
+  data.tar.gz: 86abe3bea276baa9698c6170ad6e12255f12e8408f1dd52f5690dd4a54b1242ca7fd5aaabd219a42bfa714e74440d4c14105f51c0855e09beeb84438a5bc69ba

data/History.md

@@ -1,3 +1,7 @@
+0.10.0 / 2014-10-10
+===================
+
+  * Major refactoring. jekyll-slim uses sliq from now on.
 
 0.8.2 / 2013-05-06
 ==================

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Reda Lemeden
+Copyright (c) 2013 Reda Lemeden, 2014 Daniel Mendler
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,10 +2,10 @@
 
 [![Gem Version](http://img.shields.io/gem/v/jekyll-slim.svg?style=flat)](#)
 [![Dependency
-Status](http://img.shields.io/gemnasium/kaishin/jekyll-slim.svg?style=flat)](https://gemnasium.com/kaishin/jekyll-slim)
+Status](http://img.shields.io/gemnasium/slim-template/jekyll-slim.svg?style=flat)](https://gemnasium.com/slim-template/jekyll-slim)
 [![Code
-Climate](http://img.shields.io/codeclimate/github/kaishin/jekyll-slim.svg?style=flat)](https://codeclimate.com/github/kaishin/jekyll-slim)
-[![Build Status](http://img.shields.io/travis/kaishin/jekyll-slim.svg?style=flat)](https://travis-ci.org/kaishin/jekyll-slim)
+Climate](http://img.shields.io/codeclimate/github/slim-template/jekyll-slim.svg?style=flat)](https://codeclimate.com/github/slim-template/jekyll-slim)
+[![Build Status](http://img.shields.io/travis/slim-template/jekyll-slim.svg?style=flat)](https://travis-ci.org/slim-template/jekyll-slim)
 
 A gem that adds [slim-lang](http://slim-lang.com) support to [Jekyll](http://github.com/mojombo/jekyll). Works for for pages, includes and layouts.
 
@@ -25,10 +25,8 @@ Or install it yourself as:
 
 In your Jekyll project's `_plugins` directory:
 
-    # _plugins/bundler.rb
-    require 'rubygems'
-    require 'bundler/setup'
-    Bundler.require(:default)
+    # _plugins/jekyll-slim.rb
+    require 'jekyll-slim'
 
 ## Usage
 
@@ -39,8 +37,7 @@ The gem will convert all the `.slim` files in your project's directory into HTML
 html
   head
   body
-    .content-wrapper
-      | {{ content }}
+    .content-wrapper {{ content }}
 ```
 To include a partial, use the `slim` liquid tag instead of `include`:
 
@@ -51,7 +48,7 @@ layout: default
 ---
 
 section.content Content goes here.
-| {% slim footer.slim %}
+% include footer.slim
 
 ```
 
@@ -84,16 +81,9 @@ The `SlimContext` object will be kept across calls, allowing you to easily set
 `@instance_variables` that can be accessed by **all slim files** even those included with the `slim`
 liquid tag. Those are more or less global variables in slim templates, so be careful when you use them.
 
-## TODO
+## Looking for maintainers
 
-- Per-page slim context?
-- Improve code and try to avoid patches as much as possible
-- Parsing Liquid tags before slim so you have access to everything? Can create a lot of problems with Ruby
-- Slim context must be the same as liquid, with paginator, site, page and content variables. See these links:
-  - https://github.com/mojombo/jekyll/blob/a9e2a74ea619a01a9d169da2240ce91b43362c9f/lib/jekyll/tags/include.rb
-  - https://github.com/mojombo/jekyll/blob/a9e2a74ea619a01a9d169da2240ce91b43362c9f/lib/jekyll/page.rb
-  - http://jekyllrb.com/docs/plugins/
-  - http://jekyllrb.com/docs/variables/
+We are looking for maintainers for this gem.
 
 ## Credit
 

data/jekyll-slim.gemspec

@@ -1,25 +1,24 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll-slim/version'
+require 'jekyll/slim/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'jekyll-slim'
   gem.version       = Jekyll::Slim::VERSION
-  gem.authors       = ['Reda Lemeden', 'Francesco Belladonna']
-  gem.email         = ['reda@thoughtbot.com', 'francesco.belladonna@gmail.com']
+  gem.authors       = ['Reda Lemeden', 'Francesco Belladonna', 'Daniel Menlder']
+  gem.email         = ['reda@thoughtbot.com', 'francesco.belladonna@gmail.com', 'mail@daniel-mendler.de']
   gem.description   = %q{Slim html converter for Jekyll}
   gem.summary       = %q{Slim-lang support for Jekyll. Handles includes and layouts as well.}
-  gem.homepage      = ''
+  gem.homepage      = 'https://github.com/slim-template/jekyll-slim'
 
   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', '~> 2.0.0'
-  gem.add_runtime_dependency 'activesupport', '~> 4.0'
-  gem.add_runtime_dependency 'slim', '~> 2.0.2'
+  gem.add_runtime_dependency 'jekyll', '~> 2.0'
+  gem.add_runtime_dependency 'sliq'
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('bundler')

data/lib/jekyll-slim.rb

@@ -1,8 +1 @@
-require 'slim'
-require 'jekyll-slim/version'
-require 'jekyll-slim/extensions/layout'
-require 'jekyll-slim/extensions/site'
-require 'jekyll-slim/extensions/converter'
-require 'jekyll-slim/slim_converter'
-require 'jekyll-slim/slim_context'
-require 'jekyll-slim/tags/slim_partial'
+require 'jekyll/slim'

data/lib/jekyll/slim.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+require 'sliq'
+require 'jekyll'
+require 'jekyll/slim/version'
+require 'jekyll/slim/extensions'
+require 'jekyll/slim/converter'
+require 'jekyll/slim/include_tag'

data/lib/jekyll/slim/converter.rb

@@ -0,0 +1,50 @@
+module Jekyll
+  module Slim
+    class Converter < ::Jekyll::Converter
+      safe false
+      priority :low
+
+      def matches(ext)
+        ext =~ /slim/i
+      end
+
+      def output_ext(ext)
+        '.html'
+      end
+
+      def convert(content)
+        self.class.convert(@config, content)
+      end
+
+      class << self
+        def convert(config, content)
+          config = symbolize_hash(config['slim'] || {}).merge(file: Convertible.slim_current_convertible.path)
+          context = hash2ostruct(Utils.deep_merge_hashes(Convertible.slim_current_convertible.site.site_payload,
+                                                         page: Convertible.slim_current_convertible.to_liquid))
+          # Allow also direct access to the site and page object from Slim
+          context.site_object = Convertible.slim_current_convertible.site
+          context.page_object = Convertible.slim_current_convertible
+          ::Sliq::Converter.new(config) { content }.render(context)
+        end
+
+        def hash2ostruct(hash)
+          h = {}
+          hash.keys.each do |k|
+            v = hash[k]
+            h[k] = Hash === v ? hash2ostruct(v) : v
+          end
+          OpenStruct.new(h)
+        end
+
+        def symbolize_hash(hash)
+          h = {}
+          hash.keys.each do |k|
+            v = hash[k]
+            h[(k.to_sym rescue k) || k] = Hash === v ? symbolize_hash(v) : v
+          end
+          h
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/slim/extensions.rb

@@ -0,0 +1,34 @@
+module Jekyll
+  class Layout
+    # path is required
+    # Also related to https://github.com/mojombo/jekyll/issues/225
+    def path
+      @name
+    end
+
+    # Allows layouts to be transformed by slim until this is fixed (1.4)
+    # https://github.com/mojombo/jekyll/issues/225
+    # https://github.com/mojombo/jekyll/blob/master/lib/jekyll/layout.rb
+    alias old_initialize initialize
+    def initialize(*args)
+      old_initialize(*args)
+      transform
+    end
+
+    def to_liquid
+      data.merge(name: name, content: content)
+    end
+  end
+
+  module Convertible
+    class<< self
+      attr_accessor :slim_current_convertible
+    end
+
+    alias old_transform transform
+    def transform
+      Convertible.slim_current_convertible = self
+      old_transform
+    end
+  end
+end

data/lib/jekyll/slim/include_tag.rb

@@ -0,0 +1,17 @@
+module Jekyll
+  module Slim
+    class IncludeTag < Jekyll::Tags::IncludeTag
+      def source(file, context)
+        content = super
+        if file =~ /\.slim\Z/i
+          Converter.convert(context.registers[:site].config, content)
+        else
+          content
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('slim', Jekyll::Slim::IncludeTag)
+Liquid::Template.register_tag('include', Jekyll::Slim::IncludeTag)

data/lib/{jekyll-slim → jekyll/slim}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Slim
-    VERSION = "0.9.1"
+    VERSION = '0.10.0'
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-slim
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Reda Lemeden
 - Francesco Belladonna
+- Daniel Menlder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-07 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,42 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: sliq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: slim
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +86,7 @@ description: Slim html converter for Jekyll
 email:
 - reda@thoughtbot.com
 - francesco.belladonna@gmail.com
+- mail@daniel-mendler.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,18 +98,14 @@ files:
 - History.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - jekyll-slim.gemspec
 - lib/jekyll-slim.rb
-- lib/jekyll-slim/extensions/converter.rb
-- lib/jekyll-slim/extensions/layout.rb
-- lib/jekyll-slim/extensions/site.rb
-- lib/jekyll-slim/slim_context.rb
-- lib/jekyll-slim/slim_converter.rb
-- lib/jekyll-slim/tags/slim_partial.rb
-- lib/jekyll-slim/version.rb
-- spec/spec_helper.rb
-homepage: ''
+- lib/jekyll/slim.rb
+- lib/jekyll/slim/converter.rb
+- lib/jekyll/slim/extensions.rb
+- lib/jekyll/slim/include_tag.rb
+- lib/jekyll/slim/version.rb
+homepage: https://github.com/slim-template/jekyll-slim
 licenses: []
 metadata: {}
 post_install_message: 
@@ -144,5 +128,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Slim-lang support for Jekyll. Handles includes and layouts as well.
-test_files:
-- spec/spec_helper.rb
+test_files: []
+has_rdoc: 

data/Rakefile

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

data/lib/jekyll-slim/extensions/converter.rb

@@ -1,10 +0,0 @@
-module Jekyll
-  class Converter < Plugin
-
-    # Patch used to export site variable to converters
-    def locals(locals=nil)
-      @locals = locals if locals
-      @locals
-    end
-  end
-end

data/lib/jekyll-slim/extensions/layout.rb

@@ -1,19 +0,0 @@
-module Jekyll
-  class Layout
-
-    # Allows layouts to be transformed by slim until this is fixed (1.4)
-    # https://github.com/mojombo/jekyll/issues/225
-    # https://github.com/mojombo/jekyll/blob/master/lib/jekyll/layout.rb
-    def initialize(site, base, name)
-      @site = site
-      @base = base
-      @name = name
-
-      self.data = {}
-
-      self.process(name)
-      self.read_yaml(base, name)
-      self.transform
-    end
-  end
-end

data/lib/jekyll-slim/extensions/site.rb

@@ -1,26 +0,0 @@
-require 'jekyll-slim/slim_context'
-
-module Jekyll
-  class Site
-
-    attr_reader :slim_context
-
-    # Patch to allow usage of site variable in Slim/Haml
-    # https://blog.darmasoft.net/2012/02/29/haml-processing-in-jekyll.html
-    # https://github.com/mojombo/jekyll/blob/master/lib/jekyll/site.rb
-    def instantiate_subclasses(klass)
-      klass.subclasses.select do |c|
-        !self.safe || c.safe
-      end.sort.map do |c|
-        conv = c.new(self.config)
-        # XXX: Hotfix to allow access site variable in slim/haml templates
-        if conv.respond_to?(:locals)
-          @slim_context ||= SlimContext.new(self)
-          conv.locals({ slim_context: @slim_context })
-        end
-
-        conv
-      end
-    end
-  end
-end

data/lib/jekyll-slim/slim_context.rb

@@ -1,12 +0,0 @@
-class SlimContext
-  attr_accessor :params
-
-  def initialize(site_context)
-    # XXX: Hopefully user won't overwrite this instance variable
-    @__site = site_context
-  end
-
-  def site
-    @__site
-  end
-end

data/lib/jekyll-slim/slim_converter.rb

@@ -1,34 +0,0 @@
-require 'slim'
-
-module Jekyll
-  class SlimConverter < Converter
-    safe false
-    priority :low
-
-    def initialize(config)
-      super
-      self.ensure_config_integrity
-    end
-
-    def matches(ext)
-      ext =~ /slim/i
-    end
-
-    def output_ext(ext)
-      ".html"
-    end
-
-    def convert(content)
-      begin
-        ::Slim::Template.new(@symbolized_config) { content }.render(locals[:slim_context])
-      rescue StandardError => e
-        puts "(!) SLIM ERROR: " + e.message
-      end
-    end
-
-    def ensure_config_integrity
-      @config['slim'] ||= {}
-      @symbolized_config = @config['slim'].deep_symbolize_keys
-    end
-  end
-end

data/lib/jekyll-slim/tags/slim_partial.rb

@@ -1,94 +0,0 @@
-require 'slim'
-
-module Jekyll
-  class SlimPartialTag < Liquid::Tag
-
-    SYNTAX_EXAMPLE = "{% slim file.slim param='value' param2='value' %}"
-
-    VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
-
-    def initialize(tag_name, markup, tokens)
-      super
-      @file, @params = markup.strip.split(' ', 2)
-      validate_params if @params
-    end
-
-    def validate_params
-      full_valid_syntax = Regexp.compile('\A\s*(?:' + VALID_SYNTAX.to_s + '(?=\s|\z)\s*)*\z')
-      unless @params =~ full_valid_syntax
-        raise ArgumentError.new <<-eos
-          Invalid syntax for include tag:
-        #{@params}
-
-          Valid syntax:
-        #{SYNTAX_EXAMPLE}
-        eos
-      end
-    end
-
-    def parse_params(context)
-      params = {}
-      markup = @params
-
-      while match = VALID_SYNTAX.match(markup) do
-        markup = markup[match.end(0)..-1]
-
-        value = if match[2]
-                  match[2].gsub(/\\"/, '"')
-                elsif match[3]
-                  match[3].gsub(/\\'/, "'")
-                elsif match[4]
-                  slim_context[match[4]]
-                end
-
-        params[match[1]] = value
-      end
-      params
-    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
-
-      return "File must have \".slim\" extension" if @file !~ /\.slim$/
-
-      Dir.chdir(includes_dir) do
-        choices = Dir['**/*'].reject { |x| File.symlink?(x) }
-        if choices.include?(@file)
-          source = File.read(@file)
-          context.registers[:site].slim_context.params = parse_params(context.registers[:site].slim_context)
-          conversion = ::Slim::Template.new(context.registers[:site].config['slim'].deep_symbolize_keys) { source }.render(context.registers[:site].slim_context)
-          partial = Liquid::Template.parse(conversion)
-          begin
-            return partial.render!(context)
-          rescue => e
-            if self.respond_to?(:data)
-              puts "Liquid Exception: #{e.message} in #{self.data["layout"]}"
-            else
-              puts "Liquid Exception: #{e.message} in (Unknown layout)"
-            end
-            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('slim', Jekyll::SlimPartialTag)

data/spec/spec_helper.rb

@@ -1,17 +0,0 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-end