RubyGems - ramaze - Versions diffs - 0.2.0 → 0.2.1 - Mend

ramaze 0.2.0 → 0.2.1

Files changed (55) hide show

data/Rakefile +13 -7
data/doc/README +1 -1
data/doc/README.html +729 -0
data/doc/meta/users.kml +61 -59
data/doc/readme_chunks/installing.txt +1 -1
data/examples/auth/auth.rb +13 -8
data/examples/element.rb +1 -2
data/examples/ramaise.rb +139 -0
data/examples/simple.rb +2 -5
data/examples/sourceview/public/coderay.css +104 -0
data/examples/sourceview/public/jquery.treeview.css +10 -9
data/examples/sourceview/public/jquery.treeview.js +7 -7
data/examples/sourceview/public/sourceview.js +43 -7
data/examples/sourceview/sourceview.rb +36 -33
data/examples/sourceview/template/index.haml +33 -17
data/examples/wikore/spec/wikore.rb +1 -0
data/examples/wikore/src/controller.rb +0 -1
data/examples/wikore/src/model.rb +17 -16
data/lib/proto/src/controller/main.rb +1 -1
data/lib/proto/start.rb +2 -3
data/lib/ramaze.rb +3 -0
data/lib/ramaze/contrib/auto_params.rb +3 -3
data/lib/ramaze/contrib/gzip_filter.rb +3 -4
data/lib/ramaze/contrib/route.rb +5 -0
data/lib/ramaze/controller/resolve.rb +1 -1
data/lib/ramaze/dispatcher/action.rb +1 -1
data/lib/ramaze/dispatcher/error.rb +7 -4
data/lib/ramaze/gestalt.rb +1 -2
data/lib/ramaze/helper.rb +8 -4
data/lib/ramaze/helper/auth.rb +1 -1
data/lib/ramaze/helper/cache.rb +4 -0
data/lib/ramaze/helper/identity.rb +2 -2
data/lib/ramaze/snippets/{string/DIVIDE.rb → divide.rb} +11 -8
data/lib/ramaze/snippets/string/unindent.rb +7 -0
data/lib/ramaze/snippets/thread/into.rb +5 -12
data/lib/ramaze/spec/helper/wrap.rb +1 -1
data/lib/ramaze/template/haml.rb +4 -14
data/lib/ramaze/template/sass.rb +4 -14
data/lib/ramaze/trinity/request.rb +34 -1
data/lib/ramaze/version.rb +1 -1
data/rake_tasks/coverage.rake +46 -0
data/rake_tasks/spec.rake +1 -1
data/spec/contrib/auto_params.rb +6 -1
data/spec/contrib/route.rb +0 -2
data/spec/contrib/sequel/fill.rb +6 -4
data/spec/ramaze/controller/resolve.rb +31 -0
data/spec/ramaze/helper/cache.rb +14 -7
data/spec/ramaze/template/haml.rb +14 -0
data/spec/ramaze/template/sass.rb +23 -1
data/spec/ramaze/trinity/request.rb +19 -0
data/spec/snippets/{string/DIVIDE.rb → divide.rb} +5 -1
data/spec/snippets/kernel/__dir__.rb +1 -1
data/spec/snippets/string/unindent.rb +22 -0
data/spec/snippets/thread/into.rb +21 -0
metadata +90 -80

data/Rakefile CHANGED

@@ -16,6 +16,7 @@ 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'
 task :default => ['test:all']
 task :test => ['test:all']
@@ -55,11 +56,11 @@ end
 require 'spec/rake/spectask'
 desc "Generate HTML coverage report"
-Spec::Rake::SpecTask.new(:rcov_summary => :rcov_dir) do |t|
-  t.spec_files = FileList['test/tc_adapter.rb']
-  t.spec_opts = ["--format", "html"]
-  t.out = 'doc/output/tools/rcov/test.html'
-  t.fail_on_error = false
+task :rcov_summary => :rcov_dir do
+  `rcov --version`
+  raise LoadError, "Please `gem install rcov` first" if $?.exitstatus == 127
+  raise "Run `rake coverage` to generate coverage data first" unless File.exists? 'coverage.data'
+  sh "rcov --aggregate coverage.data -o doc/output/tools/rcov/"
 end
 desc "generate rdoc"
