tigefa 1.0.0 → 1.1.1

data/lib/tigefa/converters/markdown/rdiscount_parser.rb

@@ -0,0 +1,37 @@
+module Tigefa
+  module Converters
+    class Markdown
+      class RDiscountParser
+        def initialize(config)
+          require 'rdiscount'
+          @config = config
+          @rdiscount_extensions = @config['rdiscount']['extensions'].map { |e| e.to_sym }
+        rescue LoadError
+          STDERR.puts 'You are missing a library required for Markdown. Please run:'
+          STDERR.puts '  $ [sudo] gem install rdiscount'
+          raise FatalException.new("Missing dependency: rdiscount")
+        end
+
+        def convert(content)
+          rd = RDiscount.new(content, *@rdiscount_extensions)
+          html = rd.to_html
+          if @config['rdiscount']['toc_token']
+            html = replace_generated_toc(rd, html, @config['rdiscount']['toc_token'])
+          end
+          html
+        end
+
+        private
+        def replace_generated_toc(rd, html, toc_token)
+          if rd.generate_toc && html.include?(toc_token)
+            utf8_toc = rd.toc_content
+            utf8_toc.force_encoding('utf-8') if utf8_toc.respond_to?(:force_encoding)
+            html.gsub(toc_token, utf8_toc)
+          else
+            html
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tigefa/converters/markdown/redcarpet_parser.rb

@@ -0,0 +1,70 @@
+module Tigefa
+  module Converters
+    class Markdown
+      class RedcarpetParser
+
+        module CommonMethods
+          def add_code_tags(code, lang)
+            code = code.sub(/<pre>/, "<pre><code class=\"#{lang} language-#{lang}\" data-lang=\"#{lang}\">")
+            code = code.sub(/<\/pre>/,"</code></pre>")
+          end
+        end
+
+        module WithPygments
+          include CommonMethods
+          def block_code(code, lang)
+            require 'pygments'
+            lang = lang && lang.split.first || "text"
+            output = add_code_tags(
+              Pygments.highlight(code, :lexer => lang, :options => { :encoding => 'utf-8' }),
+              lang
+            )
+          end
+        end
+
+        module WithoutPygments
+          require 'cgi'
+
+          include CommonMethods
+
+          def code_wrap(code)
+            "<div class=\"highlight\"><pre>#{CGI::escapeHTML(code)}</pre></div>"
+          end
+
+          def block_code(code, lang)
+            lang = lang && lang.split.first || "text"
+            output = add_code_tags(code_wrap(code), lang)
+          end
+        end
+
+        def initialize(config)
+          require 'redcarpet'
+          @config = config
+          @redcarpet_extensions = {}
+          @config['redcarpet']['extensions'].each { |e| @redcarpet_extensions[e.to_sym] = true }
+
+          @renderer ||= if @config['pygments']
+                          Class.new(Redcarpet::Render::HTML) do
+                            include WithPygments
+                          end
+                        else
+                          Class.new(Redcarpet::Render::HTML) do
+                            include WithoutPygments
+                          end
+                        end
+        rescue LoadError
+          STDERR.puts 'You are missing a library required for Markdown. Please run:'
+          STDERR.puts '  $ [sudo] gem install redcarpet'
+          raise FatalException.new("Missing dependency: redcarpet")
+        end
+
+        def convert(content)
+          @redcarpet_extensions[:fenced_code_blocks] = !@redcarpet_extensions[:no_fenced_code_blocks]
+          @renderer.send :include, Redcarpet::Render::SmartyPants if @redcarpet_extensions[:smart]
+          markdown = Redcarpet::Markdown.new(@renderer.new(@redcarpet_extensions), @redcarpet_extensions)
+          markdown.render(content)
+        end
+      end
+    end
+  end
+end

data/lib/tigefa/converters/markdown.rb

