homeostasis 0.0.10 → 0.0.11

data/README.md

@@ -56,7 +56,7 @@ In your controller:
 
     Homeostasis::Blog.directory('blog') # directory of posts
 
-Post files should be in the format `yyyy-mm-dd-permalink.html.{md,haml}`.  Use
+Post files should be in the format `yyyy-mm-dd-permalink.html.md`.  Use
 YAML front-matter for any metadata you want.  `:date` and `:path` will be
 added automatically for you.
 
@@ -115,7 +115,21 @@ Sitemap
 A sitemap will automatically be generated in `public/sitemap.xml`.  You'll need
 to set the root URL for this to happen:
 
-    Homeostasis.root 'http://example.com'
+    Homeostasis::Sitemap.url 'http://example.com'
+
+`loc` and `lastmod` will be generated for each page.  Use front-yaml to set the
+`changefreq` or `priority`:
+
+    <!--
+      :changefreq: monthly
+      :priority: 0.9
+    -->
+
+Use the key `private` to avoid generating an entry:
+
+    <!--
+      :private: true
+    -->
 
 Trailing Slash
 ==============
@@ -136,14 +150,6 @@ You'll get:
 This works well with an `htaccess` file that automatically appends trailing
 slashes to URLs.
 
-TODO
-====
-
-* use Dir.glob with relative paths
-* add tests/coverage
-* RSS generation
-* sitemap generation
-
 License
 =======
 

data/lib/homeostasis.rb

@@ -1,12 +1,36 @@
 require 'rubygems'
 require 'stasis'
 require 'digest/sha1'
+require 'bluecloth'
 require 'yaml'
+require 'cgi'
 
 module Homeostasis
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
+
+  module Helpers
+    private
+    def ignore?(path)
+      @ignore_paths ||= @stasis.plugins.
+        find { |plugin| plugin.class == Stasis::Ignore }.
+        instance_variable_get(:@ignore)
+
+      matches = _match_key?(@ignore_paths, path)
+      matches.each do |group|
+        group.each do |group_path|
+          return true if _within?(group_path)
+        end
+      end
+      false
+    end
+
+    def h(html)
+      CGI::escapeHTML(html)
+    end
+  end
 
   class Asset < Stasis::Plugin
+    include Helpers
     before_all :before_all
     after_all  :after_all
 
@@ -117,22 +141,10 @@ module Homeostasis
     end
 
     private
-    def ignore?(path)
-      @ignore_paths ||= @stasis.plugins.
-        find { |plugin| plugin.class == Stasis::Ignore }.
-        instance_variable_get(:@ignore)
-
-      matches = _match_key?(@ignore_paths, path)
-      matches.each do |group|
-        group.each do |group_path|
-          return true if _within?(group_path)
-        end
-      end
-      false
-    end
   end
 
   class Front < Stasis::Plugin
+    include Helpers
     before_all    :before_all
     action_method :front
     action_method :front_site