@@ -70,7 +71,9 @@ end
 desc "generate improved allison-rdoc"
 task :allison => :clean do
   opts = RDOC_OPTS
-  opts << %w[--template '/home/manveru/prog/projects/allison/allison.rb']
+  path = `allison --path`.strip
+  raise LoadError, "Please `gem install allison` first" if $?.exitstatus == 127
+  opts << %W[--template '#{path}']
   sh "rdoc #{(RDOC_OPTS + RDOC_FILES).join(' ')}"
 end
@@ -120,9 +123,12 @@ end
 desc "show how many patches we made so far"
 task :patchsize do
-  size = `darcs changes`.split("\n").reject{|l| l =~ /^\s/ or l.empty?}.size
+  patches = `darcs changes --reverse`.split("\n")
+  size = patches.reject{|l| l =~ /^\s/ or l.empty?}.size
   puts "currently we have #{size} patches"
   puts "shall i now play some Death-Metal for you?" if size == 666
+  days = (Time.now - Time.parse(patches[0])) / (3600*24)
+  puts "#{days.round} days since init, avg #{"%4.2f" % (size/days)} patches per day"
 end
 desc "show who made how many patches"

data/doc/README CHANGED

@@ -251,7 +251,7 @@ There are some basic principles that Ramaze tries to follow:
   To get the latest and sweetest, you can just pull from the repository and run
   Ramaze that way.
-    $ darcs get --partial http://manveru.mine.nu/ramaze
+    $ darcs get --partial http://darcs.ramaze.net/ramaze
   Please read the man page or `darcs help` for more information about updating
   and creating your own patches.

data/doc/README.html ADDED