@@ -0,0 +1,43 @@
+module Tigefa
+  module Converters
+    class Markdown < Converter
+      safe true
+
+      pygments_prefix "\n"
+      pygments_suffix "\n"
+
+      def setup
+        return if @setup
+        @parser = case @config['markdown']
+          when 'redcarpet'
+            RedcarpetParser.new @config
+          when 'kramdown'
+            KramdownParser.new @config
+          when 'rdiscount'
+            RDiscountParser.new @config
+          when 'maruku'
+            MarukuParser.new @config
+          else
+            STDERR.puts "Invalid Markdown processor: #{@config['markdown']}"
+            STDERR.puts "  Valid options are [ maruku | rdiscount | kramdown | redcarpet ]"
+            raise FatalException.new("Invalid Markdown process: #{@config['markdown']}")
+        end
+        @setup = true
+      end
+
+      def matches(ext)
+        rgx = '^\.(' + @config['markdown_ext'].gsub(',','|') +')$'
+        ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
+      end
+
+      def output_ext(ext)
+        ".html"
+      end
+
+      def convert(content)
+        setup
+        @parser.convert(content)
+      end
+    end
+  end
+end

data/lib/tigefa/converters/textile.rb

@@ -0,0 +1,50 @@
+module Tigefa
+  module Converters
+    class Textile < Converter
+      safe true
+
+      pygments_prefix '<notextile>'
+      pygments_suffix '</notextile>'
+
+      def setup
+        return if @setup
+        require 'redcloth'
+        @setup = true
+      rescue LoadError
+        STDERR.puts 'You are missing a library required for Textile. Please run:'
+        STDERR.puts '  $ [sudo] gem install RedCloth'
+        raise FatalException.new("Missing dependency: RedCloth")
+      end
+
+      def matches(ext)
+        rgx = '(' + @config['textile_ext'].gsub(',','|') +')'
+        ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
+      end
+
+      def output_ext(ext)
+        ".html"
+      end
+
+      def convert(content)
+        setup
+
+        # Shortcut if config doesn't contain RedCloth section
+        return RedCloth.new(content).to_html if @config['redcloth'].nil?
+
+        # List of attributes defined on RedCloth
+        # (from http://redcloth.rubyforge.org/classes/RedCloth/TextileDoc.html)
+        attrs = ['filter_classes', 'filter_html', 'filter_ids', 'filter_styles',
+                'hard_breaks', 'lite_mode', 'no_span_caps', 'sanitize_html']
+
+        r = RedCloth.new(content)
+
+        # Set attributes in r if they are NOT nil in the config
+        attrs.each do |attr|
+          r.instance_variable_set("@#{attr}".to_sym, @config['redcloth'][attr]) unless @config['redcloth'][attr].nil?
+        end
+
+        r.to_html
+      end
+    end
+  end
+end

data/lib/tigefa/convertible.rb

