staticmatic 0.9.5 → 0.10.0

data/lib/staticmatic/mixins/build.rb

@@ -0,0 +1,46 @@
+module StaticMatic::BuildMixin
+    
+  def build
+    build_css
+    build_html
+  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
+  
+  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
+end

data/lib/staticmatic/mixins/helpers.rb

@@ -0,0 +1,15 @@
+module StaticMatic::HelpersMixin    
+  # 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
+end

data/lib/staticmatic/mixins/render.rb

@@ -0,0 +1,125 @@
+module StaticMatic::RenderMixin
+  
+  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")
+  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 = determine_layout(source_dir)
+    rescue StaticMatic::TemplateError => e
+      raise e # re-raise inline errors
+    rescue Exception => e
+      raise StaticMatic::TemplateError.new(full_file_path, e)
+    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"))
+    begin 
+      template_content = generate_html(source, source_dir)
+      @layout = determine_layout(source_dir)
+      generate_html_from_template_source(source_for_layout) { template_content }
+    rescue Exception => e
+      render_rescue_from_error(e)
+    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 Exception => e
+        raise StaticMatic::TemplateError.new(partial_path, e)
+      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 Exception => e
+      render_rescue_from_error(StaticMatic::TemplateError.new(full_file_path, e))
+    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 determine_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
+    
+  # 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
+end

data/lib/staticmatic/mixins/rescue.rb

@@ -0,0 +1,12 @@
+module StaticMatic::RescueMixin
+  # Pass back an error template for the given exception
+  def render_rescue_from_error(exception)
+    rescue_template     = (exception.is_a?(StaticMatic::TemplateError)) ? "template" : "default"
+      
+    error_template_path = File.expand_path(File.dirname(__FILE__) + "/../templates/rescues/#{rescue_template}.haml")
+    
+    @scope.instance_variable_set("@exception", exception)
+    
+    generate_html_from_template_source(File.read(error_template_path))
+  end
+end

data/lib/staticmatic/mixins/server.rb

@@ -0,0 +1,6 @@
+module StaticMatic::ServerMixin
+  def preview
+    puts "StaticMatic Preview Server Starting..."
+    StaticMatic::Server.start(self)
+  end
+end

data/lib/staticmatic/mixins/setup.rb

@@ -0,0 +1,20 @@
+module StaticMatic::SetupMixin
+  
+  def setup
+    Dir.mkdir(@base_dir) unless File.exists?(@base_dir)
+  
+    StaticMatic::BASE_DIRS.each do |directory|
+      directory = "#{@base_dir}/#{directory}"
+      if !File.exists?(directory)
+        Dir.mkdir(directory)
+        puts "created #{directory}"
+      end
+    end
+
+    StaticMatic::TEMPLATES.each do |template, destination|
+      copy_file("#{@templates_dir}/#{template}", "#{@src_dir}/#{destination}")
+    end
+
+    puts "Done"
+  end
+end

data/lib/staticmatic/template_error.rb

@@ -0,0 +1,40 @@
+class StaticMatic::TemplateError < StandardError
+  SOURCE_CODE_RADIUS = 3
+  
+  attr_reader :original_exception, :backtrace
+
+  def initialize(template, original_exception)
+    @template, @original_exception = template, original_exception
+    @backtrace = original_exception.backtrace
+
+    @source = File.read(template)
+  end
+  
+  # TODO: Replace 'haml|sass' with any registered engines
+  def line_number
+    @line_number ||= $2 if backtrace.find { |line| line =~ /\((haml|sass)\)\:(\d+)/ }
+  end
+  
+  def filename
+    @template
+  end
+  
+  def source_extract(indentation = 0)
+    return unless num = line_number
+    num = num.to_i
+
+    source_code = @source.split("\n")
+
+    start_on_line = [ num - SOURCE_CODE_RADIUS - 1, 0 ].max
+    end_on_line   = [ num + SOURCE_CODE_RADIUS - 1, source_code.length].min
+
+    indent = ' ' * indentation
+    line_counter = start_on_line
+    return unless source_code = source_code[start_on_line..end_on_line]
+
+    source_code.collect do |line|
+      line_counter += 1
+      "#{indent}#{line_counter}: #{line}\n"
+    end.to_s
+  end
+end

data/lib/staticmatic/templates/rescues/default.haml

