sitefuel 0.0.0b → 0.1.0a

data/README.rdoc

@@ -0,0 +1,81 @@
+ 
+= SiteFuel
+==== http://sitefuel.org
+==== v0.1.0 (alpha release)
+ 
+
+--------------------------------------------------------------------------------
+
+A program and API for minifying websites and web applications and 
+deploying them from version control.
+
+- Get started: http://sitefuel.org/getstarted
+- Lists: http://sitefuel.org/mailinglists
+- Report a bug: http://sitefuel.org/bug
+   
+- Contribute! http://sitefuel.org/contribute
+
+
+== Table of Contents
+
+- Introduction
+- System Requirements
+- Supported Formats
+- Installation
+- Getting Started
+- Reporting a Bug
+- A Note about the API
+- Further Reading
+
+
+== Introduction 
+SiteFuel is a Ruby program 
+
+Use SiteFuel to:
+- deploy your website out of SVN or GIT
+- minify your
+
+
+== System Requirements
+
+- Ruby 1.8.6 or greater.
+- =pngcrush= for PNG compression
+- =jpegtran= for JPEG compression
+- =git= for deploying sites from Git repositories
+- =svn= for deploying sites from SVN repositories
+
+SiteFuel hasn't been tested on Windows machines.
+
+
+== Installation
+
+SiteFuel is deployed as a RubyGem through http://gemcutter.org. You 
+should be able to install it directly using RubyGems:
+
+ $ gem install -t sitefuel
+
+Note that for PNG and JPEG compression to be enabled you must install 
+the =pngcrush= and =jpegtran= programs.
+
+
+
+== Getting Started
+
+SiteFuel 
+
+
+
+
+== Reporting a Bug
+
+
+== A Note About the API
+
+The general API in SiteFuel should be considered unstable while SiteFuel 
+is <1.0. For practical reasons we can't increment the major version 
+number each time there is a non-backwards compatible API change....
+
+
+== Further Reading
+- http://sitefuel.org: main sitefuel website
+- http://sitefuel.org/help: pointers to various resources

data/bin/sitefuel

@@ -2,46 +2,74 @@
 
 # == Synopsis
 #
-# A lightweight ruby framework for processing and deploying websites, either
-# from
+# SiteFuel is a program and lightweight Ruby API for processing the
+# source code behind your static and dynamic websites. SiteFuel can
+# remove comments and unneeded whitespace from your CSS, HTML, and
+# JavaScript files (as well as fragments in RHTML and PHP) files. It can
+# also loss-lessly compress your PNG and JPEG images. SiteFuel can also
+# deploy your website from SVN or GIT.
+#
+# Support for more file formats and repositories is planned for future
+# versions.
+#
 #
 # == Usage
 #
-#  sitefuel deploy|process SOURCE [OPTIONS]
+#  sitefuel <command> [--driver=file|svn|git] <source> [<output>]
+#           [--debug] [--verbose] [--help] [--license]
 #
-# == Introduction
-# sitefuel is a lightweight ruby framework for deploying websites directly from
-# version control. sitefuel includes support for compressing HTML and CSS as
-# well as optimizing PNG graphics. Support is planned for SASS; compressing
-# JavaScript; automatically creating sprites; and supporting more image formats.
-# (and more!)
-# 
-# TODO: add more details
+# === <command>
+# Possible commands are:
+# stage::     Simulate a deployment of a site.
+# deploy::    Deploy a site using SiteFuel.
+# help::      Show this message.
 #
-# * More information: http://sitefuel.org
-# * Getting started: http://sitefuel.org/getstarted
-# * Documentation: http://sitefuel.org/documentation
+# === <driver>
+# SiteFuel can typically guess what driver to use, but you can explicitly
+# specify:
+#
+# filesystem::  deploy a directory
+# svn::   use with Subversion repositories
+# git::   use with Git repositories
+#
+# === <source>
+# Specify the source SiteFuel is deploying from. This should accept all
+# protocols supported by enabled drivers. Eg.
+#
+# For svn:
+#  svn+ssh://user@sitefuel.org/svn/web/sitefuel-main
+#
+# For git:
+#  ssh://user@sitefuel.org/...
+#
+# === <output>
+# Specify the directory into which SiteFuel is to deploy. Currently SiteFuel can
+# only deploy into the file system.
 #
-# == Commands
+# === --debug
+# Enables all messages including debugging. This will give you a blow by blow
+# account of what SiteFuel is doing.
+#
+# === --verbose
+# Enables most messages. This will give you a relatively detailed account of
+# how SiteFuel is deploying your site.
 #
-# deploy::      Deploy a site using sitefuel.
-# process::     Modify an existing website inplace.
-# stage::       Simulates a deployment without actually changing anything.
-# help::        Show this message.
 #
 # == Examples
 # Process an already deployed site:
-#  sitefuel process /var/www/
+#  sitefuel deploy /var/www/sitefuel /var/www/sitefuel-compacted
 #
 # Deploy a site from SVN:
 #  sitefuel deploy svn+ssh://sitefuel.org/svn/tags/21 /var/www/
 #
-# Specify a non-default deployment file:
-#  sitefuel process /var/www/ -c customdeployment.yml
+# == Links
 #
+# * More information: http://sitefuel.org
+# * Getting started: http://sitefuel.org/getstarted
+# * Documentation: http://sitefuel.org/documentation
 #
 # == Author
-# Zanoccio, LLC.
+# wkm, Zanoccio LLC.
 #
 # == Copyright
 # Copyright (c) 2009 Zanoccio.
@@ -51,7 +79,7 @@
 # modify it under the terms of the GNU General Public License
 # as published by the Free Software Foundation; either version 2
 # of the License, or (at your option) any later version.
-#
+#                                          # stage::
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -66,97 +94,22 @@
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 
 begin
-  require 'rubygems'
-rescue LoadError
-  # attempt to continue running the program
-end
-
-
-require 'rdoc/usage'
-require 'term/ansicolor'
-
-require 'sitefuel/SiteFuelRuntime'
-
-include Term::ANSIColor
-
-def puts_and_exit(*args)
-  puts(*args)
-  exit
-end
-
-$HELP_HINT_LINE = "type \'#{$0} help\' for usage"
-
-# parse command line arguments and configure a SiteFuelRuntime
-def parse_command_line(runtime)
-
-  #### BUILD THE OPTIONS PARSER
-  opts = OptionParser.new
-
-  # the banner text comes from the header comment for this file
-
-  opts.on('-oARG', '-o=ARG', '-o PLACE', '--output=ARG', '--output PLACE', String,
-          'Where to put a deployed site') do |out|
-    runtime.deploy_to = out
-  end
-  opts.on('-v', '--version', 'Gives the version of sitefuel') do
-    puts 'SiteFuel ' + VERSION_TEXT
-  end
-
-  opts.on('--[no-]verbose', 'List actions as they are preformed') do
-     puts 'cause SiteFuel to be verbose listing actions as they are preformed'
-  end
-  
-  opts.on('--only-list-recognized-files', 'Only list summaries for files which were changed') do
-    runtime.only_list_recognized_files = true
-  end
-
-  opts.on('-h', '--help', '-?', '--about', 'Gives help for a specific command.') do
-    RDoc::usage_no_exit('Synopsis', 'Usage', 'Introduction')
-    puts opts
-    RDoc::usage_no_exit('Examples', 'Author', 'Copyright', 'License')
-    exit
-  end
-
-  opts.separator ''
-  opts.separator 'Specific options for a command can be seen with: '
-  opts.separator '    COMMAND --help'
-
-
-  #### ATTEMPT TO PARSE THE COMMAND LINE
   begin
-    commands = opts.parse(*ARGV)
-  rescue OptionParser::InvalidOption => iopt
-    puts iopt
-    puts_and_exit $HELP_HINT_LINE
-  rescue => exception
-    # TODO: add better handling for the various exceptions (unnecessary
-    #       argument, missing argument, etc.)
-    puts_and_exit "couldn't parse command line: #{exception}", $HELP_HINT_LINE
+    require 'rubygems'
+  rescue LoadError
+    # attempt to continue running the program
   end
 
