cheese 0.0.1 → 0.0.2

data/README.txt

@@ -1,6 +1,6 @@
 == Cheese
   
-Cheese is a set of ruby scripts supplied with all Candid Mush 
+Cheese is a set of ruby scripts supplied with all Written Path 
 Virtual Cheesey Servers but available to all under the MIT license.  
 They reduce the steps needed to administrate a web server.
 

data/lib/cheese/version.rb

@@ -2,7 +2,7 @@ module Cheese #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/controller.rb

@@ -119,7 +119,7 @@ private
           end
         else
           Cheese::Verbose.log_task("create the mongrel_cluster file") do
-            Cheese::Mongrel.create(@added_domain.host, @added_domain.proxy.ports)
+            Cheese::Mongrel.create(@options[:name], @added_domain.proxy.ports)
           end
         end
       end

data/lib/database/mysql.rb

@@ -1,13 +1,10 @@
-# mysql.rb
-#
-# Create and remove mysql databases
-#
-
 require 'highline/import'
 require 'tempfile'
 
 module Cheese
-  
+  #
+  # Create and remove mysql databases
+  #
   class Mysql
     
     # create a user and new db

data/lib/database/postgresql.rb

@@ -1,10 +1,7 @@
-# postgresql.rb
-#
-# Create and remove postgresql databases
-#
-
 module Cheese
-  
+  #
+  # Create and remove postgresql databases
+  #
   class Postgresql
     SILENCER = ">/dev/null 2>/dev/null"
     

data/lib/process.rb

@@ -1,8 +1,5 @@
-# process.rb
-#
 # Run a process as a different user
 # Thanks to the "Ruby Cookbook" for this one
-
 module Process
   def as_uid(uid=0)
     old_euid, old_uid = Process.euid, Process.uid

data/lib/scm/subversion.rb

@@ -1,16 +1,19 @@
-# subversion.rb
-#
-# Acts as a subversion repository
-# This could be done with the svn ruby bindings, but it's simple
-# stuff that for now will be fine using system
-
 require 'fileutils'
 
 module Cheese
   module Subversion
+    #
+    # Represents the a subversion repository
+    # This could be done with the svn ruby bindings, but it's simple
+    # stuff that for now will be fine using system
+    #
     class Repository
       DEFAULT_ACCESS = { :anon => :none, :auth => :write }
       SILENCER = ">/dev/null 2>/dev/null"
+      
+      # Create a Subversion repository for the given name this 
+      # calls create_tmp_structure to give the tags, branches and trunk
+      # directories
       def self.create(name)
         # Create the repo
         %x{ svnadmin create /var/src/#{name} #{SILENCER} }

data/lib/verbose.rb

@@ -1,9 +1,7 @@
-# verbose.rb
-#
-# This performs tasks and spits out status depending on whether you want verbose
-#
-
 module Cheese
+  #
+  # This is a wrapper around actions that can be taken, it allows you 
+  # to control the verbosity and also 'fake' an action on a dry run.
   class Verbose
     @@loud    = false
     @@dry_run = false

data/lib/web/domain.rb

@@ -1,10 +1,8 @@
-# domain.rb
-#
-# Represents an nginx domain, which encompasses the vhost and proxies
-#
-
 module Cheese
   module Nginx
+    #
+    # Represents an nginx domain, which encompasses the vhost and proxies
+    #
     class Domain
       attr_reader :vhost, :proxy, :host
     

data/lib/web/mongrel.rb

@@ -1,15 +1,13 @@
-# mongrel.rb
-#
-# deals with mongrel cluster files and saves them as temp files and filename
-#
-
 require 'tmpdir'
 
 module Cheese
-  
+  #
+  # Representing the Mongrel cluster config file, this will be expanded/refactored 
+  # to include controlling mongrel too
   class Mongrel
     
-    # Create a temp file in the tmp dir which has the right config for the given host and ports
+    # Create a temp file which has the right config for the given host and ports
+    # and import it into the Subversion repository for this domain
     def self.create(host, ports)
       mongrel_text = IO.read(File.dirname(__FILE__) + "/../../data/templates/mongrel.inc")
       count = ports.size
@@ -20,7 +18,7 @@ module Cheese
       Cheese::Subversion::Repository.import(host, File.join(Dir.tmpdir, "/config"), "/trunk/config")
     end
     
-    # currently just deletes the file, it doesn't do subversion stuff as yet
+    # Requests that Subversion deletes the given config file for a host
     def self.remove(host)
       Cheese::Subversion::Repository.remove_file(host, "/config/mongrel_cluster.yml")
     end

data/lib/web/nginx.rb

@@ -5,6 +5,9 @@
 
 module Cheese
   module Nginx
+    
+    # Represents the Nginx config file, giving the ability to manipulate
+    # the VHosts within it, and save changes.
     class Config
       attr_reader :filename
       attr_accessor :domains
@@ -30,6 +33,7 @@ module Cheese
         find_domains
       end
       
+      # Add a virtual host to the Nginx config file
       def add(options={})
         domain = options[:name]
         return false if domain.nil?
@@ -43,7 +47,8 @@ module Cheese
         @domains << new_domain
         return new_domain
       end
-    
+      
+      # Remove a virtual host from the Nginx config file
       def remove(object)
         if object.is_a? Cheese::Nginx::VirtualHost
           @vhosts.delete(object) 
@@ -56,12 +61,15 @@ module Cheese
           return object[:name]
         end
       end
-    
+      
+      # Replace a virtual host in the Nginx config file
       def replace(options={})
         self.remove options[:name]
         self.add options
       end
-    
+      
+      # Save any changes made to the Nginx config file, this has to specifically called
+      # to be sure it's not accidentally called
       def save
         # self.as_www do
           Cheese::Verbose.log_task "Saving #{@domains.size} domains"
@@ -90,18 +98,21 @@ module Cheese
         Cheese::Verbose.log_task "Saved #{@filename}"
       end
       
+      # Stop the Nginx server
       def stop
         Cheese::Verbose.log_task "Stop nginx server" do
           %x{ /etc/init.d/nginx stop }
         end
       end
       
+      # Start the Nginx server
       def start
         Cheese::Verbose.log_task "Start nginx server" do
           %x{ /etc/init.d/nginx start }
         end
       end
       
+      # Restart the Nginx server
       def restart
         Cheese::Verbose.log_task "Restart nginx server" do
           %x{ /etc/init.d/nginx restart }

data/lib/web/proxy.rb

@@ -1,10 +1,8 @@
-# proxy.rb
-#
-# Represents the proxies to external processes that a vhost requires
-#
-
 module Cheese
   module Nginx
+    #
+    # Represents the proxies to external processes that a vhost requires
+    #
     class Proxy
       attr_reader :domain, :ports, :config
   

data/lib/web/virtual_host.rb

@@ -1,10 +1,8 @@
-# virtual_host.rb
-#
-# Represents a vhost in an nginx config file
-#
-
 module Cheese
   module Nginx
+    #
+    # Represents a vhost in an nginx config file
+    #
     class VirtualHost
       attr_reader :domain, :config
   

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: cheese
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 date: 2007-04-17 00:00:00 +01:00
 summary: Automate the creation of web applications and accompanying pieces e.g. Nginx, Subversion, Mongrel, Monit, S3.
 require_paths: