apache-config-generator 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.1.2. Some more small fixes.
+
 v0.1.1. Stupid bug in initial release.
 
 v0.1. Initial release, support for many of the Apache config basics.

data/Manifest

@@ -1,6 +1,5 @@
 CHANGELOG
-Manifest
-README.md
+README.rdoc
 Rakefile
 bin/apache-configurator
 lib/apache.rb
@@ -18,3 +17,4 @@ lib/apache/rewrites.rb
 lib/apache/ssl.rb
 skel/Rakefile
 skel/config.yml
+Manifest

data/README.rdoc

@@ -0,0 +1,34 @@
+= Apache Config Generator
+
+Programmatically construct your Apache configuration using a powerful DSL built in Ruby.
+
+== Installation
+
+<tt>gem install apache-config-generator</tt>
+
+== Usage
+
+Run <tt>apache-configurator <directory></tt> to create a new directory to hold your config files.
+A Rakefile and config.yml file will also be generated.
+
+== Building a config file
+
+Configs center around the Apache::Config.build method:
+
+  Apache::Config.build('sites-available/my-site.conf') do
+    server_name 'my-cool-website.cool.wow'
+    document_root '/var/www/my-cool-website'
+
+    directory '/' do
+      options :follow_sym_links, :indexes
+      allow_from_all
+    end
+
+    location_match %r{^/secret} do
+      deny_from_all
+
+      basic_authentication "My secret", '/etc/apache2/users/global.users', :user => :john
+      satisfy :any
+    end
+  end
+

data/Rakefile

@@ -20,6 +20,7 @@ Echoe.new('apache-config-generator') do |p|
   p.summary = "A Ruby DSL for programmatically generating Apache configs"
   p.ignore_pattern = [ 'spec/**/*', 'test/**/*', 'docs/**/*' ]
   p.executable_pattern = [ 'bin/**/*' ]
+  p.runtime_dependencies = [ 'rainbow' ]
 end
 
 namespace :spec do
@@ -34,6 +35,7 @@ end
 
 Rake::RDocTask.new do |rdoc|
   rdoc.template = 'direct'
-  rdoc.rdoc_files.add('lib')
+  rdoc.rdoc_files.add('lib', 'README.rdoc')
+  rdoc.main = 'README.rdoc'
   rdoc.rdoc_dir = 'docs'
 end

data/apache-config-generator.gemspec

@@ -2,19 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apache-config-generator}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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-10}
+  s.date = %q{2010-05-12}
   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.md", "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", "Manifest", "README.md", "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", "apache-config-generator.gemspec"]
+  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.homepage = %q{}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Apache-config-generator", "--main", "README.md"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Apache-config-generator", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{apache-config-generator}
   s.rubygems_version = %q{1.3.6}
@@ -25,8 +25,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rainbow>, [">= 0"])
     else
+      s.add_dependency(%q<rainbow>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rainbow>, [">= 0"])
   end
 end

data/lib/apache/config.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'rainbow'
 
 Dir[File.join(File.dirname(__FILE__), '*.rb')].each { |f| require f }
 
@@ -62,6 +63,7 @@ module Apache
       include Apache::Performance
       include Apache::Rewrites
       include Apache::MPM
+      include Apache::SSL
 
       # Build the provided configuration only if the current environment matches one of the conditions
       def build_if(target, *conditions, &block)
@@ -123,7 +125,9 @@ module Apache
       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')
+            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
@@ -229,17 +233,21 @@ module Apache
         "|#{@rotate_logs_path} #{path} #{time}"
       end
 
+      def warn_msg(from, color = :red)
+        "[warn::#{from}]".foreground(color)
+      end
+
       private
         def writable?(path)
-          puts "[warn] #{path} may not be writable!" if !File.directory? File.split(path).first
+          puts "  #{warn_msg('writable?')} #{path.foreground(:yellow)} may not be writable!" if !File.directory? File.split(path).first
         end
 
         def directory?(path)
