capitate 0.1.7 → 0.1.8

data/Capfile

@@ -7,18 +7,10 @@ load 'deploy' if respond_to?(:namespace) # cap2 differentiator
 require 'lib/capitate'
 
 # Load recipes
-Dir["lib/recipes/**/*.rb"].each { |recipe| load recipe }
+require 'lib/capitate/recipes'
 
 require 'erb'
 
-# This should be overriden by project specific Capfile
-set :user, Proc.new { Capistrano::CLI.ui.ask('Bootstrap user: ') }
 
-# Roles
-role :base, Capistrano::CLI.ui.ask('Server: ')
-
-# Choose a profile
-set :profile, Proc.new { load profile.choose }
-
-# Reset the password var
-reset_password
+set :recipes_run, [ "centos:setup_for_web", "packages:install", "ruby:centos:install" ]
+set :user, "root"

data/History.txt

@@ -1,4 +1,11 @@
-== 0.1.5 ?
+== 0.1.8 2008-02-22
+
+* Fixing up documentation
+* Creating recipe documentation recipe
+* New website generation
+* Moved some recipes around
+
+== 0.1.7 2008-02-21
 
 * Renamed to 'capitate'
 * Moving centos specific recipes into separate namespace

data/Manifest.txt

@@ -11,7 +11,6 @@ lib/capitate.rb
 lib/capitate/cap_ext/connections.rb
 lib/capitate/cap_ext/extension_proxy.rb
 lib/capitate/cap_ext/variables.rb
-lib/capitate/config.rb
 lib/capitate/plugins/base.rb
 lib/capitate/plugins/gem.rb
 lib/capitate/plugins/package.rb
@@ -21,21 +20,8 @@ lib/capitate/plugins/templates.rb
 lib/capitate/plugins/wget.rb
 lib/capitate/plugins/yum.rb
 lib/capitate/recipes.rb
+lib/capitate/task_node.rb
 lib/capitate/version.rb
-lib/doc/centos/memcached.yml
-lib/doc/centos/mongrel_cluster.yml
-lib/doc/centos/monit.yml
-lib/doc/centos/mysql.yml
-lib/doc/centos/nginx.yml
-lib/doc/centos/sphinx.yml
-lib/doc/gems.yml
-lib/doc/install.yml
-lib/doc/memcached.yml
-lib/doc/mongrel_cluster.yml
-lib/doc/mysql.yml
-lib/doc/nginx.yml
-lib/doc/packages.yml
-lib/doc/rails.yml
 lib/profiles/centos-sick.rb
 lib/recipes/README
 lib/recipes/centos/README
@@ -49,14 +35,15 @@ lib/recipes/centos/nginx.rb
 lib/recipes/centos/ruby.rb
 lib/recipes/centos/sphinx.rb
 lib/recipes/deploy.rb
+lib/recipes/docs.rb
 lib/recipes/gems.rb
-lib/recipes/install.rb
 lib/recipes/memcached.rb
 lib/recipes/mongrel_cluster.rb
 lib/recipes/mysql.rb
 lib/recipes/nginx.rb
 lib/recipes/packages.rb
 lib/recipes/rails.rb
+lib/recipes/recipes.rb
 lib/recipes/sphinx.rb
 lib/templates/capistrano/Capfile
 lib/templates/centos/setup_for_web.sh
@@ -86,7 +73,6 @@ script/destroy
 script/generate
 script/txt2html
 setup.rb
-tasks/capitate.rake
 tasks/deployment.rake
 tasks/environment.rake
 tasks/website.rake
@@ -98,3 +84,4 @@ website/index.txt
 website/javascripts/rounded_corners_lite.inc.js
 website/stylesheets/screen.css
 website/template.rhtml
+website/template_recipe.rhtml

data/bin/capitate

@@ -1,5 +1,23 @@
 #!/usr/bin/env ruby
-APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
 
 begin
   require 'capitate'