@@ -0,0 +1,729 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>doc/README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Wed Nov 21 14:52:17 +0900 2007</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <pre>
+          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+ All files in this distribution are subject to the terms of the Ruby license.
+</pre>
+<h1>About Ramaze</h1>
+<p>
+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 make simple
+things simple and complex things possible.
+</p>
+<p>
+This of course is nothing new to anyone who knows some ruby, but is often
+forgotten in a chase for new functionality and features. Ramaze only tries
+to give you the ultimate tools, but you have to use them yourself to
+achieve perfect custom-tailored results.
+</p>
+<p>
+Another one of the goals during development of Ramaze was to make every
+part as modular and therefor reuasable as possible, not only to provide a
+basic understanding after the first glance, but also to make it as simple
+as possible to reuse parts of the code.
+</p>
+<p>
+The original purpose of Ramaze was to act as a kind of framework to build
+web-frameworks, this was made obsolete by the introduction of rack, which
+provides this feature at a better level without trying to enforce any
+structural layout of the resulting framework.
+</p>
+<h1>Features Overview</h1>
+<p>
+Ramaze offers following features at the moment:
+</p>
+<ul>
+<li>Adapters
+<pre>
+ Ramaze takes advantage of the rack library to provide a common way of
+ handling different ways to serve its content.
+ Rack supports at the moment:
+  * [Mongrel](http://mongrel.rubyforge.org/)
+    Mongrel is a fast HTTP library and server for Ruby that is intended for
+    hosting Ruby web applications of any kind using plain HTTP rather than
+    FastCGI or SCGI.
+  * [WEBrick](http://www.webrick.org/)
+    WEBrick is a Ruby library program to build HTTP servers.
+  * CGI
+    CGI is the Common Gateway Interface and is one of the most basic ways
+    to integrate into Webservers like Apache or Lighttpd.
+  * FCGI
+    Improvment of CGI as it doesn't start up a new connection to Ramaze on
+    every request.
+</pre>
+</li>
+<li>Templates
+<ul>
+<li>[Amrita2](<a
+href="http://amrita2.rubyforge.org">amrita2.rubyforge.org</a>/)
+<p>
+Amrita2 is a xml/xhtml template library for Ruby. It makes html documents
+from a template and a model data.
+</p>
+</li>
+<li>[Erubis](<a
+href="http://rubyforge.org/projects/erubis">rubyforge.org/projects/erubis</a>)
+<p>
+Erubis is a fast, secure, and very extensible implementation of eRuby.
+</p>
+</li>
+<li>[Haml](<a href="http://haml.hamptoncatlin.com">haml.hamptoncatlin.com</a>/)
+<p>
+Haml takes your gross, ugly templates and replaces them with veritable
+Haiku.
+</p>
+</li>
+<li>[Liquid](<a
+href="http://home.leetsoft.com/liquid">home.leetsoft.com/liquid</a>)
+<p>
+Liquid&#8216;s syntax and parse model are inspired by Django templates, as
+well as PHP&#8216;s smarty.
+</p>
+</li>
+<li>[Remarkably](<a
+href="http://rubyforge.org/projects/remarkably">rubyforge.org/projects/remarkably</a>)
+<p>
+Remarkably is a very tiny Markaby-like XML builder
+</p>
+</li>
+<li>[Markaby](<a
+href="http://code.whytheluckystiff.net/markaby">code.whytheluckystiff.net/markaby</a>/)
+<p>
+Markaby means Markup as Ruby.
+</p>
+</li>
+<li>[Sass](<a
+href="http://haml.hamptoncatlin.com/docs/sass">haml.hamptoncatlin.com/docs/sass</a>)
+<p>
+Sass is a meta-language on top of CSS that‘s used to describe the style
+of a document cleanly and structurally, with more power than flat CSS
+allows.
+</p>
+</li>
+<li>Ezamar
+<p>
+A simple homage to [Nitro](<a
+href="http://nitroproject.org)s">nitroproject.org)s</a> templating, is
+shipped together with Ramaze.
+</p>
+</li>
+</ul>
+</li>
+<li>Cache
+<ul>
+<li>Hash
+</li>
+<li>YAML::Store
+</li>
+<li>MemCache
+</li>
+</ul>
+</li>
+<li>Helper
+<ul>
+<li>Active by default
+<ul>
+<li>CGI
+<p>
+Shortcuts for escape/unescape of the CGI module.
+</p>
+</li>
+<li>File
+<p>
+Helps you serving files from your Controller.
+</p>
+</li>
+<li>Flash
+<p>
+Store a couple of values for one request associated with a session.
+</p>
+</li>
+<li>Link
+<p>
+Easier linking to the various parts of your applications Controllers and
+Actions.
+</p>
+</li>
+<li>Redirect
+<p>
+Easy redirection.
+</p>
+</li>
+</ul>
+</li>
+<li>Optional
+<ul>
+<li>Aspect
+<p>
+Allows you to wrap different Actions on your Controller with code.
+</p>
+</li>
+<li>Auth
+<p>
+Simple way to add basic authentication.
+</p>
+</li>
+<li>Cache
+<p>
+Easy caching Actions and values.
+</p>
+</li>
+<li>Identity
+<p>
+For ease of use of the OpenID authentication mechanism.
+</p>
+</li>
+<li>Inform
+<p>
+Wrapping the functionality of Ramazes logging facilities.
+</p>
+</li>
+<li>Markaby
+<p>
+Allows you to use Markaby in your Controller without having it as the
+default templating engine.
+</p>
+</li>
+<li>Nitroform
+<p>
+Hooks up on nitros form builder to help you creating forms from Og objects.
+</p>
+</li>
+<li>OpenID
+<p>
+Authentication via OpenID made easy.
+</p>
+</li>
+<li>Pager
+<p>
+Displays a collection of entitities in multiple pages.
+</p>
+</li>
+<li>Partial
+<p>
+Renders so-called partials.
+</p>
+</li>
+<li>Stack
+<p>
+Allows you to use a call/answer mechanism for things like redirection to
+the site a user entered login-forms from.
+</p>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Various
+<ul>
+<li>Sessions
+</li>
+<li>Global configuration system
+</li>
+<li>Simple request/response handling
+</li>
+<li>Custom sophisticated Error-handling
+</li>
+</ul>
+</li>
+</ul>
+<h1>Basic Principles</h1>
+<p>
+There are some basic principles that Ramaze tries to follow:
+</p>
+<ul>
+<li>KISS (Keep It Super Simple)
+<p>
+Ramaze doesn&#8216;t introduce any major change of paradigm for everyone
+familiar with Ruby and the basics of Web-development.
+</p>
+</li>
+<li>POLS (Principle Of Least Surprise)
+<p>
+Ramaze tries to be intuitive and easy to learn. Most functionality is built
+in a way to help, not to obfuscate or confuse.
+</p>
+</li>
+<li>Modular design
+<p>
+Use what you want and how you want it.
+</p>
+<p>
+Through Ruby Ramaze provides one of the most powerful programming-languages
+available, giving you full control over your system.
+</p>
+<p>
+Even the most essential parts of Ramaze can easily be replaced and/or
+modified without losing the advantage of the whole framework.
+</p>
+</li>
+<li>Minimal dependencies
+<p>
+Nothing besides Ruby is required for the basic features.
+</p>
+<p>
+Of course you can take advantage of several wonderful libraries, but Ramaze
+is built in a way to be run on any basic setup.
+</p>
+</li>
+<li>Documentation
+<p>
+Document everything, classes, modules, methods, configuration&#8230;
+</p>
+<p>
+Through 100% documentation Ramaze gives the developer easy and solid
+understanding of the underlying concepts and functionality.
+</p>
+</li>
+<li>Open development
+<p>
+Everyone is welcome to contribute to Ramaze in the easiest way possible.
+The repository is open for patches passing the Test-suite.
+</p>
+</li>
+<li>Examples
+<p>
+Everyone learns different, some only read the source, others browse
+documentation, but everyone loves examples for a quick and painless start.
+</p>
+<p>
+Ramaze addresses this need and offers a wide variety of examples of usage,
+basic functionality, project-layout and more advanced applications.
+</p>
+</li>
+<li>Fully BDD (Behaviour Driven Design)
+<p>
+Ramaze has a very complete set of so-called specifications built by RSpec.
+These specs define the way Ramaze has to behave.
+</p>
+<p>
+The specs are checked every time a new patch is pushed into the repository,
+deciding whether the changes the patch applies are valid and don&#8216;t
+break the framework.
+</p>
+</li>
+</ul>
+<h1>Installation</h1>
+<ul>
+<li>via RubyGems
+<p>
+The simplest way of installing Ramaze is via
+</p>
+<pre>
+  $ gem install ramaze
+</pre>
+<p>
+in case you have RubyGems installed.
+</p>
+</li>
+<li>via darcs
+<p>
+To get the latest and sweetest, you can just pull from the repository and
+run Ramaze that way.
+</p>
+<pre>
+  $ darcs get --partial http://darcs.ramaze.net/ramaze
+</pre>
+<p>
+Please read the man page or `darcs 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.
+</p>
+<p>
+Some hints for the usage of Darcs.
+</p>
+<ul>
+<li>use require &#8216;ramaze&#8217; from everywhere
+<p>
+add a file to your site_ruby named &#8216;ramaze.rb&#8217; the content
+should be: &quot;require
+&#8217;/path/to/darcs/repo/ramaze/lib/ramaze&#8217;&quot;
+</p>
+</li>
+<li>get the latest version (from inside the ramaze-directory)
+<p>
+$ darcs pull
+</p>
+</li>
+<li>record a patch
+<p>
+$ darcs record
+</p>
+</li>
+<li>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)
+<p>
+$ darcs send -o ramaze_bundle $ gzip -c ramaze_bundle &gt; ramaze_bundle.gz
+</p>
+</li>
+</ul>
+</li>
+<li>via install.rb
+<p>
+Support for install.rb has been canceled and the file removed.
+</p>
+</li>
+</ul>
+<h1>Getting Started</h1>
+<p>
+Now that you have a vague idea of what you&#8216;re about to get into you
+might just want to get a way to get up and running ASAP. Please read below
+for more information about installation.
+</p>
+<p>
+Depending on what you are planning to do you can either just go and start
+reading the source or directly get some hands-on experience by trying some
+of the examples. Most things will require dependencies though. The basic
+functionality is provided by the WEBrick adapter and the Template::Ramaze,
+which just run out of the box. For more features you will have to install
+some templating-engines and mongrel (<em>very</em> recommended). Ramaze
+will inform you when it needs further dependencies, so just go and try some
+things.
+</p>
+<p>
+Some places to get started are:
+</p>
+<ul>
+<li>Read the documentation.
+</li>
+<li>Run and read the test cases.
+</li>
+<li>Look at the examples and run/modify them.
+</li>
+</ul>
+<h1>A couple of Examples</h1>
+<p>
+There are some examples for your instant pleasure inside the
+examples-directory in the Ramaze-distribution. To start up an example, you
+can use the Ramaze binary located in bin/ramaze for example:
+</p>
+<pre>
+  $ ramaze examples/hello.rb
+</pre>
+<p>
+Or:
+</p>
+<pre>
+  $ cd examples/blog
+  $ ramaze
+</pre>
+<p>
+Since ramaze uses the start.rb by default if you don&#8216;t pass anything
+else.
+</p>
+<p>
+For more information about the usage of ramaze try:
+</p>
+<pre>
+  $ ramaze --help
+</pre>
+<p>
+Examples include:
+</p>
+<ul>
+<li>examples/hello.rb Hello, World!
+</li>
+<li>examples/simple.rb A bit more advanced than the hello-example, but still
+very basic.
+</li>
+<li>examples/blog Not yet fully functional, but coming along.
+</li>
+<li>examples/whywiki A basic examples of a minimalistic application, based on
+the Wiki of _why in his camping-framework.
+</li>
+<li>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.
+</li>
+</ul>
+<h1>How to find Help</h1>
+<p>
+For help you can:
+</p>
+<ul>
+<li>Visit us in the channel ramaze on irc.freenode.net
+</li>
+<li>Join the Mailinglist at <a
+href="http://ramaze.rubyforge.org">ramaze.rubyforge.org</a>
+</li>
+</ul>
+<h1>Appendix</h1>
+<ul>
+<li>Performance
+<ul>
+<li>Serving
+<p>
+For best performance you should consider using Mongrel to host your
+application.
+</p>
+</li>
+<li>Caching
+<p>
+You can easily cache your pages using the CacheHelper. Also, using MemCache
+gives you high-end performance and security.
+</p>
+</li>
+</ul>
+</li>
+</ul>
+<h1>And thanks to&#8230;</h1>
+<p>
+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.
+</p>
+<p>
+This list is by no means a full listing of all these people, but I try to
+get a good coverage despite that.
+</p>
+<p>
+I would like to thank:
+</p>
+<ul>
+<li>Yukihiro Matsumoto a.k.a matz
+<pre>
+  For giving the world Ruby and bringing fun back into programming.
+</pre>
+</li>
+<li>Zed Shawn a.k.a. zedas
+<pre>
+  For developing Mongrel, Ramaze started out as a simple Hello World based
+  on that awesome server.
+</pre>
+</li>
+<li>Christian Neukirchen a.k.a chris2
+<pre>
+  For building rack, which is just what the numerous web-developers had
+  anticipated and which will, with no doubt, change the world.
+</pre>
+</li>
+<li>Pistos
+<pre>
+  For continious encouragment and building the first real webpage on Ramaze.
+  His bugreports were invaluable.
+</pre>
+</li>
+<li>Jim Weirich
+<pre>
+  For Rake, which lifts off a lot of tasks from the shoulders of every
+  developer who uses it.
+</pre>
+</li>
+<li>Thomas Sawyer a.k.a Trans
+<pre>
+  Dragging me deep into the rabbit-hole and showing me how awesome Ruby
+  truely is through his work on facets, ratchets and tons of other projects.
+</pre>
+</li>
+<li>George Moschovitis a.k.a gmosx
+<pre>
+  For his tremendous efforts in the Nitro/Og framework, which is a source of
+  steady inspiration for Ramaze and brought me to Ruby in the first place.
+</pre>
+</li>
+<li>Rob Levin a.k.a. lilo
+<pre>
+  He founded the most excellent Freenode IRC-network, where the most important
+  channels for rubyists are located (as is #ramaze).
+  May he rest in peace.
+</pre>
+</li>
+<li>The guys (and gals) in the various channels on Freenode
+<pre>
+  As the people are way too many to be listed, here the channels that i call
+  my online home.
+  All the people in there deserve special thanks for getting me hooked to Ruby
+  and providing their help in a friendly and patient manner.
+  * #nitro
+  * #ruby-de
+  * #ruby-lang
+  * #rubyforce
+</pre>
+</li>
+</ul>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>