apache-config-generator 0.2 → 0.2.2.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.2.2.1. Fix another stupid bug, yanking old version.
+
+v0.2.2. Fix a stupid bug, yanking old version.
+
+v0.2.1. Lots of code cleanup and documentation added.
+
 v0.2. Another minor release, lots of improvements since 0.1.
 
 v0.1.2. Some more small fixes.

data/Manifest

@@ -1,8 +1,11 @@
 CHANGELOG
 README.rdoc
 Rakefile
+apache-config-generator.gemspec
 bin/apache-configurator
+config/config.reek
 lib/apache.rb
+lib/apache/apachify.rb
 lib/apache/config.rb
 lib/apache/directory.rb
 lib/apache/logging.rb
@@ -11,7 +14,6 @@ lib/apache/modules.rb
 lib/apache/mpm_prefork.rb
 lib/apache/performance.rb
 lib/apache/permissions.rb
-lib/apache/quoteize.rb
 lib/apache/rake/create.rb
 lib/apache/rewrites.rb
 lib/apache/ssl.rb

data/README.rdoc

@@ -19,6 +19,8 @@ Configs center around the Apache::Config.build method:
     server_name 'my-cool-website.cool.wow'
     document_root '/var/www/my-cool-website'
 
+		server_admin! "john@coswellproductions.com"
+
     directory '/' do
       options :follow_sym_links, :indexes
       allow_from_all
@@ -30,5 +32,54 @@ Configs center around the Apache::Config.build method:
       basic_authentication "My secret", '/etc/apache2/users/global.users', :user => :john
       satisfy :any
     end
+
+    rewrites "My old content" do
+    	cond "%{HTTP_REFERER}", '!^my-cool-website\.cool\.wow$'
+    	rule %r{\.(gif|jpg|png|pdf)$}, '/lol-image-stealer.html', :last => true, :redirect => true
+
+    	rewrite_test '/index.html', '/index.html', :http_referer => 'other.site'
+    	rewrite_test '/index.gif', '/lol-image-stealer.html', :http_referer => 'other.site'
+    	rewrite_test '/index.gif', '/index.gif', :http_referer => 'my-cool-website.cool.wow'
+    end
   end
 
+Notes on how the conversion works:
+
+* Methods within the build block are translated into NerdCapsed Apache directives.
+* Directives that house children take blocks that contain the child methods.
+* Directives that expect regular expressions take a Regexp object.
+* Passing a String as a parameter, by default, double-quotes it.
+* Passing in a Symbol does not quote the parameter.
+** Some directives NerdCap Symbols, such as Options
+* Appending an exclamation point to the method turns off quoting.
+* Shortcut methods are defined as modules under the Apache module.
+
+There are also sanity checks that occur when configuration is being generated:
+
+* Directives that rely on a path will check to see if the path exists.
+* Since you need to use Regexp objects for directives that require a regular expression,
+  bad expressions will be flagged by the Ruby interpreter.
+* Rewrite rules can be tested with the rewrite_test method.
+
+The above config is transformed into the following:
+
+	ServerName "my-cool-website.cool.wow"
+	DocumentRoot "/var/www/my-cool-website"
+	ServerAdmin john@coswellproductions.com
+
+	<Directory "/">
+		Options FollowSymLinks, Indexes
+		Allow from all
+	</Directory>
+
+	<LocationMatch "^/secret">
+		Deny from all
+
+		AuthType Basic
+		AuthName "My secret"
+		AuthUserFile "/etc/apache2/users/global.users"
+		Require user john
+	</LocationMatch>
+
+	RewriteCond "%{HTTP_REFERER}" "^!my-cool-website\.cool\.wow"
+	RewriteRule "\.(gif|jpg|png|pdf)$" "/lol-image-stealer.html" [L,R]

data/Rakefile

@@ -1,5 +1,7 @@
 $LOAD_PATH << 'lib'
 
+require 'rubygems'
+
 require 'apache'
 require 'spec/rake/spectask'
 require 'sdoc'
@@ -39,3 +41,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.main = 'README.rdoc'
   rdoc.rdoc_dir = 'docs'
 end
+
+task :reek do
+  system('reek -c config/config.reek lib/*')
+end

data/apache-config-generator.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apache-config-generator}
-  s.version = "0.2"
+  s.version = "0.2.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Bintz"]
-  s.date = %q{2010-05-12}
+  s.date = %q{2010-05-19}
   s.default_executable = %q{apache-configurator}
   s.description = %q{A Ruby DSL for programmatically generating Apache configs}
   s.email = %q{}
   s.executables = ["apache-configurator"]
-  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "bin/apache-configurator", "lib/apache.rb", "lib/apache/config.rb", "lib/apache/directory.rb", "lib/apache/logging.rb", "lib/apache/master.rb", "lib/apache/modules.rb", "lib/apache/mpm_prefork.rb", "lib/apache/performance.rb", "lib/apache/permissions.rb", "lib/apache/quoteize.rb", "lib/apache/rake/create.rb", "lib/apache/rewrites.rb", "lib/apache/ssl.rb"]
-  s.files = ["CHANGELOG", "README.rdoc", "Rakefile", "bin/apache-configurator", "lib/apache.rb", "lib/apache/config.rb", "lib/apache/directory.rb", "lib/apache/logging.rb", "lib/apache/master.rb", "lib/apache/modules.rb", "lib/apache/mpm_prefork.rb", "lib/apache/performance.rb", "lib/apache/permissions.rb", "lib/apache/quoteize.rb", "lib/apache/rake/create.rb", "lib/apache/rewrites.rb", "lib/apache/ssl.rb", "skel/Rakefile", "skel/config.yml", "Manifest", "apache-config-generator.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "bin/apache-configurator", "lib/apache.rb", "lib/apache/apachify.rb", "lib/apache/config.rb", "lib/apache/directory.rb", "lib/apache/logging.rb", "lib/apache/master.rb", "lib/apache/modules.rb", "lib/apache/mpm_prefork.rb", "lib/apache/performance.rb", "lib/apache/permissions.rb", "lib/apache/rake/create.rb", "lib/apache/rewrites.rb", "lib/apache/ssl.rb"]
+  s.files = ["CHANGELOG", "README.rdoc", "Rakefile", "apache-config-generator.gemspec", "bin/apache-configurator", "config/config.reek", "lib/apache.rb", "lib/apache/apachify.rb", "lib/apache/config.rb", "lib/apache/directory.rb", "lib/apache/logging.rb", "lib/apache/master.rb", "lib/apache/modules.rb", "lib/apache/mpm_prefork.rb", "lib/apache/performance.rb", "lib/apache/permissions.rb", "lib/apache/rake/create.rb", "lib/apache/rewrites.rb", "lib/apache/ssl.rb", "skel/Rakefile", "skel/config.yml", "Manifest"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Apache-config-generator", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/config/config.reek

@@ -0,0 +1,4 @@
+---
+FeatureEnvy:
+  exclude:
+    - Apache::Logging#handle_log

data/lib/apache/apachify.rb

@@ -0,0 +1,140 @@
+module Apache
+  module Apachify
+    # Apachify a string
+    #
+    # Split the provided name on underscores and capitalize the individual parts
+    # Certain character strings are capitalized to match Apache directive names:
+    # * Cgi => CGI
+    # * Ssl => SSL
+    # * Ldap => LDAP
+    def apachify
+      self.to_s.split("_").collect { |part|
+        part.capitalize!
+
+        case part
+          when 'Ssl', 'Cgi', 'Ldap', 'Url'; part.upcase
+          when 'Etag'; 'ETag'
+          else; part
+        end
+      }.join
+    end
+  end
+end
+
+# Ruby strings
+class String
+  include Apache::Apachify
+
+  alias :optionify :apachify
+
+  def commentize
+    self.split("\n")
+  end
+
+  def quoteize
+    %{"#{self}"}
+  end
+
+  alias :blockify :quoteize
+
+  def headerize
+    "#{self.quoteize}"
+  end
+
+  def replace_placeholderize(opts)
+    self.gsub(%r{%\{([^\}]+)\}}) do |match|
+      key = $1.downcase.to_sym
+      opts[key] || ''
+    end
+  end
+end
+
+# Ruby symbols
+class Symbol
+  include Apache::Apachify
+
+  # Turn this into an option for IndexOptions
+  def optionify
+    output = self.apachify
+    output = "-#{output[3..-1]}" if self.to_s[0..3] == 'not_'
+    output
+  end
+
+  def quoteize
+    self.to_s.gsub('_', ' ')
+  end
+
+  def blockify
+    self.to_s
+  end
+
+  def headerize
+    "#{self.quoteize}"
+  end
+end
+
+class Fixnum
+  def quoteize; self; end
+end
+
+# Ruby arrays
+class Array
+  # Apachify all the elements within this array
+  def apachify
+    self.collect(&:apachify)
+  end
+
+  def quoteize
+    self.collect(&:quoteize)
+  end
+
+  def quoteize!
+    self.collect!(&:quoteize)
+  end
+
+  def blockify
+    self.quoteize * " "
+  end
+
+  alias :commentize :to_a
+
+  def headerize
+    "#{self.first.quoteize} #{self.last}"
+  end
+
+  def rewrite_cond_optionify
+    self.collect do |opt|
+      {
+        :or => 'OR',
+        :case_insensitive => 'NC',
+        :no_vary => 'NV'
+      }[opt]
+    end
+  end
+
+  def rewrite_option_listify
+    (!self.empty?) ? "[#{self * ','}]" : nil
+  end
+end
+
+# Ruby hashes
+class Hash
+  REWRITE_RULE_CONDITIONS = {
+    :last => 'L',
+    :forbidden => 'F',
+    :no_escape => 'NE',
+    :redirect => lambda { |val| val == true ? 'R' : "R=#{val}" },
+    :pass_through => 'PT',
+    :preserve_query_string => 'QSA',
+    :query_string_append => 'QSA',
+    :env => lambda { |val| "E=#{val}" }
+  }
+
+  def rewrite_rule_optionify
+    self.collect do |key, value|
+      what = REWRITE_RULE_CONDITIONS[key]
+      what = what.call(value) if what.kind_of? Proc
+      what
+    end.compact.sort
+  end
+end

data/lib/apache/config.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'fileutils'
 require 'rainbow'
 
@@ -56,7 +57,6 @@ module Apache
       attr_accessor :line_indent, :rotate_logs_path
 
       include Apache::Master
-      include Apache::Quoteize
       include Apache::Permissions
       include Apache::Directories
       include Apache::Logging
@@ -71,19 +71,27 @@ module Apache
       end
 
       # Build the provided configuration
-      def build(target = nil, &block)
+      def build_and_return(&block)
         reset!
 
         self.instance_eval(&block)
 
-        if target
-          FileUtils.mkdir_p File.split(target).first
-          File.open(target, 'w') { |f| f.puts [ "# Generated by apache-config-generator #{Time.now.to_s}", @config ].flatten * "\n" }
-        end
-
         @config
       end
 
+      def build_and_return_if(*conditions, &block)
+        build_and_return(&block) if conditions.include? APACHE_ENV
+      end
+
+      def build(target, &block)
+        config = build_and_return(&block)
+
+        FileUtils.mkdir_p File.split(target).first
+        File.open(target, 'w') { |file| file.puts [ "# Generated by apache-config-generator #{Time.now.to_s}", config ].flatten * "\n" }
+
+        config
+      end
+
       # Reset the current settings
       def reset!
         @config = []
@@ -94,7 +102,7 @@ module Apache
       def indent(string_or_array)
         case string_or_array
           when Array
-            string_or_array.collect { |s| indent(s) }
+            string_or_array.collect { |line| indent(line) }
           else
             " " * (@line_indent * 2) + string_or_array.to_s
         end
@@ -115,35 +123,18 @@ module Apache
         @config
       end
 
-      # Apachify a string
-      #
-      # Split the provided name on underscores and capitalize the individual parts
-      # Certain character strings are capitalized to match Apache directive names:
-      # * Cgi => CGI
-      # * Ssl => SSL
-      # * Ldap => LDAP
-      def apachify(name)
-        case name
-          when String, Symbol
-            name.to_s.split("_").collect(&:capitalize).join.gsub('Ssl', 'SSL').
-                gsub('Cgi', 'CGI').gsub('Ldap', 'LDAP').gsub('Url', 'URL').
-                gsub('Etag', 'ETag')
-          when Array
-            name.collect { |n| apachify(n) }
-        end
-      end
-
       # Handle options that aren't specially handled
       #
       # Method names are NerdCapsed and paramters are quoted, unless the method ends with !
       def method_missing(method, *args)
-        if method.to_s[-1..-1] == "!"
-          method = method.to_s[0..-2].to_sym
+        method_name = method.to_s
+        if method_name[-1..-1] == "!"
+          method = method_name[0..-2].to_sym
         else
-          args = *quoteize(*args)
+          args.quoteize!
         end
 
-        self << [ apachify(method), *args ].compact * ' '
+        self << [ method.apachify, *args ].compact * ' '
       end
 
       # Handle creating block methods
@@ -156,7 +147,7 @@ module Apache
         methods.each do |method|
           self.class.class_eval <<-EOT
             def #{method}(*name, &block)
-              blockify(apachify("#{method}"), name, &block)
+              blockify("#{method}".apachify, name, &block)
             end
           EOT
         end
@@ -167,25 +158,25 @@ module Apache
       # The provided module name is converted into Apache module name format:
       #  if_module(:php5) do #=> <IfModule mod_php5>
       def if_module(mod, &block)
-        blockify(apachify('if_module'), "#{mod}_module".to_sym, &block)
+        blockify('if_module'.apachify, "#{mod}_module".to_sym, &block)
       end
 
       # Create a directory block, checking to see if the source directory exists.
       def directory(dir, &block)
         directory? dir
-        blockify(apachify('directory'), dir, &block)
+        blockify('directory'.apachify, dir, &block)
       end
 
       # Create a LocationMatch block with the provided Regexp:
       #  location_match %r{^/my/location/[a-z0-9]+\.html} do #=> <LocationMatch "^/my/location/[a-z0-9]+\.html">
       def location_match(regexp, &block)
-        blockify(apachify('location_match'), regexp.source, &block)
+        blockify('location_match'.apachify, regexp.source, &block)
       end
 
       # Create a FilesMatch block with the provied Regexp:
       #  files_match %r{\.html$} do #=> FilesMatch "\.html$">
       def files_match(regexp, &block)
-        blockify(apachify('files_match'), regexp.source, &block)
+        blockify('files_match'.apachify, regexp.source, &block)
       end
 
       # Only execute the provided block if APACHE_ENV matches one of the provided enviroment symbols:
@@ -194,31 +185,16 @@ module Apache
         self.instance_eval(&block) if env.include?(APACHE_ENV)
       end
 
-      # Blockify the second parameter of a block
-      #
-      # The name is processed differently based on input object type:
-      # * String - the name is quoteized
-      # * Array - all of the array members are quoteized
-      # * Symbol - the name is to_s
-      def blockify_name(name)
-        case name
-          when String
-            quoteize(name).first
-          when Array
-            (quoteize(*name) * " ")
-          when Symbol
-            name.to_s
-        end
-      end
-
       # Handle the blockification of a provided block
       def blockify(tag_name, name, &block)
-        self << ""
-        self << "<#{[ tag_name, blockify_name(name) ].compact * ' '}>"
+        self + [ '', "<#{[ tag_name, name.blockify ].compact * ' '}>" ]
         @line_indent += 1
         self.instance_eval(&block)
         @line_indent -= 1
-        self << "</#{tag_name}>"
+        self + [ "</#{tag_name}>", '' ]
+      end
+
+      def blank_line!
         self << ""
       end
 

data/lib/apache/directory.rb

@@ -6,7 +6,7 @@ module Apache
     # The options passed into this method are Apachified:
     #  options :exec_cgi, :follow_sym_links #=> Options ExecCGI FollowSymLinks
     def options(*opt)
-      create_options_list('Options', *opt)
+      create_options_list('options'.apachify, *opt)
     end
 
     # Create an IndexOptions directive
@@ -14,25 +14,12 @@ module Apache
     # The options passed into this method are Apachified:
     #  index_options :fancy_indexing, :suppress_description #=> IndexOptions FancyIndexing SuppressDescription
     def index_options(*opt)
-      create_options_list('IndexOptions', *opt)
+      create_options_list('index_options'.apachify, *opt)
     end
 
     private
       def create_options_list(tag, *opt)
-        opt = opt.collect do |o|
-          case o
-            when Symbol
-              if o.to_s[0..3] == 'not_'
-                "-#{apachify(o.to_s[4..-1])}"
-              else
-                apachify(o)
-              end
-            else
-              apachify(o)
-          end
-        end
-
-        self << "#{tag} #{opt * " "}"
+        self << "#{tag} #{opt.collect(&:optionify) * " "}"
       end
   end
 end

data/lib/apache/logging.rb

@@ -19,11 +19,16 @@ module Apache
     [ :custom, :error, :script, :rewrite ].each do |type|
       class_eval <<-EOT
         def #{type}_log(*opts)
-          handle_log '#{type.to_s.capitalize}Log', opts.first, quoteize(opts.first), opts[1..-1]
+          handle_log :tag => '#{type.to_s.capitalize}Log',
+                     :path => opts.first,
+                     :additional_options => opts[1..-1]
         end
 
         def rotate_#{type}_log(*opts)
-          handle_log '#{type.to_s.capitalize}Log', opts.first, quoteize(rotatelogs(*opts[0..1])), opts[2..-1]
+          handle_log :tag => '#{type.to_s.capitalize}Log',
+                     :path => opts.first,
+                     :real_path => rotatelogs(*opts[0..1]),
+                     :additional_options => opts[2..-1]
         end
       EOT
     end
@@ -37,9 +42,12 @@ module Apache
     end
 
     private
-      def handle_log(tag, path, real_path, *opts)
-        writable? path
-        self << "#{tag} #{[real_path, opts].flatten * " "}"
+      def handle_log(info)
+        writable? (path = info[:path])
+
+        real_path = (info[:real_path] || path).quoteize
+
+        self << "#{info[:tag]} #{[real_path, info[:additional_options]].flatten * " "}"
       end
   end
 end

data/lib/apache/master.rb

@@ -8,8 +8,14 @@ module Apache
       @config += Modules.build(*modules, &block)
     end
 
+    # Listen on network interfaces and ports
+    #
+    # Each provided parameter generates a new Listen line:
+    #  listen "1.2.3.4:80", "2.3.4.5:80" #=>
+    #    Listen "1.2.3.4:80"
+    #    Listen "2.3.4.5:80"
     def listen(*opt)
-      opt.each { |o| self << "Listen #{quoteize(o)}" }
+      opt.each { |adapter| self << "Listen #{adapter.quoteize}" }
     end
     alias :listen! :listen
 
@@ -17,9 +23,9 @@ module Apache
     #  runner('www', 'www-data') #=>
     #    User www
     #    Group www-data
-    def runner(user, group = nil)
+    def runner(user, group)
       user! user
-      group! group if group
+      group! group
     end
 
     # Enable Passenger on this server
@@ -42,27 +48,19 @@ module Apache
     end
 
     # Set the TCP timeout. Defined here to get around various other timeout methods.
-    def timeout(t)
-      self << "Timeout #{t}"
+    def timeout(time)
+      self << "Timeout #{time}"
     end
 
     # Add a comment to the Apache config. Can pass in either a String or Array of comment lines.
-    def comment(c)
-      out = [ '' ]
-      case c
-        when String
-          out += c.split("\n")
-        when Array
-          out += c
-      end
-      out << ''
-      self + out.collect { |line| "# #{line.strip}".strip }
+    def comment(what)
+      self + [ '', what.commentize, '' ].flatten.collect { |line| "# #{line.strip}".strip }
     end
 
     # Create a ScriptAlias, checking to make sure the filesystem path exists.
     def script_alias(uri, path)
       directory? path
-      self << %{ScriptAlias #{quoteize(uri, path) * ' '}}
+      self << %{ScriptAlias #{[ uri, path ].quoteize * ' '}}
     end
 
     alias :script_alias! :script_alias
@@ -86,7 +84,7 @@ module Apache
     # Alias a URL to a directory in the filesystem.
     # Used to get around reserved Ruby keyword.
     def apache_alias(*opts)
-      self << "Alias #{quoteize(*opts) * " "}"
+      self << "Alias #{opts.quoteize * " "}"
     end
 
     # Set multiple headers to be delivered for a particular section
@@ -96,27 +94,21 @@ module Apache
     #  Header set "Content-dispoaition" "attachment" env=only-for-downloads
     def set_header(hash)
       hash.each do |key, value|
-        output = "Header set #{quoteize(key)}"
-        case value
-          when String, Symbol
-            output += " #{quoteize(value)}"
-          when Array
-            output += " #{quoteize(value.first)} #{value.last}"
-        end
-        self << output
+        self << "Header set #{key.quoteize} #{value.headerize}"
       end
     end
 
     def server_name(*opts)
       if first = opts.shift
-        self << "ServerName #{quoteize(first)}"
-        opts.each { |o| server_alias o } if !opts.empty?
+        self << "ServerName #{first.quoteize}"
+        opts.each { |name| server_alias name } if !opts.empty?
       end
     end
 
     def document_root(*opts)
-      directory? opts.first
-      self << "DocumentRoot #{quoteize(opts.first)}"
+      dir = opts.first
+      directory? dir
+      self << "DocumentRoot #{dir.quoteize}"
     end
     alias :document_root! :document_root
   end

data/lib/apache/modules.rb

@@ -1,11 +1,7 @@
-require 'apache/quoteize'
-
 module Apache
   # Create lists of modules to load in the Apache 2.2 style (with LoadModule only)
   class Modules
     class << self
-      include Apache::Quoteize
-
       attr_accessor :modules
 
       # Reset the list of modules to output
@@ -27,7 +23,7 @@ module Apache
       def build(*modules, &block)
         reset!
 
-        modules.each { |m| self.send(m) }
+        modules.each { |mod| self.send(mod) }
         self.instance_eval(&block) if block
 
         [ '' ] + @modules + [ '' ]
@@ -37,7 +33,7 @@ module Apache
       def method_missing(method, *args)
         module_name = "#{method}_module"
         module_path = args[0] || "modules/mod_#{method}.so"
-        @modules << [ 'LoadModule', *quoteize(module_name, module_path) ] * " "
+        @modules << [ 'LoadModule', *[ module_name, module_path ].quoteize ] * " "
       end
     end
   end

data/lib/apache/permissions.rb

@@ -21,7 +21,7 @@ module Apache
     #
     #  allow_from '127.0.0.1' #=> Allow from "127.0.0.1"
     def allow_from(*where)
-      self << "Allow from #{quoteize(*where) * " "}"
+      self << "Allow from #{where.quoteize * " "}"
     end
 
     # Specify default access order
@@ -58,26 +58,18 @@ module Apache
     #  basic_authentication "My other secret", '/my.users', :user => [ :john ]
     def basic_authentication(zone, users_file, requires = {})
       exist? users_file
-      auth_type :basic
-      auth_name zone
+      authentication_basics(zone, requires)
       auth_user_file users_file
-      requires.each do |type, values|
-        apache_require type, *values
-      end
     end
 
     alias :basic_authentication! :basic_authentication
 
     # Set up LDAP authentication
     def ldap_authentication(zone, url, requires = {})
-      auth_type :basic
-      auth_name zone
+      authentication_basics(zone, requires)
       auth_basic_provider :ldap
       authz_ldap_authoritative :on
       auth_ldap_url url
-      requires.each do |type, values|
-        apache_require type, *values
-      end
     end
 
     alias :ldap_authentication! :ldap_authentication
@@ -87,5 +79,14 @@ module Apache
     def apache_require(*opts)
       self << "Require #{opts.compact * " "}"
     end
+
+    private
+      def authentication_basics(zone, requires)
+        auth_type :basic
+        auth_name zone
+        requires.each do |type, values|
+          apache_require type, *values
+        end
+      end
   end
 end

data/lib/apache/rewrites.rb

@@ -9,7 +9,7 @@ module Apache
     #    RewriteEngine on
     #    RewriteLogLevel 1
     def enable_rewrite_engine(options = {})
-      self << ''
+      blank_line!
       rewrite_engine! :on
       options.each do |option, value|
         case option
@@ -17,7 +17,7 @@ module Apache
             rewrite_log_level! value
         end
       end
-      self << ''
+      blank_line!
     end
 
     # Pass the block to RewriteManager.build
@@ -27,17 +27,19 @@ module Apache
     end
 
     def rewrite(*opt, &block)
-      raise "You probably want rewrites #{quoteize(*opt) * " "} do" if block
+      raise "You probably want rewrites #{opt.quoteize * " "} do" if block
     end
 
     # Create a permanent Redirect
     #
     #  r301 '/here', '/there' #=> Redirect permanent "/here" "/there"
     def r301(*opt)
-      if opt.first && !opt.first.kind_of?(::String)
-        raise "First parameter should be a String. Did you mean to wrap this in a rewrites block? #{opt.first}"
+      if first = opt.first
+        if !first.kind_of?(::String)
+          raise "First parameter should be a String. Did you mean to wrap this in a rewrites block? #{first}"
+        end
       end
-      self << "Redirect permanent #{quoteize(*opt) * " "}"
+      self << "Redirect permanent #{opt.quoteize * " "}"
     end
   end
 
@@ -49,30 +51,34 @@ module Apache
       # Reset the current list of rewrites
       def reset!
         @rewrites = []
+        @any_tests = false
+        @needs_tests = false
       end
 
       # Build rewritable things from the provided block
       def build(*opt, &block)
         reset!
 
-        @any_tests = false
-        @needs_tests = false
         self.instance_eval(&block)
 
-        name = opt.first || (@rewrites.empty? ? 'unnamed block' : "#{@rewrites.first.from} => #{@rewrites.first.to}")
+        name = block_name(opt.first)
 
-        if !@any_tests && !@rewrites.empty?
-          puts "  [#{"rewrite".foreground(:blue)}] no tests found for #{name}"
-        end
+        show_messages! name
 
-        if @needs_tests
-          puts "  [#{"rewrite".foreground(:blue)}] #{name} needs more tests"
-        end
+        [ "# #{name}", @rewrites.collect(&:to_a) ].flatten
+      end
 
-        output = @rewrites.collect(&:to_a).flatten
-        output.unshift("# #{name}") if opt.first
+      def block_name(first)
+        first_rewrite = @rewrites.first
 
-        output
+        first || (@rewrites.empty? ? 'unnamed block' : "#{first_rewrite.from} => #{first_rewrite.to}")
+      end
+
+      def show_messages!(name)
+        blue = "rewrite".foreground(:blue)
+
+        puts "  [#{blue}] no tests found for #{name}" if !@any_tests && !@rewrites.empty?
+        puts "  [#{blue}] #{name} needs more tests" if @needs_tests
       end
 
       # Commit the latest rewritable thing to the list of rewrites
@@ -122,19 +128,18 @@ module Apache
       def rewrite_test(from, to, opts = {})
         @any_tests = true
         orig_from = from.dup
-        @rewrites.each do |r|
-          pre_from = from.dup
-          if r.match?(from, opts)
-            from = r.test(from, opts)
-            from = pre_from if (r.to == '-')
-            from = :http_forbidden if (r.forbidden?)
-            break if r.stop_if_match?
+        @rewrites.each do |rewrite|
+          if rewrite.match?(from, opts)
+            from = rewrite.from_tester(from, opts)
+            break if rewrite.stop_if_match?
           end
         end
 
         if from != to
-          puts "  [#{"rewrite".foreground(:blue)}] #{orig_from} >> #{to} failed!"
-          puts "  [#{"rewrite".foreground(:blue)}] Result: #{from}"
+          [ "#{orig_from} >> #{to} failed!", "Result: #{from}"
+          ].each do |line|
+            puts "  [#{"rewrite".foreground(:blue)}] #{line}"
+          end
         end
       end
 
@@ -170,30 +175,16 @@ module Apache
   module RegularExpressionMatcher
     # Test this rewritable thing
     def test(from, opts = {})
-      from = from.gsub(@from, @to.gsub(/\$([0-9])/) { |match| '\\' + $1 })
-      replace_placeholders(from, opts)
+      from.gsub(@from, @to.gsub(/\$([0-9])/) { |match| '\\' + $1 }).replace_placeholderize(opts)
     end
 
     def match?(from, opts = {})
-      replace_placeholders(from, opts)[@from]
-    end
-
-    # Replace the placeholders in this rewritable thing
-    def replace_placeholders(string, opts)
-      opts.each do |opt, value|
-        case value
-          when String
-            string = string.gsub('%{' + opt.to_s.upcase + '}', value)
-        end
-      end
-      string.gsub(%r{%\{[^\}]+\}}, '')
+      from.replace_placeholderize(opts)[@from]
     end
   end
 
   # A matchable thing to be extended
   class MatchableThing
-    include Apache::Quoteize
-
     attr_reader :from, :to
 
     # The Apache directive tag for this thing
@@ -205,12 +196,14 @@ module Apache
     end
 
     def rule(from, to)
+      raise "from must be a Regexp" if (!from.kind_of?(Regexp) && require_regexp?)
+
       @from = from
       @to = to
     end
 
     def to_s
-      "#{tag} #{[quoteize(@from), quoteize(@to)].compact.flatten * " "}"
+      "#{tag} #{[@from, @to].quoteize.compact.flatten * " "}"
     end
 
     def to_a
@@ -219,6 +212,14 @@ module Apache
 
     def stop_if_match?; false; end
     def forbidden?; false; end
+    def require_regexp?; false; end
+
+    def from_tester(from, opts)
+      from = test(from, opts)
+      from = @from if (@to == '-')
+      from = :http_forbidden if (forbidden?)
+      from
+    end
   end
 
   # A RewriteRule definition
@@ -237,33 +238,23 @@ module Apache
     # Define the rule, passing in additional options
     #
     # rule %r{^/here}, '/there', { :last => true, :preserve_query_string => true }
+    #
+    # Options for the options hash are:
+    # * :last => true #=> [L]
+    # * :forbidden => true #=> [F]
+    # * :no_escape => true #=> [NE]
+    # * :redirect => true #=> [R]
+    # * :redirect => 302 #=> [R=302]
+    # * :pass_through => true #=> [PT]
+    # * :preserve_query_string => true #=> [QSA]
+    # * :query_string_append => true #=> [QSA]
+    # * :env => 'what' #=>  [E=what]
     def rule(from, to, options = {})
       super(from, to)
 
-      raise "from must be a Regexp" if !from.kind_of?(Regexp)
-
       @input_options = options
 
-      options = options.collect do |key, value|
-        case key
-          when :last
-            'L'
-          when :forbidden
-            'F'
-          when :no_escape
-            'NE'
-          when :redirect
-            (value == true) ? 'R' : "R=#{value}"
-          when :pass_through
-            'PT'
-          when :preserve_query_string, :query_string_append
-            'QSA'
-          when :env
-            "E=#{value}"
-        end
-      end.compact.sort
-
-      @options = !options.empty? ? "[#{options * ','}]" : nil
+      @options = options.rewrite_rule_optionify.rewrite_option_listify
     end
 
     # Add a RewriteCondition to this RewriteRule
@@ -274,37 +265,43 @@ module Apache
       @conditions << rewrite_cond
     end
 
+    def initial_blank!
+      @conditions.empty? ? nil : ''
+    end
+
     def to_s
-      "#{tag} #{[quoteize(@from.source), quoteize(@to), @options].compact.flatten * " "}"
+      "#{tag} #{[@from.source.quoteize, @to.quoteize, @options].compact.flatten * " "}"
     end
 
     def to_a
-      [ ('' if !@conditions.empty?), @conditions.collect(&:to_s), super ].flatten
+      [ initial_blank!, @conditions.collect(&:to_s), super ].flatten
     end
 
     # Test this RewriteRule, ensuring the RewriteConds also match
     def test(from, opts = {})
+      ensure_opts!(opts)
       opts[:request_uri] = from
       result = from
 
       result = super(from, opts) if match?(from, opts)
 
-      replace_placeholders(result, opts)
+      result.replace_placeholderize(opts)
+    end
+
+    def ensure_opts!(opts)
+      raise "Options must be a hash" if !opts
+      raise "Options must be a hash" if !opts.kind_of? ::Hash
     end
 
     def match?(from, opts = {})
+      ensure_opts!(opts)
       opts[:request_uri] = from
-      ok = true
 
-      @conditions.each do |c|
-        ok = false if !c.test(from, opts)
+      @conditions.each do |cond|
+        return false if !cond.test(from, opts)
       end
 
-      if ok
-        super(from, opts)
-      else
-        false
-      end
+      super(from, opts)
     end
 
     def stop_if_match?
@@ -314,25 +311,32 @@ module Apache
     def forbidden?
       @input_options[:forbidden]
     end
+
+    def require_regexp?; true; end
   end
 
   # A permanent RedirectMatch
   class RedirectMatchPermanent < MatchableThing
     include RegularExpressionMatcher
 
+    # The Apache directive for this object.
     def tag; 'RedirectMatch permanent'; end
 
+    # Define a RedirectMatch rule.
     def rule(from, to)
       super(from, to)
 
       raise "from must be a Regexp" if !from.kind_of?(Regexp)
     end
 
+    # Convert this tag to a String.
     def to_s
-      "#{tag} #{[quoteize(@from.source), quoteize(@to)].compact.flatten * " "}"
+      "#{tag} #{[@from.source, @to].quoteize.compact.flatten * " "}"
     end
 
+    # Stop rewrite testing if this object matches.
     def stop_if_match; true; end
+    def require_regexp?; true; end
   end
 
   # A RewriteCond
@@ -345,48 +349,47 @@ module Apache
     #
     #  rule "%{REQUEST_FILENAME}", "^/here", :case_insensitive #=>
     #    RewriteCond "%{REQUEST_FILENAME}" "^/here" [NC]
+    #
+    # Additional parameters can include the following:
+    # * :or #=> [OR]
+    # * :case_insensitive #=> [NC]
+    # * :no_vary #=> [NV]
     def rule(from, to, *opts)
       super(from, to)
 
-      options = opts.collect do |opt|
-        case opt
-          when :or
-            'OR'
-          when :case_insensitive
-            'NC'
-          when :no_vary
-            'NV'
-        end
-      end
-
-      @options = (!options.empty?) ? "[#{options * ','}]" : nil
+      @options = opts.rewrite_cond_optionify.rewrite_option_listify
     end
 
     alias :cond :rule
 
+    # Create a new RewriteCond
     def initialize
       super
       @options = nil
     end
 
+    # Convert this tag to a String.
     def to_s
-      "#{tag} #{[quoteize(@from), quoteize(@to), @options].compact.flatten * " "}"
+      "#{tag} #{[@from.quoteize, @to.quoteize, @options].compact.flatten * " "}"
+    end
+
+    def inverse_result?
+      @to[0..0] == '!'
+    end
+
+    def actual_to
+      to = @to
+      to = to[1..-1] if inverse_result?
+      to
     end
 
     # Test this RewriteCond
     def test(from, opts = {})
       super(from, opts)
-      source = replace_placeholders(@from, opts)
+      source = @from.replace_placeholderize(opts)
 
-      to = @to
-      reverse = false
-
-      if @to[0..0] == '!'
-        reverse = true
-        to = @to[1..-1]
-      end
+      to = actual_to
 
-      result = false
       case to
         when '-f'
           result = opts[:files].include?(source) if opts[:files]
@@ -394,7 +397,7 @@ module Apache
           result = source[Regexp.new(to)]
       end
 
-      reverse ? !result : result
+      inverse_result? ? !result : result
     end
   end
 end

data/lib/apache/ssl.rb

@@ -1,18 +1,17 @@
 module Apache
   module SSL
     def enable_ssl_engine(options = {})
-      self << ""
-      self << "SSLEngine on"
+      self + [ '', "SSLEngine on" ]
       options.each do |key, value|
-        value = quoteize(value).first
+        value = value.quoteize
         case key
           when :certificate_file, :certificate_key_file
-            self << "SSL#{apachify(key)} #{value}"
+            self << "SSL#{key.apachify} #{value}"
           when :ca_certificate_file
             self << "SSLCACertificateFile #{value}"
         end
       end
-      self << ""
+      blank_line!
     end
   end
 end

metadata

@@ -5,7 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  version: "0.2"
+  - 2
+  - 1
+  version: 0.2.2.1
 platform: ruby
 authors: 
 - John Bintz
@@ -13,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 -04:00
+date: 2010-05-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,6 +41,7 @@ extra_rdoc_files:
 - README.rdoc
 - bin/apache-configurator
 - lib/apache.rb
+- lib/apache/apachify.rb
 - lib/apache/config.rb
 - lib/apache/directory.rb
 - lib/apache/logging.rb
@@ -47,7 +50,6 @@ extra_rdoc_files:
 - lib/apache/mpm_prefork.rb
 - lib/apache/performance.rb
 - lib/apache/permissions.rb
-- lib/apache/quoteize.rb
 - lib/apache/rake/create.rb
 - lib/apache/rewrites.rb
 - lib/apache/ssl.rb
@@ -55,8 +57,11 @@ files:
 - CHANGELOG
 - README.rdoc
 - Rakefile
+- apache-config-generator.gemspec
 - bin/apache-configurator
+- config/config.reek
 - lib/apache.rb
+- lib/apache/apachify.rb
 - lib/apache/config.rb
 - lib/apache/directory.rb
 - lib/apache/logging.rb
@@ -65,14 +70,12 @@ files:
 - lib/apache/mpm_prefork.rb
 - lib/apache/performance.rb
 - lib/apache/permissions.rb
-- lib/apache/quoteize.rb
 - lib/apache/rake/create.rb
 - lib/apache/rewrites.rb
 - lib/apache/ssl.rb
 - skel/Rakefile
 - skel/config.yml
 - Manifest
-- apache-config-generator.gemspec
 has_rdoc: true
 homepage: ""
 licenses: []

data/lib/apache/quoteize.rb

@@ -1,16 +0,0 @@
-module Apache
-  # Add quotes around parameters as needed
-  module Quoteize
-    # Add quotes around most parameters, and don't add quotes around Symbols
-    def quoteize(*args)
-      args.collect do |arg|
-        case arg
-          when Symbol
-            arg.to_s.gsub('_', ' ')
-          else
-            %{"#{arg}"}
-        end
-      end
-    end
-  end
-end