@@ -8,19 +26,6 @@ rescue LoadError
   require 'capitate'
 end
 
-def usage
-  puts <<-EOS
-  
-    Capitate your project.
-    
-    Usage:
-    
-      #{$0} bootstrap
-    
-  EOS
-    
-  exit 1
-end
 
 class CapitateBin
   class << self
@@ -28,19 +33,46 @@ class CapitateBin
   end
 end
 
+if ARGV.empty?
+  abort "Please specify the directory to capify, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capitate."
+end
+
+base = ARGV.shift
+
 puts <<-EOS
 
   Generating capistrano configuration...
-  
+
 EOS
-  
-# Write Capfile
-CapitateBin.write("capistrano/Capfile", "Capfile")
+
+files = { "Capfile" => "capistrano/Capfile" }
+
+files.each do |file, template|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "`#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "`#{file.downcase}' exists, which could conflict with `#{file}'"
+  elsif !File.exists?(File.dirname(file))
+    warn "Directory `#{File.dirname(file)}' does not exist"
+  else
+    # Write Capfile
+    CapitateBin.write(template, file)
+  end
+end
 
 puts <<-EOS
 
   You now need to create and set you deployment "profile" in the Capfile.
   This is currently a manual process, see the documentation on profiles 
   for more information.
-  
+
 EOS
+
+

data/config/hoe.rb

@@ -2,7 +2,7 @@ require 'capitate/version'
 
 AUTHOR = 'Gabriel Handford'  # can also be an array of Authors
 EMAIL = "gabrielh@gmail.com"
-DESCRIPTION = "Capistrano recipe library for all types of remote tasks."
+DESCRIPTION = "Capistrano recipes, plugins and templates."
 GEM_NAME = 'capitate' # what ppl will type to install your gem
 RUBYFORGE_PROJECT = 'capitate' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
@@ -55,10 +55,12 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
   p.test_globs = ["test/**/test_*.rb"]
   p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  p.clean_globs += ['website/recipes/**', 'docs/recipes/**']
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [ [ "capistrano", ">=2.1.0" ] ]
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   

data/lib/capitate/plugins/base.rb

@@ -4,7 +4,8 @@ require 'yaml'
 # Capitate base capistrano plugin
 module Capitate::Plugins::Base
   
-  # Project root
+  # Project root. Fetch from :project_root, or fall back to RAILS_ROOT.
+  #
   def root
     if respond_to?(:fetch)
       return fetch(:project_root)
@@ -13,7 +14,16 @@ module Capitate::Plugins::Base
     end
   end
     
-  # Path relative to project root
+  # Path relative to project root.
+  # Project root is set via, set :project_root, "path/to/project" in Capfile.
+  #
+  # ==== Options
+  # +path+:: Relative path
+  # +check_exist+:: Whether to check its existence and throw error if not found
+  #
+  # ==== Examples
+  #   relative_to_root("config/foo.yml") => "path/to/project/config/foo.yml"
+  #
   def relative_to_root(path = nil, check_exist = false)
     if path
       root_path = File.join(root, path)
@@ -33,52 +43,88 @@ module Capitate::Plugins::Base
     end
     
     root_path
-  end  
+  end    
   
-  # Documentation (yaml) for current task (namespace).
-  # 
-  # ==== Examples
-  #   capitate.current_task_docs => { "task_name" => { "variable" => "The usage docs" } }
-  #
-  def current_task_doc
-    path = File.dirname(__FILE__) + "/../../doc/" + current_task.namespace.fully_qualified_name.to_s.gsub(":", "/") + ".yml"
-    puts "Current task doc: #{path}"
-    return YAML.load_file(path) if File.exist?(path)
-    nil
-  end
-  
-  # Usage for variable from current task documentation.
+  # Usage for current task.
   #
   # ==== Options
-  # +var+:: Variable
-  # 
+  # +variable+:: Missing variable setting
+  #
   # ==== Examples
