vh 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 José Nahuel Cuesta Luengo
+
+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,52 @@
+# vh
+
+Virtual Hosts manager for the CLI -- a dead simple script to add new virtual hosts
+that will ease the local development of web apps with Apache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vh
+
+## Usage
+
+Running `vh` is pretty straight-forward:
+
+    vh path hostname
+
+Where:
+
+   * `path` is the path to the `DocumentRoot` of the Virtual Host, and
+   * `hostname` is the hostname that will be used locally for the VH.
+
+## License
+
+```
+Copyright (c) 2012 José Nahuel Cuesta Luengo
+
+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/Rakefile

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

data/bin/vh

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "vh"
+require "pathname"
+
+# Validate required arguments
+if ARGV.length < 2
+  puts 'Missing arguments.'
+  puts 'Usage:'
+  puts '  vh path hostname'
+  exit 1
+end
+
+path = Pathname.new(ARGV[0]).realpath.to_s
+host = ARGV[1]
+
+Vh.add path, host

data/lib/vh.rb

@@ -0,0 +1,31 @@
+require "vh/apache_config"
+require "vh/hosts_config"
+require "vh/apache_handler"
+
+# Virtual Hosts Manager driver
+module Vh
+  # Adds a virtual host to the currently-existing ones.
+  #
+  # Example:
+  #   >> Vh.add "~/dev/project/web", "project.local"
+  #
+  # @param  [String|Pathname] path     The local path for the web root.
+  # @param  [String]          hostname The host name for the virtual host.
+  #
+  # @return [Vh]
+  def self.add(path, hostname)
+    # Add the host to the Apache configuration
+    apache_config = ApacheConfig.new path, hostname
+    apache_config.run
+
+    # Add the hostname alias to the hosts file
+    hosts_config = HostsConfig.new hostname
+    hosts_config.run
+
+    # Restart Apache
+    apache_handler = ApacheHandler.new
+    apache_handler.run
+
+    return self
+  end
+end

data/lib/vh/apache_config.rb

@@ -0,0 +1,66 @@
+require "vh/base_config"
+
+module Vh
+  # Apache configuration manager
+  class ApacheConfig < BaseConfig
+    DEFAULT_CONFIG_PATH = '/etc/apache2/extra/httpd-vhosts.conf'
+
+    # Initializes a new instance of this class.
+    #
+    # @param [String|Pathname] path        The path to the web root.
+    # @param [String]          host        The host name to be added.
+    # @param [String]          config_path The path to the configuration path
+    #                                      (optional, defaults to `DEFAULT_CONFIG_PATH`).
+    def initialize(path, host, config_path = DEFAULT_CONFIG_PATH)
+      @path        = path
+      @host        = host
+      @config_path = config_path
+    end
+
+    # Performs any necessary checks prior to modifying the configuration file
+    # and returns a `Boolean` value indicating whether the checks were successful or not.
+    #
+    # @return [Boolean]
+    def check?
+      # Check if the path exists and is a directory
+      unless File.directory? @path
+        puts "#{@path} is not a valid path."
+        return false
+      end
+
+      # Check if the configuration file is writable
+      unless check_writable?
+        puts "The Apache configuration file is not writable by the current user."
+        return false
+      end
+
+      # Check if there is not already a virtual host defined with the same host name
+      unless check_content? /ServerName\s+"#{@host}"/i
+        puts "There already is a server named '#{@host}' on the Apache configuration file."
+        return false
+      end
+
+      # Success! :)
+      return true
+    end
+
+    # Generates the new content that will be appended to the configuration file.
+    #
+    # @return [String]
+    def new_config_content
+      return <<-VHOST
+
+# vh - #{@host}
+<Directory "#{@path}">
+  Allow From All
+  AllowOverride All
+</Directory>
+<VirtualHost *:80>
+  ServerName "#{@host}"
+  DocumentRoot "#{@path}"
+</VirtualHost>
+# /vh - #{@host}
+      VHOST
+    end
+  end
+end

data/lib/vh/apache_handler.rb

@@ -0,0 +1,19 @@
+module Vh
+  # Apache server handler
+  class ApacheHandler
+    DEFAULT_APACHE_COMMAND = "apachectl"
+
+    # Initializes a new instance of this class.
+    #
+    # @param [String] apache_command The command to use to handle Apache
+    #                                (Optional, defaults to DEFAULT_APACHE_COMMAND).
+    def initialize(apache_command = DEFAULT_APACHE_COMMAND)
+      @apachectl = apache_command
+    end
+
+    # Runs this handler - Restarts Apache server
+    def run
+      `#{@apachectl} restart`
+    end
+  end
+end

data/lib/vh/base_config.rb

@@ -0,0 +1,52 @@
+module Vh
+  # Base class for all configuration managers
+  class BaseConfig
+    # Checks if the configuration path stored in `@config_path`
+    # is writable and returns a boolean value representing the
+    # outcome of that check.
+    #
+    # @return [Boolean]
+    def check_writable?
+      File.writable? @config_path
+    end
+
+    # Checks if the configuration file at `@config_path`
+    # does not match a `regex` and returns `true` if
+    # there is no match or `false` otherwise.
+    #
+    # @param  [Regexp] regex The regular expression to check `@config_path` against.
+    #
+    # @return [Boolean]
+    def check_content?(regex)
+      open @config_path do | config |
+        config.grep(regex).length == 0
+      end
+    end
+
+    # Appends `content` to the configuration file at `@config_path`
+    #
+    # @param [String] content The content to append to the configuration file.
+    def append_to_config(content)
+      open @config_path, 'a+' do | config |
+        config << content
+      end
+    end
+
+    # Runs the manager: mainly, append the new configuration generated
+    # by {#new_config} if the checks are OK.
+    #
+    # (see #append_to_config)
+    # (see #check?)
+    # (see #new_config)
+    def run
+      append_to_config new_config_content if check?
+    end
+
+    # Generates the new content that will be appended to the configuration file.
+    #
+    # @return [String]
+    def new_config_content
+      raise NotImplementedError
+    end
+  end
+end

