monad 0.0.2 → 0.0.3

data/lib/jekyll/deprecator.rb

@@ -0,0 +1,36 @@
+module Jekyll
+  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 Jekyll 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)
+        Jekyll.logger.error "Deprecation:", "Jekyll 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)
+      Jekyll.logger.error "Deprecation:", message
+    end
+  end
+end

data/lib/{monad → jekyll}/draft.rb

@@ -1,4 +1,4 @@
-module Monad
+module Jekyll
 
   class Draft < Post
 

data/lib/{monad → jekyll}/drivers/json_driver.rb

@@ -3,7 +3,7 @@ require 'uri'
 require 'net/http'
 require 'net/https' # ruby 1.8.7 requires explicitly require net/https
 
-module Monad
+module Jekyll
   module Drivers
     class JsonDriver
       def initialize(options)

data/lib/{monad → jekyll}/drivers/yaml_driver.rb

@@ -1,6 +1,6 @@
 require 'safe_yaml'
 
-module Monad
+module Jekyll
   module Drivers
     class YamlDriver
       def initialize(options)

data/lib/{monad → jekyll}/errors.rb

@@ -1,4 +1,4 @@
-module Monad
+module Jekyll
   class FatalException < StandardError
   end
 end

data/lib/jekyll/excerpt.rb

@@ -0,0 +1,113 @@
+module Jekyll
+  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

data/lib/{monad → jekyll}/filters.rb

@@ -1,6 +1,6 @@
 require 'uri'
 
-module Monad
+module Jekyll
   module Filters
     # Convert a Textile string into HTML output.
     #
@@ -9,7 +9,7 @@ module Monad
     # Returns the HTML formatted String.
     def textilize(input)
       site = @context.registers[:site]
-      converter = site.getConverterImpl(Monad::Converters::Textile)
+      converter = site.getConverterImpl(Jekyll::Converters::Textile)
       converter.convert(input)
     end
 
@@ -20,7 +20,7 @@ module Monad
     # Returns the HTML formatted String.
     def markdownify(input)
       site = @context.registers[:site]
-      converter = site.getConverterImpl(Monad::Converters::Markdown)
+      converter = site.getConverterImpl(Jekyll::Converters::Markdown)
       converter.convert(input)
     end
 
@@ -99,7 +99,17 @@ module Monad
     def cgi_escape(input)
       CGI::escape(input)
     end
-
+    
+    # URI escape a string.
+    #
+    # input - The String to escape.
+    #
+    # Examples
+    #
+    #   uri_escape('foo, bar \\baz?')
+    #   # => "foo,%20bar%20%5Cbaz?"
+    #
+    # Returns the escaped String.
     def uri_escape(input)
       URI.escape(input)
     end
@@ -140,7 +150,7 @@ module Monad
 
     # Convert the input into json string
     #
-    # input - The Array of Hash to be converted
+    # input - The Array or Hash to be converted
     #
     # Returns the converted json string
     def json(input)
@@ -155,7 +165,7 @@ module Monad
       when String
         Time.parse(input)
       else
-        Monad::Logger.error "Invalid Date:", "'#{input}' is not a valid datetime."
+        Jekyll.logger.error "Invalid Date:", "'#{input}' is not a valid datetime."
         exit(1)
       end
     end

data/lib/{monad → jekyll}/generator.rb

@@ -1,4 +1,4 @@
-module Monad
+module Jekyll
   class Generator < Plugin
   end
 end

data/lib/jekyll/generators/pagination.rb

@@ -0,0 +1,214 @@
+module Jekyll
+  module Generators
+    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)
+        if Pager.pagination_enabled?(site)
+          if template = template_page(site)
+            paginate(site, template)
+          else
+            Jekyll.logger.warn "Pagination:", "Pagination is enabled, but I couldn't find" +
+            "an index.html page to use as the pagination template. Skipping pagination."
+          end
+        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)
+        (1..pages).each do |num_page|
+          pager = Pager.new(site, num_page, all_posts, pages)
+          if num_page > 1
+            newpage = Page.new(site, site.source, page.dir, page.name)
+            newpage.pager = pager
+            newpage.dir = Pager.paginate_path(site, num_page)
+            site.pages << newpage
+          else
+            page.pager = pager
+          end
+        end
+      end
+
+      # Static: Fetch the URL of the template page. Used to determine the
+      #         path to the first pager in the series.
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns the url of the template page
+      def self.first_page_url(site)
+        if page = Pagination.new.template_page(site)
+          page.url
+        else
+          nil
+        end
+      end
+
+      # Public: Find the Jekyll::Page which will act as the pager template
+      #
+      # site - the Jekyll::Site object
+      #
+      # Returns the Jekyll::Page which will act as the pager template
+      def template_page(site)
+        site.pages.dup.select do |page|
+          Pager.pagination_candidate?(site.config, page)
+        end.sort do |one, two|
+          two.path.size <=> one.path.size
+        end.first
+      end
+    end
+  end
+
+  class Pager
+    attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
+      :previous_page, :previous_page_path, :next_page, :next_page_path
+
+    # 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 the site.
+    #
+    # site - the Jekyll::Site object
+    #
+    # Returns true if pagination is enabled, false otherwise.
+    def self.pagination_enabled?(site)
+     !site.config['paginate'].nil? &&
+       site.pages.size > 0
+    end
+
+    # Static: Determine if a page is a possible candidate to be a template page.
+    #         Page's name must be `index.html` and exist in any of the directories
+    #         between the site source and `paginate_path`.
+    #
+    # config - the site configuration hash
+    # page   - the Jekyll::Page about which we're inquiring
+    #
+    # Returns true if the
+    def self.pagination_candidate?(config, page)
+      page_dir = File.dirname(File.expand_path(remove_leading_slash(page.path), config['source']))
+      paginate_path = remove_leading_slash(config['paginate_path'])
+      paginate_path = File.expand_path(paginate_path, config['source'])
+      page.name == 'index.html' &&
+        in_hierarchy(config['source'], page_dir, File.dirname(paginate_path))
+    end
+
+    # Determine if the subdirectories of the two paths are the same relative to source
+    #
+    # source        - the site source
+    # page_dir      - the directory of the Jekyll::Page
+    # paginate_path - the absolute paginate path (from root of FS)
+    #
+    # Returns whether the subdirectories are the same relative to source
+    def self.in_hierarchy(source, page_dir, paginate_path)
+      return false if paginate_path == File.dirname(paginate_path)
+      return false if paginate_path == Pathname.new(source).parent
+      page_dir == paginate_path ||
+        in_hierarchy(source, page_dir, File.dirname(paginate_path))
+    end
+
+    # Static: Return the pagination path of the page
+    #
+    # site     - the Jekyll::Site object
+    # num_page - the pagination page number
+    #
+    # Returns the pagination path as a string
+    def self.paginate_path(site, num_page)
+      return nil if num_page.nil?
+      return Generators::Pagination.first_page_url(site) if num_page <= 1
+      format = site.config['paginate_path']
+      format = format.sub(':num', num_page.to_s)
+      ensure_leading_slash(format)
+    end
+
+    # Static: Return a String version of the input which has a leading slash.
+    #         If the input already has a forward slash in position zero, it will be
+    #         returned unchanged.
+    #
+    # path - a String path
+    #
+    # Returns the path with a leading slash
+    def self.ensure_leading_slash(path)
+      path[0..0] == "/" ? path : "/#{path}"
+    end
+
+    # Static: Return a String version of the input without a leading slash.
+    #
+    # path - a String path
+    #
+    # Returns the input without the leading slash
+    def self.remove_leading_slash(path)
+      ensure_leading_slash(path)[1..-1]
+    end
+
+    # Initialize a new Pager.
+    #
+    # site     - the Jekyll::Site object
+    # 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(site, page, all_posts, num_pages = nil)
+      @page = page
+      @per_page = site.config['paginate'].to_i
+      @total_pages = num_pages || Pager.calculate_pages(all_posts, @per_page)
+
+      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 - 1 : nil
+      @previous_page_path = Pager.paginate_path(site, @previous_page)
+      @next_page = @page != @total_pages ? @page + 1 : nil
+      @next_page_path = Pager.paginate_path(site, @next_page)
+    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,
+        'previous_page_path' => previous_page_path,
+        'next_page' => next_page,
+        'next_page_path' => next_page_path
+      }
+    end
+  end
+end