staticmatic 0.8.10 → 0.9.0

data/CHANGELOG

@@ -0,0 +1,49 @@
+*SVN*
+
+*0.9.0* (October 16th, 2007)
+
+* [NEW] added StaticMatic::VERSION.requirements_met? [Brent Beardsley]
+
+* [NEW] added LICENSE and CHANGELOG files [Brent Beardsley]
+
+* [NEW] can now specify relative paths when only specifying a title - link("../How to download") [Brent Beardsley]
+
+* [NEW] add src_dir/stylesheets directory to sass load path so you can use @import styles.sass [Brent Beardsley]
+
+* [NEW] added sass_options hash to configuration so you can configure sass (ie: :style => :compact) [Brent Beardsley]
+
+* [NEW] added configuration.use_extensions_for_page_links (defaults to true) when false will strip index.html and .html off the end of links for pretty urls [Brent Beardsley]
+
+* [NEW] made all "local" links (pages/stylesheets/images) relative to the current page and removed use_relative_path_for_* configuration settings [Brent Beardsley]
+
+* [FIX] no longer add \n after the tag in the tag helper [Brent Beardsley]
+
+* [FIX] mailto: links were getting a / inserted at in front of the mailto: [Brent Beardsley]
+
+* [NEW] stylesheets helper can now take a list of stylesheets to include and the order as well as options (ie: :media => :print) [Brent Beardsley]
+
+* [FIX] clear all instance variables in @scope except @staticmatic [Brent Beardsley]
+
+* [NEW] added clean and clobber tasks to Rakefile [Brent Beardsley]
+
+* [NEW] added StaticMatic::VERSION in version.rb [Brent Beardsley]
+
+* [NEW] added package task to Rakefile and made it the default [Brent Beardsley]
+
+*0.8.10* (October 12th, 2007)
+
+* [NEW] rails-like partials. Partials can start with an underscore and live in the pages directory tree, old way still works [Brent Beardsley]
+
+* [NEW] img helper changes and tests [Jason Tennier]
+
+* [NEW] added current_page helper for use in other helpers, layouts, or pages [Brent Beardsley]
+
+* [NEW] add src_dir, site_dir, and current_page attr_reader's on staticmatic class [Brent Beardsley] 
+
+* [FIX] removed dependency on rails needing to be installed [Brent Beardsley] 
+
+* [FIX] fixed preview bug where setting a layout in a page would cause it to be used even for pages that did not have a layout specified and should be using the default [Brent Beardsley] 
+
+* [FIX] tag helper only outputs the attribute if it has a value [Brent Beardsley]
+
+* [FIX] renamed RakeFile to Rakefile so it'll work on non-windows boxes [Brent Beardsley]

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2007 Stephen Bartholomew
+
+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/README

@@ -32,10 +32,12 @@ After this command you'll have the following files:
         stylesheets/
         javascripts/
       src/
-        pages/
-          index.haml
+        helpers/
         layouts/
           application.haml
+        pages/
+          index.haml
+        partials/
         stylesheets/
           application.sass
 
@@ -51,28 +53,4 @@ All of the pages are parsed and wrapped up in application.haml and put into the
 StaticMatic adds a few helpers to the core Haml helpers:
 
     = link 'Title', 'url'
-    = img 'my_image.jpg'
-
-
-**_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
-* Tests, tests, tests!
-* Configuration
-* Default Rewriting for HTML pages (drop the .html)
+    = img 'my_image.jpg'

data/Rakefile

@@ -1,7 +1,30 @@
+require 'rubygems'
 require 'rake/testtask'
+require 'rake/clean'
+Gem::manage_gems
+require 'rake/gempackagetask'
+require File.join(File.dirname(__FILE__), 'lib/staticmatic/version')
 
-desc "Default Task"
-task :default => [:test]
+task :default => [:package]
+
+spec = Gem::Specification.new do |s|
+  s.name = "staticmatic"
+  s.version = StaticMatic::VERSION::STRING
+  s.author = "Stephen Bartholomew"
+  s.email = "steve@curve21.com"
+  s.homepage = "http//www.curve21.com"
+  s.summary = "Manage static sites using Haml & Sass"
+  files = FileList["**/**/**"]
+  files.exclude 'pkg'
+  s.files = files.to_a
+  s.test_files =  Dir.glob("test/*_test.rb")
+  s.add_dependency("haml")
+  s.add_dependency("mongrel")
+  s.executables=['staticmatic']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
 
 desc "Run all unit tests"
 Rake::TestTask.new(:test) do |t|

data/lib/staticmatic.rb

@@ -5,9 +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'
-
+%w(version configuration error base server).each do |file|
+  require File.join(File.dirname(__FILE__), 'staticmatic', file) 
+end
 

data/lib/staticmatic/base.rb

@@ -120,7 +120,10 @@ module StaticMatic
       full_file_path = File.join(@src_dir, 'pages', source_dir, "#{source_file}.haml")
 
       begin
