staticmatic 0.8.6 → 0.8.8

data/bin/staticmatic

@@ -1,26 +1,6 @@
 #!/usr/bin/env ruby
-require 'optparse'
-DEFAULT_PORT = 3000
-DEFAULT_HOST = "127.0.0.1"
-require File.dirname(__FILE__) + '/../lib/staticmatic'
-
-$options = {:host=>DEFAULT_HOST,:port=>DEFAULT_PORT}
 
-optparse = OptionParser.new do |opt|
-  opt.banner = "Usage: #{$0} <build|setup|preview> [OPTIONS]"
-  opt.separator ""
-  opt.on "-p", "--port [PORT]", "Select the server port, defaults to #{DEFAULT_PORT}" do |port|
-    $options[:port] = port
-  end
-  opt.on "-h", "--host [HOST]", "Select the server host, defaults to #{DEFAULT_HOST}" do |host|
-    $options[:host] = host
-  end
-  opt.on_tail "-h", "--help", "Display this help message" do
-    puts opt
-    exit
-  end
-end
-optparse.parse!
+require File.dirname(__FILE__) + '/../lib/staticmatic'
 
 command = ARGV[0]
 directory = ARGV[1]
@@ -30,5 +10,14 @@ if !command || !directory
   exit
 end
 
-staticmatic = StaticMatic::Base.new(directory)
+configuration = StaticMatic::Configuration.new
+
+config_file = "#{directory}/src/configuration.rb"
+
+if File.exists?(config_file)
+  config = File.read(config_file)
+  eval(config)
+end
+
+staticmatic = StaticMatic::Base.new(directory, configuration)
 staticmatic.run(command)

data/lib/staticmatic/base.rb

@@ -12,6 +12,8 @@ module StaticMatic
       src/pages/
       src/layouts
       src/stylesheets
+      src/partials
+      src/helpers
     }
   
     # Templates for setup and their location
@@ -21,7 +23,11 @@ module StaticMatic
       'index.haml' => 'pages'
     }
     
-    def initialize(base_dir)
+    attr_accessor :configuration
+    
+    def initialize(base_dir, configuration = Configuration.new)
+      
+      @configuration = configuration
       @base_dir = base_dir
       @src_dir = "#{@base_dir}/src"
       @site_dir = "#{@base_dir}/site"
@@ -29,9 +35,9 @@ module StaticMatic
       @layout = "application"
       @scope = Object.new
       @scope.instance_variable_set("@staticmatic", self)
+      load_helpers
     end
     
-    
     def base_dir
       @base_dir
     end
@@ -40,6 +46,7 @@ module StaticMatic
       valid_commands = ['build', 'setup', 'preview']
       
       if valid_commands.include?(command)
+
         send(command)
       else
         puts "#{command} is not a valid StaticMatic command"
@@ -73,7 +80,7 @@ module StaticMatic
     
     def preview
       puts "StaticMatic Preview Server Starting..."
-      StaticMatic::Server.start(@base_dir)
+      StaticMatic::Server.start(@base_dir, self, configuration)
     end
   
     def copy_file(from, to)
@@ -175,7 +182,6 @@ module StaticMatic
     # generate_html_from_template_source("content:\n= yield") { "blah" } -> "content: blah"
     #
     def generate_html_from_template_source(source)
-      
       html = Haml::Engine.new(source)
 
       html.render(@scope) { yield }
@@ -241,7 +247,16 @@ module StaticMatic
       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
+        Haml::Helpers.class_eval("include #{File.basename(helper, '.rb').classify}")
+      end
+    end
+    
     class << self
       def base_dirs
         @@base_dirs

data/lib/staticmatic/configuration.rb

@@ -0,0 +1,20 @@
+module StaticMatic
+  class Configuration
+    attr_accessor :preview_server_port
+
+    attr_accessor :preview_server_host
+    
+    attr_accessor :use_relative_paths_for_links
+    attr_accessor :use_relative_paths_for_images
+    attr_accessor :use_relative_paths_for_stylesheets
+    attr_accessor :use_relative_paths_for_javascripts
+    
+    def initialize
+      self.preview_server_port = 3000
+      self.use_relative_paths_for_links = false
+      self.use_relative_paths_for_images = false
+      self.use_relative_paths_for_stylesheets = false
+      self.use_relative_paths_for_javascripts = false
+    end
+  end
+end

