serum 0.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2013 Brad Fults
+
+Jekyll Copyright (c) 2008 Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Serum
+
+Serum is a simple object model on static posts with YAML front matter.
+
+## Usage
+
+Instantiate Serum passing in a directory of files that may or may not have
+YAML front matter:
+
+```irb
+>> site = Serum.for_dir("posts/")
+=> <Site: /Users/bob/posts>
+```
+
+Then ask questions about the posts:
+
+```irb
+>> site.posts.size
+=> 28
+
+>> site.posts.first
+=> <Post: /published>
+
+>> site.posts.first.next
+=> <Post: /foo-bar>
+```
+
+You can also pass in a `'baseurl'` option to `for_dir` in order to get URL
+generation on each of the posts:
+
+```irb
+>> site = Serum.for_dir('posts/', {'baseurl' => '/story'})
+=> <Site: /Users/bob/posts>
+
+>> site.posts.first.url
+=> "/story/published"
+```
+
+It's really that simple. Sometimes you just want a Ruby object model on top of
+a simple directory of posts.
+
+## Author
+
+Maybe more aptly named "deleter" considering this project's origin.
+
+[Brad Fults](http://github.com/h3h) ([bfults@gmail.com][])
+
+## Acknowledgements
+
+Serum is based entirely on [Jekyll](http://jekyllrb.com/) from Tomm Preston-Werner.
+Thank you, Tom.
+
+## License
+
+MIT License; see `LICENSE` file.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/serum.rb

@@ -0,0 +1,71 @@
+$:.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'
+
+# internal requires
+require 'serum/core_ext'
+require 'serum/site'
+require 'serum/post'
+require 'serum/static_file'
+require 'serum/errors'
+
+SafeYAML::OPTIONS[:suppress_warnings] = true
+
+module Serum
+  VERSION = '0.1.0'
+
+  # Default options.
+  # Strings rather than symbols are used for compatability with YAML.
+  DEFAULTS = {
+    'source'        => Dir.pwd,
+    'permalink'     => ':title',
+    'baseurl'       => '',
+    'include'       => ['.htaccess'],
+  }
+
+  # Public: Generate a Serum 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 Serum::DEFAULTS for a
+  #            list of option names and their defaults.
+  #
+  # Returns the final configuration Hash.
+  def self.configuration(override)
+    # Convert any symbol keys to strings and remove the old key/values
+    override = override.reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
+
+    # Merge DEFAULTS < override
+    Serum::DEFAULTS.deep_merge(override)
+  end
+
+  # Public: Generate a new Serum::Site for the given directory.
+  #
+  # source - A String path to the directory.
+  # opts   - A Hash of additional configuration options.
+  #
+  # Returns the Serum::Site.
+  def self.for_dir(source, opts={})
+    Serum::Site.new(configuration({source: source}.merge(opts)))
+  end
+
+end

data/lib/serum/core_ext.rb

@@ -0,0 +1,68 @@
+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
+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
+
+if RUBY_VERSION < "1.9"
+  class String
+    def force_encoding(enc)
+      self
+    end
+  end
+end

data/lib/serum/errors.rb

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

data/lib/serum/mime.types

@@ -0,0 +1,84 @@
+# 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.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/serum/post.rb

@@ -0,0 +1,177 @@
+require 'cgi'
+
+module Serum
+  class Post
+    include Comparable
+
+    # Valid post name regex.
+    MATCHER = %r{
+      ^(.+\/)*        # zero or more path segments including their trailing slash
+      (\d+-\d+-\d+)   # three numbers (YYYY-mm-dd) separated by hyphens for the date
+      -(.*)           # a hyphen followed by the slug
+      (\.[^.]+)$      # the file extension after a .
+    }x
+
+    # 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, :content, :output, :ext
+    attr_accessor :date, :slug, :published, :dir
+
+    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
+      @base = source
+      @dir = dir
+      @name = name
+
+      self.process(name)
+      begin
+        self.read_yaml(@base, name)
+      rescue Exception => msg
+        raise FatalException.new("#{msg} in #{@base}/#{name}")
+      end
+
+      # If we've added a date and time to the YAML, use that instead of the
+      # filename date. Means we'll sort correctly.
+      if self.data.has_key?('date')
+        # ensure Time via to_s and reparse
+        self.date = Time.parse(self.data["date"].to_s)
+      end
+
+      if self.data.has_key?('published') && self.data['published'] == false
+        self.published = false
+      else
+        self.published = true
+      end
+    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)
+      begin
+        content = File.read(File.join(base, name))
+
+        if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+          self.data = YAML.safe_load($1)
+        end
+      rescue => e
+        puts "Error reading file #{File.join(base, name)}: #{e.message}"
+      rescue SyntaxError => e
+        puts "YAML Exception reading #{File.join(base, name)}: #{e.message}"
+      end
+
+      self.data ||= {}
+    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
+
+    # 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
+
+    # 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 = "#{self.site.baseurl}#{self.id}"
+
+      # 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
+
+    # 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
+
+    def method_missing(meth, *args)
+      if self.data.has_key?(meth.to_s) && args.empty?
+        self.data[meth.to_s]
+      else
+        super
+      end
+    end
+
+  end
+end