bonsai 1.0.0

data/lib/bonsai.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'fileutils'
+require 'logger'
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/bonsai"
+
+module Bonsai
+  @@root_dir = nil
+  @@config = { :enable_logging => true }
+
+  class << self
+    def root_dir
+      @@root_dir || Dir.pwd
+    end
+  
+    def root_dir=(path)
+      unless is_a_bonsai?(path)
+        log "no bonsai site found - are you in the right directory?" 
+        exit 0
+      end
+      
+      @@root_dir = path
+      
+      Exporter.path = "#{path}/output"
+      Page.path = "#{path}/content"
+      Template.path = "#{path}/templates"
+    end
+    
+    def log(message)
+      puts message if @@config[:enable_logging]
+    end
+  
+    def config
+      @@config 
+    end
+  
+    def configure(&block)
+      yield @@config
+    end
+    
+    def version
+      File.read("#{File.dirname(__FILE__)}/../VERSION")
+    end
+    
+    private
+    def is_a_bonsai?(path)
+      File.directory?("#{path}/content") && File.directory?("#{path}/public") && File.directory?("#{path}/templates")
+    end
+  end
+  
+  autoload :Page,               "page"
+  autoload :Console,            "console"
+  autoload :Exporter,           "exporter"
+  autoload :Template,           "template"
+  autoload :Generate,           "generate"
+  autoload :Navigation,         "navigation"
+  autoload :PagePresenter,      "page_presenter"
+  autoload :StaticPassThrough,  "webserver"
+  autoload :DevelopmentServer,  "webserver"
+end

data/lib/bonsai/console.rb

@@ -0,0 +1,8 @@
+require 'irb'
+module Bonsai
+  class Console
+    def initialize
+      IRB.start(__FILE__)
+    end
+  end
+end

data/lib/bonsai/exporter.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+require 'less'
+
+module Bonsai
+  class Exporter
+    @@path = "output"
+    
+    class << self
+      def path; @@path; end
+      def path=(path); @@path = path; end
+      
+      def process!
+        setup
+        copy_public
+        copy_assets
+        cleanup
+      end
+      
+      def publish!
+        teardown
+        setup
+        copy_assets
+        copy_public
+        compress_assets
+        write_index
+        write_pages
+        cleanup
+      end
+      
+      protected 
+      def teardown
+        FileUtils.rm_rf path
+      end
+
+      def setup
+        FileUtils.mkdir_p path
+      end
+      
+      def cleanup
+        remove_less_from_public
+      end
+      
+      def write_index
+        Bonsai.log "Writing index"
+        File.open("#{path}/index.html", "w") {|file| file.write(Page.find("index").render)}
+      end
+      
+      def write_pages
+        Bonsai.log "Writing pages"
+        Page.all.each do |page|
+          Bonsai.log "\t Writing page - #{page.permalink}"
+          FileUtils.mkdir_p("#{path}#{page.permalink}")
+          File.open("#{path}#{page.write_path}", "w"){|file| file.write(page.render) }
+        end
+      end
+      
+      def copy_assets
+        Bonsai.log "Copying page assets"
+        Page.all.each do |page|
+          page.assets.each do |asset|      
+            # Create the path to the asset by the export path of the page + File.dirname(asset permalink)
+            FileUtils.mkdir_p "#{path}#{File.dirname(asset[:path])}"
+            
+            # Copy the the asset from its disk path to File.dirname(asset permalink)
+            FileUtils.cp asset[:disk_path], "#{path}#{asset[:path]}"            
+          end
+        end
+      end
+      
+      def copy_public
+        generate_css_from_less
+        
+        Bonsai.log "Copying public files"
+        # Using system call because fileutils is inadequate
+        system("cp -fR '#{Bonsai.root_dir}/public/' '#{path}'")
+      end
+      
+      def compress_assets
+        yui_compressor = File.expand_path("#{File.dirname(__FILE__)}/../../vendor/yui-compressor/yuicompressor-2.4.2.jar")
+        
+        Bonsai.log "Compressing javascript and stylesheets"
+        Dir["#{path}/**/*.{js,css}"].each do |asset|
+          system "java -jar #{yui_compressor} #{File.expand_path(asset)} -o #{File.expand_path(asset)}"
+        end
+      end
+      
+      def generate_css_from_less
+        Dir["#{Bonsai.root_dir}/public/**/*.less"].each do |lessfile|
+          css = File.open(lessfile) {|f| Less::Engine.new(f) }.to_css
+          path = "#{File.dirname(lessfile)}/#{File.basename(lessfile, ".less")}.css"
+          
+          File.open(path, "w") {|file| file.write(css) }
+        end
+      rescue Less::SyntaxError => exception
+        Bonsai.log "LessCSS Syntax error\n\n#{exception.message}"
+      end
+      
+      def remove_less_from_public
+        Dir["#{path}/**/*.less"].each{|f| FileUtils.rm(f) }
+      end
+    end
+  end
+end