@@ -0,0 +1,174 @@
+# encoding: UTF-8
+
+require 'set'
+
+# Convertible provides methods for converting a pagelike item
+# from a certain type of markup into actual content
+#
+# Requires
+#   self.site -> Tigefa::Site
+#   self.content
+#   self.content=
+#   self.data=
+#   self.ext=
+#   self.output=
+#   self.name
+module Tigefa
+  module Convertible
+    # Returns the contents as a String.
+    def to_s
+      self.content || ''
+    end
+
+    # Returns merged optin hash for File.read of self.site (if exists)
+    # and a given param
+    def merged_file_read_opts(opts)
+      (self.site ? self.site.file_read_opts : {}).merge(opts)
+    end
+
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    # opts - optional parameter to File.read, default at site configs
+    #
+    # Returns nothing.
+    def read_yaml(base, name, opts = {})
+      begin
+        self.content = File.read_with_options(File.join(base, name),
+                                              merged_file_read_opts(opts))
+        if self.content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+          self.content = $POSTMATCH
+          self.data = YAML.safe_load($1)
+        end
+      rescue SyntaxError => e
+        puts "YAML Exception reading #{File.join(base, name)}: #{e.message}"
+      rescue Exception => e
+        puts "Error reading file #{File.join(base, name)}: #{e.message}"
+      end
+
+      self.data ||= {}
+    end
+
+    # Transform the contents based on the content type.
+    #
+    # Returns nothing.
+    def transform
+      self.content = converter.convert(self.content)
+    rescue => e
+      Tigefa.logger.error "Conversion error:", "There was an error converting" +
+        " '#{self.path}'."
+      raise e
+    end
+
+    # Determine the extension depending on content_type.
+    #
+    # Returns the String extension for the output file.
+    #   e.g. ".html" for an HTML output file.
+    def output_ext
+      converter.output_ext(self.ext)
+    end
+
+    # Determine which converter to use based on this convertible's
+    # extension.
+    #
+    # Returns the Converter instance.
+    def converter
+      @converter ||= self.site.converters.find { |c| c.matches(self.ext) }
+    end
+
+    # Render Liquid in the content
+    #
+    # content - the raw Liquid content to render
+    # payload - the payload for Liquid
+    # info    - the info for Liquid
+    #
+    # Returns the converted content
+    def render_liquid(content, payload, info, path = nil)
+      Liquid::Template.parse(content).render!(payload, info)
+    rescue Tags::IncludeTagError => e
+      Tigefa.logger.error "Liquid Exception:", "#{e.message} in #{e.path}, included in #{path || self.path}"
+      raise e
+    rescue Exception => e
+      Tigefa.logger.error "Liquid Exception:", "#{e.message} in #{path || self.path}"
+      raise e
+    end
+
+    # Convert this Convertible's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Convertible.
+    def to_liquid(attrs = nil)
+      further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map { |attribute|
+        [attribute, send(attribute)]
+      }]
+      data.deep_merge(further_data)
+    end
+
+    # Recursively render layouts
+    #
+    # layouts - a list of the layouts
+    # payload - the payload for Liquid
+    # info    - the info for Liquid
+    #
+    # Returns nothing
+    def render_all_layouts(layouts, payload, info)
+      # recursively render layouts
+      layout = layouts[self.data["layout"]]
+      used = Set.new([layout])
+
+      while layout
+        payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
+
+        self.output = self.render_liquid(layout.content,
+                                         payload,
+                                         info,
+                                         File.join(self.site.config['layouts'], layout.name))
+
+        if layout = layouts[layout.data["layout"]]
+          if used.include?(layout)
+            layout = nil # avoid recursive chain
+          else
+            used << layout
+          end
+        end
+      end
+    end
+
+    # Add any necessary layouts to this convertible document.
+    #
+    # payload - The site payload Hash.
+    # layouts - A Hash of {"name" => "layout"}.
+    #
+    # Returns nothing.
+    def do_layout(payload, layouts)
+      info = { :filters => [Tigefa::Filters], :registers => { :site => self.site, :page => payload['page'] } }
+
+      # render and transform content (this becomes the final content of the object)
+      payload["pygments_prefix"] = converter.pygments_prefix
+      payload["pygments_suffix"] = converter.pygments_suffix
+
+      self.content = self.render_liquid(self.content,
+                                        payload,
+                                        info)
+      self.transform
+
+      # output keeps track of what will finally be written
+      self.output = self.content
+
+      self.render_all_layouts(layouts, payload, info)
+    end
+
+    # Write the generated page file to the destination directory.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns nothing.
+    def write(dest)
+      path = destination(dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'wb') do |f|
+        f.write(self.output)
+      end
+    end
+  end
+end

data/lib/tigefa/core_ext.rb

