vh 0.0.3 → 0.0.4

data/README.md

@@ -3,6 +3,14 @@
 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.
 
+**This is currently a WIP so things will not likely work** :)
+
+## Prerequisites
+
+Add this line to your `/etc/apache2/httpd.conf`:
+
+    Include /etc/apache2/extra/httpd-vhosts.conf
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -49,4 +57,4 @@ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIG
 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/bin/vh

@@ -5,9 +5,25 @@ require "pathname"
 
 # Validate required arguments
 if ARGV.length < 2
-  puts 'Missing arguments.'
-  puts 'Usage:'
-  puts '  vh path hostname'
+  puts <<-HELP
+You seem to have missed some arguments.
+Here is a simple usage section for you to enjoy:
+
+    #{$0} PATH HOSTNAME
+
+Where:
+    - PATH:     Is a filesystem path (relative or absolute) to the web root.
+    - HOSTNAME: Is the hostname that you'll use to access the web.
+
+For instance, executing:
+
+    #{$0} ./web my.nifty.server
+
+Will create a new web root at ./web that will be accessed
+via http://my.nifty.server/
+
+  HELP
+
   exit 1
 end
 

data/lib/vh.rb

@@ -1,3 +1,4 @@
+require "vh/apache_installer"
 require "vh/apache_config"
 require "vh/hosts_config"
 require "vh/apache_handler"
@@ -14,6 +15,9 @@ module Vh
   #
   # @return [Vh]
   def self.add(path, hostname)
+    # Check and install if necessary the configuration on the web server
+    self.install
+
     # Add the host to the Apache configuration
     apache_config = ApacheConfig.new path, hostname
     apache_config.run
@@ -28,4 +32,17 @@ module Vh
 
     return self
   end
-end
+
+  # Installs - if necessary - the initial configuration needed
+  # for the Virtual Hosts to be properly included in the Apache
+  # configuration.
+  #
+  # @return [Vh]
+  def self.install
+    # Install the Apache configuration include
+    apache_installer = ApacheInstaller.new
+    apache_installer.run
+
+    return self
+  end
+end

data/lib/vh/apache_config.rb

@@ -30,7 +30,7 @@ module Vh
 
       # Check if the configuration file is writable
       unless check_writable?
-        puts "The Apache configuration file is not writable by the current user."
+        puts "The Apache configuration file (#{@config_path}) is not writable by the current user."
         return false
       end
 

data/lib/vh/apache_installer.rb

@@ -0,0 +1,57 @@
+require "vh/base_config"
+require "vh/apache_config"
+
+module Vh
+  # Apache installation manager
+  class ApacheInstaller < BaseConfig
+    DEFAULT_CONFIG_PATH = "/etc/apache2/httpd.conf"
+
+    # Initializes a new instance of this class.
+    #
+    # @param [String] target_path The path to the vh configuration file that will be included by Apache.
+    # @param [String] config_path The path to the configuration path (optional, defaults to `DEFAULT_CONFIG_PATH`).
+    def initialize(target_path = ApacheConfig::DEFAULT_CONFIG_PATH, config_path = DEFAULT_CONFIG_PATH)
+      @target      = Pathname.new(target_path).realpath.to_s
+      @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 path exists and is a file
+      unless File.exists? @config_path
+        puts "#{@config_path} is not a valid path."
+        return false
+      end
+
+      # Check if the configuration file is writable
+      unless check_writable?
+        puts "The Apache configuration file (#{@config_path}) 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? /^\s*Include\s+#{@target}$/i
+        puts "The target configuration file (#{@target}) is already being included by Apache."
+        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 configuration file
+Include #{@target}
+# /vh configuration file
+      VHOST
+    end
+  end
+end

data/lib/vh/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,6 +44,7 @@ files:
 - lib/vh.rb
 - lib/vh/apache_config.rb
 - lib/vh/apache_handler.rb
+- lib/vh/apache_installer.rb
 - lib/vh/base_config.rb
 - lib/vh/hosts_config.rb
 - lib/vh/version.rb