tomahawk 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-1.7.9
+  - rbx-2.1.1
+  - 2.1.0

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/Sophisticates/Tomahawk.png?branch=master)](https://travis-ci.org/Sophisticates/Tomahawk)
+[![Code Climate](https://codeclimate.com/github/Sophisticates/Tomahawk.png)](https://codeclimate.com/github/Sophisticates/Tomahawk)
 # Tomahawk
 
 Tomahawk helps generating and parsing Apache 2 configuration files. You can for example parse VirtualHost configs, CRUD some directives in your Ruby code and generate a new config file out of it afterwards.
@@ -19,19 +21,87 @@ Or install it yourself as:
     $ gem install tomahawk
 
 ## Usage
-    require 'tomahawk'
 
-    httpd_config = Tomahawk.parse File.read('/etc/apache2/apache.conf')
+The following builds a new Apache Config
 
-    httpd_config.directives # lists parsed directives such as ServerName and LogLevel
+```ruby
+require 'tomahawk'
 
-    httpd_config.groups # lists parsed directive groups such as <VirtualHost> and <Directory>
+# initalize
+config = Tomahawk::Config.new do |directives, groups|
+  directives[:timeout] = '300'
+  directives[:max_keep_alive_requests] = '100'
+end
 
-    httpd_config.directives['server_name'] = 'google.com' # change a directive
+# ...
 
-    httpd_config.directives['some_new_directive'] = 'foo' # create a new directive
+httpd_config.directives[:keep_alive] = 'On' # change a directive
+
+config.to_s # => 
+    # Timeout 300
+    # MaxKeepAliveRequests 100
+    # KeepAlive On
+
+```
+
+Nested directive groups can be added as well
+
+```ruby
+require 'tomahawk'
+
+config = Tomahawk::Config.new do |directives, groups|
+    directives[:timeout] = '300'
+    directives[:max_keep_alive_requests] = '100'
+
+    groups << Tomahawk::DirectiveGroups::VirtualHost.new('*:80') do |directives, groups|
+        directives[:server_name] = 'example.com'
+        directives[:document_root] = '/var/www/example.com'
+    end
+end
+
+# ...
+
+config.groups.first.groups << Tomahawk::DirectiveGroups::Directory.new('/var/www/example.com') do |directives, groups|
+    directives[:options] = '-Indexes FollowSymLinks MultiViews'
+end
+
+config.to_s # => 
+    # Timeout 300
+    # MaxKeepAliveRequests 100
+    #
+    # <VirtualHost *:80> 
+    #  ServerName example.com
+    #  DocumentRoot /var/www/example.com
+    #
+    # <Directory /var/www/example.com> 
+    #  Options -Indexes FollowSymLinks MultiViews
+    # </Directory>
+    # 
+    # </VirtualHost>
+```
+
+Only two types of directive groups are currently implemented: `VirtualHost` and `Directory`. More groups are possible of course, just open a new issue :)
+
+### Parsing
+
+Tomahawk can also parse existing configs
+
+```ruby
+require 'tomahawk'
+
+config = Tomahawk.parse File.read('/etc/apache2/apache.conf')
+
+config.directives # lists parsed directives such as ServerName and LogLevel
+
+config.groups # lists parsed directive groups such as <VirtualHost> and <Directory>
+
+config.directives['server_name'] = 'google.com' # change a directive
+
+config.directives['some_new_directive'] = 'foo' # create a new directive
+
+File.write('/etc/apache2/apache.conf.new', httpd_config.to_s) # write your new configuration back to disk
+```
 
-    File.write('/etc/apache2/apache.conf.new', httpd_config.to_conf) # write your new configuration back to disk
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tomahawk/config.rb

@@ -0,0 +1,4 @@
+module Tomahawk
+  class Config < DirectiveGroups::HTTPd
+  end
+end

data/lib/tomahawk/directive_groups/base.rb

@@ -3,16 +3,21 @@ module Tomahawk
     class Base
       attr_accessor :parameters, :directives, :groups
 
-      def initialize(parameters = '', directives = {})
+      def initialize(parameters = '', directives = {}, groups = [])
+        yield(directives, groups) if block_given?
         @parameters = parameters
         @directives = Hash[directives]
-        @groups = []
+        @groups = Array(groups)
       end
 
-      def to_conf()
+      def to_str
         raise "#{self.class.name} doesn't support #conf!"
       end
 
+      def to_s
+        to_str
+      end
+
       def ==(obj)
         self.class == self.class && self.parameters == obj.parameters && self.directives == obj.directives && self.groups == obj.groups
       rescue

data/lib/tomahawk/directive_groups/directory.rb

@@ -1,8 +1,8 @@
 module Tomahawk
   module DirectiveGroups
     class Directory < Base
-      def to_conf(generator = Tomahawk::Generators::Directory)
-        generator.new(self)
+      def to_str(generator = Tomahawk::Generators::Directory)
+        generator.new(self).to_s
       end
     end
   end

data/lib/tomahawk/directive_groups/httpd.rb

@@ -1,8 +1,8 @@
 module Tomahawk
   module DirectiveGroups
     class HTTPd < Base
-      def to_conf(generator = Tomahawk::Generators::HTTPd)
-        generator.new(self)
+      def to_str(generator = Tomahawk::Generators::HTTPd)
+        generator.new(self).to_s
       end
     end
   end

data/lib/tomahawk/directive_groups/virtual_host.rb

@@ -1,8 +1,8 @@
 module Tomahawk
   module DirectiveGroups
     class VirtualHost < Base
-      def to_conf(generator = Generators::VirtualHost)
-        generator.new(self)
+      def to_str(generator = Generators::VirtualHost)
+        generator.new(self).to_s
       end
     end
   end

data/lib/tomahawk/directive_groups.rb

@@ -10,7 +10,7 @@ module Tomahawk
     def DirectiveGroup(directive_group_name)
       directive_group_name = String(directive_group_name)
 
-      Kernel.const_get('Tomahawk::DirectiveGroups::%s' % [directive_group_name])
+      Tomahawk::DirectiveGroups.const_get(directive_group_name)
     end
   end
 end

data/lib/tomahawk/generators/base.rb

@@ -15,7 +15,7 @@ module Tomahawk
         end
 
         @directive_group.groups.each do |group|
-          config += group.to_conf
+          config += group.to_s
         end
 
         config += "\n</#{directive_group_name}>\n"

data/lib/tomahawk/generators/httpd.rb

@@ -14,7 +14,7 @@ module Tomahawk
         end
 
         @httpd.groups.each do |group|
-          config += group.to_conf
+          config += group.to_s
         end
 
         config

data/lib/tomahawk/version.rb

@@ -1,3 +1,3 @@
 module Tomahawk
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tomahawk.rb

@@ -2,6 +2,7 @@ require "tomahawk/version"
 require "tomahawk/directive_groups"
 require "tomahawk/generators"
 require "tomahawk/config_parser"
+require "tomahawk/config"
 
 module Tomahawk
   extend self

data/spec/lib/tomahawk/config_parser_spec.rb

@@ -15,7 +15,7 @@ describe Tomahawk::ConfigParser do
     httpd.groups << google_com
     httpd.groups << github_com
 
-    config = Tomahawk::ConfigParser.new(httpd.to_conf.to_s)
+    config = Tomahawk::ConfigParser.new(httpd.to_s)
 
 
     config.call

data/spec/lib/tomahawk/config_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Tomahawk::Config do
+  it 'is in fact just a DirectiveGroups::HTTPd' do
+    Tomahawk::Config.is_a?(Tomahawk::DirectiveGroups::HTTPd)
+  end
+end

data/spec/lib/tomahawk/directive_groups/base_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Tomahawk::DirectiveGroups::Base do
+  it 'can get initialized' do
+    config = Tomahawk::DirectiveGroups::Base.new('abcd', { 'server_name' => 'example.com', 'foo' => 'bar'})
+
+    expect(config.directives['server_name']).to eq('example.com')
+    expect(config.directives['foo']).to eq('bar')
+  end
+
+  it 'can get initialized by block' do
+    config = Tomahawk::DirectiveGroups::Base.new do |directives, groups|
+      directives['server_name'] = 'example.com'
+      directives['foo'] = 'bar'
+
+      groups << Tomahawk::DirectiveGroups::Base.new do |directives, groups|
+        directives['group_test'] = 'works'
+      end
+    end
+
+    expect(config.directives['server_name']).to eq('example.com')
+    expect(config.directives['foo']).to eq('bar')
+    expect(config.groups.first.directives['group_test']).to eq('works')
+  end
+
+  it 'forwards #to_s/#to_str messages to a generator' do
+    config = Tomahawk::DirectiveGroups::HTTPd.new
+
+    expect(Tomahawk::Generators::HTTPd).to receive(:new).exactly(2).times
+
+    config.to_s # explicitly
+    "#{config}" # implicitly
+  end
+end

data/spec/lib/tomahawk/directive_groups/virtual_host_spec.rb

@@ -20,21 +20,21 @@ describe Tomahawk::DirectiveGroups::VirtualHost do
   end
 
   describe '#to_conf' do
-    it 'prints attributes in Apache Conf format' do
-      address = '*:80'
+    # it 'prints attributes in Apache Conf format' do
+    #   address = '*:80'
 
-      server_name = 'example.com'
-      document_root = '/tmp/tomahawk/test'
+    #   server_name = 'example.com'
+    #   document_root = '/tmp/tomahawk/test'
       
-      vhost = Tomahawk::DirectiveGroups::VirtualHost.new(address, { server_name: server_name, document_root: document_root })
+    #   vhost = Tomahawk::DirectiveGroups::VirtualHost.new(address, { server_name: server_name, document_root: document_root })
 
-      expect(strip_whitespaces(vhost.to_conf)).to eq(strip_whitespaces(<<-CONF))
-       <VirtualHost #{address}>
-          ServerName #{server_name}
+    #   expect(strip_whitespaces(vhost.to_conf)).to eq(strip_whitespaces(<<-CONF))
+    #    <VirtualHost #{address}>
+    #       ServerName #{server_name}
 
-          DocumentRoot #{document_root}
-        </VirtualHost>
-      CONF
-    end
+    #       DocumentRoot #{document_root}
+    #     </VirtualHost>
+    #   CONF
+    # end
   end
 end

data/spec/lib/tomahawk/generators/httpd_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+def normalize_config_string(config_string)
+  config_string.strip.gsub('/^\n$/','').gsub(/^\s*/,'').gsub(/\s*$/,'')
+end
+
+describe Tomahawk::Generators::HTTPd do
+  it "generates configs correctly" do 
+    config = Tomahawk::Config.new do |directives, groups|
+      directives[:timeout] = '300'
+      directives[:max_keep_alive_requests] = '100'
+
+      groups << Tomahawk::DirectiveGroups::VirtualHost.new('*:80') do |directives, groups|
+        directives[:server_name] = 'example.com'
+        directives[:document_root] = '/var/www/example.com'
+
+        groups << Tomahawk::DirectiveGroups::Directory.new('/var/www/example.com') do |directives, groups|
+          directives[:options] = '-Indexes FollowSymLinks MultiViews'
+        end
+      end
+    end
+
+    expected_result = <<-SAMPLE
+      Timeout 300
+      MaxKeepAliveRequests 100
+        <VirtualHost *:80>
+
+         ServerName example.com
+         DocumentRoot /var/www/example.com
+        <Directory /var/www/example.com>
+
+         Options -Indexes FollowSymLinks MultiViews
+        </Directory>
+
+        </VirtualHost>
+    SAMPLE
+    
+    expect(normalize_config_string(Tomahawk::Generators::HTTPd.new(config).to_s)).to eq(normalize_config_string(expected_result))
+  end
+end

data/tomahawk.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'rake', '>= 10.0.0'
+  
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

metadata

@@ -1,55 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: tomahawk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
+  prerelease: 
 platform: ruby
 authors:
 - Christian Schell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
+        version: 10.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -59,14 +66,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tomahawk.rb
+- lib/tomahawk/config.rb
 - lib/tomahawk/config_parser.rb
 - lib/tomahawk/directive_groups.rb
 - lib/tomahawk/directive_groups/base.rb
@@ -80,38 +89,45 @@ files:
 - lib/tomahawk/generators/virtual_host.rb
 - lib/tomahawk/version.rb
 - spec/lib/tomahawk/config_parser_spec.rb
+- spec/lib/tomahawk/config_spec.rb
+- spec/lib/tomahawk/directive_groups/base_spec.rb
 - spec/lib/tomahawk/directive_groups/virtual_host_spec.rb
 - spec/lib/tomahawk/directive_groups_spec.rb
+- spec/lib/tomahawk/generators/httpd_spec.rb
 - spec/lib/tomahawk_spec.rb
 - spec/spec_helper.rb
 - tomahawk.gemspec
 homepage: https://github.com/Sophisticates/tomahawk
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Tomahawk parses and generates Apache 2 configuration files.
 test_files:
 - spec/lib/tomahawk/config_parser_spec.rb
+- spec/lib/tomahawk/config_spec.rb
+- spec/lib/tomahawk/directive_groups/base_spec.rb
 - spec/lib/tomahawk/directive_groups/virtual_host_spec.rb
 - spec/lib/tomahawk/directive_groups_spec.rb
+- spec/lib/tomahawk/generators/httpd_spec.rb
 - spec/lib/tomahawk_spec.rb
 - spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: bdedd4162b4541f5585a387a2c57f58c3df00e99
-  data.tar.gz: 14466f1fa3b839d42cadebcbfe4eaeb0cd9d76c2
-SHA512:
-  metadata.gz: c92bf8f091b9f09c4f8ff3f16f881a2ca7c647fdc2185646a082f556ba8e22bf2763547abef2b41d81434006b3f39fd0a8650bf032c9e9f80147870020fd83be
-  data.tar.gz: 69ce697949fe15130a26fc760a8c590fb38b6b971df899841b9f86ecf72a6f9ade930caa00b12385a8a46472147d088e23f202274109663d94f9686989814a1a