@@ -0,0 +1,90 @@
+class Hash
+  # Merges self with another hash, recursively.
+  #
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  #
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+
+      target[key] = hash[key]
+    end
+
+    target
+  end
+
+  # Read array from the supplied hash favouring the singular key
+  # and then the plural key, and handling any nil entries.
+  #   +hash+ the hash to read from
+  #   +singular_key+ the singular key
+  #   +plural_key+ the plural key
+  #
+  # Returns an array
+  def pluralized_array(singular_key, plural_key)
+    hash = self
+    if hash.has_key?(singular_key)
+      array = [hash[singular_key]] if hash[singular_key]
+    elsif hash.has_key?(plural_key)
+      case hash[plural_key]
+      when String
+        array = hash[plural_key].split
+      when Array
+        array = hash[plural_key].compact
+      end
+    end
+    array || []
+  end
+
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+end
+
+# Thanks, ActiveSupport!
+class Date
+  # Converts datetime to an appropriate format for use in XML
+  def xmlschema
+    strftime("%Y-%m-%dT%H:%M:%S%Z")
+  end if RUBY_VERSION < '1.9'
+end
+
+module Enumerable
+  # Returns true if path matches against any glob pattern.
+  # Look for more detail about glob pattern in method File::fnmatch.
+  def glob_include?(e)
+    any? { |exp| File.fnmatch?(exp, e) }
+  end
+end
+
+# Ruby 1.8's File.read don't support option.
+# read_with_options ignore optional parameter for 1.8,
+# and act as alias for 1.9 or later.
+class File
+  if RUBY_VERSION < '1.9'
+    def self.read_with_options(path, opts = {})
+      self.read(path)
+    end
+
+    def self.realpath(filename)
+      Pathname.new(filename).realpath.to_s
+    end
+  else
+    def self.read_with_options(path, opts = {})
+      self.read(path, opts)
+    end
+  end
+end

data/lib/tigefa/deprecator.rb

@@ -0,0 +1,36 @@
+module Tigefa
+  class Deprecator
+    def self.process(args)
+      no_subcommand(args)
+      arg_is_present? args, "--server", "The --server command has been replaced by the \
+                          'serve' subcommand."
+      arg_is_present? args, "--no-server", "To build Tigefa without launching a server, \
+                          use the 'build' subcommand."
+      arg_is_present? args, "--auto", "The switch '--auto' has been replaced with '--watch'."
+      arg_is_present? args, "--no-auto", "To disable auto-replication, simply leave off \
+                          the '--watch' switch."
+      arg_is_present? args, "--pygments", "The 'pygments' setting can only be set in \
+                          your config files."
+      arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in your \
+                          config files."
+      arg_is_present? args, "--url", "The 'url' setting can only be set in your config files."
+    end
+
+    def self.no_subcommand(args)
+      if args.size > 0 && args.first =~ /^--/ && !%w[--help --version].include?(args.first)
+        Tigefa.logger.error "Deprecation:", "Tigefa now uses subcommands instead of just \
+                            switches. Run `jekyll help' to find out more."
+      end
+    end
+
+    def self.arg_is_present?(args, deprecated_argument, message)
+      if args.include?(deprecated_argument)
+        deprecation_message(message)
+      end
+    end
+
+    def self.deprecation_message(message)
+      Tigefa.logger.error "Deprecation:", message
+    end
+  end
+end

data/lib/tigefa/draft.rb

@@ -0,0 +1,35 @@
+module Tigefa
+
+  class Draft < Post
+
+    # Valid post name regex (no date)
+    MATCHER = /^(.*)(\.[^.]+)$/
+
+    # Draft name validator. Draft filenames must be like:
+    # my-awesome-post.textile
+    #
+    # Returns true if valid, false if not.
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+
+    # Get the full path to the directory containing the draft files
+    def containing_dir(source, dir)
+      File.join(source, dir, '_drafts')
+    end
+
+    # Extract information from the post filename.
+    #
+    # name - The String filename of the post file.
+    #
+    # Returns nothing.
+    def process(name)
+      m, slug, ext = *name.match(MATCHER)
+      self.date = File.mtime(File.join(@base, name))
+      self.slug = slug
+      self.ext = ext
+    end
+
+  end
+
+end

data/lib/tigefa/entry_filter.rb

