palmtree 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
++++ 0.0.1 2007-05-06
+
++ 1 major enhancement:
+  + Initial release

data/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/palmtree.rb
+lib/palmtree/capistrano_extensions/configuration_extensions.rb
+lib/palmtree/recipes.rb
+lib/palmtree/recipes/backgroundrb.rb
+lib/palmtree/recipes/ferret.rb
+lib/palmtree/recipes/mongrel_cluster.rb
+lib/palmtree/recipes/tail.rb
+lib/palmtree/version.rb
+scripts/txt2html
+setup.rb
+test/test_helper.rb
+test/test_palmtree.rb
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,3 @@
+README for palmtree
+===================
+

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'palmtree', 'version')
+
+AUTHOR = 'ggarside'  # can also be an array of Authors
+EMAIL = "palmtree@geoffgarside.co.uk"
+DESCRIPTION = "Collection of Capistrano recipes"
+GEM_NAME = 'palmtree' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'palmtree' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "palmtree"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = Palmtree::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'palmtree documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == 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.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+  p.extra_deps = ['capistrano', '>=1.99.0']
+end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end

data/lib/palmtree/capistrano_extensions/configuration_extensions.rb

@@ -0,0 +1,80 @@
+# Extensions to the Capistrano::Configuration class which now
+# includes the old Capistrano::Actor functionality.
+#
+# Original code by Mike Bailey in his deprec gem.
+# URL: http://rubyforge.org/projects/deprec/
+
+module Capistrano
+  class Configuration
+    # Run a command and ask for input when input_query is seen.
+    # Sends the response back to the server.
+    #
+    # +input_query+ is a regular expression that defaults to /^Password/.
+    #
+    # Can be used where +run+ would otherwise be used.
+    #
+    #  run_with_input 'ssh-keygen ...', /^Are you sure you want to overwrite\?/
+    def run_with_input(shell_command, input_query=/^Password/)
+      handle_command_with_input(:run, shell_command, input_query)
+    end
+
+    # Run a command using sudo and ask for input when a regular expression is seen.
+    # Sends the response back to the server.
+    #
+    # See also +run_with_input+
+    #
+    # +input_query+ is a regular expression
+    def sudo_with_input(shell_command, input_query=/^Password/)
+      handle_command_with_input(:sudo, shell_command, input_query)
+    end
+
+    # Run a command using sudo and continuously pipe the results back to the console.
+    #
+    # Similar to the built-in +stream+, but for privileged users.
+    def sudo_stream(command, outfunc = :puts)
+      sudo(command) do |ch, stream, out|
+        self.send(outfunc, out) if stream == :out
+        if stream == :err
+          puts "[err : #{ch[:host]}] #{out}"
+          break
+        end
+      end
+    end
+
+    # Run a command using the root account.
+    #
+    # Some linux distros/VPS providers only give you a root login when you install.
+    def run_as_root(shell_command)
+      std.connect_as_root do |tempuser|
+        run shell_command
+      end
+    end
+
+    # Run a task using root account.
+    #
+    # Some linux distros/VPS providers only give you a root login when you install.
+    #
+    # tempuser: contains the value replaced by 'root' for the duration of this call
+    def as_root()
+      std.connect_as_root do |tempuser|
+        yield tempuser
+      end
+    end
+
+    private
+      # Does the actual capturing of the input and streaming of the output.
+      #
+      # local_run_method: run or sudo
+      # shell_command: The command to run
+      # input_query: A regular expression matching a request for input: /^Please enter your password/
+      def handle_command_with_input(local_run_method, shell_command, input_query)
+        send(local_run_method, shell_command) do |channel, stream, data|
+          logger.info data, channel[:host]
+          if data =~ input_query
+            pass = ::Capistrano::CLI.password_prompt "#{data}:"
+            channel.send_data "#{pass}\n"
+          end
+        end
+      end
+  end
+end