-        @scope.instance_variable_set("@layout", nil)
+        # 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)
@@ -192,7 +195,8 @@ module StaticMatic
     def generate_css(source, source_dir = '')
       full_file_path = File.join(@src_dir, 'stylesheets', source_dir, "#{source}.sass")
       begin
-        stylesheet = Sass::Engine.new(File.read(full_file_path))
+        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)

data/lib/staticmatic/configuration.rb

@@ -4,17 +4,13 @@ module StaticMatic
 
     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
-    
+    attr_accessor :use_extensions_for_page_links
+    attr_accessor :sass_options
+
     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
+      self.use_extensions_for_page_links = true
+      self.sass_options = {}
     end
   end
 end

data/lib/staticmatic/helpers.rb

@@ -3,35 +3,57 @@ module StaticMatic
     self.extend self
     
     # Generates links to all stylesheets in the source directory
-    def stylesheets(options = {})
-      stylesheet_dir = "#{@staticmatic.base_dir}/src/stylesheets"
-      
-      stylesheet_directories = Dir["#{stylesheet_dir}/**/*.sass"]
-      
-      # Bit of a hack here - adds any stylesheets that exist in the site/ dir that haven't been generated from source sass
-      Dir["#{@staticmatic.base_dir}/site/stylesheets/*.css"].each do |filename|
-        search_filename = File.basename(filename).chomp(File.extname(filename))
-        already_included = false
-        stylesheet_directories.each do |path|
-          path = File.basename(path)
-          if path.include?(search_filename)
-            already_included = true
-          end
-        end
-        
-        stylesheet_directories << filename if !already_included
+    # = stylesheets
+    # or specific stylesheets in a specific order
+    # = stylesheets :reset, :application
+    # Can also pass options hash in at the end so you can specify :media => :print
+    def stylesheets(*params)
+      options = {}
+      if params.last.is_a?(Hash)
+        options = params.last
+        params.slice!(-1, 1)
       end
+      options[:media] = 'all' unless options.has_key?(:media)
+      options[:rel] = 'stylesheet'
+
+      relative_path = current_page_relative_path
 
       output = ""
-      stylesheet_directories.each do |path|
-        filename_without_extension = File.basename(path).chomp(File.extname(path))
-        href = "stylesheets/#{filename_without_extension}.css"
+      if params.length == 0
+        # no specific files requested so include all in no particular order
+        stylesheet_dir = File.join(@staticmatic.src_dir, 'stylesheets')
+        stylesheet_directories = Dir[File.join(stylesheet_dir, '**','*.sass')]
         
-        unless @staticmatic.configuration.use_relative_paths_for_stylesheets
-          href = "/#{href}"
+        # Bit of a hack here - adds any stylesheets that exist in the site/ dir that haven't been generated from source sass
+        Dir[File.join(@staticmatic.site_dir, 'stylesheets', '*.css')].each do |filename|
+          search_filename = File.basename(filename).chomp(File.extname(filename))
+
+          already_included = false
+          stylesheet_directories.each do |path|
+            if File.basename(path).include?(search_filename)
+              already_included = true
+              break
+            end
+          end
+          
+          stylesheet_directories << filename unless already_included
         end
 
-        output << tag(:link, :href => href, :rel => 'stylesheet', :media => 'all')
+        stylesheet_directories.each do |path|
+          filename_without_extension = File.basename(path).chomp(File.extname(path))
+
+          options[:href] = "#{relative_path}stylesheets/#{filename_without_extension}.css"
+          output << tag(:link, options)
+        end
+      else
+        #specific files requested and in a specific order
+        params.each do |file|
+          if File.exist?(File.join(@staticmatic.src_dir, 'stylesheets', "#{file}.sass")) ||
+             File.exist?(File.join(@staticmatic.site_dir, 'stylesheets', "#{file}.css"))
+            options[:href] = "#{relative_path}stylesheets/#{file}.css"
+            output << tag(:link, options)
+          end
+        end
       end
       
       output
@@ -42,16 +64,13 @@ module StaticMatic
     # javascripts('test')   ->   <script language="javascript" src="javascripts/test.js"></script>
     #    
     def javascripts(*files)
+      relative_path = current_page_relative_path
+
       output = ""
       files.each do |file|