+  require 'sitefuel/SiteFuelRuntime'
+  require 'sitefuel/CommandLine'
 
-  # note that --help will have already been intercepted but 'help' still needs
-  # special treatment
-  puts_and_exit 'no command given', $HELP_HINT_LINE if commands.length < 1
-  puts_and_exit opts if commands[0].downcase == 'help'
-
-  case commands[0].downcase
-  when 'deploy'
-    runtime.deploy_from = commands[1]
-    runtime.deploy
-
-  when 'stage'
-    runtime.deploy_from = commands[1]
-    runtime.stage
-    
-  else
-    puts_and_exit "unknown command: '#{commands[0]}'", $HELP_HINT_LINE
+  def main
+    runtime = SiteFuel::SiteFuelRuntime.new
+    SiteFuel::CommandLine::parse_command_line(runtime)
   end
-end
 
-def main
-  runtime = SiteFuel::SiteFuelRuntime.new
-  parse_command_line(runtime)
-end
+  main()
 
-main()
+rescue Interrupt
+  puts 'Fatal: interrupted. Exiting.'
+end

data/lib/sitefuel/CommandLine.rb

@@ -0,0 +1,142 @@
+#
+# File::      CommandLine.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
+#
+# Contains the command line parser for the sitefuel program
+#
+
+
+module SiteFuel
+  module CommandLine
+
+    require 'rdoc/usage'
+    require 'term/ansicolor'
+
+    require 'sitefuel/License'
+
+    include Term::ANSIColor
+
+    def self.puts_and_exit(*args)
+      puts(*args)
+      exit
+    end
+  
+    $HELP_HINT_LINE = "type '#{$0} help' for usage"
+
+    @option_parser = nil
+
+    # parse command line arguments and configure a SiteFuelRuntime
+    def self.parse_command_line(runtime)
+
+      #### BUILD THE OPTIONS PARSER
+      @option_parser = OptionParser.new
+
+      # the banner text comes from the header comment for this file
+
+      @option_parser.on('-o PLACE', '--output=ARG', '--output PLACE', String,
+              'Where to put a deployed site') do |out|
+        runtime.deploy_to = out
+      end
+      @option_parser.on('-v', '--version', 'Gives the version of sitefuel') do
+        puts_and_exit 'SiteFuel ' + VERSION_TEXT
+      end
+
+      @option_parser.on('--scm=ARG', '--scm PLACE', String,
+                        'What SCM to use (git, svn, or filesystem)') do |out|
+        runtime.scm_system = out
+      end
+
+      #
+      # Verbosity options
+      #
+
+      @option_parser.on('--[no-]verbose', 'List actions as they are preformed') do |be_verbose|
+        if be_verbose
+          # fatal, error, warnings, and info
+          runtime.verbosity(3)
+        else
+          # fatal, error, and warnings
+          runtime.verbosity(2)
+        end
+      end
+
+      @option_parser.on('--debug', 'Gives verbose debugging information') do
+        runtime.verbosity(4)
+      end
+
+      @option_parser.on('--abort-errors', '[default] Abort deployment if there are errors') do
+        runtime.abort_on_errors = true
+      end
+
+      @option_parser.on('--ignore-errors', 'Deploy even if there are errors') do
+        runtime.abort_on_errors = false
+        runtime.abort_on_warnings = false
+      end
+
+      @option_parser.on('--abort-warnings', 'Abort deployment if there are warnings') do
+        runtime.abort_on_warnings = true
+        runtime.abort_on_errors = true
+      end
+
+      @option_parser.on('--ignore-warnings', '[default] Deploy even if there are warnings') do
+        runtime.abort_on_warnings = true
+      end
+
+      @option_parser.on('--only-list-recognized-files', 'Only list summaries for files which were changed') do
+        runtime.only_list_recognized_files = true
+      end
+
+      @option_parser.on('-h', '--help', '-?', '--about', 'Gives help for a specific command.') do
+        RDoc::usage_no_exit('Synopsis', 'Usage', 'Introduction')
+        puts @option_parser
+        RDoc::usage_no_exit('Examples', 'Author', 'Copyright')
+        exit
+      end
+
+      @option_parser.on('--license', 'Gives the license for SiteFuel.') do
+        puts_and_exit SiteFuel::LICENSE
+      end
+
+      @option_parser.separator ''
+      @option_parser.separator 'Specific options for a command can be seen with: '
+      @option_parser.separator '    COMMAND --help'
+
+
+      #### ATTEMPT TO PARSE THE COMMAND LINE
+      begin
+        commands = @option_parser.parse(*ARGV)
+      rescue OptionParser::InvalidOption => invalid_option
+        puts invalid_option
+        puts_and_exit $HELP_HINT_LINE
+      rescue => exception
+        # TODO: add better handling for the various exceptions (unnecessary
+        #       argument, missing argument, etc.)
+
+        puts_and_exit "couldn't parse command line: #{exception}", $HELP_HINT_LINE
+#        puts exception.backtrace.join("\n")
+      end
+
+
+      # note that --help will have already been intercepted but 'help' still needs
+      # special treatment
+      puts_and_exit 'no command given', $HELP_HINT_LINE if commands.length < 1
+      puts_and_exit @option_parser if commands[0].downcase == 'help'
+
+      case commands[0].downcase
+        when 'deploy'
+          runtime.deploy_from = commands[1]
+          runtime.deploy_to   = commands[2]
+          runtime.deploy
+
+        when 'stage'
+          runtime.deploy_from = commands[1]
+          runtime.stage
+
+        else
+          puts_and_exit "unknown command: '#{commands[0]}'", $HELP_HINT_LINE
+      end
+    end
+  end
+end