data/lib/staticmatic/helpers.rb

@@ -27,9 +27,10 @@ module StaticMatic
         filename_without_extension = File.basename(path).chomp(File.extname(path))
         href = "stylesheets/#{filename_without_extension}.css"
         
-        if !options[:relative]
+        unless @staticmatic.configuration.use_relative_paths_for_stylesheets
           href = "/#{href}"
         end
+
         output << tag(:link, :href => href, :rel => 'stylesheet', :media => 'all')
       end
       
@@ -44,7 +45,12 @@ module StaticMatic
       output = ""
       files.each do |file|
         if !file.match(/^http\:\/\//)
-          output << tag(:script, :language => 'javascript', :src => "javascripts/#{file}.js", :type => "text/javascript") { "" }
+          src = "javascripts/#{file}.js"
+          unless @staticmatic.configuration.use_relative_paths_for_javascripts
+            src = "/#{src}"
+          end
+          
+          output << tag(:script, :language => 'javascript', :src => src, :type => "text/javascript") { "" }
         end
       end
       output
@@ -64,19 +70,33 @@ module StaticMatic
     #
     # link('Test')  ->  <a href="test.html">Test</a>
     #
-    def link(title, page = "", options = {})
-      if page.blank?
-        page = urlify(title) + ".html"
+    def link(title, href = "", options = {})
+      
+      if href.blank?
+        href = urlify(title) + ".html"
       end
       
-      options.merge!(:href => page)
+      options.merge!(:href => href)
+      
+      unless @staticmatic.configuration.use_relative_paths_for_links || href.match(/^#|\/|(http\:\/\/)/)
+        options[:href] = "/#{options[:href]}"
+      end
       
       tag(:a, options) { title }
     end
     
     # Generates an image tag
     def img(name, options = {})
-      options[:src] = "/images/#{name}"
+      if !name.match(/^\//)
+        options[:src] = "images/#{name}"
+      else
+        options[:src] = name
+      end
+
+      unless @staticmatic.configuration.use_relative_paths_for_images || options[:src].match(/^#|\/|(http\:\/\/)/)
+        options[:src] = "/#{options[:src]}"
+      end
+      
       options[:alt] ||= name.split('.').first.capitalize.gsub(/_|-/, ' ')
       tag :img, options
     end

data/lib/staticmatic/server.rb

@@ -2,9 +2,9 @@ module StaticMatic
   class Server < Mongrel::HttpHandler
     @@file_only_methods = ["GET","HEAD"]
  
-    def initialize(base_dir)
+    def initialize(base_dir, staticmatic)
       @files = Mongrel::DirHandler.new("#{base_dir}/site",false)
-      @staticmatic = StaticMatic::Base.new(base_dir)
+      @staticmatic = staticmatic
     end
   
     def process(request, response)
@@ -72,11 +72,12 @@ module StaticMatic
       #
       # StaticMatic.start('/path/to/site/')
       #
-      def start(base_dir, port = $options[:port])
-        config = Mongrel::Configurator.new :host => $options[:host] do
-          puts "Running Preview of #{base_dir} on #{$options[:host]}:#{port}"
+      def start(base_dir, staticmatic, configuration = Configuration.new)
+        port = configuration.preview_server_port || 3000
+        config = Mongrel::Configurator.new :host => configuration.preview_server_host do
+          puts "Running Preview of #{base_dir} on #{configuration.preview_server_host||"localhost"}:#{port}"
           listener :port => port do
-            uri "/", :handler => Server.new(base_dir)
+            uri "/", :handler => Server.new(base_dir, staticmatic)
           end
           trap("INT") { stop }
           run

data/lib/staticmatic.rb

@@ -5,6 +5,7 @@ require File.dirname(__FILE__) + '/staticmatic/helpers'
 
 Haml::Helpers.class_eval("include StaticMatic::Helpers")
 
+require File.dirname(__FILE__) + '/staticmatic/configuration'
 require File.dirname(__FILE__) + '/staticmatic/error'
 require File.dirname(__FILE__) + '/staticmatic/base'
 require File.dirname(__FILE__) + '/staticmatic/server'

data/test/base_test.rb

@@ -4,30 +4,30 @@ require File.dirname(__FILE__) + '/../lib/staticmatic'
 class StaticMaticBaseTest < Test::Unit::TestCase
   def setup
     @base_dir = File.dirname(__FILE__) + '/sandbox/test_site'
-    @tmp_dir = File.dirname(__FILE__) + '/sandbox/tmp'
-    
     @staticmatic = StaticMatic::Base.new(@base_dir)
   end
   
   def test_should_setup_directories
-    staticmatic = StaticMatic::Base.new(@tmp_dir)
+    tmp_dir = File.dirname(__FILE__) + '/sandbox/tmp'
+    staticmatic = StaticMatic::Base.new(tmp_dir)
     staticmatic.run('setup')
     
     StaticMatic::Base.base_dirs.each do |dir|
-      assert File.exists?("#{@tmp_dir}/#{dir}"), "Should create #{dir}"
+      assert File.exists?("#{tmp_dir}/#{dir}"), "Should create #{dir}"
     end
     
     StaticMatic::Base.base_dirs.reverse.each do |dir|
-      Dir.entries("#{@tmp_dir}/#{dir}").each do |file|
+      Dir.entries("#{tmp_dir}/#{dir}").each do |file|
         next if file.match(/^\./)
-        File.delete("#{@tmp_dir}/#{dir}/#{file}")
+        File.delete("#{tmp_dir}/#{dir}/#{file}")
       end
-      Dir.delete("#{@tmp_dir}/#{dir}") if File.exists?("#{@tmp_dir}/#{dir}")
+      Dir.delete("#{tmp_dir}/#{dir}") if File.exists?("#{tmp_dir}/#{dir}")
     end
 
   end
 
   def test_should_generate_html_with_layout
+
     content = @staticmatic.generate_html_with_layout("index")
     assert_match "StaticMatic", content
     assert_match "This is some test content", content
@@ -49,4 +49,9 @@ class StaticMaticBaseTest < Test::Unit::TestCase
   def test_should_find_layout_from_passed_path
     assert_equal "projects", @staticmatic.detirmine_layout("test/projects")
   end
+  
+  def test_should_include_custom_helper
+    content = @staticmatic.generate_html_with_layout("index")
+    assert_match "Hello, Steve!", content
+  end
 end

data/test/helpers_test.rb

@@ -12,18 +12,14 @@ class HelpersTest < Test::Unit::TestCase
     assert_match "href=\"/stylesheets\/application.css\"", stylesheets
   end
   
-  def test_should_generate_stylesheet_links_with_relative_path
-    assert_match "href=\"stylesheets\/application.css\"", stylesheets(:relative => true)
-  end
-  
   def test_should_autolink_page
-    expected_output = %q{<a href="test.html">Test</a>}
+    expected_output = %q{<a href="/test.html">Test</a>}
     assert_match expected_output, link("Test")
   end
   
   def test_should_generate_tag_with_block
-    expected_output = %q{<a href="test.html" title="My Test Link">Test</a>}
-    assert_match expected_output, tag(:a, :href => "test.html", :title => 'My Test Link') { "Test" }
+    expected_output = %q{<a href="/test.html" title="My Test Link">Test</a>}
+    assert_match expected_output, tag(:a, :href => "/test.html", :title => 'My Test Link') { "Test" }
   end
   
   def test_should_generate_tag
@@ -41,7 +37,7 @@ class HelpersTest < Test::Unit::TestCase
   end
   
   def test_should_generate_js_links
-    expected_output = %q{src="javascripts/test.js"}
+    expected_output = %q{src="/javascripts/test.js"}
     assert_match expected_output, javascripts('test')
   end
   
@@ -50,4 +46,5 @@ class HelpersTest < Test::Unit::TestCase
     expected_output = "My Menu"
     assert_match expected_output, partial("menu")
   end
+  
 end

data/test/sandbox/test_site/src/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def greet(name)
+    "Hello, #{name}!"
+  end
+end

data/test/sandbox/test_site/src/pages/index.haml

@@ -1,3 +1,5 @@
 %h1 StaticMatic!
 
-%p This is some test content
+%p This is some test content
+
+= greet("Steve")

data/website/src/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def greet(name)
+    "Hello, #{name}"
+  end
+end

data/website/src/layouts/application.haml

@@ -7,31 +7,22 @@
   %body
     #container
       #header
-        .bycurve21= link(img("bycurve21.gif"), "http://www.curve21.com")
+        .bycurve21= link(img("/images/bycurve21.gif"), "http://www.curve21.com")
         .title StaticMatic
 
       #menu
 
         %ul
           %li= link "Home", "/"
-          %li= link "Download", "/download.html"
-          %li= link "How to use", "/how_to_use.html"
+          %li= link "Download", "download.html"
+          %li= link "How to use", "how_to_use.html"
           %li= link "Development", "http://rubyforge.org/projects/staticmatic"
           %li= link "Community", "http://groups.google.co.uk/group/staticmatic"
-          %li= link "FAQ", "/faq.html"
+          %li= link "FAQ", "faq.html"
 
       #content_wrapper
         #side
-          #news
-            .heading News
-            .title 0.8.4 Released!
-            %p 
-              You can now enjoy:
-            %ul
-              %li Multiple directories
-              %li Partials
-            = link "And More!", "/releases/0_8_4.html"
-              
+          #news= partial("news")
 
         #content
           = yield

data/website/src/pages/index.haml

@@ -1,4 +1,3 @@
-
 %h1 Static websites, the modern way
 
 %p 

data/website/src/pages/releases/0_8_8.haml

@@ -0,0 +1,31 @@
+%h1 StaticMatic 0.8.8
+
+%h2 Helpers
+
+%p Thanks to Craig Webster, we now have Rails-style helpers.  
+
+src/application_helper.rb:
+
+:preserve
+  <pre class="code">
+  module ApplicationHelper
+    def greet(name)
+       "Hello, #{name}!"
+    end
+  end
+  </pre>
+
+%h2 Configuration
+
+%p We also now have configuration.  It's only basic right now but expect this to expand.
+
+src/configuration.rb:
+
+.code
+  configuration.preview_server_port = 3000
+  configuration.use_relative_paths_for_links = false
+  configuration.use_relative_paths_for_images = false
+  configuration.use_relative_paths_for_stylesheets = false
+  configuration.use_relative_paths_for_javascripts = false
+  
+%p The configuration file is also loaded before StaticMatic starts so it can be used to monkey-patch to demonstrate new features.

data/website/src/partials/news.haml

@@ -0,0 +1,8 @@
+.heading News
+.title 0.8.8 Released!
+%p 
+  Complete with:
+%ul
+  %li Helpers
+  %li Configuration
+= link "And More!", "/releases/0_8_8.html"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: staticmatic
 version: !ruby/object:Gem::Version 
-  version: 0.8.6
-date: 2007-09-24 00:00:00 +01:00
+  version: 0.8.8
+date: 2007-09-25 00:00:00 +01:00
 summary: Manage static sites using Haml & Sass
 require_paths: 
 - lib
@@ -50,6 +50,7 @@ files:
 - lib
 - lib/staticmatic
 - lib/staticmatic/base.rb
+- lib/staticmatic/configuration.rb
 - lib/staticmatic/error.rb
 - lib/staticmatic/helpers.rb
 - lib/staticmatic/server.rb
@@ -65,7 +66,7 @@ files:
 - test/helpers_test.rb
 - test/sandbox
 - test/sandbox/test_site
-- test/sandbox/test_site/config.rb
+- test/sandbox/test_site/configuration.rb
 - test/sandbox/test_site/site
 - test/sandbox/test_site/site/images
 - test/sandbox/test_site/site/index.html
@@ -73,6 +74,8 @@ files:
 - 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
@@ -104,6 +107,8 @@ files:
 - 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
@@ -114,7 +119,9 @@ files:
 - website/src/pages/index.haml
 - website/src/pages/releases
 - website/src/pages/releases/0_8_4.haml
+- website/src/pages/releases/0_8_8.haml
 - website/src/partials
+- website/src/partials/news.haml
 - website/src/stylesheets
 test_files: 
 - test/base_test.rb