geoffgarside-angel 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-17
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Geoff Garside
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 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/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/angel.rb
+lib/angel/servers.rb
+lib/angel/servers/ebb.rb
+lib/angel/servers/mongrel.rb
+lib/angel/servers/thin.rb
+lib/angel/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_angel.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on angel, see http://github.com/geoffgarside/angel
+
+Require this 'angel' into your god scripts to use it.
+
+

data/README.txt

@@ -0,0 +1,46 @@
+= angel
+
+http://github.com/geoffgarside/angel
+
+== DESCRIPTION:
+
+Some helper methods for streamlining god config files
+
+== REQUIREMENTS:
+
+While it doesnt force it, god would make sense too ;)
+
+== INSTALL:
+
+$ git clone git://github.com/geoffgarside/angel.git
+$ cd angel
+$ rake install_gem
+
+and god would help
+
+$ sudo gem install god
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Geoff Garside.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'angel/version'
+
+AUTHOR = 'Geoff Garside'  # can also be an array of Authors
+EMAIL = "geoff@geoffgarside.co.uk"
+DESCRIPTION = "Helper methods for use with God, see wiki for example"
+GEM_NAME = 'angel' # what ppl will type to install your gem
+HOMEPATH = "http://github.com/geoffgarside/angel"
+DOWNLOAD_PATH = "http://github.com/geoffgarside/angel/tarball/master"
+RUBYFORGE_PROJECT = nil # We don't use it
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Angel::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'angel documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  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.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  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.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/angel.rb

@@ -0,0 +1,94 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Angel
+  def self.stop(server_type, *args)
+    self.send(:"stop_#{server_type}", options_from_array_of_hashes(args))
+  end
+  
+  def self.start(server_type, *args)
+    self.send(:"start_#{server_type}", options_from_array_of_hashes(args))
+  end
+  
+  def self.restart(server_type, *args)
+    self.send(:"restart_#{server_type}", options_from_array_of_hashes(args))    
+  end
+  
+  def self.options_from_array_of_hashes(args)
+    args.inject({}) { |options, hash| options.merge(hash) }
+  end
+  
+  def self.pid_file(*args)
+    options = options_from_array_of_hashes(args)
+    pid_file = options[:pid_file] || File.join(options[:cwd], "tmp/pids/server.pid")
+    
+    options[:port] ? pid_file.gsub(/\.pid$/, ".#{options[:port]}.pid") : pid_file
+  end
+  
+  def self.log_file(*args)
+    options = options_from_array_of_hashes(args)
+    log_file = options[:log_file] || File.join(options[:cwd], "log/server.log")
+    
+    options[:port] ? log_file.gsub(/\.log$/, ".#{options[:port]}.log") : log_file
+  end
+  
+  def self.setup(w)
+    # clean pid file before start if necessary
+    w.behavior(:clean_pid_file)
+
+    # determine state on god startup
+    w.transition(:init, { true => :up, false => :start }) do |on|
+      on.condition(:process_running) do |c|
+        c.running = true
+      end
+    end
+
+    # determine when process has finished starting
+    w.transition([:start, :restart], :up) do |on|
+      on.condition(:process_running) do |c|
+        c.running = true
+      end
+  
+      # failsafe
+      on.condition(:tries) do |c|
+        c.times = 5
+        c.transition = :start
+      end
+    end
+
+    # start if process is not running
+    w.transition(:up, :start) do |on|
+      on.condition(:process_exits)
+    end
+
+    # Restart if memory or cpu usage is too high
+    w.transition(:up, :restart) do |on|
+      on.condition(:memory_usage) do |c|
+        c.interval = 20
+        c.above = 50.megabytes
+        c.times = [3,5] # three out of five intervals
+      end
+  
+      on.condition(:cpu_usage) do |c|
+        c.interval = 10
+        c.above = 10.percent
+        c.times = [3,5] # three out of five intervals
+      end
+    end
+
+    # Life!!!
+    w.lifecycle do |on|
+      on.condition(:flapping) do |c|
+        c.to_state     = [:start, :restart]
+        c.times        = 5
+        c.within       = 5.minutes
+        c.transition   = :unmonitored
+        c.retry_in     = 10.minutes
+        c.retry_times  = 5
+        c.retry_within = 2.hours
+      end
+    end
+  end
+end
+
+require 'angel/servers'

data/lib/angel/servers.rb

@@ -0,0 +1,3 @@
+require 'angel/servers/mongrel'
+require 'angel/servers/thin'
+require 'angel/servers/ebb'

data/lib/angel/servers/ebb.rb

@@ -0,0 +1,18 @@
+module Angel
+  def self.start_ebb(config)
+    "ebb_rails start " + [['-d'],
+     ['-p', config[:port]],
+     ['-c', config[:cwd]],
+     ['-P', pid_file(config)],
+     ['-l', log_file(config)],
+     ['-e', config[:environment]]].join(' ')
+  end
+
+  def self.stop_ebb(config)
+    "ebb_rails stop -P #{pid_file(config)}"
+  end
+
+  def self.restart_ebb(config)
+    stop_ebb(config) + " && " + start_ebb(config)
+  end  
+end

data/lib/angel/servers/mongrel.rb

@@ -0,0 +1,19 @@
+module Angel
+  def self.start_mongrel(config)
+    "mongrel_rails start " + [['-d'],
+     ['-p', config[:port]],
+     ['-c', config[:cwd]],
+     ['-a', config[:address] || "127.0.0.1"],
+     ['-P', pid_file(config)],
+     ['-l', log_file(config)],
+     ['-e', config[:environment]]].join(' ')
+  end
+
+  def self.stop_mongrel(config)
+    "mongrel_rails stop -P #{pid_file(config)}"
+  end
+
+  def self.restart_mongrel(config)
+    "mongrel_rails restart -P #{pid_file(config)}"
+  end
+end

data/lib/angel/servers/thin.rb

@@ -0,0 +1,19 @@
+module Angel
+  def self.start_thin(config)
+    "thin start " + [['-d'],
+     ['-p', config[:port]],
+     ['-c', config[:cwd]],
+     ['-a', config[:address] || "127.0.0.1"],
+     ['-P', pid_file(config)],
+     ['-l', log_file(config)],
+     ['-e', config[:environment]]].join(' ')
+  end
+
+  def self.stop_thin(config)
+    "thin stop -P #{pid_file(config)}"
+  end
+
+  def self.restart_thin(config)
+    "thin restart -P #{pid_file(config)}"
+  end
+end

data/lib/angel/version.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/angel.rb'}"
+puts "Loading angel gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'angel' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'angel'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Angel::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+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.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > 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_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  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)