-  #   usage(:gem_list) => "The usage for gem_list variable from the doc/the_namespace.yml file."
+  #   usage(:gem_list) => "Description from task definition."
   # 
-  def usage(var)
-    task_doc = current_task_doc
-    task_name = current_task.name.to_s
-    var_name = var.to_s
-    if task_doc and task_doc.has_key?(task_name)    
-      var_usage = task_doc[task_name][var_name] 
-      return <<-EOS
-      
-      Please set :#{var_name} variable in your Capfile, deploy.rb or profile.
-      
-      Usage: 
-      
-#{indent_doc(var_usage)}
-      
+  def usage(variable = nil)
+    message = ""
+    
+    if variable
+      message += <<-EOS
+    
+      Error: :#{variable} not set.    
       EOS
     end
+    
+    message += <<-EOS
+    
+    Usage: 
+    
+#{indent_doc(current_task.desc)}
+    
+    EOS
   end
   
-  
-  def indent_doc(s, amount = 8)
+  # Indent string block.
+  #
+  # ==== Options
+  # +s+:: String block
+  # +amount+:: Amount to indent
+  #
+  def indent_doc(s, amount = 4)
     return nil if s.blank?
     indentation = (0..amount).collect { |n| " " }.join
     s.split("\n").collect { |sp| "#{indentation}#{sp}"}.join("\n")
   end
