hostess 0.1.2 → 0.1.6

data/README.md

@@ -1,12 +1,10 @@
-Hostess
-=======
+# Hostess
 
 A simple tool for adding local directories as virtual hosts in a local apache installation. It probably only works well on a Mac, but we're scratching our own itch here.
 
-Usage
------
+## Usage
 
-    $ sudo hostess create mysite.local /Users/myuser/Sites/mysite
+    $ hostess create mysite.local /Users/myuser/Sites/mysite
 
 This will create a new virtual host in your Apache configuration, setup your Mac's DNS to respond to that domain name, and restart Apache to make the new virtual host live.
 
@@ -16,4 +14,3 @@ This will create a new virtual host in your Apache configuration, setup your Mac
     hostess delete domain           - delete a virtual host
     hostess list                    - list hostess virtual hosts
     hostess help                    - this info
-  

data/Rakefile

@@ -2,10 +2,15 @@ require "rubygems"
 require "rake/gempackagetask"
 require "rake/rdoctask"
 
-task :default => :package do
-  puts "Don't forget to write some tests!"
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
 end
 
+task :default => ["test"]
+
 # This builds the actual gem. For details of what all these options
 # mean, and other ones you can add, check the documentation here:
 #
@@ -15,7 +20,7 @@ spec = Gem::Specification.new do |s|
   
   # Change these as appropriate
   s.name              = "hostess"
-  s.version           = "0.1.2"
+  s.version           = "0.1.6"
   s.summary           = "Manage simple apache virtual hosts"
   s.author            = "Chris Roos, James Adam"
   s.email             = "chris@chrisroos.co.uk"
@@ -28,10 +33,10 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files  = %w(README.md)
   s.rdoc_options      = %w(--main README.md)
   
-  s.require_paths     = ['bin']
+  s.require_paths     = ['bin', 'lib']
 
   # Add any extra files to include in the gem (like your README)
-  s.files             = %w(README.md Rakefile) + Dir.glob("{bin}/**/*")
+  s.files             = %w(README.md Rakefile) + Dir.glob("{bin}/**/*") + Dir.glob("{lib}/**/*")
   s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
   
   # If you want to depend on other gems, add them here, along with any
@@ -39,7 +44,7 @@ spec = Gem::Specification.new do |s|
   # s.add_dependency("some_other_gem", "~> 0.1.0")
   
   # If your tests use any gems, include them here
-  # s.add_development_dependency("mocha")
+  s.add_development_dependency("mocha")
 
   # If you want to publish automatically to rubyforge, you'll may need
   # to tweak this, and the publishing task below too.

data/bin/hostess

@@ -1,144 +1,6 @@
 #! /usr/bin/env ruby
 
