bdimcheff-staticmatic 0.10.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2009 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.markdown

@@ -0,0 +1,50 @@
+# StaticMatic
+
+*For information on Haml & Sass please see [haml.hamptoncatlin.com](http://haml.hamptoncatlin.com)*.
+
+## 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.
+
+CMSs are often perfect for this, but sometimes they can be restrictive and more cumbersome
+than just working with good ol' source code.  At the same time we want our code to be
+structured, DRY and flexible.
+
+Enter **StaticMatic**.
+
+## Usage
+
+StaticMatic will set up a basic site structure for you with this command:
+
+    staticmatic setup <directory>
+
+After this command you'll have the following files:
+
+    <directory>/
+      site/
+        images/
+        stylesheets/
+        javascripts/
+      src/
+        helpers/
+        layouts/
+          application.haml
+        pages/
+          index.haml
+        stylesheets/
+          application.sass
+
+StaticMatic sets you up with a sample layout, stylesheet and page file.  Once you've
+edited the pages and stylesheets, you can generate the static site:
+
+    staticmatic build <directory>
+    
+All of the pages are parsed and wrapped up in application.haml and put into the site directory.
+
+## Templates
+
+StaticMatic adds a few helpers to the core Haml helpers:
+
+    = link 'Title', 'url'
+    = img 'my_image.jpg'

data/Rakefile

@@ -0,0 +1,31 @@
+require "rubygems"
+require "rake"
+require "rake/testtask"
+require File.dirname(__FILE__) + '/lib/staticmatic'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "staticmatic"
+    gem.executables = "staticmatic"
+    gem.summary = "Lightweight Static Site Framework"
+    gem.email = "steve@curve21.com"
+    gem.homepage = "http://staticmatic.net"
+    gem.description = "Lightweight Static Site Framework"
+    gem.authors = ["Stephen Bartholomew"]
+    gem.rubyforge_project = "staticmatic"
+    
+    gem.files =  FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    
+    gem.add_dependency("haml", ">=2.0.0")
+    gem.add_dependency("mongrel", ">=1.1.5")
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gemgem.github.com"
+end
+
+desc "Run all unit tests"
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir.glob("test/*_test.rb")
+  t.verbose = true
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 10
+:patch: 1

data/bin/staticmatic

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/staticmatic'
+
+command = ARGV[0]
+directory = ARGV[1]
+
+if !command || !directory
+  puts "Usage: #{$0} <build|setup|preview> <directory>"
+  exit
+end
+
+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.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'haml'
+require 'sass'
+require 'mongrel'
+require 'fileutils'
+
+module StaticMatic
+  VERSION = '0.10.2'
+end
+
+["render", "build", "setup", "server", "helpers", "rescue"].each do |mixin|
+  require File.join(File.dirname(__FILE__), "staticmatic", "mixins", mixin)
+end
+
+["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

@@ -0,0 +1,87 @@
+module StaticMatic
+  # 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'
+  }
+  
+  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] || ""
+    end
+    
+    def initialize(base_dir, configuration = Configuration.new)
+      @configuration = configuration
+      @current_page = nil
+      @current_file_stack = []
+      @base_dir = base_dir
+      @src_dir = "#{@base_dir}/src"
+      @site_dir = "#{@base_dir}/site"
+      @templates_dir = File.dirname(__FILE__) + '/templates/default/'
+      @layout = "application"
+      @scope = Object.new
+      @scope.instance_variable_set("@staticmatic", self)
+      load_helpers
+    end
+    
+    def base_dir
+      @base_dir
+    end
+  
+    def run(command)
+      if %w(build setup preview).include?(command)
+        send(command)
+      else
+        puts "#{command} is not a valid StaticMatic command"
+      end
+    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', dir, "#{name}.sass"))
+    end
+    
+    def layout_exists?(name)
+      File.exists? full_layout_path(name)
+    end
+    
+    def template_directory?(path)
+      File.directory?(File.join(@src_dir, 'pages', path))
+    end
+    
+    def full_layout_path(name)
+      "#{@src_dir}/layouts/#{name}.haml"
+    end
+    
+    class << self
+      def base_dirs
+        StaticMatic::BASE_DIRS
+      end
+    end
+  end
+end

data/lib/staticmatic/configuration.rb

@@ -0,0 +1,18 @@
+module StaticMatic
+  class Configuration
+    attr_accessor :preview_server_port
+
+    attr_accessor :preview_server_host
+    
+    attr_accessor :use_extensions_for_page_links
+    attr_accessor :sass_options
+    attr_accessor :haml_options 
+    
+    def initialize
+      self.preview_server_port = 3000
+      self.use_extensions_for_page_links = true
+      self.sass_options = {}
+      self.haml_options = {}
+    end
+  end
+end

data/lib/staticmatic/error.rb

@@ -0,0 +1,17 @@
+module StaticMatic
+  class Error < StandardError
+    attr_reader :line
+
+    attr_reader :filename
+    
+    def initialize(lineno, filename, message)
+      @line = lineno
+      @filename = filename
+      @message = message
+    end
+    
+    def message
+      "#{@filename}, line #{@line}: #{@message}"
+    end
+  end
+end

data/lib/staticmatic/helpers.rb

@@ -0,0 +1,197 @@
+module StaticMatic
+  module Helpers
+    self.extend self
+    
+    # Generates links to all stylesheets in the source directory
+    # = 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'; options[:type] = 'text/css'
+
+      relative_path = current_page_relative_path
+
+      output = ""
+      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')]
+        
+        # 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
+
+        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
+    end
+    
+    # Generate javascript source tags for the specified files
+    #
+    # javascripts('test')   ->   <script language="javascript" src="javascripts/test.js"></script>
+    #    
+    def javascripts(*files)
+      relative_path = current_page_relative_path
+
+      output = ""
+      files.each do |file|
+        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
+
+    # Generates a form text field
+    #
+    def text_field(name, value, options = {})
+      options.merge!(:type => "text", :name => name, :value => value)
+      tag(:input, options)
+    end
+    
+    # Generate a form textarea
+    #
+    def text_area(name, value, options = {})
+      options.merge!(:name => name)
+      tag(:textarea, options) { value }
+    end
+    
+    # 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, href = "", options = {})
+      if href.is_a?(Hash)
+        options = href
+        href = ""
+      end
+
+      if href.nil? || href.strip.length < 1
+        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}"
+      
+      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
+    alias link_to link
+
+    # 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"/>
+    def img(name, options = {})
+      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
+  
+    # Generates HTML tags:
+    #
+    # tag(:br)   ->   <br/>
+    # tag(:a, :href => 'test.html') { "Test" }    ->    <a href="test.html">Test</a>
+    #
+    def tag(name, options = {}, &block)
+      options[:id] ||= options[:name] if options[:name]
+      output = "<#{name}"
+      options.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |key|
+        output << " #{key}=\"#{options[key]}\"" if options[key]
+      end
+      
+      if block_given?
+        output << ">"
+        output << yield
+        output << "</#{name}>"
+      else
+        output << "/>"
+      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
+    
+    # Include a partial template
+    def partial(name, options = {})
+      @staticmatic.generate_partial(name, options)
+    end
+
+    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