+  
+  # Unindent, lifted from capistrano bin/capify
+  def unindent(string)
+    return "" if string.blank?
+    if string =~ /\A(\s*)/
+      amount = $1.length
+      return string.strip.gsub(/^#{$1}/, "")
+    end
+    string
+  end  
+  
+  # Load all tasks
+  def load_all_tasks
+    tasks = []
+    top.namespaces.each do |namespace|
+      load_tasks(namespace, tasks)
+    end
+    tasks
+  end
+  
+  def task_tree
+    top_node = Capitate::TaskNode.new("top")
+    
+    load_all_tasks.each do |task|
+      Capitate::TaskNode.populate_with_task(top_node, task)
+    end
+    top_node
+  end
+
+protected
+  
+  def load_tasks(namespace, tasks = [])    
+    recipe = namespace.last
+    
+    recipe.namespaces.each do |nested_namespace|
+      load_tasks(nested_namespace, tasks)
+    end
+    
+    recipe.task_list.each do |task|
+      tasks << task
+    end
+  end
     
 end
 

data/lib/capitate/recipes.rb

@@ -1,5 +1,4 @@
-# Load recipes
-# This is only loadable from within Capistrano
+# Load recipes.
 recipes = Dir[File.dirname(__FILE__) + "/../recipes/**/*.rb"].collect { |recipe| File.expand_path(recipe) }
 recipes.each do |recipe|
   Capistrano::Configuration.instance.load recipe

data/lib/capitate/task_node.rb

@@ -0,0 +1,157 @@
+# TODO: Document this class
+class Capitate::TaskNode
+  
+  include Capitate::Plugins::Base
+  
+  attr_reader :name, :nodes, :tasks, :parent
+    
+  def initialize(name, parent = nil)
+    @name = name
+    @parent = parent
+    @nodes = []
+    @tasks = []
+  end
+  
+  def add_node(task_node)
+    @nodes << task_node
+  end
+  
+  def find(name)
+    @nodes.each do |node| 
+      return node if node.name == name
+    end
+    nil
+  end
+  
+  def add_task(task)
+    @tasks << task
+  end
+  
+  def sorted_nodes
+    nodes.sort_by(&:name)
+  end
+  
+  # Depth first iteration
+  def each_node(level = 0, &block)
+    sorted_nodes.each do |node|
+      yield(node, level)
+      node.each_node(level + 1, &block)
+    end
+  end
+  
+  def full_name(delimeter = "-")
+    if parent
+      parent_name = parent.full_name
+      return [ parent_name, name ].compact.join(delimeter)
+    end
+    
+    # Return nil for top node
+    name == "top" ? nil : name
+  end
+  
+  # Write doc for node (recursively)
+  def write_doc(dir, file_name = nil, title = nil, options = {}, &block)
+    
+    file_name ||= full_name
+    title ||= full_name(":")
+    
+    path = "#{dir}/#{file_name}.txt"
+    puts "%10s %-30s" % [ "create", path ]
+    
+    File.open(path, "w") do |file|
+      file.puts "h1. #{title}\n\n"      
+      
+      #
+      # Breadcrumb generate
+      #
+      bc_full_name = full_name(":")
+      links = []
+      if bc_full_name
+        names = bc_full_name.split(":")
+        links << " #{names.pop} " # Pop off current
+        
+        while(!names.empty?) do          
+          links << %{ "#{names.last}":#{names.join("-")}.html }
+          names.pop
+        end
+      end
+      # Write breadcrumb
+      file.puts %{ "home":../index.html > "recipes":index.html > #{links.reverse.join(" > ")} }
+    
+      #
+      # Namespace
+      #
+      unless sorted_nodes.empty?
+        file.puts "h2. Namespaces\n\n"
+        each_node do |snode, level|
+          li_level = (0..level).collect { "*" }.join
+          file.puts %{#{li_level} "#{snode.full_name(":")}":#{snode.full_name}.html \n}                  
+        end        
+      end
+      
+      #
+      # Tasks
+      #
+      unless tasks.empty?
+        file.puts "\n\n"
+        file.puts "h2. Tasks\n\n"        
+        tasks.each do |task|
+          file.puts "h3. #{task.fully_qualified_name}\n\n"
+          file.puts "#{unindent(task.desc)}\n\n\n\n"
+        end
+      end
+      
+      #
+      # Write doc (recursively for "child" namespace)
+      sorted_nodes.each do |snode|
+        snode.write_doc(dir)
+      end
+      
+      # If block then let it do stuff with open file
+      if block_given?
+        file.puts "\n\n"
+        yield(file) 
+      end      
+    end
+  end
+  
+  def to_s(level = 0)
+    spaces = "     "
+    indent = (0...level).collect { spaces }.join("") 
+    
+    # Ignore top node (level = -1)
+    if level >= 0
+      t_indent = "\n#{indent} #{spaces} - "
+      task_names = tasks.collect(&:name).sort_by(&:to_s).join(t_indent)
+      s = "#{indent} -- #{name}:#{t_indent}#{task_names}\n"
+    else
+      s = ""
+    end
+    
+    sorted_nodes.each do |node|    
+      s += node.to_s(level + 1)
+    end
+    s
+  end
+      
+  class << self
+    
+    def populate_with_task(top_node, task)
+      node_names = task.namespace.fully_qualified_name.split(":")
+      
+      node = top_node
+      
+      node_names.each do |name|
+        parent_node = node
+        node = parent_node.find(name)
+        if !node
+          node = self.new(name, parent_node)
+          parent_node.add_node(node)
+        end
+      end
+      node.add_task(task)      
+    end
+  
+  end
+end
+  

data/lib/capitate/version.rb

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

data/lib/capitate.rb

@@ -30,3 +30,5 @@ class Capistrano::Configuration
   include Capitate::CapExt::Variables
 end
 
+require 'capitate/task_node'
+

data/lib/profiles/centos-sick.rb

@@ -2,23 +2,20 @@
 # This is an EXAMPLE profile.
 #
 # Profile for sick rails app on centos 5.1
-# Profiles are basically a beefed up deploy.rb
 #
 
 set :description, "Sick project deployment for centos 5.1 image"
 
-#set :install_user, "root"
-
-set :recipes, [ 
+set :recipes_run, [ 
   "centos:setup_for_web",
   "packages:install",
-  "centos:ruby:install", 
-  "centos:nginx:install", 
-  "centos:mysql:install", 
-  "centos:sphinx:install", 
-  "centos:monit:install",
-  "centos:imagemagick:install", 
-  "centos:memcached:install", 
+  "ruby:centos:install", 
+  "nginx:centos:install", 
+  "mysql:centos:install", 
+  "sphinx:centos:install", 
+  "monit:centos:install",
+  "imagemagick:centos:install", 
+  "memcached:centos:install", 
   "nginx:install_monit",   
   "mysql:install_monit",     
   "memcached:install_monit", 
@@ -75,7 +72,7 @@ set :memcached_port, 11211
 
 
 #
-# Settings for generating project Capfile
+# Settings for project
 #
 
 set :application, "sick"
@@ -84,7 +81,7 @@ set :deploy_to, "/var/www/apps/sick"
 set :web_host, "WEB_HOST"
 set :db_host, "DB_HOST"
 set :db_user, "sick"
-set :db_pass, ""
+set :db_pass, "sick"
 set :db_name, "sick"
 # db_port set already
 set :sphinx_host, "SPHINX_HOST"
@@ -99,14 +96,19 @@ set :deploy_via, :copy
 set :copy_strategy, :export
 
 role :web, "WEB_URL"
-role :db,  "DB_URL", :primary => true
+role :db, "DB_URL", :primary => true
 
 
 # Callbacks 
 before "deploy:setup", "centos:add_user_for_app"
 
-after "deploy:setup", "mysql:setup", "rails:setup", "mongrel_cluster:setup_monit", 
-  "nginx:setup_mongrel", "centos:sphinx:setup"
+after "deploy:setup", "mysql:setup", "rails:setup", "mongrel_cluster:centos:setup",
+  "nginx:setup_mongrel", "sphinx:centos:setup"
+  
+after "sphinx:centos:setup", "sphinx:setup_monit"
+after "mongrel_cluster:centos:setup", "mongrel_cluster:setup_monit"
+
+after "nginx:setup_mongrels", "nginx:centos:restart"
 
 after "deploy:update_code", "rails:update_code", "sphinx:update_code"
 

data/lib/recipes/centos/imagemagick.rb

@@ -1,6 +1,7 @@
-namespace :centos do 
-  namespace :imagemagick do
+namespace :imagemagick do 
+  namespace :centos do
   
+    desc "Install imagemagick"
     task :install do
       
       # Install dependencies

data/lib/recipes/centos/memcached.rb

@@ -1,8 +1,23 @@
-namespace :centos do 
+namespace :memcached do 
   
-  namespace :memcached do
+  namespace :centos do
     
-    desc "Install memcached"
+    desc <<-DESC
+    Install memcached.
+    
+    memcached_memory: Memcached memory (in MB).
+    
+      set :memcached_memory, 64
+
+    memcached_pid_path: Path to memcached pid file. Defaults to /var/run/memcached.pid
+    
+      set :memcached_pid_path, "/var/run/memcached.pid"
+
+    memcached_port: Memcached port. Defaults to 11211.
+    
+      set :memcached_port, 11211
+      
+    DESC
     task :install do
 
       # Settings

data/lib/recipes/centos/mongrel_cluster.rb

@@ -1,12 +1,22 @@
-namespace :centos do 
+namespace :mongrel_cluster do 
   
-  namespace :mongrel_cluster do
+  namespace :centos do
     
-    after "centos:mongrel_cluster:setup", "mongrel_cluster:setup_monit"  
+    desc <<-DESC
+    Create mongrel cluster.
     
-    desc "Create mongrel cluster"
-    task :setup do 
+    mongrel_size: Number of mongrels.
+    
+      set :mongrel_size, 3
+
+    mongrel_port: Starting port for mongrels. If there are 3 mongrels with port 9000, then instances will be at 
+      9000, 9001, and 9002
       
+      set :mongrel_port, 9000      
+      
+    DESC
+    task :setup do 
+
       # Settings
       fetch(:mongrel_size)
       fetch(:mongrel_port)