data/lib/sitefuel/Configuration.rb

@@ -1,35 +1,71 @@
 #
 # File::      configuration.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Load and process SiteFuel YAML configuration files
 #
 
 module SiteFuel
+  require 'sitefuel/SiteFuelLogger'
   require 'yaml'
 
+  # exception which represents that a configuration could not be found
   class Configuration
 
-    # exception which represents that a configuration could not be found
-    class NotFound < StandardError
-    end
+    include SiteFuel::Logging
+
+    DEFAULT_CONFIGURATION_FILE = 'deployment.yml'
 
     # given a directory path will attempt to location a configuration file
-    # and load it, returning a SiteFuel::Configuration class
-    def self.load(path)
-      unless File.exist?(path)
-        throw NotFound, path
+    def self.find_configuration(path, filename = DEFAULT_CONFIGURATION_FILE)
+      files = Dir["**/"+filename]
+
+      if files.length < 0
+        return nil
+      elsif files.length > 1
+        warn("Multiple  possible configuration files found: #{files.join(', ')}; using #{files.first}")
+        return files.first
+      else
+        return files.first
       end
+    end
 
-      yamlconfig = YAML::load_file(configfile)
-      
-      Configuration.new(yamlconfig)
+
+    # given a directory path will attempt to find and load a
+    # configuration file
+    def self.load_configuration(runtime, path, filename = DEFAULT_CONFIGURATION_FILE)
+      configuration_file = find_configuration(path, filename)
+
+      if configuration_file == nil
+        warn('No deployment configuration file found. Using defaults.')
+        return Configuration.new(runtime, nil)
+      else
+        yaml = YAML::load_file(configuration_file)
+        return Configuration.new(runtime, yaml)
+      end
     end
 
+    
     # builds a sitefuel configuration from a parsed YAML file
-    def initialize(yamlconfig)
+    def initialize(runtime, yaml_config)
+      @processor_configurations = Hash.new([])
+      @runtime = runtime
+
+      load_yaml_config(yaml_config)
+    end
+
+
+    # loads a yaml configuration
+    def load_yaml_config(yaml_config)
+      
+    end
+
+
+    # gives an array of configuration options for the processor
+    def processor_configuration(processor)
+      @processor_configurations[processor]
     end
   end
 end