-require 'erb'
-require 'fileutils'
-require 'pathname'
-
-module Hostess
-  SCRIPT              = File.basename($0)
-  APACHE_CONFIG_DIR   = Pathname.new('/') + 'etc' + 'apache2'
-  APACHE_CONFIG       = APACHE_CONFIG_DIR + 'httpd.conf'
-  VHOSTS_DIR          = APACHE_CONFIG_DIR + "#{SCRIPT}_vhosts"
-  class Options
-    attr_reader :action, :domain, :directory
-    def initialize(action=nil, domain=nil, directory=nil)
-      @action, @domain, @directory = action, domain, directory
-    end
-    def directory
-      File.expand_path(@directory) if @directory
-    end
-    def display_banner_and_return
-      puts banner
-      exit
-    end
-    def valid?
-      valid_create? or valid_delete? or valid_list? or valid_help?
-    end
-    private
-      def valid_create?
-        @action == 'create' and domain and directory
-      end
-      def valid_delete?
-        @action == 'delete' and domain
-      end
-      def valid_list?
-        @action == 'list'
-      end
-      def valid_help?
-        @action == 'help'
-      end
-      def banner
-<<EndBanner
-  Usage:
-    #{SCRIPT} create domain directory - create a new virtual host
-    #{SCRIPT} delete domain           - delete a virtual host
-    #{SCRIPT} list                    - list #{SCRIPT} virtual hosts
-    #{SCRIPT} help                    - this info
-EndBanner
-      end
-  end
-  class VirtualHost
-    def initialize(options)
-      @options = options
-    end
-    def execute!
-      __send__(@options.action)
-    end
-    def create
-      warn_and_return unless sudoer?
-      setup_apache_config
-      create_vhost_directory
-      create_apache_log_directory
-      system "dscl localhost -create /Local/Default/Hosts/#{@options.domain} IPAddress 127.0.0.1"
-      File.open(config_filename, 'w') { |f| f.puts(vhost_config) }
-      restart_apache
-    end
-    def delete
-      warn_and_return unless sudoer?
-      system "dscl localhost -delete /Local/Default/Hosts/#{@options.domain}"
-      File.delete(config_filename)
-      restart_apache
-    end
-    def list
-      Dir[File.join(VHOSTS_DIR, '*.conf')].each do |config_file|
-        puts File.basename(config_file, '.conf')
-      end
-    end
-    def help
-      @options.display_banner_and_return
-    end
-    private
-      def apache_log_directory
-        File.expand_path(File.join('~', "." + SCRIPT, 'log', @options.domain))
-      end
-      def create_apache_log_directory
-        FileUtils.mkdir_p(apache_log_directory)
-      end
-      def warn_and_return
-        puts "Please use sudo to use this utility to create or delete virtual hosts"
-        exit
-      end
-      def sudoer?
-        # A proxy for actually knowing whether or not the user has all required privileges
-        File.stat(APACHE_CONFIG).writable?
-      end
-      def vhost_config
-        domain, directory = @options.domain, @options.directory
-        template = <<-EOT
-        <VirtualHost *:80>
-          ServerName <%= domain %>
-          DocumentRoot <%= directory %>
-          <Directory <%= directory %>>
-            Options FollowSymLinks
-            AllowOverride All
-            allow from all
-          </Directory>
-          <DirectoryMatch "^/.*/\.svn/">
-            ErrorDocument 403 /404.html
-            Order allow,deny
-            Deny from all
-            Satisfy All
-          </DirectoryMatch>
-          ErrorLog <%= File.join(apache_log_directory, 'error_log') %>
-          CustomLog <%= File.join(apache_log_directory, 'access_log') %> common
-          #RewriteLogLevel 3
-          RewriteLog <%= File.join(apache_log_directory, 'rewrite_log') %>
-        </VirtualHost>
-        EOT
-        ERB.new(template).result(binding)
-      end
-      def config_filename
-        File.join(VHOSTS_DIR, "#{@options.domain}.conf")
-      end
-      def setup_apache_config
-        unless File.read(APACHE_CONFIG).include?("Include #{File.join(VHOSTS_DIR, '*.conf')}")
-          File.open(APACHE_CONFIG, 'a') do |file|
-            file.puts ""
-            file.puts ""
-            file.puts "# Line added by #{SCRIPT}"
-            file.puts "NameVirtualHost *:80"
-            file.puts "Include #{File.join(VHOSTS_DIR, '*.conf')}"
-          end
-        end
-      end
-      def create_vhost_directory
-        FileUtils.mkdir_p(VHOSTS_DIR)
-      end
-      def restart_apache
-        `apachectl restart`
-      end
-  end
-end
+require 'hostess'
 
 options = Hostess::Options.new(*ARGV)
 options.display_banner_and_return unless options.valid?

data/lib/hostess/options.rb

@@ -0,0 +1,40 @@
+module Hostess
+  class Options
+    attr_reader :action, :domain, :directory
+    def initialize(action=nil, domain=nil, directory=nil)
+      @action, @domain, @directory = action, domain, directory
+    end
+    def directory
+      File.expand_path(@directory) if @directory
+    end
+    def display_banner_and_return
+      puts banner
+      exit
+    end
+    def valid?
+      valid_create? or valid_delete? or valid_list? or valid_help?
+    end
+    private
+      def valid_create?
+        @action == 'create' and domain and directory
+      end
+      def valid_delete?
+        @action == 'delete' and domain
+      end
+      def valid_list?
+        @action == 'list'
+      end
+      def valid_help?
+        @action == 'help'
+      end
+      def banner
+<<EndBanner
+  Usage:
+    #{Hostess.script_name} create domain directory - create a new virtual host
+    #{Hostess.script_name} delete domain           - delete a virtual host
+    #{Hostess.script_name} list                    - list #{Hostess.script_name} virtual hosts
+    #{Hostess.script_name} help                    - this info
+EndBanner
+      end
+  end
+end

data/lib/hostess/virtual_host.rb

