apache_config 0.1.0

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "apache_config"
+    gemspec.summary = "Apache config parser and printer"
+    gemspec.description = "Parses Apache config files, allowing for changes and then can output again"
+    gemspec.email = "jan@openminds.be"
+    gemspec.homepage = "http://github.com/defv/apache_config"
+    gemspec.authors = ["Jan De Poorter"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

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

data/lib/apache_config/node.rb

@@ -0,0 +1,37 @@
+module Apache
+  class Node
+    attr_accessor :name, :content, :children, :parent
+    
+    def initialize name, content = nil
+      @name, @content = name, content
+    end
+    
+    def [] name
+      r = Array(children).select { |child| child.name == name }
+      case r.size
+      when 0
+        self << Node.new(name)
+      when 1
+        r.first
+      else
+        r
+      end
+    end
+    
+    def << node
+      @children ||= []
+      @children << node
+      node.parent = self
+      
+      node
+    end
+    
+    def isRoot?
+      parent.nil?
+    end
+    
+    def hasChildren?
+      children && children.any?
+    end
+  end
+end

data/lib/apache_config/virtual_host.rb

@@ -0,0 +1,25 @@
+class VirtualHost
+  def initialize(config)
+    @config = config
+  end
+  
+  def domain
+    @config['ServerName'].content
+  end
+  
+  def domain=(dom)
+    @config['ServerName'].content = dom
+  end
+  
+  def aliases
+    Apache::WriteBackArray.new(@config['ServerAlias'], @config['ServerAlias'].content.to_s.split(/\s+/))
+  end
+  
+  def domains
+    [domain] + aliases
+  end
+  
+  def document_root
+    @config['Documentroot'].content
+  end
+end

data/lib/apache_config/write_back_array.rb

@@ -0,0 +1,13 @@
+module Apache
+  class WriteBackArray < Array
+    def initialize(node, elements)
+      super(elements)
+      @node = node
+    end
+    
+    def <<(element)
+      super
+      @node.content = join(' ')
+    end
+  end
+end

data/lib/apache_config.rb

@@ -0,0 +1,65 @@
+module Apache
+  autoload :Node,           'apache_config/node'
+  autoload :VirtualHost,    'apache_config/virtual_host'
+  autoload :WriteBackArray, 'apache_config/write_back_array'
+  
+  class Config
+    TabSize     = "    "
+    Comment     = /^\s*#\s?(.*?)\s*$/
+    Blank       = /^\s+$/
+    Directive   = /^\s*(\w+)(?:\s+(.*?)|)$/
+    SectionOpen = /^\s*<\s*(\w+)(?:\s+([^>]+)|\s*)>$/
+    SectionClose = /^\s*<\/\s*(\w+)\s*>$/
+
+    def initialize(path)
+      @path = path
+      @config = parse_config(path)
+    end
+    
+    def virtual_hosts
+      @config.children.map { |vh| VirtualHost.new(vh) }
+    end
+
+    def to_config(root = nil, indent = "")
+      element = root || @config
+      content = ""
+
+      case
+        when element.isRoot?
+          element.children.map { |c| to_config(c) }.join
+        when element.hasChildren?
+          "#{indent}<#{element.name} #{element.content}>\n" +
+          element.children.map {|c| to_config(c, indent + TabSize) }.join +
+          "#{indent}</#{element.name}>\n"
+        when element.name == :comment
+          "#{indent}# #{element.content}\n"
+        when element.name == :blank
+          "#{indent}\n"
+        else
+          "#{indent}#{element.name} #{element.content}\n"
+        end
+    end
+
+    private
+    def parse_config(path)
+      current_child = Node.new("ROOT")
+
+      File.open(path).read.split(/\n/).each do |line|
+        case line
+        when Comment
+          current_child << Node.new(:comment, $1)
+        when Blank
+          current_child << Node.new(:blank)
+        when Directive
+          current_child << Node.new($1, $2)
+        when SectionOpen
+          current_child = current_child << Node.new($1, $2)
+        when SectionClose
+          current_child = current_child.parent
+        end
+      end
+
+      current_child
+    end
+  end
+end

data/test/apache_config_test.rb

@@ -0,0 +1,45 @@
+require "test/unit"
+require 'rubygems'
+require 'fakefs'
+
+require "apache_config"
+
+class TestApacheConfig < Test::Unit::TestCase
+  Config =<<APACHE
+<VirtualHost *>
+    ServerName example.com
+    ServerAlias www.example.com
+    Documentroot /var/www/default/public
+    Errorlog /var/log/apache2/default.errorlog
+    LogLevel Warn
+    CustomLog /var/log/apache2/default.customlog combined
+    
+    <Directory "/var/www/default/public">
+        Options Indexes Includes FollowSymLinks IncludesNOEXEC
+        AllowOverride AuthConfig FileInfo Indexes Options Limit
+        Order allow,deny
+        Allow from all
+        # Foo
+    </Directory>
+</VirtualHost>
+APACHE
+
+  def setup
+    File.open('/etc/apache2/example.conf', 'w') do |f|
+      f.write Config 
+    end
+  end
+  
+  # Quite the integration test you have here..
+  def test_apache_parsed_config_outputs_the_same
+    config = Apache::Config.new('/etc/apache2/example.conf')
+    assert_equal Config, config.to_config
+  end
+  
+  def test_adding_to_virtual_hosts
+    config = Apache::Config.new('/etc/apache2/example.conf')
+    config.virtual_hosts.first.aliases << 'foo.be'
+    
+    assert_match "ServerAlias www.example.com foo.be", config.to_config
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: apache_config
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jan De Poorter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Parses Apache config files, allowing for changes and then can output again
+email: jan@openminds.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION
+- lib/apache_config.rb
+- lib/apache_config/node.rb
+- lib/apache_config/virtual_host.rb
+- lib/apache_config/write_back_array.rb
+- test/apache_config_test.rb
+has_rdoc: true
+homepage: http://github.com/defv/apache_config
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Apache config parser and printer
+test_files: 
+- test/apache_config_test.rb