bonsai 1.0.1 → 1.1.0

data/Rakefile

@@ -1,4 +1,5 @@
-$KCODE = "U"
+# coding: utf-8
+
 require 'rubygems'
 require 'rake'
 
@@ -16,6 +17,7 @@ begin
     gem.add_development_dependency "yard", ">= 0"
     gem.add_dependency "tilt", ">= 0.4"
     gem.add_dependency "mustache", ">= 0.5.0"
+    gem.add_dependency "builder", ">= 2.1.2"
     gem.add_dependency "thin", ">= 1.0.0"
     gem.add_dependency "watch", ">= 0.1.0"
     gem.add_dependency "sinatra", ">= 0.9.4"

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/bin/bonsai

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby -KU
+#!/usr/bin/env ruby
+# coding: utf-8
 
 require 'optparse'
 require 'bonsai'

data/bonsai.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bonsai}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Schwarz"]
-  s.date = %q{2010-01-02}
+  s.date = %q{2010-01-05}
   s.default_executable = %q{bonsai}
   s.description = %q{A static site generator that uses the best toolset available}
   s.email = %q{ben.schwarz@gmail.com}
@@ -35,10 +35,13 @@ Gem::Specification.new do |s|
      "lib/bonsai/generate.rb",
      "lib/bonsai/navigation.rb",
      "lib/bonsai/page.rb",
+     "lib/bonsai/sitemap.rb",
      "lib/bonsai/template.rb",
      "lib/bonsai/templates/content/index/default.yml",
      "lib/bonsai/templates/public/.htaccess",
      "lib/bonsai/templates/public/docs/css/base.less",
+     "lib/bonsai/templates/public/robots.txt",
+     "lib/bonsai/templates/site.yml",
      "lib/bonsai/templates/templates/default.mustache",
      "lib/bonsai/webserver.rb",
      "spec/bonsai/console_spec.rb",
@@ -46,11 +49,18 @@ Gem::Specification.new do |s|
      "spec/bonsai/generate_spec.rb",
      "spec/bonsai/navigation_spec.rb",
      "spec/bonsai/page_spec.rb",
+     "spec/bonsai/sitemap_spec.rb",
      "spec/bonsai/template_spec.rb",
      "spec/bonsai_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/support/broken/content/broken_page/demo-template.yml",
+     "spec/support/broken/site.yml",
+     "spec/support/broken/templates/content/index/default.yml",
+     "spec/support/broken/templates/public/.htaccess",
+     "spec/support/broken/templates/public/docs/css/base.less",
+     "spec/support/broken/templates/public/robots.txt",
+     "spec/support/broken/templates/templates/default.mustache",
      "spec/support/content/1.about-us/1.contact/1.child/a_file_asset.txt",
      "spec/support/content/1.about-us/1.contact/1.child/demo-template.yml",
      "spec/support/content/1.about-us/1.contact/demo-template.yml",
@@ -76,6 +86,7 @@ Gem::Specification.new do |s|
      "spec/support/public/js/script.js",
      "spec/support/public/stylesheets/base.less",
      "spec/support/public/stylesheets/broken.less",
+     "spec/support/site.yml",
      "spec/support/templates/demo-template.mustache",
      "spec/support/templates/partials/inserted.mustache",
      "vendor/yui-compressor/yuicompressor-2.4.2.jar"
@@ -100,6 +111,7 @@ Gem::Specification.new do |s|
      "spec/bonsai/generate_spec.rb",
      "spec/bonsai/navigation_spec.rb",
      "spec/bonsai/page_spec.rb",
+     "spec/bonsai/sitemap_spec.rb",
      "spec/bonsai/template_spec.rb",
      "spec/bonsai_spec.rb",
      "spec/spec_helper.rb"
