sitefuel 0.0.0b → 0.1.0a

data/lib/sitefuel/extensions/SymbolComparison.rb

@@ -1,9 +1,11 @@
 #
 # File::      SymbolComparison.rb
 # Author::    wkm
-# Copyright:: 2009
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
-# Defines a spaceship for symbols based off of to_s
+# Defines a spaceship for symbols based off of to_s, this let's us sort lists
+# of symbols.
 #
 
 class Symbol

data/lib/sitefuel/extensions/TerminalInfo.rb

@@ -0,0 +1,53 @@
+#
+# File::      TerminalInfo.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
+#
+# Little Ruby library for querying for various properties of
+# a terminal window.
+#
+
+module TerminalInfo
+
+  # gives an array containing the current dimensions of the terminal
+  # window
+  #
+  # Note that unlike =stty= (and #size) the first parameter is the width of
+  # the window (x) and the second parameter is the height of the window (y)
+  #
+  #  TerminalInfo.dimensions # => [105, 34]
+  def self.dimensions
+    grab_output('stty size').split(' ').reverse.map do |val|
+      val.to_i
+    end
+  end
+
+  # gives an array with the current size of the terminal window
+  #
+  # Note that the first parameter is the height of the window, just like with
+  # =stty=
+  #
+  #  TerminalInfo.size # => [34, 105]
+  def self.size
+    dimensions.reverse
+  end
+
+  # gives the current width of the terminal window
+  def self.width
+    dimensions.first
+  end
+
+  # gives the current height of the terminal window
+  def self.height
+    dimensions.last
+  end
+
+private
+
+  # the back tick notation is annoying to read... 
+  def self.grab_output(command)
+    `#{command}`
+  end
+
+end

data/lib/sitefuel/external/AbstractExternalProgram.rb

@@ -1,8 +1,8 @@
 #
 # File::      AbstractExternalProgram.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # An abstraction around calling an external program.
 #
@@ -16,6 +16,9 @@ module SiteFuel
     require 'sitefuel/extensions/DynamicClassMethods'
     require 'sitefuel/SiteFuelLogger'
 
+    require 'tmpdir'
+    require 'sha1'
+
     # raised when an external program can't be found
     class ProgramNotFound < StandardError
       attr_reader :program_name
@@ -131,6 +134,24 @@ module SiteFuel
 
 
 
+    # raised when a program exits with a return code other than
+    # 0, generally indicating some sort of failure.
+    class ProgramExitedWithFailure < StandardError
+      attr_reader :program, :command_line, :return_code
+      def initialize(program, command_line, return_code)
+        @program = program
+        @command_line = command_line
+        @return_code = return_code
+      end
+
+      def to_s
+        "Program %s exited with %d when evaluating:\n%s" %
+        [program, return_code, command_line]
+      end
+    end
+
+
+
 
 
 
@@ -427,6 +448,7 @@ module SiteFuel
         define_class_method(method_name.to_sym) { struct }
       end
 
+
       # organizes a list of options into a ragged array of arrays
       #
       #  organize_options(:setflag, :paramsetting, 'val1', 'val2')
@@ -444,7 +466,7 @@ module SiteFuel
             j = i+1
             while j < options.length
               case options[j]
-                when String
+                when String, Fixnum, Float
                   # adds this value
                   option_row << options[j]
                   j += 1
@@ -490,6 +512,21 @@ module SiteFuel
       end
 
 
+      # creates a random string by hashing the current time into hexadecimal
+      def self.random_string(length=12)
+        Digest::SHA1.hexdigest(Time.now.to_f.to_s)[0, length]
+      end
+
+
+      # creates a temporary directory for sitefuel
+      def self.create_tmp_directory(keyword)
+        dir_name = File.join(Dir.tmpdir, "sitefuel-#{keyword}-#{random_string}")
+        Dir.mkdir(dir_name)
+
+        dir_name
+      end
+
+
 
 
       
@@ -555,7 +592,7 @@ module SiteFuel
         
       # applies a given value into an option template
       def apply_value(option_template, value)
-        option_template.gsub('${value}', value)
+        option_template.gsub('${value}', value.to_s)
       end
         
 
@@ -576,10 +613,10 @@ module SiteFuel
       def requires_value?(name)
         takes_value?(name) and not has_default?(name)
       end
-        
 
-      # executes the given AbstractExternalProgram instance
-      def execute
+
+      # builds the command line for a given program instance
+      def build_command_line
         self.class.verify_compatible_version
 
         exec_string = self.class.program_binary.clone
@@ -600,14 +637,31 @@ module SiteFuel
           exec_string << ' ' << option_string
         end
 
-        info 'Executing: '+exec_string
+        exec_string
+      end
+        
+
+      # executes the given AbstractExternalProgram instance
+      def execute
+        exec_string = build_command_line
 
