vhost_writer 0.1.0

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vhost_writer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian O'Keefe
+
+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,40 @@
+# VhostWriter
+
+Automatically generate virtual host config files based on a directory of sites and a given ERB template.
+
+## Installation
+
+    $ gem install vhost_writer
+
+## Usage
+
+`vhost_writer` takes the following:
+
+* A directory of directories that contain sites
+  * Each site's directory should share the name of its domain (like `example.com`)
+* A directory to write config files to
+* The path to a template file written in ERB
+  * Within the template, the `site` variable contains the name of the site.
+
+### Example
+
+    vhost_writer /srv/www/ /etc/apache2/sites-available/ /home/bok/template.erb
+
+### Template Example
+
+    <VirtualHost *:80>
+      ServerAdmin admin@<%= site %>
+      ServerName <%= site %>
+      ServerAlias www.<%= site %>
+      DocumentRoot /srv/www/<%= site %>/public_html/
+      ErrorLog /srv/www/<%= site %>/logs/error.log
+      CustomLog /srv/www/<%= site %>/logs/access.log combined
+    </VirtualHost>
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/vhost_writer

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'vhost_writer/cli'
+VhostWriter::CLI.start

data/lib/vhost_writer/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require 'vhost_writer'
+
+module VhostWriter
+  class CLI < Thor
+    desc 'write [SITES_DIR] [CONF_DIR] [TEMPLATE]',
+    'Use the site directories in SITES_DIRECTORY to generate vhost configs in
+    CONFIG_DIRECTORY using TEMPLATE'
+    def write(sites_dir, conf_dir, template)
+      writer = VhostWriter::Writer.new :sites_dir => sites_dir, :conf_dir => conf_dir
+      writer.write_configs_using File.read template
+    end
+  end
+end

data/lib/vhost_writer/version.rb

@@ -0,0 +1,3 @@
+module VhostWriter
+  VERSION = '0.1.0'
+end

data/lib/vhost_writer/writer.rb

@@ -0,0 +1,39 @@
+require 'erb'
+
+module VhostWriter
+  class Writer
+    attr_reader :conf_dir, :sites
+
+    def initialize(options={})
+      raise ArgumentError, ':conf_dir is required' unless options.key? :conf_dir
+      raise ArgumentError, 'Either :sites_dir or :sites is required' unless options.key? :sites_dir or options.key? :sites
+      raise ArgumentError, 'Only one of :sites_dir and :sites is allowed' if options.key? :sites_dir and options.key? :sites
+
+      options[:conf_dir] << '/' unless options[:conf_dir] =~ /\/\z/
+      @conf_dir = options[:conf_dir]
+
+      if options.key? :sites_dir
+        @sites = Dir.glob("#{options[:sites_dir]}*").map { |f| File.basename f }
+      else
+        @sites = options[:sites]
+      end
+    end
+
+    def blacklist(site_blacklist)
+      Writer.new :conf_dir => @conf_dir, :sites => @sites - site_blacklist
+    end
+
+    def whitelist(site_whitelist)
+      Writer.new :conf_dir => @conf_dir, :sites => site_whitelist - (@sites - site_whitelist)
+    end
+
+    def write_configs_using(template)
+      @sites.each do |site|
+        File.open("#{@conf_dir}#{site}", 'w') do |f|
+          f.write ERB.new(template).result(binding)
+        end
+      end
+    end
+
+  end
+end

data/lib/vhost_writer.rb

@@ -0,0 +1,2 @@
+require 'vhost_writer/version'
+require 'vhost_writer/writer'

data/spec/cli_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'vhost_writer/cli'
+
+describe VhostWriter::CLI do
+  describe '#write' do
+    context 'when given parameters' do
+      before { subject.write 'spec/test/www/', 'spec/test/sites-available/', 'spec/test/templates/template.erb' }
+
+      it 'should write config files' do
+        expect(Dir.glob('spec/test/sites-available/*').map { |f| File.basename f }).to eql ['example.com', 'example.org', 'foo.example.com']
+      end
+
+      it 'should utilize the specified template' do
+        expect(File.read 'spec/test/sites-available/example.com').to eql File.read 'spec/test/expected/example.com'
+      end
+
+      after { Dir.glob('spec/test/sites-available/*').each { |f| File.delete f } }
+    end
+
+    context 'when given a config file' do
+      pending 'not yet implemented'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/spec/test/expected/example.com

@@ -0,0 +1,8 @@
+<VirtualHost *:80>
+  ServerAdmin admin@example.com
+  ServerName example.com
+  ServerAlias www.example.com
+  DocumentRoot /srv/www/example.com/public_html/
+  ErrorLog /srv/www/example.com/logs/error.log
+  CustomLog /srv/www/example.com/logs/access.log combined
+</VirtualHost>

data/spec/test/templates/template.erb

