tomahawk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3321497e0e37efc0950be9ece1d7b843beafb880
+  data.tar.gz: dd2c3437d9acf92cbb456f4e121c967e1ed8229e
+SHA512:
+  metadata.gz: 27393b6bf0bb0072fc45746a1e941c62d4a2d92d3c22a42551317993dbbb2de11750c27015a9644c40d1b0dc10c8ee0ad4fb3d96ca755afb63d5d34d46a26d23
+  data.tar.gz: 80204485dcf3d2b26f80e5f1a6a558668e420042209e6b949eeb1009c190663d2e62a39cc1f89b3bb7ea16e84f2b365339ebd21a180c5f94771b2e7a07aa6388

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christian Schell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# 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.
+
+**This gem is still under an early alpha stage and may change it's API faster than you blink. Still any contributions are highly appreciated.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tomahawk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tomahawk
+
+## Usage
+    require 'tomahawk'
+
+    httpd_config = Tomahawk.parse File.read('/etc/apache2/apache.conf')
+
+    httpd_config.directives # lists parsed directives such as ServerName and LogLevel
+
+    httpd_config.groups # lists parsed directive groups such as <VirtualHost> and <Directory>
+
+    httpd_config.directives['server_name'] = 'google.com' # change a directive
+
+    httpd_config.directives['some_new_directive'] = 'foo' # create a new directive
+
+    File.write('/etc/apache2/apache.conf.new', httpd_config.to_conf) # write your new configuration back to disk
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tomahawk/config_parser.rb