@@ -0,0 +1,7 @@
+%h1= @exception.class.name
+
+%p= @exception.message
+
+%h2 Stack Trace
+
+= @exception.backtrace.join("<br/>")

data/lib/staticmatic/templates/rescues/template.haml

@@ -0,0 +1,18 @@
+%html
+  %head
+    %style{:type => "text/css"}
+      body { font-family: helvetica, verdana, arial; font-size: 10pt;}
+  %body
+    %h1
+      = @exception.class.name
+      in
+      = @exception.filename
+
+    %p= @exception.original_exception.message
+  
+    = @exception.source_extract.gsub(/\n/, "<br/>")
+
+
+    %h2 Backtrace
+
+    = @exception.backtrace.join("<br/>")

data/test/test_helper.rb

@@ -1,48 +1,20 @@
-require 'test/unit'
-
-class Test::Unit::TestCase
-
-  # Split an (X)HTML tag into its constituent parts, e.g. tag name, tag attributes (if any),
-  # and tag content (if any).  We are assuming that we are being given a valid XHTML tag (i.e
-  # all attributes have both a name and a value, and that value is enclosed in double quotes).
-  # Returns a hash:
-  #   { :name => 'tag_name', :attributes => {'attribute1' => 'value1', ...}, :content => 'text content' } 
-  def split_html_tag(tag)
-    # Rather then try to come up with some big huge regexp that matches every bit of
-    # the tag, let's just easily match each part.
-
-    # Match the tag name
-    name_match = /<(\w+)/.match(tag)
-    name = (name_match.nil? ? nil : name_match[1])
-    
-    # Match the tag content
-    content_match = /<.+>(.*)<\/.+>/.match(tag)
-    content = (content_match.nil? ? nil : content_match[1])
-    
-    # Match _all_ the key => value attribute pairs
-    attributes = {}
-    rest_of_tag = tag
-    while (attribute_match = /(\w+)="([^"]+)"/.match(rest_of_tag))
-      attributes[attribute_match[1]] = attribute_match[2]
-      rest_of_tag = attribute_match.post_match
-    end
-    
-    {:name => name, :attributes => attributes, :content => content}
-  end
-
-  # Asserts that two html tags match each other.  In this case 'matching' means that they have
-  # the same name, same attributes (which can be in any order) and the same content (if any).
-  # Note: this does not check tags for well-formedness.
-  def assert_tags_match(tag_one, tag_two, message = nil)
-    message = build_message message, 'Tag <?> does not match <?>.', tag_one, tag_two
-    assert_block message do
-      split_tag_one = split_html_tag(tag_one)
-      split_tag_two = split_html_tag(tag_two)
-
-      (split_tag_one[:name] === split_tag_two[:name]) &&
-        (split_tag_one[:attributes] === split_tag_two[:attributes]) &&
-        (split_tag_one[:content] === split_tag_two[:content])
-    end
-  end
-  
-end
+require 'rubygems'
+require 'stringio'
+require 'test/unit'
+
+require File.dirname(__FILE__) + '/../lib/staticmatic'
+
+TEST_SITE_PATH = File.join(File.dirname(__FILE__), "sandbox", "test_site")
+
+class Test::Unit::TestCase
+  def self.should(description, &block)
+    test_name = "test_should_#{description.gsub(/[\s]/,'_')}".to_sym
+    raise "#{test_name} is already defined in #{self}" if self.instance_methods.include?(test_name.to_s)
+    define_method(test_name, &block)
+  end
+end
+
+def setup_staticmatic
+  @staticmatic = StaticMatic::Base.new(TEST_SITE_PATH)
+end
+

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: staticmatic
 version: !ruby/object:Gem::Version 
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors: 
 - Stephen Bartholomew
-- Brent Beardsley (brentbeardsley@gmail.com)
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-12-15 00:00:00 +00:00
+date: 2009-01-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: "2.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: mongrel
@@ -31,133 +30,69 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "1.0"
     version: 
-description: 
-email: steve@curve21.com
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: FIX (describe your package)
+email: 
+- steve@curve21.com
 executables: 
 - staticmatic
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
 files: 
-- bin
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
 - bin/staticmatic
