capitate 0.1.8 → 0.1.9

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.9 2008-02-23
+
+* Adding config_script to mongrel_cluster recipe
+* Creating upload plugin that streams data
+
 == 0.1.8 2008-02-22
 
 * Fixing up documentation

data/Manifest.txt

@@ -17,6 +17,7 @@ lib/capitate/plugins/package.rb
 lib/capitate/plugins/profiles.rb
 lib/capitate/plugins/script.rb
 lib/capitate/plugins/templates.rb
+lib/capitate/plugins/upload.rb
 lib/capitate/plugins/wget.rb
 lib/capitate/plugins/yum.rb
 lib/capitate/recipes.rb
@@ -77,6 +78,7 @@ tasks/deployment.rake
 tasks/environment.rake
 tasks/website.rake
 test/test_helper.rb
+test/test_plugin_upload.rb
 test/test_recipes.rb
 test/test_templates.rb
 website/index.html

data/lib/capitate/plugins/base.rb

@@ -1,3 +1,10 @@
+#--
+# =============================================================================
+# Copyright (c) 2007, Gabriel Handford (gabrielh@gmail.com)
+# All rights reserved.
+# =============================================================================
+#++
+
 require 'erb'
 require 'yaml'
 

data/lib/capitate/plugins/upload.rb

