ramaze 0.3.9.1 → 2008.06

data/{doc/README → README.markdown}

@@ -1,7 +1,7 @@
-          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
  All files in this distribution are subject to the terms of the Ruby license.
 
-= About Ramaze
+# About Ramaze
 
 Ramaze is a very simple and straight-forward web-framework.
 The philosophy of it could be expressed in a mix of KISS and POLS, trying to
@@ -23,7 +23,7 @@ provides this feature at a better level without trying to enforce any structural
 layout of the resulting framework.
 
 
-= Features Overview
+# Features Overview
 
 Ramaze offers following features at the moment:
 
@@ -175,7 +175,7 @@ Ramaze offers following features at the moment:
   * Custom sophisticated Error-handling
 
 
-= Basic Principles
+# Basic Principles
 
 There are some basic principles that Ramaze tries to follow:
 
@@ -235,57 +235,103 @@ There are some basic principles that Ramaze tries to follow:
   deciding whether the changes the patch applies are valid and don't break the framework.
 
 
-= Installation
+# Installation
 
 * via RubyGems
 
-  The simplest way of installing Ramaze is via 
+  The simplest way of installing Ramaze is via the gem.
 
-    $ gem install ramaze
+  [Rubygems](http://rubygems.org) is the package manager for ruby apps and
+  libraries and provides you with the last tagged version of Ramaze.
 
-  in case you have RubyGems installed.
+      $ gem install ramaze
 
+  Versions are made as we see fit and get an announcment out (usually that's
+  the major obstacle as there is a lot to announce).
 
-* via darcs
+  If you want to install the nightly gem of Ramaze you can do this with:
+
+      $ gem install ramaze --source=http://gem.ramaze.net/
+
+  We also use the gem building process on github, which locates gems at
+  http://gems.github.com - so you can get a version from there as well:
+
+      $ gem install manveru-ramaze --source=http://gems.github.com/
+
+* via git
 
   To get the latest and sweetest, you can just pull from the repository and run
   Ramaze that way.
 
-    $ darcs get --partial http://darcs.ramaze.net/ramaze
+      $ git clone git://github.com/manveru/ramaze.git
 
-  Please read the man page or `darcs help` for more information about updating
+  Please read the `man git` or `git help` for more information about updating
   and creating your own patches.
-  This is at the moment the premier way to use Ramaze, since it is the way I use
-  it.
+  This is at the moment the premier way to use Ramaze, since it is the way I
+  use it.
+
+  Some hints for the usage of Git.
+
+  * use `require 'ramaze'` from everywhere
+
+    Simply add the path to your repository to the RUBYLIB environment variable.
+    If you are using bash you can simply put following line into your .bashrc:
+
+        $ export RUBYLIB="$HOME/path/to/repo/lib/"
+
+    Of course you should put the real path instead, you can also add multiple
+    paths, or create your personal `site_ruby`:
+
+        $ export RUBYLIB="$HOME/ruby/ramaze/lib:$HOME/.site_ruby:$HOME/ruby/bacon/lib"
+
+  * use `require 'ramaze'` systemwide from everywhere
+
+    add a file to your `site_ruby` directory named 'ramaze.rb'
+    the content should be: `require '/path/to/git/repo/ramaze/lib/ramaze'`
+
+  * Pull the latest version
+
+        $ git pull
+
+  * Reset the repo to original state (if you screw up something)
+
+        $ git reset --hard # resets the whole repo
+
+  * Revert changes to (for example) lib/ramaze.rb only
 
-  Some hints for the usage of Darcs.
+        $ git checkout master lib/ramaze.rb
 
-  * use require 'ramaze' from everywhere
+  * Add and commit all changes.
 
-    add a file to your site_ruby named 'ramaze.rb'
-    the content should be: "require '/path/to/darcs/repo/ramaze/lib/ramaze'"
+        $ git commit -a
 
-  * get the latest version (from inside the ramaze-directory)
+  * Adding only specific changes.
 
-    $ darcs pull
+        # Add hunks you want to commit to the staging area (index)
+        $ git add -p
 
-  * record a patch
+  * Commit the changes into the history of your repository
 
-    $ darcs record
+        # Create a commit from the hunks added
+        $ git commit
 
   * output your patches into a bundle ready to be mailed (compress it before
     sending to make sure it arrives in the way you sent it)
 
-    $ darcs send -o ramaze_bundle
-    $ gzip -c ramaze_bundle > ramaze_bundle.gz
+    At the end of this process you will have a tar.bz2 for all your changes
+    that you can mail to ramaze@googlegroups.com
 
+        # make sure you are on latest revision to avoid conflicts
+        $ git pull
 
-* via install.rb
+        # create 00xx-blah.patch files against the remote repo
+        $ git format-patch origin/HEAD
 
-  Support for install.rb has been canceled and the file removed.
+        # From here on you can use either git-send-email or go the manual route
+        $ tar -cjf ramaze_bundle.tar.bz2 *.patch
 
 
-= Getting Started
+# Getting Started
 
 Now that you have a vague idea of what you're about to get into you might just
 want to get a way to get up and running ASAP.
@@ -307,7 +353,7 @@ Some places to get started are:
 
 
 
-= A couple of Examples
+# A couple of Examples
 
 There are some examples for your instant pleasure inside the examples-directory
 in the Ramaze-distribution.
@@ -340,16 +386,16 @@ Examples include:
   Not yet fully functional, but coming along.
 
 * examples/whywiki
-  A basic examples of a minimalistic application, based on the Wiki of _why in
+  A basic examples of a minimalistic application, based on the Wiki of \_why in
   his camping-framework.
 
 * examples/templates
   examples of real usage of the templating-engines. Tries to implement the same
-  functionality in each template_*.rb file using a different engine.
+  functionality in each `template_*.rb` file using a different engine.
 
 
 
-= How to find Help
+# How to find Help
 
 For help you can:
 
@@ -358,7 +404,7 @@ For help you can:
 - Join the Mailinglist at http://ramaze.rubyforge.org
 
 
-= Appendix
+# Appendix
 
 * Performance
   * Serving
@@ -372,7 +418,7 @@ For help you can:
     Also, using MemCache gives you high-end performance and security.
 
 
-= And thanks to...
+# And thanks to...
 
 There is a large number of people who made Ramaze possibe by their ongoing
 efforts in the world of open source and by encouraging and helping me.

data/Rakefile

@@ -8,23 +8,28 @@ require 'rake/clean'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
-require 'fileutils'
-require 'time'
+
 require 'pp'
+require 'date'
+require 'time'
+require 'fileutils'
+
 include FileUtils
 
 $:.unshift File.join(File.dirname(__FILE__), "lib")
 
 require 'ramaze/version'
 load 'rake_tasks/conf.rake'
-load 'rake_tasks/gem.rake'
 load 'rake_tasks/maintenance.rake'
 load 'rake_tasks/spec.rake'
 load 'rake_tasks/coverage.rake'
+load 'rake_tasks/release.rake'
+load 'rake_tasks/git.rake'
+load 'rake_tasks/gem.rake'
 
-task :default => ['spec']
-task :test => ['spec']
-task :package => ['jquery']
+# task :default => ['spec']
+# task :test => ['spec']
+# task :package => ['jquery']
 
 desc 'download latest jquery and put in /lib/proto/public/js/jquery.js'
 task :jquery do
@@ -42,35 +47,6 @@ task :jquery do
   end
 end
 
-desc "sanitize the code and darcs record"
-task :record => ['fix-end-spaces', 'add-copyright'] do
-  sh "darcs record"
-end
-
-desc "create the doc/changes.xml"
-task 'changes-xml' do
-  File.open('doc/changes.xml', 'w+') do |f|
-    f.print(`darcs changes --xml`)
-  end
-end
-
-desc "create the doc/changes.txt"
-task 'changes-text' do
-  File.open('doc/changes.txt', 'w+') do |f|
-    f.print(`darcs changes --human-readable`)
-  end
-end
-
-desc "create both doc/changes.txt and doc/changes.xml"
-task :changes => ['changes-xml', 'changes-text'] do
-  puts(`darcs changes`.split("\n").first(25))
-end
-
-desc "copy the doc/changes.txt to doc/CHANGELOG"
-task :changelog => :changes do
-  cp 'doc/changes.txt', 'doc/CHANGELOG'
-end
-
 task :rcov_dir do
   mkdir_p 'doc/output/tools/rcov/'
 end
@@ -101,7 +77,7 @@ desc "create bzip2 and tarball"
 task :distribute => :gem do
   sh "rm -rf pkg/ramaze-#{VERS}"
   sh "mkdir -p pkg/ramaze-#{VERS}"
-  sh "cp -r {bin,doc,lib,examples,spec,Rakefile,rake_tasks} pkg/ramaze-#{VERS}/"
+  sh "cp -r {bin,doc,lib,examples,spec,Rakefile,README.markdown,rake_tasks} pkg/ramaze-#{VERS}/"
 
   Dir.chdir('pkg') do |pwd|
     sh "tar -zcvf ramaze-#{VERS}.tar.gz ramaze-#{VERS}"
@@ -158,20 +134,6 @@ task 'request' do
   end
 end
 
-desc "runs all the testdocs (not functional yet)"
-task "testdoc" do
-  require '../testdoc/lib/testdoc'
-  Dir['lib/ramaze/helper/*.rb'].each do |file|
-    p file
-    begin
-      require file
-      TestDoc.rspec_run(file)
-    rescue Object => ex
-      puts ex
-    end
-  end
-end
-
 desc 'listing of available traits per class/module'
 task 'traits' do
   nodes = Hash.new{|h,k| h[k] = []}
@@ -193,3 +155,44 @@ task 'traits' do
     puts
   end
 end
+
+desc "Update doc/CHANGELOG"
+task 'doc/CHANGELOG' do
+  File.open('doc/CHANGELOG', 'w+') do |f|
+    f.puts `git log`
+  end
+end
+
+desc "#{README} to doc/README.html"
+task 'doc/README.html' => [README] do
+  sh "maruku #{README}"
+  mv 'README.html', 'doc/README.html'
+end
+
+desc "Compile the #{README} from the parts of doc/readme"
+task README do
+  require 'enumerator'
+
+  chapters = [
+    'About Ramaze',         'introduction',
+    'Features Overview',    'features',
+    'Basic Principles',     'principles',
+    'Installation',         'installing',
+    'Getting Started',      'getting_started',
+    'A couple of Examples', 'examples',
+    'How to find Help',     'getting_help',
+    'Appendix',             'appendix',
+    'And thanks to...',     'thanks',
+  ]
+
+  File.open(README, 'w+') do |readme|
+    readme.puts COPYRIGHT.map{|l| l[1..-1]}, ''
+
+    chapters.each_slice(2) do |title, file|
+      file = File.join('doc', 'readme_chunks', "#{file}.txt")
+      chapter = File.read(file)
+      readme.puts "# #{title}", '', chapter
+      readme.puts '', '' unless title == chapters[-2]
+    end
+  end
+end

data/benchmark/results.txt

@@ -0,0 +1,131 @@
+====== simple ======
+<code ruby>
+require 'ramaze'
+
+class MainController < Ramaze::Controller
+  def index
+    "Hello, World!"
+  end
+end
+</code>
+
+=== webrick ===
+  Mem usage before:       20.32MB
+  Time taken for tests:   7.747022 seconds
+  Failed requests:        0
+  Requests per second:    129.08 [#/sec] (mean)
+  Time per request:       77.470 [ms] (mean)
+  Time per request:       7.747 [ms] (mean, across all concurrent requests)
+  Mem usage after:        25.43MB
+
+=== mongrel ===
+  Mem usage before:       20.25MB
+  Time taken for tests:   2.205161 seconds
+  Failed requests:        0
+  Requests per second:    453.48 [#/sec] (mean)
+  Time per request:       22.052 [ms] (mean)
+  Time per request:       2.205 [ms] (mean, across all concurrent requests)
+  Mem usage after:        21.91MB
+
+=== evented_mongrel ===
+  Mem usage before:       22.64MB
+  Time taken for tests:   1.311583 seconds
+  Failed requests:        0
+  Requests per second:    762.44 [#/sec] (mean)
+  Time per request:       13.116 [ms] (mean)
+  Time per request:       1.312 [ms] (mean, across all concurrent requests)
+  Mem usage after:        27.03MB
+
+====== no_template ======
+<code ruby>
+require 'ramaze'
+
+class MainController < Ramaze::Controller
+  engine :None
+
+  def index
+    "Hello, World!"
+  end
+end
+</code>
+
+=== evented_mongrel ===
+  Mem usage before:       22.63MB
+  Time taken for tests:   1.151947 seconds
+  Failed requests:        0
+  Requests per second:    868.10 [#/sec] (mean)
+  Time per request:       11.519 [ms] (mean)
+  Time per request:       1.152 [ms] (mean, across all concurrent requests)
+  Mem usage after:        27.11MB
+
+====== no_informer ======
+<code ruby>
+require 'ramaze'
+
+class MainController < Ramaze::Controller
+  def index
+    "Hello, World!"
+  end
+end
+
+Ramaze::Inform.loggers = []
+</code>
+
+=== evented_mongrel ===
+  Mem usage before:       22.63MB
+  Time taken for tests:   1.202878 seconds
+  Failed requests:        0
+  Requests per second:    831.34 [#/sec] (mean)
+  Time per request:       12.029 [ms] (mean)
+  Time per request:       1.203 [ms] (mean, across all concurrent requests)
+  Mem usage after:        27.07MB
+
+====== no_sessions ======
+<code ruby>
+require 'ramaze'
+
+class MainController < Ramaze::Controller
+  def index
+    "Hello, World!"
+  end
+end
+
+Ramaze::Inform.loggers = []
+Ramaze::Global.sessions = false
+</code>
+
+=== evented_mongrel ===
+  Mem usage before:       22.63MB
+  Time taken for tests:   0.835254 seconds
+  Failed requests:        0
+  Requests per second:    1197.24 [#/sec] (mean)
+  Time per request:       8.353 [ms] (mean)
+  Time per request:       0.835 [ms] (mean, across all concurrent requests)
+  Mem usage after:        26.38MB
+
+====== minimal ======
+<code ruby>
+require 'ramaze'
+
+class MainController < Ramaze::Controller
+  engine :None
+
+  def index
+    "Hello, World!"
+  end
+end
+
+Ramaze::Global.sourcereload = false
+Ramaze::Global.sessions = false
+Ramaze::Inform.loggers = []
+</code>
+
+=== evented_mongrel ===
+  Mem usage before:       22.62MB
+  Time taken for tests:   0.647273 seconds
+  Failed requests:        0
+  Requests per second:    1544.94 [#/sec] (mean)
+  Time per request:       6.473 [ms] (mean)
+  Time per request:       0.647 [ms] (mean, across all concurrent requests)
+  Mem usage after:        26.42MB
+