@@ -151,28 +163,32 @@ module Homeostasis
     def before_all
       @stasis.paths.each do |path|
         next if path !~ /\.(#{@@matchers.keys.join('|')})$/
-        next if (contents = File.read(path)) !~ @@matchers[File.extname(path)[1..-1]]
-
-        lines, data, index = contents.split("\n"), "", 1
-        while index < lines.size
-          break if lines[index] !~ /^  /
-          data += lines[index] + "\n"
-          index += 1
+        if (contents = File.read(path)) !~ @@matchers[File.extname(path)[1..-1]]
+          yaml = {}
+        else
+          lines, data, index = contents.split("\n"), "", 1
+          while index < lines.size
+            break if lines[index] !~ /^  /
+            data += lines[index] + "\n"
+            index += 1
+          end
+          begin
+            yaml = YAML.load(data)
+          rescue Psych::SyntaxError
+            yaml = {}
+          end
         end
 
-        relative = path[(@stasis.root.length+1)..-1]
-        ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
-        dest = trailify((ext && File.extname(relative) == ".#{ext}") ?
-          relative[0..-1*ext.length-2] :
-          relative)
-        
-        begin
-          yaml = YAML.load(data)
+        # add special :path key for generated files
+        if !ignore?(path)
+          relative = path[(@stasis.root.length+1)..-1]
+          ext = Tilt.mappings.keys.find { |ext| File.extname(path)[1..-1] == ext }
+          dest = trailify((ext && File.extname(relative) == ".#{ext}") ?
+            relative[0..-1*ext.length-2] :
+            relative)
           yaml[:path] = dest
-          @@front_site[front_key(path)] = yaml if yaml.is_a?(Hash)
-        rescue Psych::SyntaxError => error
-          @@front_site[front_key(path)] = {:path => dest}
         end
+        @@front_site[front_key(path)] = yaml
       end
     end
 
@@ -229,7 +245,54 @@ module Homeostasis
     end
   end
 
+  class Sitemap < Stasis::Plugin
+    include Helpers
+    after_all :after_all
+
+    def initialize(stasis)
+      @stasis = stasis
+      @@url = nil
+    end
+
+    def self.url(url)
+      @@url = url
+    end
+    
+    def after_all
+      return if @@url.nil?
+      xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      xml += "<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n"
+      front_site = Homeostasis::Front._front_site
+      pages = front_site.keys.sort_by do |page|
+        depth = page.scan('/').length
+        depth -= 1 if page =~ /index\.html/
+        "#{depth}-#{page}"
+      end
+      pages.each do |page|
+        front = front_site[page]
+        filename = File.join(@stasis.root, page)
+        next if page !~ /\.html/ || front[:private] || front[:path].nil?
+
+        log = `git log -n1 #{filename} 2> /dev/null | grep "Date:"`
+        lastmod = log.length > 0 ?
+          Date.parse(log.split("\n")[0].split(":",2)[1].strip).strftime('%Y-%m-%d') :
+          nil
+        xml += "  <url>\n"
+        xml += "    <loc>#{h(@@url + front[:path])}</loc>\n" if front[:path]
+        xml += "    <lastmod>#{h lastmod}</lastmod>\n" if lastmod
+        xml += "    <changefreq>#{h front[:changefreq]}</changefreq>\n" if front[:changefreq]
+        xml += "    <priority>#{h front[:priority]}</priority>\n" if front[:priority]
+        xml += "  </url>\n"
+      end
+      xml += '</urlset>'
+      File.open(File.join(@stasis.destination, 'sitemap.xml'), 'w') do |f|
+        f.puts(xml)
+      end
+    end
+  end
+
   class Blog < Stasis::Plugin
+    include Helpers
     DATE_REGEX = /^(\d{4}-\d{2}-\d{2})-/
     before_all    :before_all
     after_all     :after_all
@@ -238,11 +301,17 @@ module Homeostasis
     def initialize(stasis)
       @stasis = stasis
       @@directory = nil
+      @@link = nil
+      @@title = nil
+      @@desc = nil
       @@posts = []
     end
 
-    def self.directory(directory)
+    def self.config(directory, link, title, desc)
       @@directory = directory
+      @@link = link
+      @@title = title
+      @@desc = desc
     end
 
     def before_all
@@ -254,6 +323,7 @@ module Homeostasis
         post = front_site[filename.sub(@stasis.root, '')[1..-1]] || {}
         post[:date] = Date.parse(date)
         post[:path] = post[:path].sub("/#{@@directory}/#{date}-", "/#{@@directory}/")
+        post[:body] = BlueCloth.new(File.read(filename)).to_html if filename =~ /\.md$/
         @@posts << post
       end
       @@posts = @@posts.sort_by { |post| post[:date] }.reverse
@@ -267,10 +337,31 @@ module Homeostasis
           filename,
           File.join(File.dirname(filename), base.sub(DATE_REGEX, '')))
       end
+      url = h("#{@@link}/#{@@directory}/")
+      rss = "<?xml version=\"1.0\"?>\n"
+      rss += "<rss version=\"2.0\">\n"
+      rss += "  <channel>\n"
+      rss += "    <title>#{h @@title}</title>\n" if @@title
+      rss += "    <link>#{h @@link}/</link>\n" if @@link
+      rss += "    <description>#{h @@desc}</description>\n" if @@desc
+      rss += "    <atom:link href=\"#{url}/\" rel=\"self\" type=\"application/rss+xml\" />\n"
+      blog_posts[0..5].each do |post|
+        rss += "    <item>\n"
+        rss += "      <title>#{h post[:title]}</title>\n"
+        rss += "      <link>#{h(@@link + post[:path])}</link>\n"
+        rss += "      <pubDate>#{post[:date].strftime('%m-%d-%Y %H:%M')}</pubDate>\n"
+        rss += "      <description>#{h post[:body]}</description>\n"
+        rss += "    </item>\n"
+      end
+      rss += "  </channel>\n"
+      rss += "</rss>"
+      File.open(File.join(@stasis.destination, @@directory, 'rss.xml'), 'w') do |f|
+        f.puts(rss)
+      end
     end
 
     def blog_posts
-      raise 'Homeostasis::Blog#directory never set' if @@directory.nil?
+      raise 'Homeostasis::Blog#config never called' if @@directory.nil?
       @@posts
     end
   end
@@ -280,5 +371,6 @@ if !ENV['HOMEOSTASIS_UNREGISTER']
   Stasis.register(Homeostasis::Asset)
   Stasis.register(Homeostasis::Front)
   Stasis.register(Homeostasis::Trail)
+  Stasis.register(Homeostasis::Sitemap)
   Stasis.register(Homeostasis::Blog)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: homeostasis
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors: