serum 0.1.0

data/lib/serum/site.rb

@@ -0,0 +1,116 @@
+module Serum
+  class Site
+    attr_accessor :config, :posts, :static_files, :exclude, :include, :source
+    attr_accessor :time, :baseurl
+
+    # Public: Initialize a new Site.
+    #
+    # config - A Hash containing site configuration details.
+    def initialize(config)
+      self.config          = config.clone
+
+      self.source          = File.expand_path(config['source'])
+      self.baseurl         = config['baseurl']
+      self.exclude         = config['exclude'] || []
+      self.include         = config['include'] || []
+
+      self.reset
+      self.read_directories
+    end
+
+    # Reset Site details.
+    #
+    # Returns nothing
+    def reset
+      self.time            = if self.config['time']
+                               Time.parse(self.config['time'].to_s)
+                             else
+                               Time.now
+                             end
+      self.posts           = []
+      self.static_files    = []
+    end
+
+    # Recursively traverse directories to find posts and static files
+    # that will become part of the site according to the rules in
+    # filter_entries.
+    #
+    # dir - The String relative path of the directory to read. Default: ''.
+    #
+    # Returns nothing.
+    def read_directories(dir = '')
+      self.reset
+      base = File.join(self.source, dir)
+      entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) }
+
+      self.read_posts(dir)
+      self.posts.sort!
+
+      entries.each do |f|
+        f_abs = File.join(base, f)
+        f_rel = File.join(dir, f)
+        if File.directory?(f_abs)
+          read_directories(f_rel)
+        elsif !File.symlink?(f_abs)
+          static_files << StaticFile.new(self, self.source, dir, f)
+        end
+      end
+    end
+
+    # Read all the files in <source>/<dir> 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)
+      entries = get_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)
+
+          if post.published && post.date <= self.time
+            self.posts << post
+          end
+        end
+      end
+    end
+
+    # Filter out any files/directories that are hidden or backup files (start
+    # with "." or "#" or end with "~"), or contain site content (start with "_"),
+    # or are excluded in the site configuration, unless they are web server
+    # files such as '.htaccess'.
+    #
+    # entries - The Array of String file/directory entries to filter.
+    #
+    # Returns the Array of filtered entries.
+    def filter_entries(entries)
+      entries.reject do |e|
+        unless self.include.glob_include?(e)
+          ['.', '_', '#'].include?(e[0..0]) ||
+          e[-1..-1] == '~' ||
+          self.exclude.glob_include?(e) ||
+          (File.symlink?(e) && self.safe)
+        end
+      end
+    end
+
+    # Read the entries from a particular directory for processing
+    #
+    # dir - The String relative path of the directory to read
+    # subfolder - The String directory to read
+    #
+    # Returns the list of entries to process
+    def get_entries(dir, subfolder)
+      base = File.join(self.source, dir, subfolder)
+      return [] unless File.exists?(base)
+      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+    end
+
+    def inspect
+      "<Site: #{source}>"
+    end
+  end
+end

data/lib/serum/static_file.rb

@@ -0,0 +1,53 @@
+module Serum
+  class StaticFile
+    # The cache of last modification times [path] -> mtime.
+    @@mtimes = Hash.new
+
+    # Initialize a new StaticFile.
+    #
+    # site - The Site.
+    # base - The String path to the <source>.
+    # dir  - The String path between <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
+    end
+
+    # Returns source file path.
+    def path
+      File.join(@base, @dir, @name)
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path.
+    def destination(dest)
+      File.join(dest, @dir, @name)
+    end
+
+    # Returns last modification time for this file.
+    def mtime
+      File.stat(path).mtime.to_i
+    end
+
+    # Is source path modified?
+    #
+    # Returns true if modified since last write.
+    def modified?
+      @@mtimes[path] != mtime
+    end
+
+    # Reset the mtimes cache (for testing purposes).
+    #
+    # Returns nothing.
+    def self.reset_cache
+      @@mtimes = Hash.new
+      nil
+    end
+  end
+end

data/serum.gemspec