data/lib/palmtree/recipes/backgroundrb.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+Capistrano::Configuration.instance(true).load do
+  set :backgroundrb_host, 'localhost'
+  set :backgroundrb_port, 2000
+  set :backgroundrb_env, 'production'
+  
+  namespace :backgroundrb do
+    desc "Uses 'set' variables in deploy.rb to write the shared/config/backgroundrb.yml file"
+    task :configure, :role => :app do
+      config = {:host => backgroundrb_host, :port => backgroundrb_port, :rails_env => backgroundrb_env}
+      backgroundrb_yml = config.to_yaml
+    
+      run "if [ ! -d #{shared_path}/config ]; then mkdir #{shared_path}/config; fi"
+      put(backgroundrb_yml, "#{shared_path}/config/backgroundrb.yml", :mode => 0644)
+    end
+
+    desc "Stops the backgroundrb server."
+    task :stop, :role => :app do
+      run "#{current_path}/script/backgroundrb stop"
+    end
+  
+    desc "Starts the backgroundrb server."
+    task :start, :role => :app do
+      run "#{current_path}/script/backgroundrb start"
+    end
+  
+    desc "Restarts a running backgroundrb server."
+    task :restart, :role => :app do
+      backgroundrb.stop
+      sleep(5)  # sleep for 5 seconds to make sure the server has mopped up everything
+      backgroundrb.start
+    end
+  
+    desc "Copies the shared/config/backgroundrb yaml to release/config/"
+    task :copy_config, :role => :app do
+      on_rollback {
+        puts "***** File shared/config/backgroundrb.yml is missing. Make sure you have run backgroundrb:configure first. *****"
+      }
+    
+      run "cp #{shared_path}/config/backgroundrb.yml #{release_path}/config/"
+    end
+  end
+end

data/lib/palmtree/recipes/ferret.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+
+Capistrano::Configuration.instance(true).load do
+  set :ferret_host, ''
+  set :ferret_port, 9009
+  
+  namespace :ferret do
+    namespace :index do
+      desc <<-DESC
+      An after_update_code task to symlink release/index to shared/index \
+      useful for maintaining a constant ferret index between deployments
+      DESC
+      task :symlink, :role => :app do
+        ferret.index.create
+        run <<-CMD
+          rm -rf #{release_path}/index &&
+          ln -nfs #{shared_path}/index #{release_path}/index
+        CMD
+      end
+  
+      desc "Creates the shared/index directory for persistent ferret indexes"
+      task :create, :role => :app do
+        run "if [ ! -d #{shared_path}/index ]; then mkdir -p #{shared_path}/index ; fi"
+      end
+      
+      desc "Removes the contents of the shared/index directory"
+      task :purge, :role => :app do
+        run "if [ -d #{shared_path}/index ]; then rm -rf #{shared_path}/index/* ; fi"
+      end
+    end
+  
+    namespace :server do
+      desc "Configure ferret server"
+      task :configure, :role => :app do
+        config = {rails_env => {'port' => ferret_port, 'host' => ferret_host, 'pid_file' => "log/ferret-#{rails_env}.pid"}}
+        ferret_server_yml = config.to_yaml
+    
+        run "if [ ! -d #{shared_path}/config ]; then mkdir #{shared_path}/config; fi"
+        put(ferret_server_yml, "#{shared_path}/config/ferret_server.yml", :mode => 0644)
+      end
+  
+      desc "Copies the ferret_server.yml file to release_path/config"
+      task :copy_config, :role => :app do
+        on_rollback {
+          puts "***** File shared/config/ferret_server.yml is missing. Make sure you have run configure_ferret first. *****"
+        }
+    
+        run "cp #{shared_path}/config/ferret_server.yml #{release_path}/config/"
+      end
+  
+      desc "Start ferret server"
+      task :start, :role => :app do
+        run "RAILS_ENV=#{rails_env} #{current_path}/script/runner \"load '#{current_path}/script/ferret_start'\""
+      end
+
+      desc "Stop ferret server"
+      task :stop, :role => :app do
+        run "RAILS_ENV=#{rails_env} #{current_path}/script/runner \"load '#{current_path}/script/ferret_stop'\""
+      end
+  
+      desc "Restart ferret server"
+      task :restart, :role => :app do
+        ferret.server.stop
+        sleep(5)
+        ferret.server.start
+      end
+    end
+  end
+end

data/lib/palmtree/recipes/mongrel_cluster.rb

