staticmatic 0.0.1 → 0.1.0

data/README

@@ -1,13 +1,13 @@
-= StaticMatic
+# StaticMatic
 
-Managing static sites with [Haml & Sass](http://haml.hamptoncatlin.com).
+*For information on Haml & Sass please see [haml.hamptoncatlin.com](http://haml.hamptoncatlin.com)*.
 
 **Please Note:**  StaticMatic is fresh out the oven.  It has a limited feature set and
 is only really covering my immediate requirements.  
 
-_However_, I am interested in getting feedback on the idea and code contributions are always welcome.
+_However_, I am interested in getting feedback on the idea and code contributions & ideas are always welcome.
 
-== Introduction
+## What's it all about?
 
 CMS is overrated.  A lot of the time, clients want us to do what we do 
 best - well designed pages with structured, accessible and maintainable markup & styling.
@@ -18,7 +18,7 @@ structured, DRY and flexible.
 
 Enter **StaticMatic**.
 
-== Usage
+## Usage
 
 StaticMatic will set up a basic site structure for you with this command:
 
@@ -46,15 +46,33 @@ edited the pages and stylesheets, you can generate the static site:
     
 All of the pages are parsed and wrapped up in application.haml and put into the site directory.
 
-== Templates
+## Templates
 
 StaticMatic adds a few helpers to the core Haml helpers:
 
     = link 'Title', 'url'
     = img 'my_image.jpg'
 
-== What's Next?
+
+**_Coming soon:_** 
+
+I'm already extending these to include some neat conventions to speed up coding.  For example, in the next version:
+
+    = link 'Contact Us'
+
+will produce 
+
+    <a href="contact_us.html">Contact Us</a>
+
+Or with the Rewriting enabled:
+
+    <a href="contact_us">Contact Us</a>
+
+## What's Next?
 
 * Multiple directories of content
 * Layouts based on directory of page template
-* Additional Helpers
+* Additional Helpers
+* Tests, tests, tests!
+* Configuration
+* Default Rewriting for HTML pages (drop the .html)

data/lib/staticmatic/helpers.rb

@@ -1,6 +1,7 @@
 module Haml
   module Helpers
     
+    # Generates links to all stylesheets in the site's directory
     def stylesheets
       stylesheet_dir = "#{base_dir}/site/stylesheets/"
       output = ""
@@ -13,23 +14,51 @@ module Haml
       output
     end
     
+    # Generate javascript source tags for the specified files
+    #
+    # javascripts('test')   ->   <script language="javascript" src="javascripts/test.js"></script>
+    #    
     def javascripts(*files)
+      output = ""
+      files.each do |file|
+        if !file.match(/^http\:\/\//)
+          output << tag(:script, :language => 'javascript', :src => "javascripts/#{file}.js") { "" }
+        end
+      end
+      output
     end
-    
-    def text_field(name)
+
+    # Generates a form text field
+    #
+    def text_field(name, value)
+      tag(:input, :type => "text", :name => name, :value => value)
     end
     
-    def submit(title)
-    end
-    
-    def link(title, page = "")
+    # Generate an HTML link
+    #
+    # If only the title is passed, it will automatically
+    # create a link from this value:
+    #
+    # link('Test')  ->  <a href="test.html">Test</a>
+    #
+    def link(title, page = "", options = {})
+      if page.blank?
+        page = urlify(title) + ".html"
+      end
+      
       tag(:a, :href => page) { title }
     end
     
+    # Generates an image tag
     def img(name, options = {})
       tag :img, options.merge!({:src => "images/#{name}"})
     end
   
+    # Generates HTML tags:
+    #
+    # tag(:br)   ->   <br/>
+    # tag(:a, :href => 'test.html') { "Test" }    ->    <a href="test.html">Test</a>
+    #
     def tag(name, options = {}, &block)
       output = "<#{name}"
       options.each do |attribute, value|
@@ -45,5 +74,20 @@ module Haml
       end
       output
     end
+    
+    # Generates a URL friendly string from the value passed:
+    #
+    # "We love Haml"  ->  "we_love_haml"
+    # "Elf & Ham"     ->  "elf_and_ham"
+    # "Stephen's gem" ->  "stephens_gem"
+    #
+    def urlify(string)
+      string.tr(" ", "_").
+             sub("&", "and").
+             sub("@", "at").
+             tr("^A-Za-z0-9_", "").
+             sub(/_{2,}/, "_").
+             downcase
+    end
   end
 end

data/lib/staticmatic.rb

@@ -3,10 +3,10 @@ require 'haml'
 require File.dirname(__FILE__) + '/staticmatic/helpers'
 
 class StaticMatic
-  VERSION = '0.0.1'
-  
+  VERSION = '0.1.0'
+
+  # Directories generated for a new site setup
   cattr_reader :base_dirs
-  
   @@base_dirs = %w{
     site/
     site/stylesheets
@@ -18,6 +18,7 @@ class StaticMatic
     src/stylesheets
   }
   
+  # Templates for setup and their location
   @@templates = {
     'application.haml' => 'layouts',
     'application.sass' => 'stylesheets',
@@ -50,7 +51,7 @@ class StaticMatic
     end
   
     @@templates.each do |template, destination|
-      `cp #{@templates_dir}/#{template} #{@src_dir}/#{destination}`
+      copy_file("#{@templates_dir}/#{template}", "#{@src_dir}/#{destination}")
     end
   
     puts "Done"
@@ -59,6 +60,7 @@ class StaticMatic
   private
   
   def copy_file(from, to)
+    `cp #{from} #{to}`
   end
   
   def save_page(filename, content)
@@ -86,7 +88,7 @@ class StaticMatic
         
         filename_without_extension = matches[1]
         
-        page = Haml::Engine.new(File.read("#{@src_dir}/pages/#{file}"))
+        page = Haml::Engine.new(File.read("#{@src_dir}/pages/#{file}", :locals => {:base_dir => @base_dir}))
         page_content = page.render
 
         content_with_layout = Haml::Engine.new(layout_content, :locals => {:base_dir => @base_dir}).render { page_content }

data/test/helpers_test.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/staticmatic'
+
+class HelpersTest < Test::Unit::TestCase
+  include Haml::Helpers
+  
+  # Provide method in place of local variable for the helpers - don'tcha just love ruby?
+  def base_dir
+    File.dirname(__FILE__) + '/sandbox/test_site'
+  end
+  
+  def test_should_generate_stylesheet_links
+    assert_match "href=\"stylesheets\/application.css\"", stylesheets
+  end
+  
+  def test_should_autolink_page
+    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" }
+  end
+  
+  def test_should_generate_tag
+    expected_output = %q{<br/>}
+    assert_match expected_output, tag(:br)
+  end
+  
+  def test_should_urlify_string
+    assert_equal "stephens_haml_and_sass_project", urlify("Stephen's Haml & Sass Project")
+  end
+  
+  def test_should_generate_input
+    expected_output = %q{<input type="text" value="blah" name="test"/>}
+    assert_match expected_output, text_field("test", "blah")
+  end
+  
+  def test_should_generate_js_links
+    expected_output = %q{<script src="javascripts/test.js" language="javascript"></script>}
+    assert_match expected_output, javascripts('test')
+  end
+end

data/test/sandbox/test_site/site/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <title>StaticMatic</title>
+    <link rel="stylesheet" href="stylesheets/application.css" media="all"/>
+  </head>
+  <body>
+    <h1>StaticMatic!</h1>
+  </body>
+</html>

data/test/sandbox/test_site/site/stylesheets/application.css

@@ -0,0 +1,2 @@
+body {
+  font-family: Verdana, Helvetica, sans-serif; }

data/test/sandbox/test_site/src/layouts/application.haml

@@ -0,0 +1,7 @@
+!!!
+%html
+  %head
+    %title StaticMatic
+    = stylesheets
+  %body
+    = yield

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

@@ -0,0 +1 @@
+%h1 StaticMatic!

data/test/sandbox/test_site/src/stylesheets/application.sass

@@ -0,0 +1,2 @@
+body
+  :font-family = "Verdana, Helvetica, sans-serif"

data/test/staticmatic_test.rb

@@ -3,11 +3,7 @@ require File.dirname(__FILE__) + '/../lib/staticmatic'
 
 class StaticMaticTest < Test::Unit::TestCase
   def setup
-    @base_dir = File.dirname(__FILE__) + '/sandbox'
-    
-    StaticMatic.base_dirs.reverse.each do |dir|
-      Dir.delete("#{@base_dir}/#{dir}") if File.exists?("#{@base_dir}/#{dir}")
-    end
+    @base_dir = File.dirname(__FILE__) + '/sandbox/tmp'
   end
   
   def test_should_setup_directories
@@ -18,4 +14,14 @@ class StaticMaticTest < Test::Unit::TestCase
       assert File.exists?("#{@base_dir}/#{dir}"), "Should create #{dir}"
     end
   end
+  
+  def teardown
+    StaticMatic.base_dirs.reverse.each do |dir|
+      Dir.entries("#{@base_dir}/#{dir}").each do |file|
+        next if file.match(/^\./)
+        File.delete("#{@base_dir}/#{dir}/#{file}")
+      end
+      Dir.delete("#{@base_dir}/#{dir}") if File.exists?("#{@base_dir}/#{dir}")
+    end
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: staticmatic
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-05-22 00:00:00 +01:00
+  version: 0.1.0
+date: 2007-05-24 00:00:00 +01:00
 summary: Manage static sites using Haml & Sass
 require_paths: 
 - lib
@@ -58,9 +58,27 @@ files:
 - lib/staticmatic/templates/application.haml
 - lib/staticmatic/templates/application.sass
 - lib/staticmatic/templates/index.haml
+- test/helpers_test.rb
 - test/sandbox
 - test/staticmatic_test.rb
+- test/sandbox/test_site
+- test/sandbox/tmp
+- test/sandbox/test_site/config.rb
+- test/sandbox/test_site/site
+- test/sandbox/test_site/src
+- 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/layouts
+- test/sandbox/test_site/src/pages
+- test/sandbox/test_site/src/stylesheets
+- test/sandbox/test_site/src/layouts/application.haml
+- test/sandbox/test_site/src/pages/index.haml
+- test/sandbox/test_site/src/stylesheets/application.sass
 test_files: 
+- test/helpers_test.rb
 - test/staticmatic_test.rb
 rdoc_options: []