RubyGems - bonsai - Versions diffs - 1.0.0 - Mend

bonsai 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

data/.document +5 -0
data/.gitignore +23 -0
data/.kick +26 -0
data/LICENSE +20 -0
data/README.md +65 -0
data/Rakefile +64 -0
data/VERSION +1 -0
data/benchmark/associations.rb +51 -0
data/bin/bonsai +69 -0
data/bonsai.gemspec +142 -0
data/lib/bonsai.rb +60 -0
data/lib/bonsai/console.rb +8 -0
data/lib/bonsai/exporter.rb +103 -0
data/lib/bonsai/generate.rb +24 -0
data/lib/bonsai/navigation.rb +7 -0
data/lib/bonsai/page.rb +192 -0
data/lib/bonsai/template.rb +31 -0
data/lib/bonsai/templates/content/index/default.yml +3 -0
data/lib/bonsai/templates/public/.htaccess +28 -0
data/lib/bonsai/templates/public/docs/css/base.less +1 -0
data/lib/bonsai/templates/templates/default.mustache +14 -0
data/lib/bonsai/webserver.rb +19 -0
data/spec/bonsai/console_spec.rb +12 -0
data/spec/bonsai/exporter_spec.rb +142 -0
data/spec/bonsai/generate_spec.rb +40 -0
data/spec/bonsai/navigation_spec.rb +28 -0
data/spec/bonsai/page_spec.rb +225 -0
data/spec/bonsai/template_spec.rb +19 -0
data/spec/bonsai_spec.rb +21 -0
data/spec/spec.opts +1 -0
data/spec/spec_helper.rb +14 -0
data/spec/support/broken/content/broken_page/demo-template.yml +3 -0
data/spec/support/content/1.about-us/1.contact/1.child/a_file_asset.txt +0 -0
data/spec/support/content/1.about-us/1.contact/1.child/demo-template.yml +1 -0
data/spec/support/content/1.about-us/1.contact/demo-template.yml +7 -0
data/spec/support/content/1.about-us/1.contact/images/image001.jpg +0 -0
data/spec/support/content/1.about-us/1.contact/magic/image001.jpg +0 -0
data/spec/support/content/1.about-us/1.contact/magic/image002.jpg +0 -0
data/spec/support/content/1.about-us/demo-template.yml +1 -0
data/spec/support/content/1.about-us/history/a_file_asset.txt +0 -0
data/spec/support/content/1.about-us/history/child/a_file_asset.txt +0 -0
data/spec/support/content/1.about-us/history/child/demo-template.yml +1 -0
data/spec/support/content/1.about-us/history/demo-template.yml +1 -0
data/spec/support/content/1.about-us/history/image001.jpg +0 -0
data/spec/support/content/1.about-us/history/images/image001.jpg +0 -0
data/spec/support/content/1.about-us/history/magic/image001.jpg +0 -0
data/spec/support/content/1.about-us/history/magic/image002.jpg +0 -0
data/spec/support/content/10.many-pages/demo-template.yml +1 -0
data/spec/support/content/2.products/1.product-a/demo-template.yml +1 -0
data/spec/support/content/2.products/2.product-b/demo-template.yml +1 -0
data/spec/support/content/2.products/demo-template.yml +1 -0
data/spec/support/content/index/demo-template.yml +1 -0
data/spec/support/content/legals/terms-and-conditions/demo-template.yml +1 -0
data/spec/support/public/.htaccess +31 -0
data/spec/support/public/js/script.js +19 -0
data/spec/support/public/stylesheets/base.less +2 -0
data/spec/support/public/stylesheets/broken.less +2 -0
data/spec/support/templates/demo-template.mustache +19 -0
data/spec/support/templates/partials/inserted.mustache +1 -0
data/vendor/yui-compressor/yuicompressor-2.4.2.jar +0 -0
metadata +201 -0

data/lib/bonsai/templates/public/docs/css/base.less ADDED Viewed

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

data/lib/bonsai/templates/templates/default.mustache ADDED Viewed

@@ -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/lib/bonsai/webserver.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module Bonsai
+  class StaticPassThrough < Rack::Static
+    def call(env)
+      result = super
+      return result unless result[0] == 404 || result[0] == "404"
+      @app.call(env)
+    end
+  end
+  class DevelopmentServer < Sinatra::Base
+    get '/' do
+      Page.find("index").render
+    end
+    get '/*' do
+      Page.find(params[:splat].to_s).render
+    end
+  end
+end

data/spec/bonsai/console_spec.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+describe Bonsai::Console do
+  it "should respond to new" do
+    Bonsai::Console.should respond_to(:new)
+  end
+  it "should start a new IRB session" do
+    IRB.should_receive(:start)
+    Bonsai::Console.new
+  end
+end

data/spec/bonsai/exporter_spec.rb ADDED Viewed

@@ -0,0 +1,142 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+describe Bonsai::Exporter do
+  after :suite do
+    FileUtils.rm_rf Bonsai::Exporter.path
+  end
+  it "should have a path" do
+    Bonsai::Exporter.path.should_not be_nil
+  end
+  it "should set the path" do
+    Bonsai::Exporter.path = 'support/exporter/test'
+    Bonsai::Exporter.path.should == 'support/exporter/test'
+    Bonsai::Exporter.path = BONSAI_PATH + "/output"
+  end
+  shared_examples_for "lesscss" do
+    it "should process .less files to .css" do
+      File.exists?("#{Bonsai::Exporter.path}/stylesheets/base.css").should be_true
+    end
+    it "should log an error when badly formatted less is supplied (and not raise an exception)" do
+      Bonsai.should_receive(:log)
+      lambda { Bonsai::Exporter.send(:generate_css_from_less) }.should_not raise_error(Less::SyntaxError)
+    end
+  end
+  describe "process!" do
+    describe "tasks" do
+      before :all do
+        FileUtils.rm_rf Bonsai::Exporter.path
+        Bonsai::Exporter.process!
+      end
+      it_should_behave_like "lesscss"
+      # Uncompressed CSS
+      it "should be processed with less" do
+        File.read("#{Bonsai::Exporter.path}/stylesheets/base.css").should == ".mymixin, #content { display: block; }\n"
+      end
+      it "should not write the base.css file to the public directory" do
+        File.exists?("#{Bonsai.root_dir}/public/base.css").should_not be_true
+      end
+    end
+    describe "expectations" do
+      after do
+        Bonsai::Exporter.process!
+      end
+      it "should copy assets" do
+        Bonsai::Exporter.should_receive(:copy_assets)
+      end
+      it "should copy public" do
+        Bonsai::Exporter.should_receive(:copy_public)
+      end
+      it "should generate css via lesscss" do
+        Bonsai::Exporter.should_receive(:generate_css_from_less)
+      end
+    end
+  end
+  describe "publish!" do
+    describe "actions" do
+      before :all do
+        FileUtils.rm_rf Bonsai::Exporter.path
+        Bonsai::Exporter.publish!
+      end
+      it_should_behave_like "lesscss"
+      # Compressed CSS
+      it "should be processed with less" do
+        File.read("#{Bonsai::Exporter.path}/stylesheets/base.css").should == ".mymixin,#content{display:block;}"
+      end
+      it "should not export the base.less file" do
+        File.exists?("#{Bonsai::Exporter.path}/stylesheets/base.less").should be_false
+      end
+      it "should create the output directory" do
+        File.exists?(Bonsai::Exporter.path).should be_true
+      end
+      it "should render pages to the output directory" do
+        # Index is rendered to index.html and index/index.html
+        Dir[Bonsai::Exporter.path + "/**/*.html"].size.should == Bonsai::Page.all.size + 1
+      end
+      it "should copy the images of each page to its directory" do
+        File.exists?("#{Bonsai::Exporter.path}/about-us/history/images/image001.jpg").should be_true
+      end
+      it 'should copy the assets of each page to its directory' do
+        File.exists?("#{Bonsai::Exporter.path}/about-us/history/a_file_asset.txt").should be_true
+      end
+      it "should copy the contents of the public directory to the root export path" do
+        File.exists?("#{Bonsai::Exporter.path}/.htaccess").should be_true
+      end
+      it "should write the index file to output/index.html" 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"
+      describe "asset compression" do
+        it "should compress the css file" do
+          File.read("#{Bonsai::Exporter.path}/stylesheets/base.css").should == ".mymixin,#content{display:block;}"
+        end
+        it "should compress the js file" do
+          File.read("#{Bonsai::Exporter.path}/js/script.js").should == "$(function(){$(\".default-value\").each(function(){var a=this.value;$(this).focus(function(){if(this.value==a){this.value=\"\"}});$(this).blur(function(){if(this.value==\"\"){this.value=a}})});$(\".details dd:empty\").hide().prev(\"dt\").hide()});"
+        end
+      end
+    end
+    describe "expectations" do
+      after do
+        Bonsai::Exporter.publish!
+      end
+      it "should remove the output directory before re-creating it" do
+        FileUtils.should_receive(:rm_rf).with(Bonsai::Exporter.path)
+      end
+      it "should generate css via lesscss" do
+        Bonsai::Exporter.should_receive(:generate_css_from_less)
+      end
+      it "should compress assets" do
+        Bonsai::Exporter.should_receive(:compress_assets)
+      end
+    end
+  end
+end