@@ -0,0 +1,35 @@
+class EntryFilter
+  attr_reader :site
+  def initialize(site)
+    @site = site
+  end
+
+  def filter(entries)
+    entries.reject do |e|
+      unless included?(e)
+        special?(e) || backup?(e) || excluded?(e) || symlink?(e)
+      end
+    end
+  end
+
+  def included?(entry)
+    site.include.glob_include?(entry)
+  end
+
+  def special?(entry)
+    ['.', '_', '#'].include?(entry[0..0])
+  end
+
+  def backup?(entry)
+    entry[-1..-1] == '~'
+  end
+
+  def excluded?(entry)
+    site.exclude.glob_include?(entry)
+  end
+
+  def symlink?(entry)
+    File.symlink?(entry) && site.safe
+  end
+
+end

data/lib/tigefa/errors.rb

@@ -0,0 +1,4 @@
+module Tigefa
+  class FatalException < StandardError
+  end
+end

data/lib/tigefa/excerpt.rb

@@ -0,0 +1,113 @@
+module Tigefa
+  class Excerpt
+    include Convertible
+
+    attr_accessor :post
+    attr_accessor :content, :output, :ext
+
+    # Initialize this Post instance.
+    #
+    # site       - The Site.
+    # base       - The String path to the dir containing the post file.
+    # name       - The String filename of the post file.
+    #
+    # Returns the new Post.
+    def initialize(post)
+      self.post = post
+      self.content = extract_excerpt(post.content)
+    end
+
+    %w[site name ext].each do |meth|
+      define_method(meth) do
+        post.send(meth)
+      end
+    end
+
+    def to_liquid
+      post.to_liquid(Post::EXCERPT_ATTRIBUTES_FOR_LIQUID)
+    end
+
+    # Fetch YAML front-matter data from related post, without layout key
+    #
+    # Returns Hash of post data
+    def data
+      @data ||= post.data.dup
+      @data.delete("layout")
+      @data
+    end
+
+    # 'Path' of the excerpt.
+    # 
+    # Returns the path for the post this excerpt belongs to with #excerpt appended
+    def path
+      File.join(post.path, "#excerpt")
+    end
+
+    # Check if excerpt includes a string
+    #
+    # Returns true if the string passed in 
+    def include?(something)
+      (self.output && self.output.include?(something)) || self.content.include?(something)
+    end
+
+    # The UID for this post (useful in feeds).
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns the String UID.
+    def id
+      File.join(post.dir, post.slug, "#excerpt")
+    end
+
+    def to_s
+      self.output || self.content
+    end
+
+    # Returns the shorthand String identifier of this Post.
+    def inspect
+      "<Excerpt: #{self.id}>"
+    end
+
+    protected
+
+    # Internal: Extract excerpt from the content
+    #
+    # By default excerpt is your first paragraph of a post: everything before
+    # the first two new lines:
+    #
+    #     ---
+    #     title: Example
+    #     ---
+    #
+    #     First paragraph with [link][1].
+    #
+    #     Second paragraph.
+    #
+    #     [1]: http://example.com/
+    #
+    # This is fairly good option for Markdown and Textile files. But might cause
+    # problems for HTML posts (which is quite unusual for Jekyll). If default
+    # excerpt delimiter is not good for you, you might want to set your own via
+    # configuration option `excerpt_separator`. For example, following is a good
+    # alternative for HTML posts:
+    #
+    #     # file: _config.yml
+    #     excerpt_separator: "<!-- more -->"
+    #
+    # Notice that all markdown-style link references will be appended to the
+    # excerpt. So the example post above will have this excerpt source:
+    #
+    #     First paragraph with [link][1].
+    #
+    #     [1]: http://example.com/
+    #
+    # Excerpts are rendered same time as content is rendered.
+    #
+    # Returns excerpt String
+    def extract_excerpt(post_content)
+      separator     = site.config['excerpt_separator']
+      head, _, tail = post_content.partition(separator)
+
+      "" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n")
+    end
+  end
+end