sitefuel 0.0.0b → 0.1.0a

data/lib/sitefuel/processors/AbstractStringBasedProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      AbstractStringBasedProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Defines an abstract processor that runs by loading an entire file into
 # memory as a string. Since most files we're looking at are very small
@@ -21,6 +21,10 @@ module SiteFuel
         'String'
       end
 
+      def processor_symbol
+        'S'
+      end
+
       # lightweight wrapper for opening a resource and generating the file
       def self.process_file(filename, config = {})
         proc = self.new()
@@ -50,6 +54,8 @@ module SiteFuel
 
       # opens a resource from a file
       def open_file(filename)
+        info "#{self.class} opening #{filename}"
+
         self.document = File.read(filename)
         self.original_size = File.size(filename)
         self.resource_name = filename
@@ -59,9 +65,11 @@ module SiteFuel
 
       # opens a resource directly from a string
       def open_string(string)
+        info "#{self.class} opening in embedded mode"
+
         self.document = string
         self.original_size = string.length
-        self.resource_name = '<<in-memory string>>'
+        self.resource_name = '<<embedded string>>'
       end
 
       # generates the actual string
@@ -77,6 +85,15 @@ module SiteFuel
         generate_string
         return self
       end
+
+      def save(file_tree)
+        file_name = create_file(file_tree)
+        File.open(file_name, 'w') do |file|
+          file << @document
+        end
+
+        info "Wrote document into #{file}"
+      end
       
       attr_reader :document
       

data/lib/sitefuel/processors/CSSProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      CSSProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Rather lightweight CSS processor; primarily intended to minify CSS, but has
 # basic support for beautifcation as well

data/lib/sitefuel/processors/Configurable.rb

@@ -0,0 +1,94 @@
+#
+# File::      Configurable.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
+#
+# Implements a general abstraction for configuring a class instance
+#
+
+module SiteFuel
+  module Processor
+    module Configurable
+
+      class UnknownConfigurationOption < StandardError
+        attr_reader :class_name, :option_name
+        def initialize(class_name, option_name)
+          @class_name = class_name
+          @option_name = option_name
+        end
+
+        def to_s
+          "Class #{class_name} has no known option '#{option_name}'"
+        end
+      end
+
+
+
+      # gives a list of all configurable options for this class
+      def configuration_options
+        names = methods.map do |name|
+          if name =~ /^configure_(.*)$/
+            $1.to_sym
+          else
+            nil
+          end
+        end
+
+        names.compact
+      end
+
+
+      def pre_configuration
+        # stub to be overriden by child classes
+      end
+
+
+      def post_configuration
+        # stub to be overriden by child classes
+      end
+
+
+      # configures a particular instance given a hash; runs #pre_configuration
+      # before running any particular config method and #post_configuration
+      # afterwards
+      def configure(config = {})
+        pre_configuration
+
+        unless config == nil or config == {}
+          config.each_pair do |k, v|
+            set_configuration(k, v)
+          end
+        end
+
+        post_configuration
+      end
+
+
+      # ensures the given option name is configurable; otherwise
+      # raises a UnknownConfigurationOption exception
+      def ensure_configurable_option (name)
+        if configuration_options.include?(name.to_sym)
+          return true
+        else
+          raise UnknownConfigurationOption.new(self.class, name)
+        end
+      end
+
+
+      # sets the configuration for a single option
+      def set_configuration(key, value)
+        ensure_configurable_option(key)
+        method = "configure_" + key.to_s
+
+        case value
+          when Array
+            send(method.to_sym, *value)
+
+          else
+            send(method.to_sym, value)
+        end
+      end
+    end
+  end
+end

data/lib/sitefuel/processors/HAMLProcessor.rb

@@ -1,8 +1,8 @@
 #
-# File::       HAMLProcessor.rb
-# Author::     wkm
-# Copyright::  2009
-# License::    GPL
+# File::      HAMLProcessor.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # processes .haml source files to generate the associated HTML
 #

data/lib/sitefuel/processors/HTMLProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      HTMLProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Defines an HTMLProcessor class that is used to compress and cleanup HTML
 # files for deployment with sitefuel. Uses hpricot to process the HTML.