@@ -0,0 +1,95 @@
+Capistrano::Configuration.instance(true).load do
+  set :mongrel_servers, 2
+  set :mongrel_port, 8000
+  set :mongrel_address, "127.0.0.1"
+  set :mongrel_environment, "production"
+  set :mongrel_conf, nil
+  set :mongrel_user, nil
+  set :mongrel_group, nil
+  set :mongrel_prefix, nil
+  
+  namespace :mongrel do
+    namespace :cluster do
+      desc <<-DESC
+      Configure Mongrel processes on the app server. This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :configure, :roles => :app do
+        set_mongrel_conf
+        
+        argv = []
+        argv << "mongrel_rails cluster::configure"
+        argv << "-N #{mongrel_servers.to_s}"
+        argv << "-p #{mongrel_port.to_s}"
+        argv << "-e #{mongrel_environment}"
+        argv << "-a #{mongrel_address}"
+        argv << "-c #{current_path}"
+        argv << "-C #{mongrel_conf}"
+        argv << "--user #{mongrel_user}" if mongrel_user
+        argv << "--group #{mongrel_group}" if mongrel_group
+        argv << "--prefix #{mongrel_prefix}" if mongrel_prefix
+        cmd = argv.join " "
+        send(run_method, cmd)
+      end
+  
+      desc <<-DESC
+      Start Mongrel processes on the app server.  This uses the :use_sudo variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :start , :roles => :app do
+        set_mongrel_conf
+        send(run_method, "mongrel_rails cluster::start -C #{mongrel_conf}")
+      end
+  
+      desc <<-DESC
+      Restart the Mongrel processes on the app server by starting and stopping the cluster. This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is set to true.
+      DESC
+      task :restart , :roles => :app do
+        set_mongrel_conf
+        send(run_method, "mongrel_rails cluster::restart -C #{mongrel_conf}")
+      end
+  
+      desc <<-DESC
+      Stop the Mongrel processes on the app server.  This uses the :use_sudo
+      variable to determine whether to use sudo or not. By default, :use_sudo is
+      set to true.
+      DESC
+      task :stop , :roles => :app do
+        set_mongrel_conf
+        send(run_method, "mongrel_rails cluster::stop -C #{mongrel_conf}")
+      end
+  
+      def set_mongrel_conf
+        set :mongrel_conf, "etc/mongrel_cluster/#{application}.yml" unless mongrel_conf
+      end
+    end
+  end
+  
+  # We need to override the core deployment tasks so they use mongrel cluster instead.
+  namespace :deploy do
+    desc <<-DESC
+    Restart the Mongrel processes on the app server by calling mongrel:cluster:restart.
+    DESC
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      mongrel.cluster.restart
+    end
+    
+    namespace :app do
+      desc <<-DESC
+        Start the application servers. Calls mongrel:cluster:start.
+      DESC
+      task :start, :roles => :app do
+        mongrel.cluster.start
+      end
+      
+      desc <<-DESC
+        Stop the application servers. Calls mongrel:cluster:stop.
+      DESC
+      task :stop, :roles => :app do
+        mongrel.cluster.stop
+      end
+    end
+  end
+end

data/lib/palmtree/recipes/tail.rb

@@ -0,0 +1,39 @@
+Capistrano::Configuration.instance(true).load do
+  set(:log_file) { rails_env }
+  
+  namespace :tail do
+    desc <<-DESC
+      Streams a log file. \
+      you should set log_file to full path of the log file to tail.
+    DESC
+    task :file do
+      stream "tail -F #{log_file}"
+    end
+    
+    desc <<-DESC
+      Streams a log file from shared/log/. \
+      you should set log_file to name of the log file to tail.
+    DESC
+    task :log_file do
+      stream "tail -F #{shared_path}/log/#{log_file}.log"
+    end
+    
+    namespace :log do
+      desc <<-DESC
+        Streams the shared/log/production.log file
+      DESC
+      task :production , :roles => :app do
+        set :log_file, "production"
+        tail.log_file
+      end
+      
+      desc <<-DESC
+       Streams the shared/log/development.log file
+      DESC
+      task :development , :roles => :app do
+        set :log_file, "development"
+        tail.log_file
+      end
+    end
+  end
+end

data/lib/palmtree/recipes.rb

@@ -0,0 +1,2 @@
+require 'palmtree/capistrano_extensions/configuration_extensions'
+require 'palmtree/recipes/tail_log'

data/lib/palmtree/version.rb

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

data/lib/palmtree.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'palmtree/**/*.rb')].sort.each { |lib| require lib }

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/palmtree/version.rb'
+
+version  = Palmtree::VERSION::STRING
+download = 'http://rubyforge.org/projects/palmtree'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+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.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  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=['"]([^'"]+)[^>]*>(.*?)</
>!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)