@@ -0,0 +1,58 @@
+module Capitate::Plugins::Upload
+  
+  # Upload file with source path.
+  # Data is streamed.
+  #
+  # ==== Options
+  # +src_path+:: Source path
+  # +dest_path:: Remote destination path
+  # +options+:: Options (see capistrano 'put')
+  #
+  def file(src_path, dest_path, options = {})
+    data = FileData.new(src_path)
+    put(data, dest_path, options)    
+  end
+    
+  # Stream data with Net::SFTP by looking like an Array
+  class FileData
+    
+    def initialize(path)
+      @path = path
+      @next_start = 0
+    end
+    
+    def [](start, length)
+      
+      if start != @next_start
+        raise <<-EOS
+        
+        Can only access data sequentially; so we can stream it (The next start position should have been: #{@next_start})
+        
+        EOS
+      end
+      
+      data = file.read(length)
+      
+      @next_start = start + length
+      close if @next_start >= self.length
+        
+      data
+    end
+    
+    def length
+      @file_size ||= File.size(@path)
+    end
+    
+    def file
+      @file ||= File.open(@path, "r")
+    end
+    
+    def close
+      @file.close if @file
+    end
+    
+  end
+  
+end
+  
+Capistrano.plugin :upload, Capitate::Plugins::Upload

data/lib/capitate/task_node.rb

@@ -1,10 +1,18 @@
-# TODO: Document this class
+# Task node in the capistrano namespace, task hierarchy.
+#
 class Capitate::TaskNode
   
   include Capitate::Plugins::Base
   
   attr_reader :name, :nodes, :tasks, :parent
-    
+
+  # Create task node with name and parent
+  # For root not use name = "top"
+  #
+  # ==== Options
+  # +name+:: Node name (namespace name)
+  # +parent+:: Parent node
+  #
   def initialize(name, parent = nil)
     @name = name
     @parent = parent
@@ -12,10 +20,20 @@ class Capitate::TaskNode
     @tasks = []
   end
   
+  # Add "child" node.
+  #
+  # ==== Options
+  # +task_node+:: Node
+  #
   def add_node(task_node)
     @nodes << task_node
   end
   
+  # Find node with name (namespace).
+  #
+  # ==== Options
+  # +name+:: Name to look for
+  #
   def find(name)
     @nodes.each do |node| 
       return node if node.name == name
@@ -23,15 +41,27 @@ class Capitate::TaskNode
     nil
   end
   
+  # Add task to this node.
+  #
+  # ==== Options
+  # +task+:: Add task associated with this node (namespace).
+  #
   def add_task(task)
     @tasks << task
   end
   
+  # Get "child" nodes (sorted).
+  #
   def sorted_nodes
     nodes.sort_by(&:name)
   end
   
-  # Depth first iteration
+  # Iterate over ALL "child" nodes, depth first.
+  # Yields |node, level|.
+  #
+  # ==== Options
+  # +level+:: Current level
+  #
   def each_node(level = 0, &block)
     sorted_nodes.each do |node|
       yield(node, level)
@@ -39,6 +69,14 @@ class Capitate::TaskNode
     end
   end
   
+  # Get the full name, using delimeter
+  #
+  # ==== Options
+  # +delimeter+:: Delimeter
+  #
+  # ==== Examples
+  #   node.full_name(":") => "mysql:centos"  # On node mysql centos node (top -> mysql -> centos)
+  #
   def full_name(delimeter = "-")
     if parent
       parent_name = parent.full_name
@@ -50,6 +88,13 @@ class Capitate::TaskNode
   end
   
   # Write doc for node (recursively)
+  #
+  # ==== Options
+  # +dir+:: Dir to write to
+  # +file_name+:: File name to write to, defaults to full name
+  # +title+:: Title and h1 for page, defaults to name
+  # +options+:: Options
+  #
   def write_doc(dir, file_name = nil, title = nil, options = {}, &block)
     
     file_name ||= full_name
@@ -115,6 +160,8 @@ class Capitate::TaskNode
     end
   end
   
+  # Node to string. 
+  #
   def to_s(level = 0)
     spaces = "     "
     indent = (0...level).collect { spaces }.join("") 
@@ -133,9 +180,20 @@ class Capitate::TaskNode
     end
     s
   end
-      
+    
+  # Class methods  
   class << self
     
+    # Create nodes and and task to node.
+    #
+    # If task is "mysql:centos:install", the nodes will look like:
+    #
+    #   (top node) -> (mysql node) -> (centos node; w/ tasks: install)
+    #
+    # ==== Options
+    # +top_node+:: Node to start at
+    # +task+:: Task to add
+    #    
     def populate_with_task(top_node, task)
       node_names = task.namespace.fully_qualified_name.split(":")
       

data/lib/capitate/version.rb

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

data/lib/capitate.rb

@@ -22,6 +22,8 @@ require 'capitate/plugins/templates'
 require 'capitate/plugins/wget'
 require 'capitate/plugins/yum'
 
+require 'capitate/plugins/upload'
+
 require "capitate/cap_ext/connections"
 require "capitate/cap_ext/extension_proxy"
 require "capitate/cap_ext/variables"

data/lib/recipes/docs.rb

@@ -4,8 +4,6 @@ namespace :docs do
   task :recipes do
     top_node = capitate.task_tree
     
-    puts "Tree:\n#{}"
-    
     dir = "docs/recipes"
     FileUtils.rm_rf(dir)
     FileUtils.mkdir_p(dir)

data/lib/recipes/mongrel_cluster.rb

@@ -13,6 +13,10 @@ namespace :mongrel_cluster do
     
     set :mongrel_port, 9000
     
+  mongrel_config_script: Config script to load with mongrel.
+  
+    set :mongrel_config_script, "config/mongrel_handler.rb"
+    
   DESC
   task :setup_monit do
     
@@ -24,13 +28,30 @@ namespace :mongrel_cluster do
     # Settings
     fetch(:mongrel_size)
     fetch(:mongrel_port)
+    fetch_or_default(:mongrel_config_script, nil)
     
     processes = []
     ports = (0...mongrel_size).collect { |i| mongrel_port + i }
     ports.each do |port|
       
       pid_path = "#{shared_path}/pids/mongrel.#{port}.pid"
-      start_options = "-d -e production -a 127.0.0.1 -c #{current_path} --user #{user} --group #{user} -p #{port} -P #{pid_path} -l log/mongrel.#{port}.log"
+      
+      default_options = [
+        [ "-d" ], 
+        [ "-e", "production" ],
+        [ "-a", "127.0.0.1" ],
+        [ "-c", current_path ],
+        [ "--user", user ], 
+        [ "--group", user ],
+        [ "-p", port ], 
+        [ "-P", pid_path ],
+        [ "-l", "log/mongrel.#{port}.log" ]
+      ]
+      
+      default_options << [ "-S", mongrel_config_script ] if mongrel_config_script 
+      
+      start_options = default_options.collect { |a| a.join(" ") }.join(" ")      
+      #start_options = "-d -e production -a 127.0.0.1 -c #{current_path} --user #{user} --group #{user} -p #{port} -P #{pid_path} -l log/mongrel.#{port}.log"
       stop_options = "-p #{port} -P #{pid_path}"
       
       processes << { :port => port, :start_options => start_options, :stop_options => stop_options, :name => "/usr/bin/mongrel_rails", :pid_path => pid_path }

data/lib/templates/mongrel/mongrel_cluster.yml.erb

@@ -8,3 +8,4 @@ pid_file: <%= pid_path %>/mongrel.pid
 servers: <%= mongrel_size %>
 user: <%= user %>
 group: <%= user %>
+config_script: <%= mongrel_config_script %>

data/lib/templates/nginx/nginx.conf.erb

@@ -4,10 +4,18 @@
 # See vhost conf for site specific stuff.
 #
 # ==== References:
+# http://brainspl.at/articles/2006/08/23/nginx-my-new-favorite-front-end-for-mongrel-cluster
 # http://brainspl.at/articles/2007/01/03/new-nginx-conf-with-optimizations
 # http://topfunky.net/svn/shovel/nginx
 # http://robsanheim.com/2008/02/07/beware-the-default-nginx-config-old-ie6-hates-gzip/
 #
+# Nginx + memcached:
+# http://www.igvita.com/2008/02/11/nginx-and-memcached-a-400-boost/
+# http://blog.kovyrin.net/2007/08/05/using-nginx-ssi-and-memcache-to-make-your-web-applications-faster/
+#
+# Fair balancing:
+# http://brainspl.at/articles/2007/11/09/a-fair-proxy-balancer-for-nginx-and-mongrel
+ 
 
 # user and group to run as
 user nginx nginx;

data/script/txt2html

@@ -40,35 +40,41 @@ def convert_syntax(syntax, source)
   return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
 end
 
-if ARGV.length >= 1
-  src, template = ARGV
-  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
-  
+if ARGV.length >= 3
+  src_glob, template, output_dir = ARGV  
+  src_files = Dir[src_glob]
 else
-  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  puts("Usage: #{File.split($0).last} path/to/source*.txt template.rhtml output_dir")
   exit!
 end
 
 template = ERB.new(File.open(template).read)
 
-title = nil
-body = nil
-File.open(src) do |fsrc|
-  title_text = fsrc.readline
-  body_text = fsrc.read
-  syntax_items = []
-  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
-    ident = syntax_items.length
-    element, syntax, source = $1, $2, $3
-    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
-    "syntax-temp-#{ident}"
-  }
-  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
-  body = RedCloth.new(body_text).to_html
-  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
-end
-stat = File.stat(src)
-created = stat.ctime
-modified = stat.mtime
+src_files.each do |src|
+  title = nil
+  body = nil
+  File.open(src) do |fsrc|
+    title_text = fsrc.readline
+    body_text = fsrc.read
+    syntax_items = []
+    body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+      ident = syntax_items.length
+      element, syntax, source = $1, $2, $3
+      syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+      "syntax-temp-#{ident}"
+    }
+    title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+    body = RedCloth.new(body_text).to_html
+    body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+  end
+  stat = File.stat(src)
+  created = stat.ctime
+  modified = stat.mtime
 