-- CHANGELOG
-- example
-- example/site
-- example/site/contact.html
-- example/site/images
-- example/site/index.html
-- example/site/javascripts
-- example/site/javascripts/application.css
-- example/site/stylesheets
-- example/src
-- example/src/layouts
-- example/src/layouts/application.haml
-- example/src/pages
-- example/src/pages/contact.haml
-- example/src/pages/index.haml
-- example/src/pages/test test
-- example/src/pages/test test/blah.haml
-- example/src/stylesheets
-- example/src/stylesheets/application.sass
-- lib
-- lib/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
-- lib/staticmatic/templates/application.haml
-- lib/staticmatic/templates/application.sass
-- lib/staticmatic/templates/index.haml
-- lib/staticmatic/version.rb
-- lib/staticmatic.rb
-- LICENSE
-- Rakefile
-- README
-- test
-- test/base_test.rb
-- test/helpers_test.rb
-- test/sandbox
-- test/sandbox/test_site
-- test/sandbox/test_site/configuration.rb
-- test/sandbox/test_site/site
-- test/sandbox/test_site/site/images
-- test/sandbox/test_site/site/index.html
-- test/sandbox/test_site/site/javascripts
-- test/sandbox/test_site/site/stylesheets
-- test/sandbox/test_site/site/stylesheets/application.css
-- test/sandbox/test_site/src
-- test/sandbox/test_site/src/helpers
-- test/sandbox/test_site/src/helpers/application_helper.rb
-- test/sandbox/test_site/src/layouts
-- test/sandbox/test_site/src/layouts/alternate_layout.haml
-- test/sandbox/test_site/src/layouts/application.haml
-- test/sandbox/test_site/src/layouts/projects.haml
-- test/sandbox/test_site/src/pages
-- test/sandbox/test_site/src/pages/index.haml
-- test/sandbox/test_site/src/pages/layout_test.haml
-- test/sandbox/test_site/src/partials
-- test/sandbox/test_site/src/partials/menu.haml
-- test/sandbox/test_site/src/stylesheets
-- test/sandbox/test_site/src/stylesheets/application.sass
-- test/sandbox/tmp
-- test/server_test.rb
-- test/test_helper.rb
-- test/test_helper_test.rb
-- test/version_test.rb
-- website
-- website/site
-- website/site/download.html
-- website/site/faq.html
-- website/site/helper_central
-- website/site/helper_central/index.html
-- website/site/how_to_use.html
-- website/site/images
-- website/site/images/bycurve21.gif
-- website/site/images/curve21.jpg
-- website/site/images/homepage-build.jpg
-- website/site/images/homepage-previewing.jpg
-- website/site/images/homepage-templating.jpg
-- website/site/index.html
-- website/site/releases
-- website/site/releases/0_8_10.html
-- website/site/releases/0_8_4.html
-- website/site/releases/0_8_8.html
-- website/site/releases/0_9_0.html
-- website/site/stylesheets
-- website/site/stylesheets/application.css
-- website/src
-- website/src/helpers
-- website/src/helpers/application_helper.rb
-- website/src/layouts
-- website/src/layouts/application.haml
-- website/src/layouts/test.haml
-- website/src/pages
-- website/src/pages/_qa.haml
-- website/src/pages/download.haml
-- website/src/pages/faq.haml
-- website/src/pages/helper_central
-- website/src/pages/helper_central/_helper.haml
-- website/src/pages/helper_central/index.haml
-- website/src/pages/how_to_use.haml
-- website/src/pages/index.haml
-- website/src/pages/releases
-- website/src/pages/releases/0_8_10.haml
-- website/src/pages/releases/0_8_4.haml
-- website/src/pages/releases/0_8_8.haml
-- website/src/pages/releases/0_9_0.haml
-- website/src/partials
-- website/src/partials/news.haml
-has_rdoc: false
-homepage: http//staticmatic.rubyforge.org
+- lib/staticmatic/templates/default/application.haml
+- lib/staticmatic/templates/default/application.sass
+- 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
+has_rdoc: true
+homepage: FIX (url)
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -178,10 +113,6 @@ rubyforge_project: staticmatic
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Manage static sites using Haml & Sass
+summary: FIX (describe your package)
 test_files: 
-- test/base_test.rb
-- test/helpers_test.rb
-- test/server_test.rb
-- test/test_helper_test.rb
-- test/version_test.rb
+- test/test_helper.rb