@@ -0,0 +1,104 @@
+module Hostess
+  class VirtualHost
+    def initialize(options, debug=false)
+      @options, @debug = options, debug
+    end
+    def execute!
+      __send__(@options.action)
+    end
+    def create
+      setup_apache_config
+      create_vhost_directory
+      create_apache_log_directory
+      create_dns_entry
+      create_vhost
+      restart_apache
+    end
+    def delete
+      delete_dns_entry
+      delete_vhost
+      restart_apache
+    end
+    def list
+      Dir[File.join(Hostess.vhosts_dir, '*.conf')].each do |config_file|
+        puts File.basename(config_file, '.conf')
+      end
+    end
+    def help
+      @options.display_banner_and_return
+    end
+    private
+      def create_dns_entry
+        run "dscl localhost -create /Local/Default/Hosts/#{@options.domain} IPAddress 127.0.0.1"
+      end
+      def delete_dns_entry
+        run "dscl localhost -delete /Local/Default/Hosts/#{@options.domain}"
+      end
+      def create_vhost
+        tempfile = Tempfile.new('vhost')
+        tempfile.puts(vhost_config)
+        tempfile.close
+        run "mv #{tempfile.path} #{config_filename}"
+      end
+      def delete_vhost
+        run "rm #{config_filename}"
+      end
+      def apache_log_directory
+        File.join(Hostess.vhosts_log_dir, @options.domain)
+      end
+      def create_apache_log_directory
+        run "mkdir -p #{apache_log_directory}"
+      end
+      def vhost_config
+        domain, directory = @options.domain, @options.directory
+        template = <<-EOT
+<VirtualHost *:80>
+  ServerName <%= domain %>
+  DocumentRoot <%= directory %>
+  <Directory <%= directory %>>
+    Options FollowSymLinks
+    AllowOverride All
+    allow from all
+  </Directory>
+  <DirectoryMatch "^/.*/\.svn/">
+    ErrorDocument 403 /404.html
+    Order allow,deny
+    Deny from all
+    Satisfy All
+  </DirectoryMatch>
+  ErrorLog <%= File.join(apache_log_directory, 'error_log') %>
+  CustomLog <%= File.join(apache_log_directory, 'access_log') %> common
+  #RewriteLogLevel 3
+  RewriteLog <%= File.join(apache_log_directory, 'rewrite_log') %>
+</VirtualHost>
+        EOT
+        ERB.new(template).result(binding)
+      end
+      def config_filename
+        File.join(Hostess.vhosts_dir, "#{@options.domain}.conf")
+      end
+      def setup_apache_config
+        unless File.read(Hostess.apache_config).include?("Include #{File.join(Hostess.vhosts_dir, '*.conf')}")
+          run "echo '' >> #{Hostess.apache_config}"
+          run "echo '' >> #{Hostess.apache_config}"
+          run "echo '# Line added by #{Hostess.script_name}' >> #{Hostess.apache_config}"
+          run "echo 'NameVirtualHost *:80' >> #{Hostess.apache_config}"
+          run "echo 'Include #{File.join(Hostess.vhosts_dir, '*.conf')}' >> #{Hostess.apache_config}"
+        end
+      end
+      def create_vhost_directory
+        run "mkdir -p #{Hostess.vhosts_dir}"
+      end
+      def restart_apache
+        run "apachectl restart"
+      end
+      def run(cmd)
+        cmd = sudo(cmd) if Hostess.use_sudo?
+        puts cmd if @debug
+        system cmd
+      end
+      def sudo(cmd)
+         "sudo -s \"#{cmd}\""
+      end
+  end
+end

data/lib/hostess.rb

@@ -0,0 +1,49 @@
+require 'erb'
+require 'fileutils'
+require 'pathname'
+require 'tempfile'
+
+module Hostess
+  
+  autoload :Options,     'hostess/options'
+  autoload :VirtualHost, 'hostess/virtual_host'
+  
+  class << self
+    
+    attr_writer :apache_config_dir, :apache_log_dir
+    
+    def script_name
+      'hostess'
+    end
+    
+    def apache_config_dir
+      @apache_config_dir || File.join('/', 'etc', 'apache2')
+    end
+    
+    def apache_config
+      File.join(apache_config_dir, 'httpd.conf')
+    end
+    
+    def vhosts_dir
+      File.join(apache_config_dir, "#{script_name}_vhosts")
+    end
+    
+    def apache_log_dir
+      @apache_log_dir || File.join('/', 'var', 'log', 'apache2')
+    end
+    
+    def vhosts_log_dir
+      File.join(apache_log_dir, "#{script_name}_vhosts")
+    end
+    
+    def disable_sudo!
+      @disable_sudo = true
+    end
+    
+    def use_sudo?
+      @disable_sudo ? false : true
+    end
+    
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hostess
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Chris Roos, James Adam
@@ -15,10 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-20 00:00:00 +00:00
+date: 2010-11-26 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: 
 email: chris@chrisroos.co.uk
 executables: 
@@ -31,6 +44,9 @@ files:
 - README.md
 - Rakefile
 - bin/hostess
+- lib/hostess/options.rb
+- lib/hostess/virtual_host.rb
+- lib/hostess.rb
 has_rdoc: false
 homepage: http://chrisroos.co.uk
 licenses: []
@@ -41,6 +57,7 @@ rdoc_options:
 - README.md
 require_paths: 
 - bin
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: