moft 1.0.0

data/lib/moft/logger.rb

@@ -0,0 +1,52 @@
+module Moft
+  module Logger
+    # Public: Print a moft message to stdout
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def self.info(topic, message)
+      $stdout.puts message(topic, message)
+    end
+
+    # Public: Print a moft message to stderr
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def self.warn(topic, message)
+      $stderr.puts message(topic, message).yellow
+    end
+
+    # Public: Print a moft error message to stderr
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns nothing
+    def self.error(topic, message)
+      $stderr.puts message(topic, message).red
+    end
+
+    # Public: Build a Moft topic method
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    # message - the message detail
+    #
+    # Returns the formatted message
+    def self.message(topic, message)
+       formatted_topic(topic) + message.gsub(/\s+/, ' ')
+    end
+
+    # Public: Format the topic
+    #
+    # topic - the topic of the message, e.g. "Configuration file", "Deprecation", etc.
+    #
+    # Returns the formatted topic statement
+    def self.formatted_topic(topic)
+      "#{topic} ".rjust(20)
+    end
+  end
+end

data/lib/moft/mime.types

@@ -0,0 +1,85 @@
+# These are the same MIME types that GitHub Pages uses as of 17 Mar 2013.
+
+text/html                             html htm shtml
+text/css                              css
+text/xml                              xml rss xsl
+image/gif                             gif
+image/jpeg                            jpeg jpg
+application/x-javascript              js
+application/atom+xml                  atom
+
+text/mathml                           mml
+text/plain                            txt
+text/vnd.sun.j2me.app-descriptor      jad
+text/vnd.wap.wml                      wml
+text/x-component                      htc
+text/cache-manifest                   manifest appcache
+text/coffeescript                     coffee
+text/plain                            pde
+text/plain                            md markdown
+
+image/png                             png
+image/svg+xml                         svg
+image/tiff                            tif tiff
+image/vnd.wap.wbmp                    wbmp
+image/x-icon                          ico
+image/x-jng                           jng
+image/x-ms-bmp                        bmp
+
+application/json                      json
+application/java-archive              jar ear
+application/mac-binhex40              hqx
+application/msword                    doc
+application/pdf                       pdf
+application/postscript                ps eps ai
+application/rdf+xml                   rdf
+application/rtf                       rtf
+text/vcard                            vcf vcard
+application/vnd.apple.pkpass          pkpass
+application/vnd.ms-excel              xls
+application/vnd.ms-powerpoint         ppt
+application/vnd.wap.wmlc              wmlc
+application/xhtml+xml                 xhtml
+application/x-chrome-extension        crx
+application/x-cocoa                   cco
+application/x-font-ttf                ttf
+application/x-java-archive-diff       jardiff
+application/x-java-jnlp-file          jnlp
+application/x-makeself                run
+application/x-ns-proxy-autoconfig     pac
+application/x-perl                    pl pm
+application/x-pilot                   prc pdb
+application/x-rar-compressed          rar
+application/x-redhat-package-manager  rpm
+application/x-sea                     sea
+application/x-shockwave-flash         swf
+application/x-stuffit                 sit
+application/x-tcl                     tcl tk
+application/x-web-app-manifest+json   webapp
+application/x-x509-ca-cert            der pem crt
+application/x-xpinstall               xpi
+application/x-zip                     war
+application/zip                       zip
+
+application/octet-stream              bin exe dll
+application/octet-stream              deb
+application/octet-stream              dmg
+application/octet-stream              eot
+application/octet-stream              iso img
+application/octet-stream              msi msp msm
+
+audio/midi                            mid midi kar
+audio/mpeg                            mp3
+audio/x-realaudio                     ra
+audio/ogg                             ogg
+
+video/3gpp                            3gpp 3gp
+video/mpeg                            mpeg mpg
+video/quicktime                       mov
+video/x-flv                           flv
+video/x-mng                           mng
+video/x-ms-asf                        asx asf
+video/x-ms-wmv                        wmv
+video/x-msvideo                       avi
+video/ogg                             ogv
+video/webm                            webm

data/lib/moft/page.rb

@@ -0,0 +1,147 @@
+module Moft
+  class Page
+    include Convertible
+
+    attr_writer :dir
+    attr_accessor :site, :pager
+    attr_accessor :name, :ext, :basename
+    attr_accessor :data, :content, :output
+
+    # Initialize a new Page.
+    #
+    # site - The Site object.
+    # base - The String path to the source.
+    # dir  - The String path between the source and the file.
+    # name - The String filename of the file.
+    def initialize(site, base, dir, name)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = name
+
+      self.process(name)
+      self.read_yaml(File.join(base, dir), name)
+    end
+
+    # The generated directory into which the page will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, we be '/'
+    #
+    # Returns the String destination directory.
+    def dir
+      url[-1, 1] == '/' ? url : File.dirname(url)
+    end
+
+    # The full path and filename of the post. Defined in the YAML of the post
+    # body.
+    #
+    # Returns the String permalink or nil if none has been set.
+    def permalink
+      self.data && self.data['permalink']
+    end
+
+    # The template of the permalink.
+    #
+    # Returns the template String.
+    def template
+      if self.site.permalink_style == :pretty
+        if index? && html?
+          "/:path/"
+        elsif html?
+          "/:path/:basename/"
+        else
+          "/:path/:basename:output_ext"
+        end
+      else
+        "/:path/:basename:output_ext"
+      end
+    end
+
+    # The generated relative url of this page. e.g. /about.html.
+    #
+    # Returns the String url.
+    def url
+      return @url if @url
+
+      url = if permalink
+        permalink
+      else
+        {
+          "path"       => @dir,
+          "basename"   => self.basename,
+          "output_ext" => self.output_ext,
+        }.inject(template) { |result, token|
+          result.gsub(/:#{token.first}/, token.last)
+        }.gsub(/\/\//, "/")
+      end
+
+      # sanitize url
+      @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
+      @url += "/" if url =~ /\/$/
+      @url
+    end
+
+    # Extract information from the page filename.
+    #
+    # name - The String filename of the page file.
+    #
+    # Returns nothing.
+    def process(name)
+      self.ext = File.extname(name)
+      self.basename = name[0 .. -self.ext.length-1]
+    end
+
+    # Add any necessary layouts to this post
+    #
+    # layouts      - The Hash of {"name" => "layout"}.
+    # site_payload - The site payload Hash.
+    #
+    # Returns nothing.
+    def render(layouts, site_payload)
+      payload = {
+        "page" => self.to_liquid,
+        'paginator' => pager.to_liquid
+      }.deep_merge(site_payload)
+
+      do_layout(payload, layouts)
+    end
+
+    # Convert this Page's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Page.
+    def to_liquid
+      self.data.deep_merge({
+        "url"        => self.url,
+        "content"    => self.content,
+        "path"       => self.data['path'] || File.join(@dir, @name).sub(/\A\//, '') })
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns the destination file path String.
+    def destination(dest)
+      # The url needs to be unescaped in order to preserve the correct
+      # filename.
+      path = File.join(dest, CGI.unescape(self.url))
+      path = File.join(path, "index.html") if self.url =~ /\/$/
+      path
+    end
+
+    # Returns the object as a debug String.
+    def inspect
+      "#<Moft:Page @name=#{self.name.inspect}>"
+    end
+
+    # Returns the Boolean of whether this Page is HTML or not.
+    def html?
+      output_ext == '.html'
+    end
+
+    # Returns the Boolean of whether this Page is an index file or not.
+    def index?
+      basename == 'index'
+    end
+  end
+end

data/lib/moft/plugin.rb

@@ -0,0 +1,75 @@
+module Moft
+  class Plugin
+    PRIORITIES = { :lowest => -100,
+                   :low => -10,
+                   :normal => 0,
+                   :high => 10,
+                   :highest => 100 }
+
+    # Install a hook so that subclasses are recorded. This method is only
+    # ever called by Ruby itself.
+    #
+    # base - The Class subclass.
+    #
+    # Returns nothing.
+    def self.inherited(base)
+      subclasses << base
+      subclasses.sort!
+    end
+
+    # The list of Classes that have been subclassed.
+    #
+    # Returns an Array of Class objects.
+    def self.subclasses
+      @subclasses ||= []
+    end
+
+    # Get or set the priority of this plugin. When called without an
+    # argument it returns the priority. When an argument is given, it will
+    # set the priority.
+    #
+    # priority - The Symbol priority (default: nil). Valid options are:
+    #            :lowest, :low, :normal, :high, :highest
+    #
+    # Returns the Symbol priority.
+    def self.priority(priority = nil)
+      @priority ||= nil
+      if priority && PRIORITIES.has_key?(priority)
+        @priority = priority
+      end
+      @priority || :normal
+    end
+
+    # Get or set the safety of this plugin. When called without an argument
+    # it returns the safety. When an argument is given, it will set the
+    # safety.
+    #
+    # safe - The Boolean safety (default: nil).
+    #
+    # Returns the safety Boolean.
+    def self.safe(safe = nil)
+      if safe
+        @safe = safe
+      end
+      @safe || false
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # other - The class to be compared.
+    #
+    # Returns -1, 0, 1.
+    def self.<=>(other)
+      PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+    end
+
+    # Initialize a new plugin. This should be overridden by the subclass.
+    #
+    # config - The Hash of configuration options.
+    #
+    # Returns a new instance.
+    def initialize(config = {})
+      # no-op for default
+    end
+  end
+end

data/lib/moft/post.rb

@@ -0,0 +1,377 @@
+module Moft
+  class Post
+    include Comparable
+    include Convertible
+
+    class << self
+      attr_accessor :lsi
+    end
+
+    # Valid post name regex.
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = %w[
+      title
+      url
+      date
+      id
+      categories
+      next
+      previous
+      tags
+      content
+      excerpt
+      path
+    ]
+
+    # Post name validator. Post filenames must be like:
+    # 2008-11-05-my-awesome-post.textile
+    #
+    # Returns true if valid, false if not.
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+
+    attr_accessor :site
+    attr_accessor :data, :extracted_excerpt, :content, :output, :ext
+    attr_accessor :date, :slug, :published, :tags, :categories
+
+    attr_reader :name
+
+    # 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(site, source, dir, name)
+      @site = site
+      @dir = dir
+      @base = self.containing_dir(source, dir)
+      @name = name
+
+      self.categories = dir.downcase.split('/').reject { |x| x.empty? }
+      self.process(name)
+      self.read_yaml(@base, name)
+
+      if self.data.has_key?('date')
+        self.date = Time.parse(self.data["date"].to_s)
+      end
+
+      self.published = self.published?
+
+      self.populate_categories
+      self.populate_tags
+    end
+
+    def published?
+      if self.data.has_key?('published') && self.data['published'] == false
+        false
+      else
+        true
+      end
+    end
+
+    def populate_categories
+      if self.categories.empty?
+        self.categories = self.data.pluralized_array('category', 'categories').map {|c| c.downcase}
+      end
+      self.categories.flatten!
+    end
+
+    def populate_tags
+      self.tags = self.data.pluralized_array("tag", "tags").flatten
+    end
+
+    # Get the full path to the directory containing the post files
+    def containing_dir(source, dir)
+      return File.join(source, dir, '_posts')
+    end
+
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      super(base, name)
+      self.extracted_excerpt = self.extract_excerpt
+    end
+
+    # The post excerpt. This is either a custom excerpt
+    # set in YAML front matter or the result of extract_excerpt.
+    #
+    # Returns excerpt string.
+    def excerpt
+      if self.data.has_key? 'excerpt'
+        self.data['excerpt']
+      else
+        self.extracted_excerpt
+      end
+    end
+
+    # Public: the Post title, from the YAML Front-Matter or from the slug
+    #
+    # Returns the post title
+    def title
+      self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' ')
+    end
+
+    # Public: the path to the post relative to the site source,
+    #         from the YAML Front-Matter or from a combination of
+    #         the directory it's in, "_posts", and the name of the
+    #         post file
+    #
+    # Returns the path to the file relative to the site source
+    def path
+      self.data['path'] || File.join(@dir, '_posts', @name).sub(/\A\//, '')
+    end
+
+    # Compares Post objects. First compares the Post date. If the dates are
+    # equal, it compares the Post slugs.
+    #
+    # other - The other Post we are comparing to.
+    #
+    # Returns -1, 0, 1
+    def <=>(other)
+      cmp = self.date <=> other.date
+      if 0 == cmp
+       cmp = self.slug <=> other.slug
+      end
+      return cmp
+    end
+
+    # Extract information from the post filename.
+    #
+    # name - The String filename of the post file.
+    #
+    # Returns nothing.
+    def process(name)
+      m, cats, date, slug, ext = *name.match(MATCHER)
+      self.date = Time.parse(date)
+      self.slug = slug
+      self.ext = ext
+    rescue ArgumentError
+      raise FatalException.new("Post #{name} does not have a valid date.")
+    end
+
+    # Transform the contents and excerpt based on the content type.
+    #
+    # Returns nothing.
+    def transform
+      super
+      self.extracted_excerpt = converter.convert(self.extracted_excerpt)
+    end
+
+    # The generated directory into which the post will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, set to the default date
+    # e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing.
+    #
+    # Returns the String directory.
+    def dir
+      File.dirname(url)
+    end
+
+    # The full path and filename of the post. Defined in the YAML of the post
+    # body (optional).
+    #
+    # Returns the String permalink.
+    def permalink
+      self.data && self.data['permalink']
+    end
+
+    def template
+      case self.site.permalink_style
+      when :pretty
+        "/:categories/:year/:month/:day/:title/"
+      when :none
+        "/:categories/:title.html"
+      when :date
+        "/:categories/:year/:month/:day/:title.html"
+      when :ordinal
+        "/:categories/:year/:y_day/:title.html"
+      else
+        self.site.permalink_style.to_s
+      end
+    end
+
+    # The generated relative url of this post.
+    # e.g. /2008/11/05/my-awesome-post.html
+    #
+    # Returns the String URL.
+    def url
+      return @url if @url
+
+      url = if permalink
+        permalink
+      else
+        {
+          "year"       => date.strftime("%Y"),
+          "month"      => date.strftime("%m"),
+          "day"        => date.strftime("%d"),
+          "title"      => CGI.escape(slug),
+          "i_day"      => date.strftime("%d").to_i.to_s,
+          "i_month"    => date.strftime("%m").to_i.to_s,
+          "categories" => categories.map { |c| URI.escape(c.to_s) }.join('/'),
+          "short_month" => date.strftime("%b"),
+          "y_day"      => date.strftime("%j"),
+          "output_ext" => self.output_ext
+        }.inject(template) { |result, token|
+          result.gsub(/:#{Regexp.escape token.first}/, token.last)
+        }.gsub(/\/\//, "/")
+      end
+
+      # sanitize url
+      @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
+      @url += "/" if url =~ /\/$/
+      @url
+    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(self.dir, self.slug)
+    end
+
+    # Calculate related posts.
+    #
+    # Returns an Array of related Posts.
+    def related_posts(posts)
+      return [] unless posts.size > 1
+
+      if self.site.lsi
+        build_index
+
+        related = self.class.lsi.find_related(self.content, 11)
+        related - [self]
+      else
+        (posts - [self])[0..9]
+      end
+    end
+
+    def build_index
+      
+#      self.class.lsi ||= begin
+#        puts "Starting the classifier..."
+#        lsi = Classifier::LSI.new(:auto_rebuild => false)
+#        $stdout.print("  Populating LSI... "); $stdout.flush
+#        posts.each { |x| $stdout.print("."); $stdout.flush; lsi.add_item(x) }
+#        $stdout.print("\n  Rebuilding LSI index... ")
+#        lsi.build_index
+#        puts ""
+#        lsi
+#      end
+    end
+
+    # Add any necessary layouts to this post.
+    #
+    # layouts      - A Hash of {"name" => "layout"}.
+    # site_payload - The site payload hash.
+    #
+    # Returns nothing.
+    def render(layouts, site_payload)
+      # construct payload
+      payload = {
+        "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
+        "page" => self.to_liquid
+      }.deep_merge(site_payload)
+
+      do_layout(payload, layouts)
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path String.
+    def destination(dest)
+      # The url needs to be unescaped in order to preserve the correct filename
+      path = File.join(dest, CGI.unescape(self.url))
+      path = File.join(path, "index.html") if template[/\.html$/].nil?
+      path
+    end
+
+    # Convert this post into a Hash for use in Liquid templates.
+    #
+    # Returns the representative Hash.
+    def to_liquid
+      further_data = Hash[ATTRIBUTES_FOR_LIQUID.map { |attribute|
+        [attribute, send(attribute)]
+      }]
+      data.deep_merge(further_data)
+    end
+
+    # Returns the shorthand String identifier of this Post.
+    def inspect
+      "<Post: #{self.id}>"
+    end
+
+    def next
+      pos = self.site.posts.index(self)
+
+      if pos && pos < self.site.posts.length-1
+        self.site.posts[pos+1]
+      else
+        nil
+      end
+    end
+
+    def previous
+      pos = self.site.posts.index(self)
+      if pos && pos > 0
+        self.site.posts[pos-1]
+      else
+        nil
+      end
+    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 Moft). 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
+      separator     = self.site.config['excerpt_separator']
+      head, _, tail = self.content.partition(separator)
+
+      "" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n")
+    end
+  end
+end