staticmatic 0.9.5 → 0.10.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.10.0 2009-01-01
+
+* Refactoring for forthcoming improvements
+* Improved Error Reporting
+	* More useful error pages
+	* Removed Haml specific error handling

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/staticmatic
+lib/staticmatic.rb
+lib/staticmatic/base.rb
+lib/staticmatic/configuration.rb
+lib/staticmatic/error.rb
+lib/staticmatic/helpers.rb
+lib/staticmatic/mixins/build.rb
+lib/staticmatic/mixins/helpers.rb
+lib/staticmatic/mixins/render.rb
+lib/staticmatic/mixins/server.rb
+lib/staticmatic/mixins/setup.rb
+lib/staticmatic/server.rb
+lib/staticmatic/templates/default/application.haml
+lib/staticmatic/templates/default/application.sass
+lib/staticmatic/templates/default/index.haml
+lib/staticmatic/templates/default/index.haml
+lib/staticmatic/templates/rescues/default.haml
+lib/staticmatic/templates/rescues/template.haml
+lib/staticmatic/template_error.rb
+lib/staticmatic/mixins/rescue.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= staticmatic-core
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,33 +1,28 @@
-require 'rubygems'
-require 'rake/testtask'
-require 'rake/clean'
-Gem::manage_gems
-require 'rake/gempackagetask'
-require File.join(File.dirname(__FILE__), 'lib/staticmatic/version')
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/staticmatic'
 