@@ -114,6 +126,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_runtime_dependency(%q<tilt>, [">= 0.4"])
       s.add_runtime_dependency(%q<mustache>, [">= 0.5.0"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
       s.add_runtime_dependency(%q<thin>, [">= 1.0.0"])
       s.add_runtime_dependency(%q<watch>, [">= 0.1.0"])
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.4"])
@@ -124,6 +137,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<tilt>, [">= 0.4"])
       s.add_dependency(%q<mustache>, [">= 0.5.0"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
       s.add_dependency(%q<thin>, [">= 1.0.0"])
       s.add_dependency(%q<watch>, [">= 0.1.0"])
       s.add_dependency(%q<sinatra>, [">= 0.9.4"])
@@ -135,6 +149,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<tilt>, [">= 0.4"])
     s.add_dependency(%q<mustache>, [">= 0.5.0"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
     s.add_dependency(%q<thin>, [">= 1.0.0"])
     s.add_dependency(%q<watch>, [">= 0.1.0"])
     s.add_dependency(%q<sinatra>, [">= 0.9.4"])

data/lib/bonsai/exporter.rb

@@ -24,6 +24,8 @@ module Bonsai
         compress_assets
         write_index
         write_pages
+        write_sitemap
+        write_readme
         cleanup
       end
       
@@ -54,6 +56,24 @@ module Bonsai
         end
       end
       
+      def write_sitemap
+        Bonsai.log "Writing sitemap"
+        File.open("#{path}/sitemap.xml", "w") {|file| file.write(Bonsai::Sitemap.generate) }
+      end
+      
+      def write_readme
+        Bonsai.log "Writing ABOUT-THIS-SITE"
+        
+        readme = <<-README
+          This site was built using Bonsai (http://tinytree.info)
+          
+          To make changes to the site you will require the original source files.
+          Please contact the author of your site for details.
+        README
+        
+        File.open("#{path}/ABOUT-THIS-SITE", "w") {|file| file.write(readme) }
+      end
+      
       def copy_assets
         Bonsai.log "Copying page assets"
         Page.all.each do |page|

data/lib/bonsai/page.rb

@@ -50,6 +50,9 @@ module Bonsai
       web_path(directory)
     end
     
+    def ctime; File.ctime(disk_path); end
+    def mtime; File.mtime(disk_path); end
+    
     def write_path
       "#{permalink}/index.html"
     end

data/lib/bonsai/sitemap.rb

@@ -0,0 +1,30 @@
+module Bonsai
+  class Sitemap
+    def self.generate(change_freq = "monthly")
+      index = Bonsai::Page.find("index")
+      
+      template = Tilt::BuilderTemplate.new do
+        lambda { |xml|
+          xml.instruct!
+          xml.urlset(:xmlns=>'http://www.sitemaps.org/schemas/sitemap/0.9') {
+            xml.url {
+              xml.loc(Bonsai.site[:site][:url])
+            	xml.lastmod(index.mtime.utc.strftime("%Y-%m-%d"))
+            	xml.changefreq(change_freq)
+           	}
+
+            Bonsai::Page.all.delete_if{|p| p.permalink === "/index"}.each do |page|
+              xml.url {
+                xml.loc(Bonsai.site[:site][:url] + page.permalink)
+              	xml.lastmod(page.mtime.utc.strftime("%Y-%m-%d"))
+              	xml.changefreq(change_freq)
+             	}
+            end
+          }
+        }
+      end
+      
+      template.render
+    end
+  end
+end

data/lib/bonsai/templates/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /

data/lib/bonsai/templates/site.yml

@@ -0,0 +1,4 @@
+:site:
+  :name: Your website title
+  :url: http://yourdomain.com
+  :copyright: 2010

data/lib/bonsai.rb

@@ -42,6 +42,12 @@ module Bonsai
       File.read("#{File.dirname(__FILE__)}/../VERSION")
     end
     
+    def site
+      YAML::load(File.read("#{Bonsai.root_dir}/site.yml")) || {}
+    rescue ArgumentError
+      Bonsai.log "Badly formatted site.yml"
+    end
+    
     private
     def is_a_bonsai?(path)
       File.directory?("#{path}/content") && File.directory?("#{path}/public") && File.directory?("#{path}/templates")
@@ -50,6 +56,7 @@ module Bonsai
   
   autoload :Page,               "page"
   autoload :Console,            "console"
+  autoload :Sitemap,            "sitemap"
   autoload :Exporter,           "exporter"
   autoload :Template,           "template"
   autoload :Generate,           "generate"

data/spec/bonsai/exporter_spec.rb

@@ -108,7 +108,13 @@ describe Bonsai::Exporter do
         File.exists?("#{Bonsai::Exporter.path}/index.html").should be_true
       end
       
-      it "should write a readme file to explain how the site was generated"
+      it "should write a sitemap.xml" do
+        File.exists?("#{Bonsai::Exporter.path}/sitemap.xml").should be_true
+      end
+      
+      it "should write a readme file to explain how the site was generated" do
+        File.exists?("#{Bonsai::Exporter.path}/ABOUT-THIS-SITE").should be_true
+      end
       
       describe "asset compression" do
         it "should compress the css file" do

data/spec/bonsai/generate_spec.rb

@@ -29,8 +29,16 @@ describe Bonsai::Generate do
       File.exists?("#{@path}/templates/default.mustache").should be_true
     end
     
-    it "should generate 4 files" do
-      Dir.glob("#{@path}/**/*", File::FNM_DOTMATCH).select{|f| File.file?(f) }.size.should == 4
+    it "should create a robots.txt" do
+      File.exists?("#{@path}/public/robots.txt").should be_true
+    end
+    
+    it "should create a site.yml" do
+      File.exists?("#{@path}/site.yml").should be_true
+    end
+    
+    it "should generate 6 files" do
+      Dir.glob("#{@path}/**/*", File::FNM_DOTMATCH).select{|f| File.file?(f) }.size.should == 6
     end
     
     it "should generate 7 directories" do

data/spec/bonsai/page_spec.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "#{File.dirname(__FILE__)}/../spec_helper"
 
 describe Bonsai::Page do
@@ -26,6 +28,15 @@ describe Bonsai::Page do
       @page.permalink.should == "/about-us/history"
     end
     
+    it "should have a ctime" do
+      @page.should respond_to :ctime
+      @page.ctime.should be_an_instance_of(Time)
+    end
+    
+    it "should have an mtime" do
+      @page.should respond_to :mtime
+      @page.mtime.should be_an_instance_of(Time)
+    end
     it "should remove numbers over 10 from the permalink" do
       Bonsai::Page.find("many-pages").permalink.should == "/many-pages"
     end

data/spec/bonsai/sitemap_spec.rb

@@ -0,0 +1,15 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe Bonsai::Sitemap do
+  before :all do
+    @sitemap = Bonsai::Sitemap.generate
+  end
+  
+  it "should contain /" do
+    @sitemap.should include "<loc>http://tinytree.info</loc>"
+  end
+
+  it "should not include /index" do
+    @sitemap.should_not include "<loc>http://tinytree.info/index</loc>"
+  end
+end

data/spec/bonsai_spec.rb

@@ -18,4 +18,32 @@ describe Bonsai do
   it "should know the version" do
     Bonsai.version.should =~ /\d+.\d+.\d+/
   end
+  
+  
+  describe "site yml" do
+    describe "working" do
+      it "should respond to site" do
+        Bonsai.should respond_to(:site)
+      end
+
+      it "should contain the contents of the site yml" do
+        Bonsai.site.should == YAML.load(File.read("#{Bonsai.root_dir}/site.yml"))
+      end
+    end
+    
+    describe "broken" do
+      before :all do
+        Bonsai.root_dir = "spec/support/broken"
+      end
+      
+      after :all do
+        Bonsai.root_dir = "spec/support"
+      end 
+      
+      it "should log rather than raising exception with badly formatted yml" do
+        Bonsai.should_receive(:log).with("Badly formatted site.yml")
+        lambda { Bonsai.site }.should_not raise_error
+      end
+    end
+  end
 end

data/spec/support/broken/content/broken_page/demo-template.yml

@@ -1,3 +1,2 @@
-:page_variable: A popular plastic chair that has returned direct from 1971. Casalino was very popular during the 1970’s, however the design become out of vogue during the 1980’s and has not been available since. It wasn’t until the original moulds were rediscovered recently that Casalino has found a new life.
-
-A popular plastic chair that has returned direct from 1971. Casalino was very popular during the 1970’s, however the design become out of vogue during the 1980’s and has not been available since. It wasn’t until the original moulds were rediscovered recently that Casalino has found a new life.
+:page_variable: 
+Broken, broken broken

data/spec/support/broken/site.yml

@@ -0,0 +1,6 @@
+:site: 
+  :name: My broken site
+  :url: http://broke.it
+  :copyright: 2010
+  :how-to-break-it: 
+Just start writing like you don't know what you're doing.

data/spec/support/broken/templates/content/index/default.yml

@@ -0,0 +1,3 @@
+headline: Welcome to Bonsai
+body: |
+  A designer knows he has achieved perfection not when there is nothing left to add, but when there is nothing left to take away. 

data/spec/support/broken/templates/public/.htaccess

@@ -0,0 +1,28 @@
+DirectoryIndex index.html
+FileETag All
+
+# Compress all static assets
+<IfModule mod_deflate.c>
+	# compress content with type html, text, and css
+  AddOutputFilterByType DEFLATE text/css text/html text/javascript application/javascript application/x-javascript text/js text/plain text/xml
+
+	<IfModule mod_headers.c>
+		# properly handle requests coming from behind proxies
+		Header append Vary User-Agent
+	</IfModule>
+</IfModule>
+
+# Cache, aggressively 
+<IfModule mod_expires.c>
+  ExpiresActive On
+  ExpiresDefault "access plus 10 days"
+
+	<FilesMatch "\.(eot|ttf|otf)$">
+		ExpiresDefault "access plus 10 years"
+	</filesMatch>
+</IfModule>
+
+# Mime-types
+AddType application/vnd.ms-fontobject .eot
+AddType font/ttf .ttf
+AddType font/otf .otf

data/spec/support/broken/templates/public/docs/css/base.less

@@ -0,0 +1 @@
+/* Put your styles here */

data/spec/support/broken/templates/public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /

data/spec/support/broken/templates/templates/default.mustache

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <title>{{name}}</title>
+    <link rel="stylesheet" href="/css/base.css" type="text/css">
+  </head>
+  <body id="{{slug}}" class="default">
+    <header>
+      <h1>{{headline}}</h1>
+      {{{body}}}
+    </header>
+  </body>
+</html>

data/spec/support/site.yml

@@ -0,0 +1,4 @@
+:site: 
+  :name: Bonsai
+  :url: http://tinytree.info
+  :copyright: 2010

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bonsai
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-02 00:00:00 +11:00
+date: 2010-01-05 00:00:00 +11:00
 default_executable: bonsai
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.5.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
 - !ruby/object:Gem::Dependency 
   name: thin
   type: :runtime
@@ -128,10 +138,13 @@ files:
 - lib/bonsai/generate.rb
 - lib/bonsai/navigation.rb
 - lib/bonsai/page.rb
+- lib/bonsai/sitemap.rb
 - lib/bonsai/template.rb
 - lib/bonsai/templates/content/index/default.yml
 - lib/bonsai/templates/public/.htaccess
 - lib/bonsai/templates/public/docs/css/base.less
+- lib/bonsai/templates/public/robots.txt
+- lib/bonsai/templates/site.yml
 - lib/bonsai/templates/templates/default.mustache
 - lib/bonsai/webserver.rb
 - spec/bonsai/console_spec.rb
@@ -139,11 +152,18 @@ files:
 - spec/bonsai/generate_spec.rb
 - spec/bonsai/navigation_spec.rb
 - spec/bonsai/page_spec.rb
+- spec/bonsai/sitemap_spec.rb
 - spec/bonsai/template_spec.rb
 - spec/bonsai_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/broken/content/broken_page/demo-template.yml
+- spec/support/broken/site.yml
+- spec/support/broken/templates/content/index/default.yml
+- spec/support/broken/templates/public/.htaccess
+- spec/support/broken/templates/public/docs/css/base.less
+- spec/support/broken/templates/public/robots.txt
+- spec/support/broken/templates/templates/default.mustache
 - spec/support/content/1.about-us/1.contact/1.child/a_file_asset.txt
 - spec/support/content/1.about-us/1.contact/1.child/demo-template.yml
 - spec/support/content/1.about-us/1.contact/demo-template.yml
@@ -169,6 +189,7 @@ files:
 - spec/support/public/js/script.js
 - spec/support/public/stylesheets/base.less
 - spec/support/public/stylesheets/broken.less
+- spec/support/site.yml
 - spec/support/templates/demo-template.mustache
 - spec/support/templates/partials/inserted.mustache
 - vendor/yui-compressor/yuicompressor-2.4.2.jar
@@ -206,6 +227,7 @@ test_files:
 - spec/bonsai/generate_spec.rb
 - spec/bonsai/navigation_spec.rb
 - spec/bonsai/page_spec.rb
+- spec/bonsai/sitemap_spec.rb
 - spec/bonsai/template_spec.rb
 - spec/bonsai_spec.rb
 - spec/spec_helper.rb