@@ -0,0 +1,8 @@
+<VirtualHost *:80>
+  ServerAdmin admin@<%= site %>
+  ServerName <%= site %>
+  ServerAlias www.<%= site %>
+  DocumentRoot /srv/www/<%= site %>/public_html/
+  ErrorLog /srv/www/<%= site %>/logs/error.log
+  CustomLog /srv/www/<%= site %>/logs/access.log combined
+</VirtualHost>

data/spec/writer_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe VhostWriter::Writer do
+  subject(:writer) { VhostWriter::Writer.new :sites_dir => 'spec/test/www/', :conf_dir => 'spec/test/sites-available'}
+  let(:template) { File.read 'spec/test/templates/template.erb' }
+  let(:all_sites) { ['example.com', 'example.org', 'foo.example.com'] }
+
+  describe '#initialize' do
+    it 'should return a writer object' do
+      expect(writer).to be_an_instance_of VhostWriter::Writer
+    end
+
+    it 'requires a :conf_dir parameter' do
+      expect { VhostWriter::Writer.new :sites_dir => 'foo/bar' }.to raise_error ':conf_dir is required'
+    end
+
+    it 'requires either :sites_dir or :sites' do
+      expect { VhostWriter::Writer.new :conf_dir => 'foo/bar' }.to raise_error 'Either :sites_dir or :sites is required'
+    end
+
+    it 'should not accept both :sites_dir and :sites' do
+      expect { VhostWriter::Writer.new :conf_dir => 'foo/bar', :sites_dir => 'bar/baz', :sites => ['example.com', 'example.org']}.to raise_error 'Only one of :sites_dir and :sites is allowed'
+    end
+
+    context 'when conf_dir does not have a trailing slash' do
+      it 'should automatically add a trailing slash' do
+        expect(writer.conf_dir).to eql 'spec/test/sites-available/'
+      end
+    end
+  end
+
+  describe '#sites' do
+    it 'should reflect the sites in the sites directory' do
+      expect(writer.sites).to eql all_sites
+    end
+  end
+
+  describe '#blacklist' do
+    let(:blacklisted_writer) { writer.blacklist ['example.com'] }
+
+    it 'should return a writer object' do
+      expect(blacklisted_writer).to be_an_instance_of VhostWriter::Writer
+    end
+
+    it 'should ignore blacklisted sites' do
+      expect(blacklisted_writer.sites).to eql ['example.org', 'foo.example.com']
+    end
+  end
+
+  describe '#whitelist' do
+    let(:whitelisted_writer) { writer.whitelist ['example.com'] }
+
+    it 'should return a writer object' do
+      expect(whitelisted_writer).to be_an_instance_of VhostWriter::Writer
+    end
+
+    it 'should only operate on whitelisted sites' do
+      expect(whitelisted_writer.sites).to eql ['example.com']
+    end
+  end
+
+  describe '#write_configs_using' do
+    before { writer.write_configs_using template }
+    let(:results_dir_contents) { Dir.glob('spec/test/sites-available/*').map { |f| File.basename f } }
+
+    it 'should write config files' do
+      expect(results_dir_contents).to eql all_sites
+    end
+
+    it 'should utilize the provided template' do
+      expect(File.read 'spec/test/sites-available/example.com').to eql File.read 'spec/test/expected/example.com'
+    end
+
+    after { Dir.glob('spec/test/sites-available/*').each { |f| File.delete f } }
+  end
+end

data/vhost_writer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vhost_writer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'vhost_writer'
+  gem.version       = VhostWriter::VERSION
+  gem.authors       = ["Brian O'Keefe"]
+  gem.email         = ['brian@bokstuff.com']
+  gem.summary       = %q(Virtual host configuration generator)
+  gem.description   = %q(Automatically generate virtual host config files based on a directory of sites and a given ERB template)
+  gem.homepage      = 'https://github.com/brianokeefe/vhost_writer'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split
+  gem.executables   = ['vhost_writer']
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'thor'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: vhost_writer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian O'Keefe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: Automatically generate virtual host config files based on a directory
+  of sites and a given ERB template
+email:
+- brian@bokstuff.com
+executables:
+- vhost_writer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/vhost_writer
+- lib/vhost_writer.rb
+- lib/vhost_writer/cli.rb
+- lib/vhost_writer/version.rb
+- lib/vhost_writer/writer.rb
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/test/expected/example.com
+- spec/test/templates/template.erb
+- spec/test/www/example.com/.keep
+- spec/test/www/example.org/.keep
+- spec/test/www/foo.example.com/.keep
+- spec/writer_spec.rb
+- vhost_writer.gemspec
+homepage: https://github.com/brianokeefe/vhost_writer
+licenses:
+- MIT
+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: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Virtual host configuration generator
+test_files:
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/test/expected/example.com
+- spec/test/templates/template.erb
+- spec/test/www/example.com/.keep
+- spec/test/www/example.org/.keep
+- spec/test/www/foo.example.com/.keep
+- spec/writer_spec.rb