link-checker 0.0.0

data/spec/test-site/plugins/octopress_filters.rb

@@ -0,0 +1,135 @@
+#custom filters for Octopress
+require './plugins/backtick_code_block'
+require './plugins/post_filters'
+require './plugins/raw'
+require './plugins/date'
+require 'rubypants'
+
+module OctopressFilters
+  include BacktickCodeBlock
+  include TemplateWrapper
+  def pre_filter(input)
+    input = render_code_block(input)
+    input.gsub /(<figure.+?>.+?<\/figure>)/m do
+      safe_wrap($1)
+    end
+  end
+  def post_filter(input)
+    input = unwrap(input)
+    RubyPants.new(input).to_html
+  end
+end
+
+module Jekyll
+  class ContentFilters < PostFilter
+    include OctopressFilters
+    def pre_render(post)
+      if post.ext.match('html|textile|markdown|md|haml|slim|xml')
+        post.content = pre_filter(post.content)
+      end
+    end
+    def post_render(post)
+      if post.ext.match('html|textile|markdown|md|haml|slim|xml')
+        post.content = post_filter(post.content)
+      end
+    end
+  end
+end
+
+
+module OctopressLiquidFilters
+  include Octopress::Date
+
+  # Used on the blog index to split posts on the <!--more--> marker
+  def excerpt(input)
+    if input.index(/<!--\s*more\s*-->/i)
+      input.split(/<!--\s*more\s*-->/i)[0]
+    else
+      input
+    end
+  end
+
+  # Checks for excerpts (helpful for template conditionals)
+  def has_excerpt(input)
+    input =~ /<!--\s*more\s*-->/i ? true : false
+  end
+
+  # Summary is used on the Archive pages to return the first block of content from a post.
+  def summary(input)
+    if input.index(/\n\n/)
+      input.split(/\n\n/)[0]
+    else
+      input
+    end
+  end
+
+  # Extracts raw content DIV from template, used for page description as {{ content }}
+  # contains complete sub-template code on main page level
+  def raw_content(input)
+    /<div class="entry-content">(?<content>[\s\S]*?)<\/div>\s*<(footer|\/article)>/ =~ input
+    return (content.nil?) ? input : content
+  end
+
+  # Escapes CDATA sections in post content
+  def cdata_escape(input)
+    input.gsub(/<!\[CDATA\[/, '&lt;![CDATA[').gsub(/\]\]>/, ']]&gt;')
+  end
+
+  # Replaces relative urls with full urls
+  def expand_urls(input, url='')
+    url ||= '/'
+    input.gsub /(\s+(href|src)\s*=\s*["|']{1})(\/[^\"'>]*)/ do
+      $1+url+$3
+    end
+  end
+
+  # Improved version of Liquid's truncate:
+  # - Doesn't cut in the middle of a word.
+  # - Uses typographically correct ellipsis (…) insted of '...'
+  def truncate(input, length)
+    if input.length > length && input[0..(length-1)] =~ /(.+)\b.+$/im
+      $1.strip + ' &hellip;'
+    else
+      input
+    end
+  end
+
+  # Improved version of Liquid's truncatewords:
+  # - Uses typographically correct ellipsis (…) insted of '...'
+  def truncatewords(input, length)
+    truncate = input.split(' ')
+    if truncate.length > length
+      truncate[0..length-1].join(' ').strip + ' &hellip;'
+    else
+      input
+    end
+  end
+
+  # Condenses multiple spaces and tabs into a single space
+  def condense_spaces(input)
+    input.gsub(/\s{2,}/, ' ')
+  end
+
+  # Removes trailing forward slash from a string for easily appending url segments
+  def strip_slash(input)
+    if input =~ /(.+)\/$|^\/$/
+      input = $1
+    end
+    input
+  end
+
+  # Returns a url without the protocol (http://)
+  def shorthand_url(input)
+    input.gsub /(https?:\/\/)(\S+)/ do
+      $2
+    end
+  end
+
+  # Returns a title cased string based on John Gruber's title case http://daringfireball.net/2008/08/title_case_update
+  def titlecase(input)
+    input.titlecase
+  end
+
+end
+Liquid::Template.register_filter OctopressLiquidFilters
+

data/spec/test-site/plugins/pagination.rb

@@ -0,0 +1,121 @@
+module Jekyll
+
+  class Pagination < Generator
+    # This generator is safe from arbitrary code execution.
+    safe true
+
+    # Generate paginated pages if necessary.
+    #
+    # site - The Site.
+    #
+    # Returns nothing.
+    def generate(site)
+      site.pages.dup.each do |page|
+        paginate(site, page) if Pager.pagination_enabled?(site.config, page)
+      end
+    end
+
+    # Paginates the blog's posts. Renders the index.html file into paginated
+    # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
+    # site-wide data.
+    #
+    # site - The Site.
+    # page - The index.html Page that requires pagination.
+    #
+    # {"paginator" => { "page" => <Number>,
+    #                   "per_page" => <Number>,
+    #                   "posts" => [<Post>],
+    #                   "total_posts" => <Number>,
+    #                   "total_pages" => <Number>,
+    #                   "previous_page" => <Number>,
+    #                   "next_page" => <Number> }}
+    def paginate(site, page)
+      all_posts = site.site_payload['site']['posts']
+      pages = Pager.calculate_pages(all_posts, site.config['paginate'].to_i)
+      page_dir = page.destination('').sub(/\/[^\/]+$/, '')
+      page_dir_config = site.config['pagination_dir']
+      dir = ((page_dir_config || page_dir) + '/').sub(/^\/+/, '')
+
+      (1..pages).each do |num_page|
+        pager = Pager.new(site.config, num_page, all_posts, page_dir+'/', '/'+dir, pages)
+        if num_page > 1
+          newpage = Page.new(site, site.source, page_dir, page.name)
+          newpage.pager = pager
+          newpage.dir = File.join(page.dir, "#{dir}page/#{num_page}")
+          site.pages << newpage
+        else
+          page.pager = pager
+        end
+      end
+    end
+  end
+
+  class Pager
+    attr_reader :page, :per_page, :posts, :total_posts, :total_pages, :previous_page, :next_page
+
+    # Calculate the number of pages.
+    #
+    # all_posts - The Array of all Posts.
+    # per_page  - The Integer of entries per page.
+    #
+    # Returns the Integer number of pages.
+    def self.calculate_pages(all_posts, per_page)
+      (all_posts.size.to_f / per_page.to_i).ceil
+    end
+
+    # Determine if pagination is enabled for a given file.
+    #
+    # config - The configuration Hash.
+    # file   - The String filename of the file.
+    #
+    # Returns true if pagination is enabled, false otherwise.
+    def self.pagination_enabled?(config, file)
+      file.name == 'index.html' && !config['paginate'].nil? && file.content =~ /paginator\./
+    end
+
+    # Initialize a new Pager.
+    #
+    # config    - The Hash configuration of the site.
+    # page      - The Integer page number.
+    # all_posts - The Array of all the site's Posts.
+    # num_pages - The Integer number of pages or nil if you'd like the number
+    #             of pages calculated.
+    def initialize(config, page, all_posts, index_dir, pagination_dir, num_pages = nil)
+      @page = page
+      @per_page = config['paginate'].to_i
+      @page_dir = pagination_dir + 'page/'
+      @total_pages = num_pages || Pager.calculate_pages(all_posts, @per_page)
+      @previous_page = nil
+
+      if @page > @total_pages
+        raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
+      end
+
+      init = (@page - 1) * @per_page
+      offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
+
+      @total_posts = all_posts.size
+      @posts = all_posts[init..offset]
+      @previous_page = @page != 1 ? @page_dir + (@page - 1).to_s + '/' : nil
+      @previous_page = index_dir if @page - 1 == 1
+      @next_page = @page != @total_pages ? @page_dir + (@page + 1).to_s + '/' : nil
+    end
+
+    # Convert this Pager's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Pager.
+    def to_liquid
+      {
+        'page' => page,
+        'per_page' => per_page,
+        'posts' => posts,
+        'total_posts' => total_posts,
+        'total_pages' => total_pages,
+        'previous_page' => previous_page,
+        'next_page' => next_page
+      }
+    end
+  end
+
+end
+

data/spec/test-site/plugins/post_filters.rb

@@ -0,0 +1,176 @@
+module Jekyll
+
+  # Extended plugin type that allows the plugin
+  # to be called on varous callback methods.
+  #
+  # Examples:
+  # https://github.com/tedkulp/octopress/blob/master/plugins/post_metaweblog.rb
+  # https://github.com/tedkulp/octopress/blob/master/plugins/post_twitter.rb
+  class PostFilter < Plugin
+
+    #Called before post is sent to the converter. Allows
+    #you to modify the post object before the converter
+    #does it's thing
+    def pre_render(post)
+    end
+
+    #Called after the post is rendered with the converter.
+    #Use the post object to modify it's contents before the
+    #post is inserted into the template.
+    def post_render(post)
+    end
+
+    #Called after the post is written to the disk.
+    #Use the post object to read it's contents to do something
+    #after the post is safely written.
+    def post_write(post)
+    end
+  end
+
+  # Monkey patch for the Jekyll Site class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/site.rb
+  class Site
+
+    # Instance variable to store the various post_filter
+    # plugins that are loaded.
+    attr_accessor :post_filters
+
+    # Instantiates all of the post_filter plugins. This is basically
+    # a duplication of the other loaders in Site#setup.
+    def load_post_filters
+      self.post_filters = Jekyll::PostFilter.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
+      end
+    end
+  end
+
+  # Monkey patch for the Jekyll Post class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/post.rb
+  class Post
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Page class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/page.rb
+  class Page
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Convertible module. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/convertible.rb
+  module Convertible
+
+    def is_post?
+      self.class.to_s == 'Jekyll::Post'
+    end
+
+    def is_page?
+      self.class.to_s == 'Jekyll::Page'
+    end
+
+    def is_filterable?
+      is_post? or is_page?
+    end
+
+    # Call the #pre_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def pre_render
+      self.site.load_post_filters unless self.site.post_filters
+
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.pre_render(self)
+        end
+      end
+    end
+
+    # Call the #post_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_render
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_render(self)
+        end
+      end
+    end
+
+    # Call the #post_write methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_write
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_write(self)
+        end
+      end
+    end
+
+    # Copy the #transform method to #old_transform, so we can
+    # redefine #transform method.
+    alias_method :old_transform, :transform
+
+    # Transform the contents based on the content type. Then calls the
+    # #post_render method if it exists
+    #
+    # Returns nothing.
+    def transform
+      old_transform
+      post_render if respond_to?(:post_render)
+    end
+
+    # Copy the #do_layout method to #old_do_layout, so we can
+    # redefine #do_layout method.
+    alias_method :old_do_layout, :do_layout
+
+    # Calls the pre_render method if it exists and then adds 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)
+      pre_render if respond_to?(:pre_render)
+      old_do_layout(payload, layouts)
+    end
+
+    # Returns the full url of the post, including the
+    # configured url
+    def full_url
+      self.site.config['url'] + self.url
+    end
+  end
+end

data/spec/test-site/plugins/preview_unpublished.rb

@@ -0,0 +1,48 @@
+# Monkeypatch for Jekyll
+# Introduce distinction between preview/productive site generation
+# so posts with YAML attribute `published: false` can be previewed
+# on localhost without being published to the productive environment.
+
+module Jekyll
+
+  class Site
+    # Read all the files in <source>/<dir>/_posts and create a new Post
+    # object with each one.
+    #
+    # dir - The String relative path of the directory to read.
+    #
+    # Returns nothing.
+    def read_posts(dir)
+      base = File.join(self.source, dir, '_posts')
+      return unless File.exists?(base)
+      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+
+      # first pass processes, but does not yet render post content
+      entries.each do |f|
+        if Post.valid?(f)
+          post = Post.new(self, self.source, dir, f)
+
+          # Monkeypatch:
+          # On preview environment (localhost), publish all posts
+          if ENV.has_key?('OCTOPRESS_ENV') && ENV['OCTOPRESS_ENV'] == 'preview' && post.data.has_key?('published') && post.data['published'] == false
+            post.published = true
+            # Set preview mode flag (if necessary), `rake generate` will check for it
+            # to prevent pushing preview posts to productive environment
+            File.open(".preview-mode", "w") {}
+          end
+
+          if post.published && (self.future || post.date <= self.time)
+            self.posts << post
+            post.categories.each { |c| self.categories[c] << post }
+            post.tags.each { |c| self.tags[c] << post }
+          end
+        end
+      end
+
+      self.posts.sort!
+
+      # limit the posts if :limit_posts option is set
+      self.posts = self.posts[-limit_posts, limit_posts] if limit_posts
+    end
+  end
+end