-        case self.class.output_handling
+        info '    Executing: '+exec_string
+        output_handler = self.class.output_handling
+        case output_handler
           when :capture
-            self.class.capture_output(exec_string)
+            output_string = self.class.capture_output(exec_string)
 
           when :forward
-            exec(exec_string)
+            output_string = exec(exec_string)
+
+          else
+            raise "Unknown output handler: #{output_handler}"
+        end
+
+        if $?.success?
+          return output_string
+        else
+          raise ProgramExitedWithFailure.new(self.class, exec_string, $?.to_i)
         end
       end
 

data/lib/sitefuel/external/ExternalProgramTestCase.rb

@@ -1,8 +1,8 @@
 #
 # File::      ExternalProgramTestCase.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPl
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Lightweight utility that will effectively scrap
 # the entire test case if the program being tested doesn't exist.

data/lib/sitefuel/external/GIT.rb

@@ -1,9 +1,56 @@
 #
 # File::      GIT.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Wrapper around the git version control system.
 #
-#
+
+module SiteFuel
+  module External
+
+    require 'sitefuel/external/AbstractExternalProgram'
+
+    # defines a wrapper around the Git version control system
+    # this wrapper is designed to only handle 
+    class GIT < AbstractExternalProgram
+
+      def self.program_name
+        'git'
+      end
+
+      # this would probably work with 
+      def self.compatible_versions
+        '> 1.4'
+      end
+
+      # creates a new repository from an existing git repository
+      option :clone, 'clone'
+
+      # sets the source from which to read repository data
+      option :source, '${value}'
+
+      # specify a depth for a shallow clone
+      option :depth, '--depth ${value}', 1
+
+      # specifies an output directory for git
+      option :output, '${value}'
+
+      # creates a shallow clone of an existing repository
+      def self.shallow_clone(source, directory = nil, depth=1)
+        if directory == nil
+          directory = create_tmp_directory('git')
+        end
+
+        execute :clone,
+                :depth, depth,
+                :source, source,
+                :output, directory
+
+        directory
+      end
+      
+    end
+  end
+end

data/lib/sitefuel/external/JPEGTran.rb

@@ -1,8 +1,8 @@
 #
 # File::      JPEGTran.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Wrapper around the jpegtran program.
 #

data/lib/sitefuel/external/PNGCrush.rb

@@ -1,8 +1,8 @@
 #
 # File::      PNGCrush.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Wrapper around the pngcrush program.
 #

data/lib/sitefuel/external/SVN.rb

@@ -0,0 +1,57 @@
+#
+# File::      SVN.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
+#
+# Wrapper around the SVN version control system.
+#
+
+module SiteFuel
+  module External
+
+    require 'sitefuel/external/AbstractExternalProgram'
+
+    class SVN < AbstractExternalProgram
+
+      def self.program_name
+        'svn'
+      end
+
+      # again, earlier versions would probably work
+      def self.compatible_versions
+        '> 1.2'
+      end
+      
+
+      option :source, '${value}'
+      option :export, 'export'
+      option :revision, '-r ${value}'
+      option :output, '${value}'
+      option :force, '--force'
+
+      def self.export(source, output=nil, revision='HEAD')
+        use_force = false
+
+        if output == nil
+          output = create_tmp_directory('svn')
+          use_force = true
+        end
+
+        args = [:export,
+                :revision, revision,
+                :source, source,
+                :output, output]
+
+        if use_force
+          args << :force
+        end
+
+        execute(*args)
+
+        output
+      end
+
+    end
+  end
+end

data/lib/sitefuel/processors/AbstractExternalProgramProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      AbstractExternalProgramProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # TODO: this abstraction assumes only one filter will ever be run on a file,
 # which is rather naive. Need to add support to process a file multiple times.
@@ -33,8 +33,14 @@ module SiteFuel
         'External'
       end
 
+      def processor_symbol
+        'E'
+      end
+
       # processes a file using a given configuration
       def self.process_file(filename, config = {})
+        info "#{self.class} opening for #{filename}"
+
         proc = self.new()
         proc.configure(config)
         proc.set_file(filename)
@@ -64,9 +70,16 @@ module SiteFuel
         self.execute
         self.processed_size = File.size(output_filename)
         return self
+      rescue SiteFuel::External::ProgramExitedWithFailure => exception
+        error "When processing #{resource_name}:"
+        error exception.to_s
       end
-      
-    end
 
+      def save(base_file_tree)
+        final_filename = base_file_tree.get_file(resource_name)
+        File.rename(output_filename, final_filename)
+        info "Moved #{output_filename} to #{final_filename}"
+      end
+    end
   end
 end

data/lib/sitefuel/processors/AbstractProcessor.rb

@@ -1,7 +1,8 @@
 #
 # File::      AbstractProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Defines an AbstractProcessor class that gives the interface implemented by
 # specific processors.
