tigefa 1.0.0 → 1.1.1

data/lib/tigefa/tags/highlight.rb

@@ -0,0 +1,85 @@
+module Tigefa
+  module Tags
+    class HighlightBlock < Liquid::Block
+      include Liquid::StandardFilters
+
+      # The regular expression syntax checker. Start with the language specifier.
+      # Follow that by zero or more space separated options that take one of two
+      # forms:
+      #
+      # 1. name
+      # 2. name=value
+      SYNTAX = /^([a-zA-Z0-9.+#-]+)((\s+\w+(=\w+)?)*)$/
+
+      def initialize(tag_name, markup, tokens)
+        super
+        if markup.strip =~ SYNTAX
+          @lang = $1.downcase
+          @options = {}
+          if defined?($2) && $2 != ''
+            $2.split.each do |opt|
+              key, value = opt.split('=')
+              if value.nil?
+                if key == 'linenos'
+                  value = 'inline'
+                else
+                  value = true
+                end
+              end
+              @options[key] = value
+            end
+          end
+        else
+          raise SyntaxError.new <<-eos
+Syntax Error in tag 'highlight' while parsing the following markup:
+
+  #{markup}
+
+Valid syntax: highlight <lang> [linenos]
+eos
+        end
+      end
+
+      def render(context)
+        if context.registers[:site].pygments
+          render_pygments(context, super)
+        else
+          render_codehighlighter(context, super)
+        end
+      end
+
+      def render_pygments(context, code)
+        require 'pygments'
+
+        @options[:encoding] = 'utf-8'
+
+        output = add_code_tags(
+          Pygments.highlight(code, :lexer => @lang, :options => @options),
+          @lang
+        )
+
+        output = context["pygments_prefix"] + output if context["pygments_prefix"]
+        output = output + context["pygments_suffix"] if context["pygments_suffix"]
+        output
+      end
+
+      def render_codehighlighter(context, code)
+        #The div is required because RDiscount blows ass
+        <<-HTML
+  <div>
+    <pre><code class='#{@lang}'>#{h(code).strip}</code></pre>
+  </div>
+        HTML
+      end
+
+      def add_code_tags(code, lang)
+        # Add nested <code> tags to code blocks
+        code = code.sub(/<pre>/,'<pre><code class="' + lang + '">')
+        code = code.sub(/<\/pre>/,"</code></pre>")
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('highlight', Jekyll::Tags::HighlightBlock)

data/lib/tigefa/tags/include.rb

@@ -0,0 +1,134 @@
+module Tigefa
+  module Tags
+    class IncludeTagError < StandardError
+      attr_accessor :path
+
+      def initialize(msg, path)
+        super(msg)
+        @path = path
+      end
+    end
+
+    class IncludeTag < Liquid::Tag
+
+      SYNTAX_EXAMPLE = "{% include file.ext param='value' param2='value' %}"
+
+      VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
+
+      INCLUDES_DIR = '_includes'
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @file, @params = markup.strip.split(' ', 2);
+        validate_params if @params
+      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]
+            context[match[4]]
+          end
+
+          params[match[1]] = value
+        end
+        params
+      end
+
+      def validate_file_name(file)
+        if file !~ /^[a-zA-Z0-9_\/\.-]+$/ || file =~ /\.\// || file =~ /\/\./
+            raise ArgumentError.new <<-eos
+Invalid syntax for include tag. File contains invalid characters or sequences:
+
+	#{@file}
+
+Valid syntax:
+
+	#{SYNTAX_EXAMPLE}
+
+eos
+        end
+      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
+
+      # Grab file read opts in the context
+      def file_read_opts(context)
+        context.registers[:site].file_read_opts
+      end
+
+      def retrieve_variable(context)
+        if /\{\{([\w\-\.]+)\}\}/ =~ @file
+          raise ArgumentError.new("No variable #{$1} was found in include tag") if context[$1].nil?
+          context[$1]
+        end
+      end
+
+      def render(context)
+        dir = File.join(File.realpath(context.registers[:site].source), INCLUDES_DIR)
+
+        file = retrieve_variable(context) || @file
+        validate_file_name(file)
+
+        path = File.join(dir, file)
+        validate_path(path, dir, context.registers[:site].safe)
+
+        begin
+          partial = Liquid::Template.parse(source(path, context))
+
+          context.stack do
+            context['include'] = parse_params(context) if @params
+            partial.render!(context)
+          end
+        rescue => e
+          raise IncludeTagError.new e.message, File.join(INCLUDES_DIR, @file)
+        end
+      end
+
+      def validate_path(path, dir, safe)
+        if safe && !realpath_prefixed_with?(path, dir)
+          raise IOError.new "The included file '#{path}' should exist and should not be a symlink"
+        elsif !File.exist?(path)
+          raise IOError.new "Included file '#{path}' not found"
+        end
+      end
+
+      def realpath_prefixed_with?(path, dir)
+        File.exist?(path) && File.realpath(path).start_with?(dir)
+      end
+
+      def blank?
+        false
+      end
+
+      # This method allows to modify the file content by inheriting from the class.
+      def source(file, context)
+        File.read_with_options(file, file_read_opts(context))
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('include', Jekyll::Tags::IncludeTag)

data/lib/tigefa/tags/post_url.rb

@@ -0,0 +1,63 @@
+module TigefaTigefa
+  module Tags
+    class PostComparer
+      MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)$/
+
+      attr_accessor :date, :slug
+
+      def initialize(name)
+        all, path, date, slug = *name.sub(/^\//, "").match(MATCHER)
+        @slug = path ? path + slug : slug
+        @date = Time.parse(date)
+      end
+
+      def ==(other)
+        slug == post_slug(other) &&
+          date.year  == other.date.year &&
+          date.month == other.date.month &&
+          date.day   == other.date.day
+      end
+
+      private
+      # Construct the directory-aware post slug for a TigefaTigefa::Post
+      #
+      # other - the TigefaTigefa::Post
+      #
+      # Returns the post slug with the subdirectory (relative to _posts)
+      def post_slug(other)
+        path = other.name.split("/")[0...-1].join("/")
+        if path.nil? || path == ""
+          other.slug
+        else
+          path + '/' + other.slug
+        end
+      end
+    end
+
+    class PostUrl < Liquid::Tag
+      def initialize(tag_name, post, tokens)
+        super
+        @orig_post = post.strip
+        @post = PostComparer.new(@orig_post)
+      end
+
+      def render(context)
+        site = context.registers[:site]
+
+        site.posts.each do |p|
+          if @post == p
+            return p.url
+          end
+        end
+
+        raise ArgumentError.new <<-eos
+Could not find post "#{@orig_post}" in tag 'post_url'.
+
+Make sure the post exists and the name is correct.
+eos
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('post_url', Tigefa::Tags::PostUrl)

data/lib/tigefa/url.rb

@@ -0,0 +1,69 @@
+# Public: Methods that generate a URL for a resource such as a Post or a Page.
+#
+# Examples
+#
+#   URL.new({
+#     :template => /:categories/:title.html",
+#     :placeholders => {:categories => "ruby", :title => "something"}
+#   }).to_s
+#
+module Tigefa
+  class URL
+
+    # options - One of :permalink or :template must be supplied.
+    #           :template     - The String used as template for URL generation,
+    #                           for example "/:path/:basename:output_ext", where
+    #                           a placeholder is prefixed with a colon.
+    #           :placeholders - A hash containing the placeholders which will be
+    #                           replaced when used inside the template. E.g.
+    #                           { "year" => Time.now.strftime("%Y") } would replace
+    #                           the placeholder ":year" with the current year.
+    #           :permalink    - If supplied, no URL will be generated from the
+    #                           template. Instead, the given permalink will be
+    #                           used as URL.
+    def initialize(options)
+      @template = options[:template]
+      @placeholders = options[:placeholders] || {}
+      @permalink = options[:permalink]
+
+      if (@template || @permalink).nil?
+        raise ArgumentError, "One of :template or :permalink must be supplied."
+      end
+    end
+
+    # The generated relative URL of the resource
+    #
+    # Returns the String URL
+    def to_s
+      sanitize_url(@permalink || generate_url)
+    end
+
+    # Internal: Generate the URL by replacing all placeholders with their
+    # respective values
+    #
+    # Returns the _unsanitizied_ String URL
+    def generate_url
+      @placeholders.inject(@template) do |result, token|
+        result.gsub(/:#{token.first}/, token.last)
+      end
+    end
+
+    # Returns a sanitized String URL
+    def sanitize_url(in_url)
+
+      # Remove all double slashes
+      url = in_url.gsub(/\/\//, "/")
+
+      # Remove every URL segment that consists solely of dots
+      url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
+
+      # Append a trailing slash to the URL if the unsanitized URL had one
+      url += "/" if in_url =~ /\/$/
+
+      # Always add a leading slash
+      url.gsub!(/\A([^\/])/, '/\1')
+
+      url
+    end
+  end
+end

data/lib/tigefa.rb

@@ -1,6 +1,100 @@
-% cat lib/tigefa.rb
-class Tigefa
-  def self.hi
-    puts "Hello world!"
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# Require all of the Ruby files in the given directory.
+#
+# path - The String relative path from here to the directory.
+#
+# Returns nothing.
+def require_all(path)
+  glob = File.join(File.dirname(__FILE__), path, '*.rb')
+  Dir[glob].each do |f|
+    require f
+  end
+end
+
+# rubygems
+require 'rubygems'
+
+# stdlib
+require 'fileutils'
+require 'time'
+require 'safe_yaml'
+require 'English'
+require 'pathname'
+
+# 3rd party
+require 'liquid'
+require 'maruku'
+require 'colorator'
+require 'toml'
+
+# internal requires
+require 'tigefa/core_ext'
+require 'tigefa/stevenson'
+require 'tigefa/deprecator'
+require 'tigefa/configuration'
+require 'tigefa/site'
+require 'tigefa/convertible'
+require 'tigefa/url'
+require 'tigefa/layout'
+require 'tigefa/page'
+require 'tigefa/post'
+require 'tigefa/excerpt'
+require 'tigefa/draft'
+require 'tigefa/filters'
+require 'tigefa/static_file'
+require 'tigefa/errors'
+require 'tigefa/related_posts'
+require 'tigefa/cleaner'
+require 'tigefa/entry_filter'
+
+# extensions
+require 'tigefa/plugin'
+require 'tigefa/converter'
+require 'tigefa/generator'
+require 'tigefa/command'
+
+require_all 'tigefa/commands'
+require_all 'tigefa/converters'
+require_all 'tigefa/converters/markdown'
+require_all 'tigefa/generators'
+require_all 'tigefa/tags'
+
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+module Jekyll
+  VERSION = '1.1.1'
+
+  # Public: Generate a Jekyll configuration Hash by merging the default
+  # options with anything in _config.yml, and adding the given options on top.
+  #
+  # override - A Hash of config directives that override any options in both
+  #            the defaults and the config file. See Jekyll::Configuration::DEFAULTS for a
+  #            list of option names and their defaults.
+  #
+  # Returns the final configuration Hash.
+  def self.configuration(override)
+    config = Configuration[Configuration::DEFAULTS]
+    override = Configuration[override].stringify_keys
+    config = config.read_config_files(config.config_files(override))
+
+    # Merge DEFAULTS < _config.yml < override
+    config = config.deep_merge(override).stringify_keys
+    set_timezone(config['timezone']) if config['timezone']
+
+    config
+  end
+
+  # Static: Set the TZ environment variable to use the timezone specified
+  #
+  # timezone - the IANA Time Zone
+  #
+  # Returns nothing
+  def self.set_timezone(timezone)
+    ENV['TZ'] = timezone
+  end
+
+  def self.logger
+    @logger ||= Stevenson.new
   end
 end

data/script/bootstrap

@@ -0,0 +1,2 @@
+#!/bin/sh
+bundle install

data/site/.gitignore

@@ -0,0 +1,4 @@
+_site/
+*.swp
+pkg/
+test/

data/site/CNAME

@@ -0,0 +1 @@
+jekyllrb.com

data/site/README

@@ -0,0 +1 @@
+Jekyll's awesome website.

data/site/_config.yml

@@ -0,0 +1,6 @@
+pygments: true
+relative_permalinks: false
+gauges_id: 503c5af6613f5d0f19000027
+permalink: /news/:year/:month/:day/:title/
+excerpt_separator: noifniof3nioaniof3nioafafinoafnoif
+repository: https://github.com/mojombo/jekyll

data/site/_includes/analytics.html

@@ -0,0 +1,32 @@
+{% if site.gauges_id %}
+  <!-- Gauges (http://gaug.es/) -->
+  <script type="text/javascript">
+    var _gauges = _gauges || [];
+    (function() {
+      var t   = document.createElement('script');
+      t.type  = 'text/javascript';
+      t.async = true;
+      t.id    = 'gauges-tracker';
+      t.setAttribute('data-site-id', '{{ site.gauges_id }}');
+      t.src = '//secure.gaug.es/track.js';
+      var s = document.getElementsByTagName('script')[0];
+      s.parentNode.insertBefore(t, s);
+    })();
+  </script>
+{% endif %}
+
+{% if site.google_analytics_id %}
+  <!-- Google Analytics (http://google.com/analytics) -->
+  <script type="text/javascript">
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', '{{ site.google_analytics_id }}']);
+    _gaq.push(['_setDomainName', '{{ site.url }}']); // Multiple sub-domains
+    _gaq.push(['_setAllowLinker', true]); // Multiple TLDs
+    _gaq.push(['_trackPageview']);
+    (function() {
+      var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+      ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+    })();
+  </script>
+{% endif %}

data/site/_includes/docs_contents.html

@@ -0,0 +1,16 @@
+<div class="unit one-fifth hide-on-mobiles">
+  <aside>
+    <h4>Getting Started</h4>
+    {% include docs_ul.html items='home quickstart installation usage structure configuration' %}
+    <h4>Your Content</h4>
+    {% include docs_ul.html items='frontmatter posts drafts pages variables datafiles migrations' %}
+    <h4>Customization</h4>
+    {% include docs_ul.html items='templates permalinks pagination plugins extras' %}
+    <h4>Deployment</h4>
+    {% include docs_ul.html items='github-pages deployment-methods' %}
+    <h4>Miscellaneous</h4>
+    {% include docs_ul.html items='troubleshooting sites resources upgrading' %}
+    <h4>Meta</h4>
+    {% include docs_ul.html items='contributing history' %}
+  </aside>
+</div>

data/site/_includes/docs_contents_mobile.html

@@ -0,0 +1,23 @@
+<div class="docs-nav-mobile unit whole show-on-mobiles">
+  <select onchange="if (this.value) window.location.href=this.value">
+    <option value="">Navigate the docs…</option>
+    <optgroup label="Getting started">
+      {% include docs_option.html items='home quickstart installation usage structure configuration' %}
+    </optgroup>
+    <optgroup label="Your Content">
+      {% include docs_option.html items='frontmatter posts drafts pages variables datafiles migrations' %}
+    </optgroup>
+    <optgroup label="Customization">
+      {% include docs_option.html items='templates permalinks pagination plugins extras' %}
+    </optgroup>
+    <optgroup label="Deployment">
+      {% include docs_option.html items='github-pages deployment-methods' %}
+    </optgroup>
+    <optgroup label="Miscellaneous">
+      {% include docs_option.html items='troubleshooting sites resources upgrading' %}
+    </optgroup>
+    <optgroup label="Meta">
+      {% include docs_option.html items='contributing history' %}
+    </optgroup>
+  </select>
+</div>

data/site/_includes/docs_option.html

@@ -0,0 +1,11 @@
+{% assign items = include.items | split: ' ' %}
+
+{% for item in items %}
+  {% assign item_url = item | prepend:'/docs/' | append:'/' %}
+
+  {% for p in site.pages %}
+    {% if p.url == item_url %}
+      <option value="{{ site.url }}{{ p.url }}">{{ p.title }}</option>
+    {% endif %}
+  {% endfor %}
+{% endfor %}

data/site/_includes/docs_ul.html

@@ -0,0 +1,20 @@
+{% assign items = include.items | split: ' ' %}
+
+<ul>
+{% for item in items %}
+  {% assign item_url = item | prepend:'/docs/' | append:'/' %}
+
+  {% if item_url == page.url %}
+    {% assign c = 'current' %}
+  {% else %}
+    {% assign c = '' %}
+  {% endif %}
+
+  {% for p in site.pages %}
+    {% if p.url == item_url %}
+      <li class="{{ c }}"><a href="{{ site.url }}{{ p.url }}">{{ p.title }}</a></li>
+    {% endif %}
+  {% endfor %}
+
+{% endfor %}  
+</ul>

data/site/_includes/footer.html

@@ -0,0 +1,15 @@
+<footer>
+  <div class="grid">
+    <div class="unit one-third center-on-mobiles">
+      <p>By <a href="http://tom.preston-werner.com">Tom Preston-Werner</a>, <a href="http://quaran.to/">Nick Quaranto</a>, and many more <a href="{{ site.repository }}/graphs/contributors">awesome&nbsp;contributors</a>.</p>
+    </div>
+    <div class="unit two-thirds align-right center-on-mobiles">
+      <p>
+        Proudly hosted by
+        <a href="https://github.com">
+          <img src="{{ site.url }}/img/footer-logo.png" alt="GitHub • Social coding">
+        </a>
+      </p>
+    </div>
+  </div>
+</footer>

data/site/_includes/header.html

@@ -0,0 +1,18 @@
+<header>
+  <nav class="mobile-nav show-on-mobiles">
+    {% include primary-nav-items.html %}
+  </nav>
+  <div class="grid">
+    <div class="unit one-third center-on-mobiles">
+      <h1>
+        <a href="{{ site.url }}/">
+          <span>Jekyll</span>
+          <img src="{{ site.url }}/img/logo-2x.png" width="249" height="115" alt="">
+        </a>
+      </h1>
+    </div>
+    <nav class="main-nav unit two-thirds hide-on-mobiles">
+      {% include primary-nav-items.html %}
+    </nav>
+  </div>
+</header>

data/site/_includes/news_contents.html

@@ -0,0 +1,23 @@
+<div class="unit one-fifth hide-on-mobiles">
+  <aside>
+    <ul>
+      <li class="{% if page.title == 'News' %}current{% endif %}">
+        <a href="/news/">All News</a>
+      </li>
+      <li class="{% if page.title == 'Releases' %}current{% endif %}">
+        <a href="/news/releases/">Jekyll Releases</a>
+      </li>
+    </ul>
+    <h4>Recent Releases</h4>
+    <ul>
+      {% for post in site.posts limit:5 %}
+      <li class="{% if page.title == post.title %}current{% endif %}">
+        <a href="{{ post.url }}">Version {{ post.version }}</a>
+      </li>
+      {% endfor %}
+      <li>
+        <a href="/docs/history/">History »</a>
+      </li>
+    </ul>
+  </aside>
+</div>

data/site/_includes/news_contents_mobile.html

@@ -0,0 +1,11 @@
+<div class="docs-nav-mobile unit whole show-on-mobiles">
+  <select onchange="if (this.value) window.location.href=this.value">
+    <option value="">Navigate the blog…</option>
+    <option value="/news/">Home</option>
+    <optgroup label="v1.x">
+      {% for post in site.posts %}
+      <option value="{{ post.url }}">{{ post.title }}</option>
+      {% endfor %}
+    </optgroup>
+  </select>
+</div>