data/lib/sitefuel/processors/JavaScriptProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      JavaScriptProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 
 module SiteFuel

data/lib/sitefuel/processors/PHPProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      PHPProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Defines a PHPProcessor class; but it's really a very lightweight alias
 # around the HTMLProcessor

data/lib/sitefuel/processors/PNGProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      PNGProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Interfaces with the rbcrush library that's wrapped around pngcrush
 #

data/lib/sitefuel/processors/RHTMLProcessor.rb

@@ -1,8 +1,8 @@
 #
 # File::      RHTMLProcessor.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Defines the RHTMLProcessor class. This is a lightweight wrapper
 # around the HTMLProcessor class

data/lib/sitefuel/processors/SASSProcessor.rb

@@ -1,8 +1,8 @@
 #
-# File::       SASSProcessor.rb
-# Author::     wkm
-# Copyright::  2009
-# License::    GPL
+# File::      SASSProcessor.rb
+# Author::    wkm
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # processes .sass stylesheets to generate the associated CSS
 #

data/test/processor_listing.rb

@@ -2,8 +2,8 @@
 #
 # File::      processor_listing.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Lists all the processors in SiteFuel with their file patterns
 #

data/test/{test_programs → programs}/versioning.rb

@@ -2,8 +2,8 @@
 #
 # File::      versioning.rb
 # Author::    wkm
-# Copyright:: 2009
-# License::   GPL
+# Copyright:: 2009, Zanoccio LLC.
+# License::   GPL version 2.0 (see LICENSE.rb)
 #
 # Simple program for testing various versioning controls
 #

data/test/repositories/git/few_files/index.html

@@ -0,0 +1,10 @@
+<html>
+	<head>
+		<title>Just a little test</title>
+		<link rel="stylesheet" type="text/css" href="style.css" />
+	</head>
+	<body>
+		<h1>Git Repository Test</h1>
+		<p>Ta da....</p>
+	</body>
+</html>

data/test/repositories/git/few_files/style.css

@@ -0,0 +1,2 @@
+body { font-family: sans-serif; font-size: 16pt; }
+

data/test/repositories/svn/testrepo1/README.txt

@@ -0,0 +1,5 @@
+This is a Subversion repository; use the 'svnadmin' tool to examine
+it.  Do not add, delete, or modify files here unless you know how
+to avoid corrupting the repository.
+
+Visit http://subversion.tigris.org/ for more information.

data/test/repositories/svn/testrepo1/conf/authz

@@ -0,0 +1,32 @@
+### This file is an example authorization file for svnserve.
+### Its format is identical to that of mod_authz_svn authorization
+### files.
+### As shown below each section defines authorizations for the path and
+### (optional) repository specified by the section name.
+### The authorizations follow. An authorization line can refer to:
+###  - a single user,
+###  - a group of users defined in a special [groups] section,
+###  - an alias defined in a special [aliases] section,
+###  - all authenticated users, using the '$authenticated' token,
+###  - only anonymous users, using the '$anonymous' token,
+###  - anyone, using the '*' wildcard.
+###
+### A match can be inverted by prefixing the rule with '~'. Rules can
+### grant read ('r') access, read-write ('rw') access, or no access
+### ('').
+
+[aliases]
+# joe = /C=XZ/ST=Dessert/L=Snake City/O=Snake Oil, Ltd./OU=Research Institute/CN=Joe Average
+
+[groups]
+# harry_and_sally = harry,sally
+# harry_sally_and_joe = harry,sally,&joe
+
+# [/foo/bar]
+# harry = rw
+# &joe = r
+# * =
+
+# [repository:/baz/fuz]
+# @harry_and_sally = rw
+# * = r

data/test/repositories/svn/testrepo1/conf/passwd

@@ -0,0 +1,8 @@
+### This file is an example password file for svnserve.
+### Its format is similar to that of svnserve.conf. As shown in the
+### example below it contains one section labelled [users].
+### The name and password for each user follow, one account per line.
+
+[users]
+# harry = harryssecret
+# sally = sallyssecret

