jekyll-slim 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e7d4235a49301422ec2482bc64a43b5c0b01b13
-  data.tar.gz: 1709e4b9a0fc7971dbe41cfc8949a2de79df1131
+  metadata.gz: 3636386147b7f495d491744828c52ff23d66f856
+  data.tar.gz: d2821b227136f82fbe7cefb16b3c57f1e1694c5b
 SHA512:
-  metadata.gz: dbb329a6cc989816940abe55a655079cc5928d716f7b7d9554afabde17c5fd746ab1106547a4f7332294f36f5fae3fbfb0d25b22f588a986c33fa2b777b9e247
-  data.tar.gz: 23e09c32c68123e9e18ea3d7c8de0dc88787e11889d2140f635b8214178c2c567ded3948e123c79f72597834becc82a835b533cdff27e9d158dac19896cb1b7b
+  metadata.gz: 6a4d62aeba3d64840abdc4028757f786ebbdefabf14acc3f5be95ad8c95f27bc417e06169cc31b71d98225871553b295556598a94144f5c0fbe468d5f8803097
+  data.tar.gz: db620117af430c661f7f647fe25528c109d9a9edaaebf4cfd74509252415bdc0a5fd9eecc21ba0ba91181a343d877c34ea5cebfe69d5d683259b77f996b9504a

data/History.md

@@ -1,4 +1,9 @@
 
+0.8.2 / 2013-05-06
+==================
+
+  * Fix `layout.rb` import path
+
 0.8.1 / 2013-05-05
 ==================
 

data/README.md

@@ -1,6 +1,11 @@
 # Jekyll-slim
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-slim.png)](http://badge.fury.io/rb/jekyll-slim) [![Dependency Status](https://gemnasium.com/kaishin/jekyll-slim.png)](https://gemnasium.com/kaishin/jekyll-slim) [![Code Climate](https://codeclimate.com/github/kaishin/jekyll-slim.png)](https://codeclimate.com/github/kaishin/jekyll-slim) [![Build Status](https://travis-ci.org/kaishin/jekyll-slim.png)](https://travis-ci.org/kaishin/jekyll-slim)
+[![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)
+[![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)
 
 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.
 
@@ -29,7 +34,7 @@ In your Jekyll project's `_plugins` directory:
 
 The gem will convert all the `.slim` files in your project's directory into HTML. That includes files in sub-directories, includes and layouts. Example:
 
-```haml
+```slim
 # _layouts/default.slim
 html
   head
@@ -39,7 +44,7 @@ html
 ```
 To include a partial, use the `slim` liquid tag instead of `include`:
 
-```haml
+```slim
 # index.slim
 ---
 layout: default
@@ -50,7 +55,46 @@ section.content Content goes here.
 
 ```
 
+### Options
+
+Is possible to set options available for Slim engine through the `slim` key in `_config.yml`. Example:
+
+```yaml
+# _config.yml
+slim:
+  pretty: true
+  format: html5
+```
+
+### Context
+
+The slim context is set to acess a `SlimContext` object which has a `site` method, used to access `config`. Be careful because this is a breaking change.
+
+This allows you to access configuration information in your slim file. Example:
+
+```slim
+html
+  head
+  body
+    .content-wrapper
+      = "slim pretty mode: #{ site.config['slim']['pretty'].to_s }"
+```
+
+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
+
+- 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/
+
 ## Credit
 
 Jekyll-slim was heavily inspired by [jekyll-haml](https://github.com/samvincent/jekyll-haml). It is free software, and may be redistributed under the terms specified in the LICENSE file.
-

data/jekyll-slim.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jekyll-slim/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "jekyll-slim"
+  gem.name          = 'jekyll-slim'
   gem.version       = Jekyll::Slim::VERSION
-  gem.authors       = ["Reda Lemeden"]
-  gem.email         = ["reda@thoughtbot.com"]
+  gem.authors       = ['Reda Lemeden', 'Francesco Belladonna']
+  gem.email         = ['reda@thoughtbot.com', 'francesco.belladonna@gmail.com']
   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      = ''
 
   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.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'jekyll', ">= 0.10.0"
-  gem.add_runtime_dependency 'slim'
+  gem.add_runtime_dependency 'jekyll', '~> 1.2.1'
+  gem.add_runtime_dependency 'activesupport', '~> 4.0'
+  gem.add_runtime_dependency 'slim', '~> 2.0.2'
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('bundler')

data/lib/jekyll-slim.rb

@@ -1,27 +1,8 @@
 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/ext/layout'
-
-module Jekyll
-  class SlimConverter < Converter
-    safe true
-    priority :low
-
-    def matches(ext)
-      ext =~ /slim/i
-    end
-
-    def output_ext(ext)
-      ".html"
-    end
-
-    def convert(content)
-      begin
-        ::Slim::Template.new { content }.render
-      rescue StandardError => e
-        puts "(!) SLIM ERROR: " + e.message
-      end
-    end
-  end
-end

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

@@ -0,0 +1,10 @@
+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/{ext → extensions}/layout.rb

@@ -1,5 +1,9 @@
 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

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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,34 @@
+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

@@ -2,9 +2,48 @@ require 'slim'
 
 module Jekyll
   class SlimPartialTag < Liquid::Tag
-    def initialize(tag_name, file, tokens)
+
+    SYNTAX_EXAMPLE = "{% slim file.slim param='value' param2='value' %}"
+
+    VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
+
+    def initialize(tag_name, markup, tokens)
       super
-      @file = file.strip
+      @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)
@@ -24,12 +63,17 @@ module Jekyll
         choices = Dir['**/*'].reject { |x| File.symlink?(x) }
         if choices.include?(@file)
           source = File.read(@file)
-          conversion = ::Slim::Template.new{ source }.render
+          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
-            puts "Liquid Exception: #{e.message} in #{self.data["layout"]}"
+            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

data/lib/jekyll-slim/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Slim
-    VERSION = "0.8.2"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,95 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-slim
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Reda Lemeden
+- Francesco Belladonna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: '0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Slim html converter for Jekyll
 email:
 - reda@thoughtbot.com
+- francesco.belladonna@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - History.md
 - LICENSE.txt
@@ -97,7 +113,11 @@ files:
 - Rakefile
 - jekyll-slim.gemspec
 - lib/jekyll-slim.rb
-- lib/jekyll-slim/ext/layout.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
@@ -110,17 +130,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Slim-lang support for Jekyll. Handles includes and layouts as well.