-        if !file.match(/^http\:\/\//)
-          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
+        file_str = file.to_s
+        src = file_str.match(%r{^((\.\.?)?/|https?://)}) ? file_str : "#{relative_path}javascripts/#{file_str}.js"
+        output << tag(:script, :language => 'javascript', :src => src, :type => "text/javascript") { "" }
       end
       output
     end
@@ -77,38 +96,34 @@ module StaticMatic
       end
 
       if href.nil? || href.strip.length < 1
-        href = urlify(title) + ".html"
+        path_prefix = ''
+        if title.match(/^(\.\.?)?\//)
+          # starts with relative path so strip it off and prepend it to the urlified title
+          path_prefix_match = title.match(/^[^\s]*\//)
+          path_prefix = path_prefix_match[0] if path_prefix_match
+          title = title[path_prefix.length, title.length]
+        end
+        href = path_prefix + urlify(title) + ".html"
       end
+
+      options[:href] = "#{current_page_relative_path(href)}#{href}"
       
-      options.merge!(:href => href)
-      
-      unless @staticmatic.configuration.use_relative_paths_for_links || href.match(/^#|\/|(http\:\/\/)/)
-        options[:href] = "/#{options[:href]}"
+      local_page = (options[:href].match(/^(\#|.+?\:)/) == nil)
+      unless @staticmatic.configuration.use_extensions_for_page_links || !local_page
+        options[:href].chomp!(".html")
+        options[:href].chomp!("index") if options[:href][-5, 5] == 'index'
       end
-      
+
       tag(:a, options) { title }
     end
     
-    # Generates an image tag.
+    # Generates an image tag always relative to the current page unless absolute path or http url specified.
     # 
     # img('test_image.gif')   ->   <img src="/images/test_image.gif" alt="Test image"/>
     # img('contact/test_image.gif')   ->   <img src="/images/contact/test_image.gif" alt="Test image"/>
     # img('http://localhost/test_image.gif')   ->   <img src="http://localhost/test_image.gif" alt="Test image"/>
-    # 
-    # If you want to use relative paths instead set 'configuration.use_relative_paths_for_images = true'
-    # in configuration.rb.  This will set the image source relative to the page.
-    # 
-    # img('test_image.gif')   ->   <img src="images/test_image.gif" alt="Test image"/>
     def img(name, options = {})
-      unless name.match(%r{^(/|http://)})
-        options[:src] = "images/#{name}"
-        unless @staticmatic.configuration.use_relative_paths_for_images
-          options[:src] = "/" + options[:src]
-        end
-      else
-        options[:src] = name
-      end
-
+      options[:src] = name.match(%r{^((\.\.?)?/|https?://)}) ? name : "#{current_page_relative_path}images/#{name}"
       options[:alt] ||= name.split('/').last.split('.').first.capitalize.gsub(/_|-/, ' ')
       tag :img, options
     end
@@ -127,9 +142,9 @@ module StaticMatic
       if block_given?
         output << ">"
         output << yield
-        output << "</#{name}>\n"
+        output << "</#{name}>"
       else
-        output << "/>\n"
+        output << "/>"
       end
       output
     end
@@ -157,5 +172,17 @@ module StaticMatic
     def current_page
       @staticmatic.current_page
     end
+
+    private
+
+    def current_page_relative_path(current_path = nil)
+      if current_path.nil? || current_path.match(/^((\.\.?)?\/|\#|.+?\:)/) == nil
+        current_page_depth = current_page.split('/').length - 2;
+        (current_page_depth > 0) ? ([ '..' ] * current_page_depth).join('/') + '/' : ''
+      else
+        ''
+      end
+    end
+
   end
 end

data/lib/staticmatic/version.rb

@@ -0,0 +1,34 @@
+module StaticMatic #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+    URLIFIED = STRING.tr('.', '_')
+
+    # requirements_met? can take a hash with :major, :minor, :tiny set or
+    # a string in the format "major.minor.tiny"
+    def self.requirements_met?(minimum_version = {})
+      major = minor = tiny = 0
+      if minimum_version.is_a?(Hash)
+        major = minimum_version[:major].to_i if minimum_version.has_key?(:major)
+        minor = minimum_version[:minor].to_i if minimum_version.has_key?(:minor)
+        tiny = minimum_version[:tiny].to_i if minimum_version.has_key?(:tiny)
+      else
+        major, minor, tiny = minimum_version.to_s.split('.').collect { |v| v.to_i }
+      end
+      met = false
+      if StaticMatic::VERSION::MAJOR > major
+        met = true
+      elsif StaticMatic::VERSION::MAJOR == major
+        if StaticMatic::VERSION::MINOR > minor
+          met = true
+        elsif StaticMatic::VERSION::MINOR == minor
+          met = StaticMatic::VERSION::TINY >= tiny
+        end
+      end
+      met
+    end
+  end
+end

data/test/base_test.rb

@@ -6,6 +6,11 @@ class StaticMaticBaseTest < Test::Unit::TestCase
     @base_dir = File.dirname(__FILE__) + '/sandbox/test_site'
     @staticmatic = StaticMatic::Base.new(@base_dir)
   end
+
+  def test_initial_configuration_settings
+    assert_equal true, @staticmatic.configuration.use_extensions_for_page_links
+    assert_equal 3000, @staticmatic.configuration.preview_server_port
+  end
   
   def test_should_setup_directories
     tmp_dir = File.dirname(__FILE__) + '/sandbox/tmp'
@@ -23,11 +28,9 @@ class StaticMaticBaseTest < Test::Unit::TestCase
       end
       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