data/lib/bonsai/generate.rb

@@ -0,0 +1,24 @@
+module Bonsai
+  class Generate  
+    def initialize(path)
+      @path = path
+    
+      Bonsai.log "Planting your bonsai '#{path}'"
+      copy_templates
+      create_directories
+    end
+  
+    private  
+    def create_directories
+      %w(content content/index public/docs/css public/docs/js).each do |dir|
+        Bonsai.log "\tcreate\t#{dir}"
+        FileUtils.mkdir_p(File.join(@path, dir))
+      end
+    end
+  
+    def copy_templates
+      # Using system call because fileutils is inadequate
+      system("cp -fR '#{File.expand_path("#{File.dirname(__FILE__)}/templates")}' '#{@path}'")
+    end
+  end
+end

data/lib/bonsai/navigation.rb

@@ -0,0 +1,7 @@
+module Bonsai
+  class Navigation
+    def self.tree
+      Page.all(Page.path, "*").select{|p| File.dirname(p.disk_path).match(/\d.*$/) }
+    end
+  end
+end

data/lib/bonsai/page.rb

@@ -0,0 +1,192 @@
+require 'yaml'
+require 'rdiscount'
+require 'tilt'
+
+module Bonsai
+  class Page
+    class NotFound < StandardError; end;
+    class PropertyNotFound < StandardError; end
+    @@pages = {}
+    
+    class << self    
+      def path; @@path; end
+      def path=(path); @@path = path; end
+      
+      def all(dir_path = path, pattern = "*/**")
+        Dir["#{dir_path}/#{pattern}/*.yml"].map {|p| Page.new p }
+      end
+      
+      def find(permalink)        
+        @@pages[permalink] ||= find!(permalink)
+      end
+      
+      private
+      def find!(permalink)
+        search_path = permalink.gsub("/", "/*")
+        disk_path = Dir["#{path}/*#{search_path}/*.yml"]
+        if disk_path.any?
+          return new disk_path.first
+        else
+          raise NotFound, "page '#{permalink}' not found at '#{path}'"
+        end
+      end
+    end
+    
+    attr_reader :disk_path
+    
+    def initialize(path)
+      @disk_path = path
+    end
+    
+    def slug
+      permalink.split('/').pop
+    end
+    
+    def name
+      slug.gsub(/\W/, " ").gsub(/\d\./, '').gsub(/^\w/){$&.upcase}
+    end
+    
+    def permalink
+      web_path(directory)
+    end
+    
+    def write_path
+      "#{permalink}/index.html"
+    end
+    
+    def template
+      Template.find(template_name)
+    end
+    
+    # This method is used for the exporter to copy assets
+    def assets
+      Dir["#{directory}/**/*"].select{|p| !File.directory?(p) && !File.basename(p).include?("yml") }.map do |a|
+        {
+          :name       => File.basename(a),
+          :path       => web_path(a),
+          :disk_path  => a
+        }
+      end
+    end
+    
+    def floating?
+      !!(File.dirname(disk_path) =~ /\/[a-zA-z][\w-]+$/)
+    end
+    
+    def parent
+      id = permalink[/^\/(.+)\/[^\/]*$/, 1]
+      return nil if id.nil?
+      
+      parent = Page.find(id)
+      return nil if parent == self
+      
+      parent
+    rescue NotFound
+      nil
+    end
+    
+    def siblings
+      self.class.all(File.dirname(disk_path[/(.+)\/[^\/]*$/, 1]), "*").delete_if{|p| p == self}
+    end
+    
+    def children
+      self.class.all(File.dirname(disk_path), "*").delete_if{|p| p.floating? }
+    end
+    
+    def ancestors
+      ancestors = []
+      # Remove leading slash
+      page_ref = permalink.gsub(/^\//, '')
+      
+      # Find pages up the permalink tree if possible
+      while(page_ref) do
+        page_ref = page_ref[/(.+)\/[^\/]*$/, 1]
+        ancestors << self.class.find(page_ref) rescue nil
+      end
+      
+      ancestors.compact.reverse
+    end
+    
+    def ==(other)
+      self.permalink == other.permalink
+    end
+    
+    def render
+      Tilt.new(template.path, :path => template.class.path).render(self, to_hash)
+    rescue => stack
+      raise "Issue rendering #{permalink}\n\n#{stack}"
+    end
+    
+    def content
+      YAML::load(File.read(@disk_path)) || {}
+    rescue ArgumentError
+      Bonsai.log "Page '#{permalink}' has badly formatted content"
+    end
+    
+    # This hash is available to all templates, it will map common properties, 
+    # content file results, as well as any "magic" hashes for file 
+    # system contents
+    def to_hash
+      {
+        :slug         => slug, 
+        :permalink    => permalink, 
+        :name         => name, 
+        :children     => children,
+        :siblings     => siblings,
+        :parent       => parent, 
+        :ancestors    => ancestors,
+        :navigation   => Bonsai::Navigation.tree
+      }.merge(formatted_content).merge(disk_assets)
+    end
+    
+    private
+    def formatted_content
+      formatted_content = content
+      
+      formatted_content.each do |k,v|
+        if v.is_a?(String) and v =~ /\n/
+          formatted_content[k] = RDiscount.new(v, :smart).to_html
+        end
+      end
+      
+      formatted_content
+    end
+    
+    # Creates methods for each sub-folder within the page's folder
+    # that isn't a sub-page (a page object)
+    def disk_assets
+      assets = {}
+      Dir["#{File.dirname(disk_path)}/**"].select{|p| File.directory?(p)}.reject {|p|
+        Dir.entries(p).any?{|e| e.include? "yml"}
+      }.each{|asset_path| assets.merge!(map_to_disk(asset_path)) }
+
+      assets
+    end
+    
+    def map_to_disk(path)
+      name = File.basename(path)
+      
+      {
+        name.to_sym => Dir["#{path}/*"].map do |file|
+          {
+            :name       => File.basename(file),
+            :path       => web_path(file),
+            :disk_path  => file
+          }  
+        end
+      }
+    end
+    
+    def directory
+      @disk_path.split("/")[0..-2].join("/")
+    end
+    
+    def template_name
+      File.basename(@disk_path, '.*')
+    end
+    
+    def web_path(path)
+      path.gsub(self.class.path, '').gsub(/\/\d+\./, '/')
+    end
+  end
+end

data/lib/bonsai/template.rb

@@ -0,0 +1,31 @@
+module Bonsai
+  class Template
+    @@path = "templates"
+    
+    class NotFound < StandardError; end
+    
+    class << self
+      def path; @@path; end
+      
+      def path=(path)
+        @@path = path
+      end
+      
+      def find(name)
+        disk_path = Dir["#{path}/#{name}.*"]
+        
+        if disk_path.any? 
+          new disk_path.first
+        else
+          raise NotFound, "template '#{name}' not found at #{path}"
+        end
+      end
+    end
+    
+    attr_reader :path
+    
+    def initialize(path)
+      @path = path
+    end
+  end
+end

data/lib/bonsai/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/lib/bonsai/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