-task :default => [:package]
-
-spec = Gem::Specification.new do |s|
-  s.name = "staticmatic"
-  s.rubyforge_project = "staticmatic"
-  s.version = StaticMatic::VERSION::STRING
-  s.author = "Stephen Bartholomew"
-  s.email = "steve@curve21.com"
-  s.authors << "Brent Beardsley (brentbeardsley@gmail.com)"
-  s.homepage = "http//staticmatic.rubyforge.org"
-  s.summary = "Manage static sites using Haml & Sass"
-  files = FileList["**/**/**"]
-  files.exclude 'pkg'
-  files.exclude 'contrib'
-  s.files = files.to_a
-  s.test_files =  Dir.glob("test/*_test.rb")
-  s.add_dependency("haml", ">=2.0.0")
-  s.add_dependency("mongrel")
-  s.executables=['staticmatic']
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('staticmatic', StaticMatic::VERSION) do |p|
+  p.developer('Stephen Bartholomew', 'steve@curve21.com')
+  p.rubyforge_name       = p.name 
+  p.extra_deps         = [
+    ['haml','>= 2.0'],
+    ['mongrel','>= 1.0']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-end
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
 
 desc "Run all unit tests"
 Rake::TestTask.new(:test) do |t|

data/lib/staticmatic.rb

@@ -2,11 +2,19 @@ require 'rubygems'
 require 'haml'
 require 'sass'
 require 'mongrel'
-require File.dirname(__FILE__) + '/staticmatic/helpers'
+require 'fileutils'
 
-Haml::Helpers.class_eval("include StaticMatic::Helpers")
+module StaticMatic
+  VERSION = '0.10.0'
+end
+
+["render", "build", "setup", "server", "helpers", "rescue"].each do |mixin|
+  require File.join(File.dirname(__FILE__), "staticmatic", "mixins", mixin)
+end
 
-%w(version configuration error base server).each do |file|
-  require File.join(File.dirname(__FILE__), 'staticmatic', file) 
+["base", "configuration", "error", "server", "helpers", "template_error"].each do |lib|
+  require File.join(File.dirname(__FILE__), "staticmatic", lib)
 end
 
+Haml::Helpers.class_eval("include StaticMatic::Helpers")
+

data/lib/staticmatic/base.rb

@@ -1,33 +1,38 @@
-require 'fileutils'
-
 module StaticMatic
-  class Base
-    # Directories generated for a new site setup
-    @@base_dirs = %w{
-      site/
-      site/stylesheets
-      site/images
-      site/javascripts
-      src/
-      src/pages/
-      src/layouts
-      src/stylesheets
-      src/partials
-      src/helpers
-    }
+  # Directories generated for a new site setup
+  BASE_DIRS = %w{
+    site/
+    site/stylesheets
+    site/images
+    site/javascripts
+    src/
+    src/pages/
+    src/layouts
+    src/stylesheets
+    src/helpers
+  }
+
+  # Templates for setup and their location
+  TEMPLATES = {
+    'application.haml' => 'layouts',
+    'application.sass' => 'stylesheets',
+    'index.haml' => 'pages'
+  }
   
-    # Templates for setup and their location
-    @@templates = {
-      'application.haml' => 'layouts',
-      'application.sass' => 'stylesheets',
-      'index.haml' => 'pages'
-    }
+  class Base
     
+    include StaticMatic::RenderMixin
+    include StaticMatic::BuildMixin
+    include StaticMatic::SetupMixin
+    include StaticMatic::HelpersMixin    
+    include StaticMatic::ServerMixin    
+    include StaticMatic::RescueMixin    
+  
     attr_accessor :configuration
     attr_reader :current_page, :src_dir, :site_dir
 
     def current_file
-      @current_file_stack[0]
+      @current_file_stack[0] || ""
     end
     
     def initialize(base_dir, configuration = Configuration.new)
@@ -37,7 +42,7 @@ module StaticMatic
       @base_dir = base_dir
       @src_dir = "#{@base_dir}/src"
       @site_dir = "#{@base_dir}/site"
-      @templates_dir = File.dirname(__FILE__) + '/templates'
+      @templates_dir = File.dirname(__FILE__) + '/templates/default/'
       @layout = "application"
       @scope = Object.new
       @scope.instance_variable_set("@staticmatic", self)
@@ -55,185 +60,7 @@ module StaticMatic
         puts "#{command} is not a valid StaticMatic command"
       end
     end
-    
-    def build
-      build_css
-      build_html
-    end
-  
-    def setup
-      Dir.mkdir(@base_dir) unless File.exists?(@base_dir)
-    
-      @@base_dirs.each do |directory|
-        directory = "#{@base_dir}/#{directory}"
-        if !File.exists?(directory)
-          Dir.mkdir(directory)
-          puts "created #{directory}"
-        end
-      end
-  
-      @@templates.each do |template, destination|
-        copy_file("#{@templates_dir}/#{template}", "#{@src_dir}/#{destination}")
-      end
-  
-      puts "Done"
-    end
-    
-    def preview
-      puts "StaticMatic Preview Server Starting..."
-      StaticMatic::Server.start(self)
-    end
-  
-    def copy_file(from, to)
-      FileUtils.cp(from, to)
-    end
-  
-    def save_page(filename, content)
-      generate_site_file(filename, 'html', content)
-    end
-  
-    def save_stylesheet(filename, content)
-      generate_site_file(File.join('stylesheets', filename), 'css', content)
-    end
-  
-    def generate_site_file(filename, extension, content)
-      path = File.join(@site_dir,"#{filename}.#{extension}")
-      FileUtils.mkdir_p(File.dirname(path))
-      File.open(path, 'w+') do |f|
-        f << content
-      end
-      
-      puts "created #{path}"
-    end
-    
-    def source_for_layout
-      if layout_exists?(@layout)
-        File.read(full_layout_path(@layout))
-      else
-        raise StaticMatic::Error.new("", full_layout_path(@layout), "Layout not found")
-      end
-    end
-    
-    # Generate html from source file:
-    # generate_html("index.haml")
-    def generate_html(source_file, source_dir = '')
-      full_file_path = File.join(@src_dir, 'pages', source_dir, "#{source_file}.haml")
-
-      begin
-        # clear all scope variables except @staticmatic
-        @scope.instance_variables.each do |var|
-          @scope.instance_variable_set(var, nil) unless var == '@staticmatic' 
-        end
-        html = generate_html_from_template_source(File.read(full_file_path))
       
-        @layout = detirmine_layout(source_dir)
-      rescue StaticMatic::Error => staticmatic_error
-        # Catch any errors from the actual template - otherwise the error will be assumed to be from the
-        # layout
-        raise staticmatic_error
-      rescue Haml::Error => haml_error
-        raise StaticMatic::Error.new(haml_error.line, "#{source_dir}/#{source_file}", haml_error.message)
-      end
-      
-      # 
-      # # TODO: DRY this up
-      # if @scope.instance_variable_get("@layout")
-      #   @layout = @scope.instance_variable_get("@layout")
-      # end
-      # 
-      html
-    end
-    
-    def generate_html_with_layout(source, source_dir = '')
-      @current_page = File.join(source_dir, "#{source}.html")
-      @current_file_stack.unshift(File.join(source_dir, "#{source}.haml"))
-
-      template_content = generate_html(source, source_dir)
-      @layout = detirmine_layout(source_dir)
-      
-      begin
-        generate_html_from_template_source(source_for_layout) { template_content }
-      rescue StaticMatic::Error => staticmatic_error
-        # Catch any errors from the actual template - otherwise the error will be assumed to be from the
-        # layout
-        raise staticmatic_error
-      rescue Haml::Error => haml_error
-        raise StaticMatic::Error.new("", "Layout: #{source_dir}/#{@layout}", haml_error.message)
-      ensure
-        @current_page = nil
-        @current_file_stack.shift
-      end
-    end
-    
-    def generate_partial(name, options = {})
-      partial_dir, partial_name = File.dirname(self.current_file), name  # default relative to current file
-      partial_dir, partial_name = File.split(name) if name.index('/') # contains a path so it's absolute from src/pages dir
-      partial_name = "_#{partial_name}.haml"
-
-      partial_path = File.join(@src_dir, 'pages', partial_dir, partial_name)
-      unless File.exists?(partial_path)
-        # couldn't find it in the pages subdirectory tree so try old way (ignoring the path)
-        partial_dir = 'partials'; partial_name = "#{File.basename(name)}.haml"
-        partial_path = File.join(@src_dir, partial_dir, partial_name)
-      end
-      
-      if File.exists?(partial_path)
-        partial_rel_path = "/#{partial_dir}/#{partial_name}".gsub(/\/+/, '/')
-        @current_file_stack.unshift(partial_rel_path)
-        begin
-          generate_html_from_template_source(File.read(partial_path), options)
-        rescue Haml::Error => haml_error
-          raise StaticMatic::Error.new(haml_error.line, "Partial: #{partial_rel_path[0,partial_rel_path.length-5]}", haml_error.message)
-        ensure
-          @current_file_stack.shift
-        end
-      else
-        raise StaticMatic::Error.new("", name, "Partial not found")
-      end
-    end
-
-    def generate_css(source, source_dir = '')
-      full_file_path = File.join(@src_dir, 'stylesheets', source_dir, "#{source}.sass")
-      begin
-        sass_options = { :load_paths => [ File.join(@src_dir, 'stylesheets') ] }.merge(self.configuration.sass_options)
-        stylesheet = Sass::Engine.new(File.read(full_file_path), sass_options)
-        stylesheet.to_css
-      rescue Sass::SyntaxError => sass_error
-        raise StaticMatic::Error.new(sass_error.sass_line, full_file_path, sass_error.message)
-      end
-    end
-    
-    # Generates html from the passed source string
-    #
-    # generate_html_from_template_source("%h1 Welcome to My Site") -> "<h1>Welcome to My Site</h1>"
-    #
-    # Pass a block containing a string to yield within in the passed source:
-    #
-    # generate_html_from_template_source("content:\n= yield") { "blah" } -> "content: blah"
-    #
-    def generate_html_from_template_source(source, options = {})
-      html = Haml::Engine.new(source, options)
-
-      html.render(@scope) { yield }
-    end
-    
-    def detirmine_layout(dir = '')
-      layout_name = "application"
-      
-      if @scope.instance_variable_get("@layout")
-        layout_name = @scope.instance_variable_get("@layout")
-      elsif dir
-        dirs = dir.split("/")
-        dir_layout_name = dirs[1]
-        
-        if layout_exists?(dir_layout_name)
-          layout_name = dir_layout_name
-        end
-      end
-
-      layout_name
-    end
-  
     # TODO: DRY this _exists? section up
     def template_exists?(name, dir = '')
       File.exists?(File.join(@src_dir, 'pages', dir, "#{name}.haml")) || File.exists?(File.join(@src_dir, 'stylesheets', "#{name}.sass"))
@@ -251,48 +78,9 @@ module StaticMatic
       "#{@src_dir}/layouts/#{name}.haml"
     end
     
-    # Build HTML from the source files
-    def build_html
-      Dir["#{@src_dir}/pages/**/*.haml"].each do |path|
-        next if File.basename(path) =~ /^\_/  # skip partials
-        file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}\/pages/, ''))
-        save_page(File.join(file_dir, template), generate_html_with_layout(template, file_dir))
-      end
-    end
-  
-    # Build CSS from the source files
-    def build_css
-      Dir["#{@src_dir}/stylesheets/**/*.sass"].each do |path|
-        file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}\/stylesheets/, ''))
-        save_stylesheet(File.join(file_dir, template), generate_css(template, file_dir))
-      end
-    end
-    
-    # Returns a raw template name from a source file path:
-    # source_template_from_path("/path/to/site/src/stylesheets/application.sass")  ->  "application"
-    def source_template_from_path(path)
-      file_dir, file_name = File.split(path)
-      file_name.chomp!(File.extname(file_name))
-      [ file_dir, file_name ]
-    end
-    
-    # Loads any helpers present in the helpers dir and mixes them into the template helpers
-    def load_helpers
-
-      Dir["#{@src_dir}/helpers/**/*_helper.rb"].each do |helper|
-        load_helper(helper)
-      end
-    end
-
-    def load_helper(helper)
-      load helper
-      module_name = File.basename(helper, '.rb').gsub(/(^|\_)./) { |c| c.upcase }.gsub(/\_/, '')
-      Haml::Helpers.class_eval("include #{module_name}")
-    end
-    
     class << self
       def base_dirs
-        @@base_dirs
+        StaticMatic::BASE_DIRS
       end
     end
   end