data/test/repositories/svn/testrepo1/conf/svnserve.conf

@@ -0,0 +1,47 @@
+### This file controls the configuration of the svnserve daemon, if you
+### use it to allow access to this repository.  (If you only allow
+### access through http: and/or file: URLs, then this file is
+### irrelevant.)
+
+### Visit http://subversion.tigris.org/ for more information.
+
+[general]
+### These options control access to the repository for unauthenticated
+### and authenticated users.  Valid values are "write", "read",
+### and "none".  The sample settings below are the defaults.
+# anon-access = read
+# auth-access = write
+### The password-db option controls the location of the password
+### database file.  Unless you specify a path starting with a /,
+### the file's location is relative to the directory containing
+### this configuration file.
+### If SASL is enabled (see below), this file will NOT be used.
+### Uncomment the line below to use the default password file.
+# password-db = passwd
+### The authz-db option controls the location of the authorization
+### rules for path-based access control.  Unless you specify a path
+### starting with a /, the file's location is relative to the the
+### directory containing this file.  If you don't specify an
+### authz-db, no path-based access control is done.
+### Uncomment the line below to use the default authorization file.
+# authz-db = authz
+### This option specifies the authentication realm of the repository.
+### If two repositories have the same authentication realm, they should
+### have the same password database, and vice versa.  The default realm
+### is repository's uuid.
+# realm = My First Repository
+
+[sasl]
+### This option specifies whether you want to use the Cyrus SASL
+### library for authentication. Default is false.
+### This section will be ignored if svnserve is not built with Cyrus
+### SASL support; to check, run 'svnserve --version' and look for a line
+### reading 'Cyrus SASL authentication is available.'
+# use-sasl = true
+### These options specify the desired strength of the security layer
+### that you want SASL to provide. 0 means no encryption, 1 means
+### integrity-checking only, values larger than 1 are correlated
+### to the effective key length for encryption (e.g. 128 means 128-bit
+### encryption). The values below are the defaults.
+# min-encryption = 0
+# max-encryption = 256

data/test/repositories/svn/testrepo1/db/current

@@ -0,0 +1 @@
+1

data/test/repositories/svn/testrepo1/db/format

@@ -0,0 +1,2 @@
+4
+layout sharded 1000

data/test/repositories/svn/testrepo1/db/fs-type

@@ -0,0 +1 @@
+fsfs

data/test/repositories/svn/testrepo1/db/fsfs.conf

@@ -0,0 +1,37 @@
+### This file controls the configuration of the FSFS filesystem.
+
+[memcached-servers]
+### These options name memcached servers used to cache internal FSFS
+### data.  See http://www.danga.com/memcached/ for more information on
+### memcached.  To use memcached with FSFS, run one or more memcached
+### servers, and specify each of them as an option like so:
+# first-server = 127.0.0.1:11211
+# remote-memcached = mymemcached.corp.example.com:11212
+### The option name is ignored; the value is of the form HOST:PORT.
+### memcached servers can be shared between multiple repositories;
+### however, if you do this, you *must* ensure that repositories have
+### distinct UUIDs and paths, or else cached data from one repository
+### might be used by another accidentally.  Note also that memcached has
+### no authentication for reads or writes, so you must ensure that your
+### memcached servers are only accessible by trusted users.
+
+[caches]
+### When a cache-related error occurs, normally Subversion ignores it
+### and continues, logging an error if the server is appropriately
+### configured (and ignoring it with file:// access).  To make
+### Subversion never ignore cache errors, uncomment this line.
+# fail-stop = true
+
+[rep-sharing]
+### To conserve space, the filesystem can optionally avoid storing
+### duplicate representations.  This comes at a slight cost in performace,
+### as maintaining a database of shared representations can increase
+### commit times.  The space savings are dependent upon the size of the
+### repository, the number of objects it contains and the amount of
+### duplication between them, usually a function of the branching and
+### merging process.
+###
+### The following parameter enables rep-sharing in the repository.  It can
+### be switched on and off at will, but for best space-saving results
+### should be enabled consistently over the life of the repository.
+# enable-rep-sharing = false