@@ -11,10 +12,13 @@ module SiteFuel
   module Processor
 
     require 'sitefuel/SiteFuelLogger'
+    require 'sitefuel/processors/Configurable'
 
     # raised when a method isn't implemented by a child class.
     class NotImplemented < StandardError; end
 
+
+
     # raised when attempting to run a filter that doesn't exist
     class UnknownFilter < StandardError
       attr_reader :processor, :name
@@ -30,6 +34,8 @@ module SiteFuel
       end
     end
 
+
+
     class UnknownFilterset < StandardError
       attr_reader :processor, :name
 
@@ -44,6 +50,8 @@ module SiteFuel
       end
     end
 
+
+
     # raised when multiple processors trigger off of a single file
     class MultipleApplicableProcessors < StandardError
       attr_reader :filename, :processors, :chosen_processor
@@ -60,14 +68,19 @@ module SiteFuel
       end
     end
 
+
+
     # defines the base functions every processor must implement to
     # interface with the sitefuel architecture
     class AbstractProcessor
 
       include SiteFuel::Logging
+      extend SiteFuel::ClassLogging
+
+      include Configurable
 
       # setup an AbstractProcessor
-      def initialize
+      def initialize        
         self.logger = SiteFuelLogger.instance
         @execution_list = []
         @filters = []
@@ -114,6 +127,12 @@ module SiteFuel
         self.to_s.sub(/.*\b(.*)Processor/, '\1')
       end
 
+      # gives the symbol of the processor; used when showing deployment
+      # progress
+      def processor_symbol
+        'A'
+      end
+
       
       # gives the file patterns that trigger the processor by default; this
       # behavior can be over-ridden by configuration files.
@@ -283,18 +302,22 @@ module SiteFuel
         end
       end
 
+
       # called in #execute _before_ running the execution list of filters; note
       # that #setup_filters is only called _once_ before all of the filters are
       # batch executed. It is not called before every filter executes.
       def setup_filters; end
 
+      
       # called in #execute _after_ running the execution list of filters
       def finish_filters; end
 
+
       # runs all filters in the execution list
       def execute
         setup_filters
         @execution_list.uniq.each do |filter|
+          info "    Running filter: #{filter}"
           run_filter(filter)
         end
         finish_filters
@@ -303,71 +326,65 @@ module SiteFuel
       end
 
 
+      # creates a file with the given name
+      def create_file(base_file_tree)
+        base_file_tree.get_file(resource_name)
+      end
 
 
-      def save(basepath)
-        File.open(File.join(basepath, resource_name), 'w') do |fhndl|
-          fhndl.write(document.to_s)
-        end
+      # default save method. This will only create a file, the
+      # more specific abstractions need to implement the actual method
+      def save(base_file_tree)
+        create_file(base_file_tree)
       end
 
-
+    protected
       #
-      # CONFIGURATION SUPPORT
+      # Configuration Support
       #
-      def configure(config)
+
+      def pre_configuration
         @filters_cleared = false
-        unless config == nil  or  config == {}
-          config.each_pair do |k, v|
-            set_configuration(k, v)
-          end
-        end
+      end
 
-        if !@filters_cleared && execution_list.empty?
+      def post_configuration
+        if !@filters_cleared and execution_list.empty?
           add_filterset(self.class.default_filterset)
         end
-        @filters_cleared = false
+        @filters_cleared = true
       end
 
-    private
-      def set_configuration(key, value)
-        case key
-          when :resource_name
-            @resource_name = value
+
+      # ensures the filters have been cleared during this
+      # configuration phase. Preforms the #clear_filters if they haven't
+      def ensure_cleared_filters
+        if not @filters_cleared
+          clear_filters
+          @filters_cleared = true
+        end
+      end
 
 
-          when :filters
-            if not @filters_cleared
-              clear_filters
-              @filters_cleared = true
-            end
+      # sets the name for the resource that is being processed
+      def configure_resource_name(value)
+        @resource_name = value
+      end
 
-            case value
-              when Array
-                value.each { |v| add_filter(v) }
-              when Symbol, String
-                add_filter(value)
-            end
 
-          when :filtersets
-            if not @filters_cleared
-              clear_filters
-              @filters_cleared = true
-            end
+      # adds filters to this processor
+      def configure_filters(*values)
+        ensure_cleared_filters
+        values.each { |v| add_filter(v) }
+      end
 
-            case value
-              when Array
-                value.each { |v| add_filterset(v) }
-              when Symbol, String
-                add_filterset(value)
-            end
 
-          else
-            raise UnknownConfigurationOption(self.class, key, value)
-        end
+      # adds filtersets to this processor
+      def configure_filtersets(*values)
+        ensure_cleared_filters
+        values.each { |v| add_filterset(v) }
       end
 
-    protected
+      
       # gives write-access to children classes
       attr_writer :original_size
       attr_writer :processed_size