-          puts "[warn] #{path} does not exist!" if !File.directory? path
+          puts "  #{warn_msg('directory?')} #{path.foreground(:yellow)} does not exist!" if !File.directory? path
         end
 
         def exist?(path)
-          puts "[warn] #{path} does not exist!" if !File.exist?(path)
+          puts "  #{warn_msg('exist?')} #{path.foreground(:yellow)} does not exist!" if !File.exist?(path)
         end
     end
 

data/lib/apache/directory.rb

@@ -19,7 +19,20 @@ module Apache
 
     private
       def create_options_list(tag, *opt)
-        self << "#{tag} #{apachify(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 * " "}"
       end
   end
 end

data/lib/apache/master.rb

@@ -8,6 +8,11 @@ module Apache
       @config += Modules.build(*modules, &block)
     end
 
+    def listen(*opt)
+      opt.each { |o| self << "Listen #{quoteize(o)}" }
+    end
+    alias :listen! :listen
+
     # Add a User/Group block
     #  runner('www', 'www-data') #=>
     #    User www
@@ -101,5 +106,12 @@ module Apache
         self << output
       end
     end
+
+    def server_name(*opts)
+      if first = opts.shift
+        self << "ServerName #{quoteize(first)}"
+        opts.each { |o| server_alias o } if !opts.empty?
+      end
+    end
   end
 end

data/lib/apache/permissions.rb

@@ -85,7 +85,7 @@ module Apache
     # Create an Apache require directive.
     # Used to get around Ruby reserved word.
     def apache_require(*opts)
-      self << "Require #{opts * " "}"
+      self << "Require #{opts.compact * " "}"
     end
   end
 end

data/lib/apache/rake/create.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'apache/config'
 require 'apache/rake/create'
 require 'yaml'
+require 'rainbow'
 
 namespace :apache do
   desc "Create all defined configs for the specified environment"
@@ -19,7 +20,7 @@ namespace :apache do
     Dir.chdir CONFIG[:dest_path]
 
     Dir[File.join(CONFIG[:source_path], '**', '*.rb')].each do |file|
-      puts file
+      puts file.foreground(:green)
       require file
     end
   end

data/lib/apache/rewrites.rb

@@ -1,3 +1,5 @@
+require 'pp'
+
 module Apache
   # Handle the creation of RewriteRules, RewriteConds, Redirects, and RedirectMatches
   module Rewrites
@@ -6,7 +8,7 @@ module Apache
     #  enable_rewrite_engine :log_level => 1 #=>
     #    RewriteEngine on
     #    RewriteLogLevel 1
-    def enable_rewrite_engine(options)
+    def enable_rewrite_engine(options = {})
       self << ''
       rewrite_engine! :on
       options.each do |option, value|
@@ -19,15 +21,22 @@ module Apache
     end
 
     # Pass the block to RewriteManager.build
-    def rewrites(&block)
-      self + indent(RewriteManager.build(&block))
+    def rewrites(*opt, &block)
+      self + indent(RewriteManager.build(*opt, &block))
       self << ''
     end
 
+    def rewrite(*opt, &block)
+      raise "You probably want rewrites #{quoteize(*opt) * " "} 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}"
+      end
       self << "Redirect permanent #{quoteize(*opt) * " "}"
     end
   end
@@ -43,12 +52,27 @@ module Apache
       end
 
       # Build rewritable things from the provided block
-      def build(&block)
+      def build(*opt, &block)
         reset!
 
+        @any_tests = false
+        @needs_tests = false
         self.instance_eval(&block)
 