@@ -0,0 +1,85 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'serum'
+  s.version           = '0.1.0'
+  s.license           = 'MIT'
+  s.date              = '2013-03-30'
+  s.rubyforge_project = 'serum'
+
+  s.summary     = "A simple object model on static posts with YAML front matter."
+  s.description = "Serum is a simple object model on static posts with YAML front matter."
+
+  s.authors  = ["Brad Fults"]
+  s.email    = 'bfults@gmail.com'
+  s.homepage = 'http://github.com/h3h/serum'
+
+  s.require_paths = %w[lib]
+
+  s.executables = []
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_runtime_dependency('safe_yaml', "~> 0.7.0")
+
+  s.add_development_dependency('rake', "~> 10.0.3")
+  s.add_development_dependency('rdoc', "~> 3.11")
+  s.add_development_dependency('redgreen', "~> 1.2")
+  s.add_development_dependency('shoulda', "~> 3.3.2")
+  s.add_development_dependency('rr', "~> 1.0")
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    Rakefile
+    lib/serum.rb
+    lib/serum/core_ext.rb
+    lib/serum/errors.rb
+    lib/serum/mime.types
+    lib/serum/post.rb
+    lib/serum/site.rb
+    lib/serum/static_file.rb
+    serum.gemspec
+    test/helper.rb
+    test/source/2008-02-02-not-published.textile
+    test/source/2008-02-02-published.textile
+    test/source/2008-10-18-foo-bar.textile
+    test/source/2008-11-21-complex.textile
+    test/source/2008-12-03-permalinked-post.textile
+    test/source/2008-12-13-include.markdown
+    test/source/2009-01-27-array-categories.textile
+    test/source/2009-01-27-categories.textile
+    test/source/2009-01-27-category.textile
+    test/source/2009-01-27-empty-categories.textile
+    test/source/2009-01-27-empty-category.textile
+    test/source/2009-03-12-hash-#1.markdown
+    test/source/2009-05-18-empty-tag.textile
+    test/source/2009-05-18-empty-tags.textile
+    test/source/2009-05-18-tag.textile
+    test/source/2009-05-18-tags.textile
+    test/source/2009-05-24-yaml-linebreak.markdown
+    test/source/2009-06-22-empty-yaml.textile
+    test/source/2009-06-22-no-yaml.textile
+    test/source/2010-01-08-triple-dash.markdown
+    test/source/2010-01-09-date-override.textile
+    test/source/2010-01-09-time-override.textile
+    test/source/2010-01-09-timezone-override.textile
+    test/source/2010-01-16-override-data.textile
+    test/source/2011-04-12-md-extension.md
+    test/source/2011-04-12-text-extension.text
+    test/source/2013-01-02-post-excerpt.markdown
+    test/source/2013-01-12-nil-layout.textile
+    test/source/2013-01-12-no-layout.textile
+    test/suite.rb
+    test/test_core_ext.rb
+    test/test_post.rb
+    test/test_site.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'serum'
+
+require 'redgreen' if RUBY_VERSION < '1.9'
+require 'shoulda'
+require 'rr'
+
+include Serum
+
+# Send STDERR into the void to suppress program output messages
+STDERR.reopen(test(?e, '/dev/null') ? '/dev/null' : 'NUL:')
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+
+  def source_dir(*subdirs)
+    test_dir('source', *subdirs)
+  end
+
+  def test_dir(*subdirs)
+    File.join(File.dirname(__FILE__), *subdirs)
+  end
+
+end

data/test/source/2008-02-02-not-published.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Not published!
+published: false
+category: publish_test
+---
+
+This should *not* be published!

data/test/source/2008-02-02-published.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Publish
+category: publish_test
+---
+
+This should be published.
+

data/test/source/2008-10-18-foo-bar.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Foo Bar
+---
+
+h1. {{ page.title }}
+
+Best *post* ever

data/test/source/2008-11-21-complex.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Complex
+---
+
+url: {{ page.url }}
+date: {{ page.date }}
+id: {{ page.id }}

data/test/source/2008-12-03-permalinked-post.textile

@@ -0,0 +1,9 @@
+---
+title: Post with Permalink
+permalink: my_category/permalinked-post
+---
+
+h1. {{ page.title }}
+
+
+<p>Best <strong>post</strong> ever</p>

data/test/source/2008-12-13-include.markdown

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Include
+---
+
+{% include sig.markdown %}
+
+This _is_ cool

data/test/source/2009-01-27-array-categories.textile

@@ -0,0 +1,10 @@
+---
+layout: default
+title: Array categories in YAML
+categories:
+- foo
+- bar
+- baz
+---
+
+Best *post* ever

data/test/source/2009-01-27-categories.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Categories in YAML
+categories: foo bar baz
+---
+
+Best *post* ever

data/test/source/2009-01-27-category.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Category in YAML
+category: foo
+---
+
+Best *post* ever

data/test/source/2009-01-27-empty-categories.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Category in YAML
+categories:
+---
+
+Best *post* ever

data/test/source/2009-01-27-empty-category.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Category in YAML
+category:
+---
+
+Best *post* ever

data/test/source/2009-03-12-hash-#1.markdown

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Hash #1
+---
+
+Hashes are nice

data/test/source/2009-05-18-empty-tag.textile

@@ -0,0 +1,6 @@
+---
+title: A Tag
+tag:
+---
+
+Whoa.

data/test/source/2009-05-18-empty-tags.textile

@@ -0,0 +1,6 @@
+---
+title: Some Tags
+tags:
+---
+
+Awesome!

data/test/source/2009-05-18-tag.textile

@@ -0,0 +1,6 @@
+---
+title: A Tag
+tag: code
+---
+
+Whoa.

data/test/source/2009-05-18-tags.textile

@@ -0,0 +1,9 @@
+---
+title: Some Tags
+tags:
+- food
+- cooking
+- pizza
+---
+
+Awesome!

data/test/source/2009-05-24-yaml-linebreak.markdown

@@ -0,0 +1,7 @@
+---
+layout: post
+title: "Test title"
+tag: "Ruby"
+---
+
+This is the content

data/test/source/2009-06-22-empty-yaml.textile

@@ -0,0 +1,3 @@
+---
+---
+Empty YAML.