@@ -0,0 +1,75 @@
+module Tomahawk
+  class ConfigParser
+    attr_accessor :result
+    def initialize(config_string)
+      @config_string = config_string.to_s.strip
+      @result = []
+    end
+
+    def call
+      @config_lines = @config_string.split("\n")
+      parse
+    end
+
+    private
+
+    def parse
+      
+      directive_groups = [Tomahawk::DirectiveGroups::HTTPd.new]
+
+      @config_lines.each do |line|
+
+        is_end_tag?(line) do
+          directive_groups.pop
+        end
+
+        is_start_tag?(line) do |group_name, group_parameters|
+          group = Tomahawk::DirectiveGroups.DirectiveGroup(group_name).new(group_parameters)
+          directive_groups.last.groups << group
+          directive_groups.push(group)
+        end
+
+        is_directive?(line) do |directive_name, directive_value|
+          directive_groups.last.directives[directive_name] = directive_value
+        end
+      end
+
+      @result = directive_groups.first
+    end
+
+    def is_end_tag?(line, &block)
+      if line[/<\/.+?>/]
+        yield if block
+        return true
+      end
+
+      false
+    end
+
+    def is_start_tag?(line, &block)
+      if line[/<\s*([^\/\s]+)(.*?)>/]
+        yield $1.strip, $2.strip if block
+        return true
+      end
+
+      false
+    end
+
+    def is_directive?(line, &block)
+      if line[/^\s*([^#<\s]+)(.+)$/]
+
+        if block
+          directive_value = $2.strip if $2
+          directive_name = $1.scan(/[A-Z][^A-Z\s]*/)
+                            .map(&:downcase)
+                            .join('_')
+
+          yield(directive_name, directive_value)
+        end
+        return true
+      end
+
+      false
+    end
+  end
+end

data/lib/tomahawk/directive_groups/base.rb

@@ -0,0 +1,23 @@
+module Tomahawk
+  module DirectiveGroups
+    class Base
+      attr_accessor :parameters, :directives, :groups
+
+      def initialize(parameters = '', directives = {})
+        @parameters = parameters
+        @directives = Hash[directives]
+        @groups = []
+      end
+
+      def to_conf()
+        raise "#{self.class.name} doesn't support #conf!"
+      end
+
+      def ==(obj)
+        self.class == self.class && self.parameters == obj.parameters && self.directives == obj.directives && self.groups == obj.groups
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/tomahawk/directive_groups/directory.rb

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

data/lib/tomahawk/directive_groups/httpd.rb

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

data/lib/tomahawk/directive_groups/virtual_host.rb

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

data/lib/tomahawk/directive_groups.rb

@@ -0,0 +1,16 @@
+require_relative 'directive_groups/base'
+require_relative 'directive_groups/httpd'
+require_relative 'directive_groups/virtual_host'
+require_relative 'directive_groups/directory'
+
+module Tomahawk
+  module DirectiveGroups
+    extend self
+
+    def DirectiveGroup(directive_group_name)
+      directive_group_name = String(directive_group_name)
+
+      Kernel.const_get('Tomahawk::DirectiveGroups::%s' % [directive_group_name])
+    end
+  end
+end

data/lib/tomahawk/generators/base.rb

@@ -0,0 +1,31 @@
+module Tomahawk
+  module Generators
+    class Base
+      include Generators
+
+      def initialize(directive_group)
+        @directive_group = directive_group
+      end
+
+      def to_str
+        config = "\n<#{directive_group_name} #{@directive_group.parameters}>\n"
+
+        @directive_group.directives.each do |directive, value|
+          config += generate_directive(directive, value) 
+        end
+
+        @directive_group.groups.each do |group|
+          config += group.to_conf
+        end
+
+        config += "\n</#{directive_group_name}>\n"
+      end
+
+      alias_method :to_s, :to_str
+    end
+
+    def directive_group_name
+      @directive_group.class.name.split('::').last
+    end
+  end
+end

data/lib/tomahawk/generators/directory.rb

@@ -0,0 +1,6 @@
+module Tomahawk
+  module Generators    
+    class Directory < Base
+    end
+  end
+end

data/lib/tomahawk/generators/httpd.rb

@@ -0,0 +1,24 @@
+module Tomahawk
+  module Generators    
+    class HTTPd < Base
+
+      def initialize(httpd)
+        @httpd = httpd
+      end
+
+      def to_str
+        config = ''
+
+        @httpd.directives.each do |directive, value|
+          config += generate_directive(directive, value) 
+        end
+
+        @httpd.groups.each do |group|
+          config += group.to_str
+        end
+
+        config
+      end
+    end
+  end
+end

data/lib/tomahawk/generators/virtual_host.rb

@@ -0,0 +1,6 @@
+module Tomahawk
+  module Generators    
+    class VirtualHost < Base
+    end
+  end
+end

data/lib/tomahawk/generators.rb

@@ -0,0 +1,12 @@
+require_relative 'generators/base'
+require_relative 'generators/httpd'
+require_relative 'generators/virtual_host'
+require_relative 'generators/directory'
+
+module Tomahawk
+  module Generators
+    def generate_directive(directive, value)
+      "\n %s %s" % [directive.to_s.split('_').map(&:capitalize).join, value]
+    end
+  end
+end

data/lib/tomahawk/version.rb

@@ -0,0 +1,3 @@
+module Tomahawk
+  VERSION = "0.0.1"
+end

data/lib/tomahawk.rb

@@ -0,0 +1,12 @@
+require "tomahawk/version"
+require "tomahawk/directive_groups"
+require "tomahawk/generators"
+require "tomahawk/config_parser"
+
+module Tomahawk
+  extend self
+
+  def parse(input)
+    ConfigParser.new(input).call
+  end
+end

data/spec/lib/tomahawk/config_parser_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Tomahawk::ConfigParser do
+  it "parses Vhost files correctly" do
+    google_com = Tomahawk::DirectiveGroups::VirtualHost.new('173.194.35.174:80', 'server_name' => 'google.com', 'server_alias' => 'www.google.com', 'document_root' => '/var/www/google.com')
+    google_com.groups << Tomahawk::DirectiveGroups::Directory.new('/var/www/google.com', 'options' => '-Indexes FollowSymLinks MultiViews', 'allow_override' => 'AuthConfig Limit Indexes Options=All,MultiViews FileInfo')
+    
+    github_com = Tomahawk::DirectiveGroups::VirtualHost.new('192.30.252.131:80', 'server_name' => 'github.com', 'server_alias' => 'www.github.com github.io', 'document_root' => '/var/www/github.com')
+    github_com.groups << Tomahawk::DirectiveGroups::Directory.new('/var/www/github.com', 'options' => '-Indexes FollowSymLinks MultiViews', 'allow_override' => 'AuthConfig Indexes Options=All FileInfo')
+    github_com.groups << Tomahawk::DirectiveGroups::Directory.new('/var/www/github.com/private', 'order' => 'allow, deny', 'allow' => 'from all')
+
+    config = Tomahawk::ConfigParser.new(google_com.to_conf.to_s + github_com.to_conf.to_s)
+
+
+    config.call
+
+    expect(config.result.groups).to eq([google_com, github_com])
+  end
+end
+

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

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+def strip_whitespaces(str)
+  String(str).gsub(/^\s+/, '').gsub(/\n{2,}/, '\n')
+end
+
+describe Tomahawk::DirectiveGroups::VirtualHost do
+  describe '.new' do
+    it 'initializes correctly' do
+      address = '*:80'
+
+      server_name = 'example.com'
+      document_root = '/tmp/tomahawk/test'
+      
+      vhost = Tomahawk::DirectiveGroups::VirtualHost.new(address, { server_name: server_name, document_root: document_root })
+
+      expect(vhost.directives[:server_name]).to eq(server_name)
+      expect(vhost.directives[:document_root]).to eq(document_root)
+    end
+  end
+
+  describe '#to_conf' do
+    it 'prints attributes in Apache Conf format' do
+      address = '*:80'
+
+      server_name = 'example.com'
+      document_root = '/tmp/tomahawk/test'
+      
+      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}
+
+          DocumentRoot #{document_root}
+        </VirtualHost>
+      CONF
+    end
+  end
+end

data/spec/lib/tomahawk/directive_groups_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Tomahawk::DirectiveGroups do
+  describe '.DirectiveGroup' do 
+    it 'returns corresponding DirectiveGroup if String given' do
+      expect(Tomahawk::DirectiveGroups.DirectiveGroup('VirtualHost')).to eq(Tomahawk::DirectiveGroups::VirtualHost)
+    end
+  end
+end

data/spec/lib/tomahawk_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Tomahawk do
+  describe '.parse' do
+    it 'delegates it' do 
+      input = 'some input'
+      expect_any_instance_of(Tomahawk::ConfigParser).to receive(:call)
+
+      Tomahawk.parse(input)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'tomahawk'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/tomahawk.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tomahawk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tomahawk"
+  spec.version       = Tomahawk::VERSION
+  spec.authors       = ["Christian Schell"]
+  spec.email         = ["mail@chrisschell.de"]
+  spec.summary       = 'Tomahawk parses and generates Apache 2 configuration files.'
+  spec.description   = nil
+  spec.homepage      = 'https://github.com/cschell/tomahawk'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tomahawk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Schell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- mail@chrisschell.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tomahawk.rb
+- lib/tomahawk/config_parser.rb
+- lib/tomahawk/directive_groups.rb
+- lib/tomahawk/directive_groups/base.rb
+- lib/tomahawk/directive_groups/directory.rb
+- lib/tomahawk/directive_groups/httpd.rb
+- lib/tomahawk/directive_groups/virtual_host.rb
+- lib/tomahawk/generators.rb
+- lib/tomahawk/generators/base.rb
+- lib/tomahawk/generators/directory.rb
+- lib/tomahawk/generators/httpd.rb
+- lib/tomahawk/generators/virtual_host.rb
+- lib/tomahawk/version.rb
+- spec/lib/tomahawk/config_parser_spec.rb
+- spec/lib/tomahawk/directive_groups/virtual_host_spec.rb
+- spec/lib/tomahawk/directive_groups_spec.rb
+- spec/lib/tomahawk_spec.rb
+- spec/spec_helper.rb
+- tomahawk.gemspec
+homepage: https://github.com/cschell/tomahawk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Tomahawk parses and generates Apache 2 configuration files.
+test_files:
+- spec/lib/tomahawk/config_parser_spec.rb
+- spec/lib/tomahawk/directive_groups/virtual_host_spec.rb
+- spec/lib/tomahawk/directive_groups_spec.rb
+- spec/lib/tomahawk_spec.rb
+- spec/spec_helper.rb