-$stdout << template.result(binding)
+  #$stdout << template.result(binding)
+  output_file_path = src.split("/").last.gsub(/txt$/, "html")
+  output_path = output_dir + "/" + output_file_path
+  puts "    create #{output_path}"
+  File.open(output_path, "w") { |file| file.puts template.result(binding) }
+  
+end

data/tasks/website.rake

@@ -1,17 +1,14 @@
 desc 'Generate website files'
 task :website_generate => :ruby_env do
-  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
-    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
-  end
+  template = File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  sh %{ #{RUBY_APP} script/txt2html "website/**/*.txt" #{template} website }
   
   # Clean and re-create
   FileUtils.rm_rf("website/recipes")
   FileUtils.mkdir_p("website/recipes")  
   sh "cap docs:recipes"
   template = File.join(File.dirname(__FILE__), '/../website/template_recipe.rhtml')
-  Dir['docs/recipes/**/*.txt'].each do |txt|
-    sh %{ #{RUBY_APP} script/txt2html #{txt} #{template} > website/recipes/#{txt.split("/").last.gsub(/txt$/,'html')} }
-  end
+  sh %{ #{RUBY_APP} script/txt2html "docs/recipes/**/*.txt" #{template} website/recipes }
 end
 
 desc 'Upload website files to rubyforge'

data/test/test_plugin_upload.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestPluginUpload < Test::Unit::TestCase
+  
+  include Capitate::Plugins::Upload
+
+  # Mocked put
+  def put(data, dest_path, options)    
+    start = 0
+    length = 4096
+        
+    @mock_put << data[start, length]    
+  end
+  
+  # Test upload streamed
+  def test_upload
+    @mock_put = ""
+    
+    # Use this file for data
+    path = __FILE__
+    
+    file(path, "mocked")
+    
+    data = nil
+    File.open(__FILE__) { |f| data = f.readlines }
+    data = data.join
+    
+    assert_equal data, @mock_put
+  end
+  
+end
+

data/website/index.html

@@ -38,7 +38,7 @@
 
     <div id="version" class="clickable box" onclick='document.location = "http://rubyforge.org/projects/capitate"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/capitate" class="numbers">0.1.8</a>
+      <a href="http://rubyforge.org/projects/capitate" class="numbers">0.1.9</a>
     </div>
     
     <div id="recipes" class="box">
@@ -65,10 +65,9 @@
 	<p>Add capitate to your Capfile. Copy this somewhere near the top:</p>
 
 
-	<p><pre class='syntax'>
-  <span class="ident">set</span> <span class="symbol">:project_root</span><span class="punct">,</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">dirname</span><span class="punct">(</span><span class="constant">__FILE__</span><span class="punct">)</span>
-  <span class="ident">require</span> <span class="punct">'</span><span class="string">capitate</span><span class="punct">'</span>  
-  <span class="ident">require</span> <span class="punct">'</span><span class="string">capitate/recipes</span><span class="punct">'</span>
+	<p><pre class='syntax'><span class="ident">require</span> <span class="punct">'</span><span class="string">capitate</span><span class="punct">'</span>  
+<span class="ident">require</span> <span class="punct">'</span><span class="string">capitate/recipes</span><span class="punct">'</span>
+<span class="ident">set</span> <span class="symbol">:project_root</span><span class="punct">,</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">dirname</span><span class="punct">(</span><span class="constant">__FILE__</span><span class="punct">)</span>
 </pre></p>
 
 
@@ -152,7 +151,7 @@
 	<p>Comments are welcome. Send an email to <a href="mailto:gabrielh@gmail.com">Gabriel Handford</a> via the <a href="http://groups.google.com/group/capitate">forum</a></p>
     </div>
     <p class="coda">
-      <a href="FIXME email">Gabriel Handford</a>, 21st February 2008<br>
+      <a href="FIXME email">Gabriel Handford</a>, 22nd February 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -13,10 +13,9 @@ h2. Running
 
 Add capitate to your Capfile. Copy this somewhere near the top:
 
-<pre syntax="ruby">
-  set :project_root, File.dirname(__FILE__)
-  require 'capitate'  
-  require 'capitate/recipes'
+<pre syntax="ruby">require 'capitate'  
+require 'capitate/recipes'
+set :project_root, File.dirname(__FILE__)
 </pre>
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: capitate
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.1.9
 platform: ""
 authors: 
 - Gabriel Handford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-21 00:00:00 -05:00
+date: 2008-02-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,6 +54,7 @@ files:
 - lib/capitate/plugins/profiles.rb
 - lib/capitate/plugins/script.rb
 - lib/capitate/plugins/templates.rb
+- lib/capitate/plugins/upload.rb
 - lib/capitate/plugins/wget.rb
 - lib/capitate/plugins/yum.rb
 - lib/capitate/recipes.rb
@@ -114,6 +115,7 @@ files:
 - tasks/environment.rake
 - tasks/website.rake
 - test/test_helper.rb
+- test/test_plugin_upload.rb
 - test/test_recipes.rb
 - test/test_templates.rb
 - website/index.html
@@ -151,5 +153,6 @@ specification_version: 2
 summary: Capistrano recipes, plugins and templates.
 test_files: 
 - test/test_helper.rb
+- test/test_plugin_upload.rb
 - test/test_recipes.rb
 - test/test_templates.rb