data/spec/bonsai/generate_spec.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+describe Bonsai::Generate do
+  describe "generator" do
+    before :all do
+      @path = File.expand_path("spec/tmp-generator")
+      FileUtils.rm_rf @path
+      Bonsai::Generate.new(@path)
+    end
+    it "should create base directories" do
+      %w(content content/index templates public public/docs public/docs/css public/docs/js).each do |dir|
+        File.directory?("#{@path}/#{dir}").should be_true
+      end
+    end
+    it "should copy the htaccess file to public/.htaccess" do
+      File.exists?("#{@path}/public/.htaccess").should be_true
+    end
+    it "should copy the base.less file" do
+      File.exists?("#{@path}/public/docs/css/base.less").should be_true
+    end
+    it "should copy an index page" do
+      File.exists?("#{@path}/content/index/default.yml").should be_true
+    end
+    it "should copy a default template" 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
+    end
+    it "should generate 7 directories" do
+      Dir.glob("#{@path}/**/*").select{|f| File.directory?(f) }.size.should == 7
+    end
+  end
+end

data/spec/bonsai/navigation_spec.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+describe Bonsai::Navigation do
+  it "should respond to tree" do
+    Bonsai::Navigation.should respond_to :tree
+  end
+  before do
+    @tree = Bonsai::Navigation.tree
+    @about = Bonsai::Page.find("about-us")
+    @products = Bonsai::Page.find("products")
+  end
+  it "should contain 2 items" do
+    @tree.should be_an_instance_of(Array)
+    @tree.size.should == 3
+  end
+  it "should contain about and products" do
+    @tree.should include @about
+    @tree.should include @products
+  end
+  it "should be ordered" do
+    @tree.first.should == @about
+    @tree.last.should == @products
+  end
+end

data/spec/bonsai/page_spec.rb ADDED Viewed