data/lib/vh/hosts_config.rb

@@ -0,0 +1,47 @@
+require "vh/base_config"
+
+module Vh
+  # Hosts aliases configuration manager
+  class HostsConfig < BaseConfig
+    DEFAULT_CONFIG_PATH = '/etc/hosts'
+
+    # Initializes a new instance of this class.
+    #
+    # @param [String] hostname    The hostname to be added.
+    # @param [String] ip          The IP address to use (optional, defaults to `'127.0.0.1'`).
+    # @param [String] config_path The path to the configuration path (optional, defaults to `DEFAULT_CONFIG_PATH`).
+    def initialize(hostname, ip = '127.0.0.1', config_path = DEFAULT_CONFIG_PATH)
+      @hostname    = hostname
+      @ip_address  = ip
+      @config_path = config_path
+    end
+
+    # Performs any necessary checks prior to modifying the configuration file
+    # and returns a `Boolean` value indicating whether the checks were successful or not.
+    #
+    # @return [Boolean]
+    def check?
+      # Check if the configuration file is writable
+      unless check_writable?
+        puts "You don't have the required permissions to modify hosts configuration file."
+        return false
+      end
+
+      # Check if there is not already a host defined with the same name
+      unless check_content? /\W#{@hostname}\W/i
+        puts "There already is a host named '#{@hostname}'."
+        return false
+      end
+
+      # Success! :)
+      return true
+    end
+
+    # Generates the new content that will be appended to the configuration file.
+    #
+    # @return [String]
+    def new_config_content
+      return "\n#{@ip_address} #{@hostname} # vh"
+    end
+  end
+end

data/lib/vh/version.rb

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

data/vh.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vh/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vh"
+  gem.version       = Vh::VERSION
+  gem.authors       = ["José Nahuel Cuesta Luengo"]
+  gem.email         = ["nahuelcuestaluengo@gmail.com"]
+  gem.description   = %q{CLI tool for managing Virtual Hosts on a local environment.}
+  gem.summary       = %q{Virtual Hosts manager.}
+  gem.homepage      = "https://ncuesta.github.com/vh"
+
+  gem.add_development_dependency "rspec"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/vh.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+##
+# vh.rb
+# Add virtual hosts to the apache configuration and the hosts file.
+#
+# Copyright (c) 2012 José Nahuel Cuesta Luengo
+##
+
+require 'pathname'
+
+# Validate required arguments
+if ARGV.length < 2
+  puts 'Missing arguments.'
+  puts 'Usage:'
+  puts '  vh.rb path hostname'
+  exit 1
+end
+
+path = Pathname.new(ARGV[0]).realpath
+server_name = ARGV[1]
+
+# Check the validity of path
+if not File.directory? path
+  puts "'#{path}' is not a valid path. Please correct that and try again."
+  exit 2
+end
+
+# Check if the server is not already defined
+vhosts_path = '/etc/apache2/extra/httpd-vhosts.conf'
+add = true
+open vhosts_path do | f |
+  if f.grep(/ServerName\s+"#{server_name}"/i).length > 0
+    puts "There already exists a server named '#{server_name}' in the virtual hosts file. Skipping..."
+    add = false
+  end  
+end
+
+# Append the vhost to the vhosts file
+if add
+  puts 'Adding virtual host to the virtual hosts file...'
+  open vhosts_path, 'a+' do | f |
+    f.puts <<-VHOST
+
+# vh - #{server_name}
+<Directory "#{path}">
+  Allow From All
+  AllowOverride All
+</Directory>
+<VirtualHost *:80>
+	ServerName "#{server_name}"
+	DocumentRoot "#{path}"
+</VirtualHost>
+# /vh - #{server_name}
+VHOST
+  end
+  puts 'Done'
+end
+
+# Append the new host to the hosts file
+hosts_path = '/etc/hosts'
+add = true
+open hosts_path do | f |
+  if f.grep(/\W#{server_name}\W/i).length > 0
+    puts "There is already a host named '#{server_name}'. Skipping..."
+    add = false
+  end
+end
+
+if add
+  puts 'Adding host alias to hosts file...'
+  open hosts_path, 'a+' do | f |
+    f.puts <<-HOST
+127.0.0.1 #{server_name} # vh
+HOST
+  end
+  puts 'Done'
+end
+
+# Restart apache
+puts 'Restarting apache...'
+system 'apachectl restart'
+puts 'Done'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: vh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- José Nahuel Cuesta Luengo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !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: CLI tool for managing Virtual Hosts on a local environment.
+email:
+- nahuelcuestaluengo@gmail.com
+executables:
+- vh
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/vh
+- lib/vh.rb
+- lib/vh/apache_config.rb
+- lib/vh/apache_handler.rb
+- lib/vh/base_config.rb
+- lib/vh/hosts_config.rb
+- lib/vh/version.rb
+- vh.gemspec
+- vh.rb
+homepage: https://ncuesta.github.com/vh
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Virtual Hosts manager.
+test_files: []