-        @rewrites.collect(&:to_a).flatten
+        name = opt.first || (@rewrites.empty? ? 'unnamed block' : "#{@rewrites.first.from} => #{@rewrites.first.to}")
+
+        if !@any_tests && !@rewrites.empty?
+          puts "  [#{"rewrite".foreground(:blue)}] no tests found for #{name}"
+        end
+
+        if @needs_tests
+          puts "  [#{"rewrite".foreground(:blue)}] #{name} needs more tests"
+        end
+
+        output = @rewrites.collect(&:to_a).flatten
+        output.unshift("# #{name}") if opt.first
+
+        output
       end
 
       # Commit the latest rewritable thing to the list of rewrites
@@ -96,16 +120,49 @@ module Apache
 
       # Test the rewritable things defined in this block
       def rewrite_test(from, to, opts = {})
+        @any_tests = true
         orig_from = from.dup
         @rewrites.each do |r|
-          from = r.test(from, opts)
+          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?
+          end
         end
 
         if from != to
-          puts "[warn] #{orig_from} >> #{to} failed!"
-          puts "[warn] Result: #{from}"
+          puts "  [#{"rewrite".foreground(:blue)}] #{orig_from} >> #{to} failed!"
+          puts "  [#{"rewrite".foreground(:blue)}] Result: #{from}"
         end
       end
+
+      def needs_tests
+        @needs_tests = true
+      end
+
+      def cond_not_a_file(opts = {})
+        cond_file_flag '!-f', opts
+      end
+
+      def cond_is_a_file(opts = {})
+        cond_file_flag '-f', opts
+      end
+
+      def cond_not_a_directory(opts = {})
+        cond_file_flag '!-d', opts
+      end
+
+      def cond_is_a_directory(opts = {})
+        cond_file_flag '-d', opts
+      end
+
+      private
+        def cond_file_flag(flag, opts)
+          cond opts[:filename_only] ? "%{REQUEST_FILENAME}" : "%{DOCUMENT_ROOT}%{REQUEST_FILENAME}", flag
+        end
+
     end
   end
 
@@ -117,6 +174,10 @@ module Apache
       replace_placeholders(from, opts)
     end
 
+    def match?(from, opts = {})
+      replace_placeholders(from, opts)[@from]
+    end
+
     # Replace the placeholders in this rewritable thing
     def replace_placeholders(s, opts)
       opts.each do |opt, value|
@@ -125,7 +186,7 @@ module Apache
             s = s.gsub('%{' + opt.to_s.upcase + '}', value)
         end
       end
-      s
+      s.gsub(%r{%\{[^\}]+\}}, '')
     end
   end
 
@@ -133,6 +194,8 @@ module Apache
   class MatchableThing
     include Apache::Quoteize
 
+    attr_reader :from, :to
+
     # The Apache directive tag for this thing
     def tag; raise 'Override this method'; end
 
@@ -153,6 +216,9 @@ module Apache
     def to_a
       [ to_s ]
     end
+
+    def stop_if_match?; false; end
+    def forbidden?; false; end
   end
 
   # A RewriteRule definition
@@ -165,24 +231,37 @@ module Apache
       super
       @conditions = []
       @options = nil
+      @input_options = {}
     end
 
     # Define the rule, passing in additional options
     #
     # rule %r{^/here}, '/there', { :last => true, :preserve_query_string => true }
-    def rule(from, to,options = {})
+    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 :preserve_query_string
+          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.sort
+      end.compact.sort
 
       @options = !options.empty? ? "[#{options * ','}]" : nil
     end
@@ -200,12 +279,23 @@ module Apache
     end
 
     def to_a
-      [ @conditions.collect(&:to_s), super ].flatten
+      [ ('' if !@conditions.empty?), @conditions.collect(&:to_s), super ].flatten
     end
 
     # Test this RewriteRule, ensuring the RewriteConds also match
     def test(from, opts = {})
+      opts[:request_uri] = from
+      result = from
+
+      result = super(from, opts) if match?(from, opts)
+
+      replace_placeholders(result, opts)
+    end
+
+    def match?(from, opts = {})
+      opts[:request_uri] = from
       ok = true
+
       @conditions.each do |c|
         ok = false if !c.test(from, opts)
       end
@@ -213,9 +303,17 @@ module Apache
       if ok
         super(from, opts)
       else
-        replace_placeholders(from, opts)
+        false
       end
     end
+
+    def stop_if_match?
+      @input_options[:last]
+    end
+
+    def forbidden?
+      @input_options[:forbidden]
+    end
   end
 
   # A permanent RedirectMatch
@@ -233,6 +331,8 @@ module Apache
     def to_s
       "#{tag} #{[quoteize(@from.source), quoteize(@to)].compact.flatten * " "}"
     end
+
+    def stop_if_match; true; end
   end
 
   # A RewriteCond
@@ -278,20 +378,26 @@ module Apache
       super(from, opts)
       source = replace_placeholders(@from, opts)
 
+      to = @to
+      reverse = false
+
+      if @to[0..0] == '!'
+        reverse = true
+        to = @to[1..-1]
+      end
+
       result = false
-      case @to[0..0]
-        when '!'
-          result = !source[Regexp.new(@to[1..-1])]
+      case to[0..0]
         when '-'
-          case @to
+          case to
             when '-f'
               result = opts[:files].include? source if opts[:files]
           end
         else
-          result = source[Regexp.new(@to)]
+          result = source[Regexp.new(to)]
       end
 
-      result
+      reverse ? !result : result
     end
   end
 end

data/lib/apache/ssl.rb

@@ -0,0 +1,17 @@
+module Apache
+  module SSL
+    def enable_ssl_engine(options = {})
+      self << ""
+      self << "SSLEngine on"
+      options.each do |k, v|
+        case k
+          when :certificate_file, :certificate_key_file
+            self << "SSL#{apachify(k)} #{quoteize(v).first}"
+          when :ca_certificate_file
+            self << "SSLCACertificateFile #{quoteize(v).first}"
+        end
+      end
+      self << ""
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - John Bintz
@@ -14,10 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-10 00:00:00 -04:00
+date: 2010-05-12 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: A Ruby DSL for programmatically generating Apache configs
 email: ""
 executables: 
@@ -26,7 +37,7 @@ extensions: []
 
 extra_rdoc_files: 
 - CHANGELOG
-- README.md
+- README.rdoc
 - bin/apache-configurator
 - lib/apache.rb
 - lib/apache/config.rb
@@ -43,8 +54,7 @@ extra_rdoc_files:
 - lib/apache/ssl.rb
 files: 
 - CHANGELOG
-- Manifest
-- README.md
+- README.rdoc
 - Rakefile
 - bin/apache-configurator
 - lib/apache.rb
@@ -62,6 +72,7 @@ files:
 - lib/apache/ssl.rb
 - skel/Rakefile
 - skel/config.yml
+- Manifest
 - apache-config-generator.gemspec
 has_rdoc: true
 homepage: ""
@@ -74,7 +85,7 @@ rdoc_options:
 - --title
 - Apache-config-generator
 - --main
-- README.md
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/README.md

@@ -1,33 +0,0 @@
-# Apache Config Generator
-
-Programmatically construct your Apache configuration using a powerful DSL built in Ruby.
-
-## Installation
-
-`gem install apache-config-generator`
-
-## Usage
-
-Run `apache-configurator <directory>` to create a new directory to hold your config files.
-A Rakefile and config.yml file will also be generated.
-
-## Building a config file
-
-Configs center around the Apache::Config.build method:
-
-		Apache::Config.build('sites-available/my-site.conf') do
-			server_name 'my-cool-website.cool.wow'
-			document_root '/var/www/my-cool-website'
-
-			directory '/' do
-				options :follow_sym_links, :indexes
-				allow_from_all
-			end
-
-			location_match %r{^/secret} do
-				deny_from_all
-
-				basic_authentication "My secret", '/etc/apache2/users/global.users', :user => :john
-				satisfy :any
-			end
-		end