@@ -0,0 +1,225 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+describe Bonsai::Page do
+  it "should respond to all" do
+    Bonsai::Page.should respond_to :all
+  end
+  it "should contain pages" do
+    Bonsai::Page.all.first.should be_an_instance_of(Bonsai::Page)
+  end
+  describe "instance" do
+    before :all do
+      @page = Bonsai::Page.find("about-us/history")
+    end
+    it "should have a slug" do
+      @page.slug.should == "history"
+    end
+    it "should have a name" do
+      @page.name.should == "History"
+    end
+    it "should have a permalink" do
+      @page.permalink.should == "/about-us/history"
+    end
+    it "should remove numbers over 10 from the permalink" do
+      Bonsai::Page.find("many-pages").permalink.should == "/many-pages"
+    end
+    it "should have a write_path" do
+      @page.write_path.should == "/about-us/history/index.html"
+    end
+    it "should respond to disk path" do
+      @page.disk_path.should == "#{Bonsai.root_dir}/content/1.about-us/history/demo-template.yml"
+    end
+    it "should have assets" do
+      @page.assets.should be_an_instance_of(Array)
+      @page.assets.length.should == 6
+    end
+    it "should be equal" do
+      Bonsai::Page.find("about-us").should == Bonsai::Page.find("about-us")
+    end
+    describe "relationships" do
+      before :all do
+        @index = Bonsai::Page.find("index")
+        @about = Bonsai::Page.find("about-us")
+        @history = Bonsai::Page.find("about-us/history")
+        @contact = Bonsai::Page.find("about-us/contact")
+        @child = Bonsai::Page.find("about-us/history/child")
+      end
+      it "should have siblings" do
+        @history.siblings.should be_an_instance_of(Array)
+        @history.siblings.size.should == 1
+        @history.siblings.should include(@contact)
+        @history.siblings.should_not include(@history)
+      end
+      it "should have a parent" do
+        @history.parent.should == @about
+      end
+      it "should not have a parent" do
+        @about.parent.should == nil
+      end
+      it "should not have a parent for index" do
+        @index.parent.should == nil
+      end
+      it "should have children" do
+        @about.children.should be_an_instance_of(Array)
+        @about.children.size.should == 1
+        @about.children.should include(@contact)
+      end
+      it "should not have floating pages in the children array" do
+        @about.children.should_not include(@history)
+      end
+      it "should have ancestors" do
+        @child.ancestors.should be_an_instance_of(Array)
+        @child.ancestors.size.should == 2
+        @child.ancestors.should include(@history)
+        @child.ancestors.should include(@about)
+      end
+      it "should have the ancestors in a top down order" do
+        @child.ancestors.first.should == @about
+        @child.ancestors.last.should == @history
+      end
+      it "index should be a floating page" do
+        @index.floating?.should be_true
+      end
+      it "about should not be a floating page" do
+        @about.floating?.should be_false
+      end
+    end
+    it "should have a template" do
+      @page.template.should be_an_instance_of(Bonsai::Template)
+    end
+    it "should to_hash to its variables" do
+      @page.content[:page_title].should == "About our history"
+      @page.content[:page_title].should_not be_nil
+    end
+    describe "render" do
+      before :all do
+        @output = Bonsai::Page.find("about-us/contact").render
+      end
+      it "should render" do
+        @output.should_not be_nil
+      end
+      it "should replace moustache variables with properties from the content file" do
+        @output.should == "Hello from our template, named Contact\n\nGet in touch\n\n/about-us/contact/images/image001.jpg\n/about-us/contact/child\n/about-us/contact/magic/image001.jpg\n/about-us/contact/magic/image002.jpg\nThis content should be inserted!\n\n<p>&ldquo;A designer knows he has achieved perfection\nnot when there is nothing left to add,\nbut when there is nothing left to take away.&rdquo;</p>\n\n<p>– Antoine de Saint-Exupery</p>\n"
+      end
+      it "should write in images" do
+        @output.should include "image001.jpg"
+      end
+      # Pages that use a structure yet have no parent page should still render
+      describe "page without parent" do
+        it "should render successfully" do
+          lambda { Bonsai::Page.find("legals/terms-and-conditions").render }.should_not raise_error
+        end
+      end
+      describe "markdown" do
+        it "should not use markdown for single line content" do
+          @output.should =~ /\nGet in touch\n/
+        end
+        it "should use markdown for multiple line content" do
+          @output.should =~ /<p>&ldquo;A designer knows he/
+        end
+        it "should use smartypants" do
+          @output.should =~ /&rdquo;/
+        end
+      end
+    end
+    describe "to hash" do
+      before :all do
+        @page = Bonsai::Page.find("about-us/history")
+      end
+      it "should respond to to_hash" do
+        @page.should respond_to(:to_hash)
+      end
+      %w(slug permalink name page_title children siblings parent ancestors magic navigation).each do |key|
+        it "should have a to_hash key for #{key}" do
+          @page.to_hash.keys.should include(key.to_sym)
+        end
+      end
+      describe "disk_assets" do
+        before :all do
+          @vars = @page.to_hash
+        end
+        describe "enum" do
+          it "should not have a child" do
+            @vars.should_not have_key(:child)
+          end
+          it "should have magic" do
+            @vars.should have_key(:magic)
+          end
+          it "it should be a an array of hashes" do
+            @vars[:magic].should be_an_instance_of(Array)
+            @vars[:magic].first.should be_an_instance_of(Hash)
+            @vars[:magic].size.should == 2
+          end
+        end
+        describe "boolean" do
+          it "should be false" do
+            pending
+            @vars[:child?].should be_false
+          end
+          it "should be true" do
+            pending
+            @vars[:magic?].should be_true
+          end
+        end
+      end
+    end
+    describe "broken page" do
+      before :all do
+        Bonsai::Page.path = "spec/support/broken/content"
+      end
+      after :all do
+        Bonsai::Page.path = "spec/support/content"
+      end
+      it "should exist" do
+        Bonsai::Page.find("page").should be_an_instance_of(Bonsai::Page)
+      end
+      it "should error gracefully" do
+        lambda { Bonsai::Page.find("page").render }.should_not raise_error(ArgumentError)
+      end
+    end
+  end
+end