RubyGems - manveru-ramaze - Versions diffs - 2009.04.01 → 2009.04.08 - Mend

manveru-ramaze 2009.04.01 → 2009.04.08

Files changed (38) hide show

data/CHANGELOG +201 -0
data/MANIFEST +10 -8
data/Rakefile +19 -3
data/bin/ramaze +142 -55
data/doc/tutorial/todolist.html +83 -5
data/doc/tutorial/todolist.txt +85 -33
data/examples/app/blog/start.rb +1 -1
data/examples/app/todolist/model/init.rb +3 -0
data/examples/templates/template_redcloth.rb +2 -2
data/lib/proto/layout/{default.nag → default.xhtml} +0 -0
data/lib/proto/view/{index.nag → index.xhtml} +0 -0
data/lib/proto/view/{page.nag → page.xhtml} +0 -0
data/lib/ramaze/app.rb +5 -5
data/lib/ramaze/cache.rb +3 -2
data/lib/ramaze/cache/localmemcache.rb +56 -0
data/lib/ramaze/contrib/app_graph.rb +64 -0
data/lib/ramaze/controller/default.rb +5 -0
data/lib/ramaze/helper.rb +6 -16
data/lib/ramaze/helper/httpdigest.rb +1 -1
data/lib/ramaze/helper/link.rb +2 -5
data/lib/ramaze/helper/partial.rb +85 -10
data/lib/ramaze/request.rb +20 -0
data/lib/ramaze/snippets/ramaze/deprecated.rb +0 -1
data/lib/ramaze/spec.rb +10 -0
data/lib/ramaze/tool/create.rb +48 -0
data/lib/ramaze/tool/project_creator.rb +111 -0
data/lib/ramaze/version.rb +1 -1
data/ramaze.gemspec +3 -9
data/spec/examples/templates/template_markaby.rb +1 -1
data/spec/ramaze/cache/localmemcache.rb +49 -0
data/spec/ramaze/helper/sequel_form.rb +1 -1
data/tasks/bacon.rake +38 -21
metadata +12 -31
data/examples/templates/template_xslt.rb +0 -48
data/examples/templates/view/external.xsl +0 -57
data/lib/ramaze/contrib/sequel/fill.rb +0 -12
data/spec/contrib/sequel/fill.rb +0 -47
data/spec/examples/templates/template_xslt.rb +0 -10

data/doc/tutorial/todolist.html CHANGED Viewed

@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.4.1" />
+<meta name="generator" content="AsciiDoc 8.4.2" />
 <title>The official Ramaze Todo-list tutorial</title>
 <style type="text/css">
 /* Debug borders */
@@ -448,6 +448,12 @@ either on the <a href="http://ramazetrac.purepistos.org/">Bug tracker</a>, or ju
 drop by on IRC on <tt>irc.freenode.org</tt> in the channel <tt>#ramaze</tt>.</p></div>
 <div class="paragraph"><p>If you have trouble with some of the terms used in this tutorial you can
 consult the <a href="#glossary">Glossary</a> at the end of this document.</p></div>
+<div class="paragraph"><p>We are also working on a book that describes Ramaze in more depth, called
+<em>Journey to Ramaze</em>, it is still very much work in progress, but some of the
+contents might interest you.</p></div>
+<div class="paragraph"><p>The repository for the book is at <a href="http://github.com/manveru/ramaze-book">http://github.com/manveru/ramaze-book</a>.
+Every once in a while, updates for the book will be available in HTML and PDF
+form at <a href="http://book.ramaze.net">http://book.ramaze.net</a>.</p></div>
 </div>
 <h2 id="_first_step_create">First Step, Create</h2>
 <div class="sectionbody">
@@ -521,7 +527,7 @@ Ramaze<span style="color: #990000">.</span>start</tt></pre></div></div>
 <pre><tt>delta ~/tmp/tutorial % ruby start.rb
 D [2009-03-30 14:15:01 $2124] DEBUG | : Using webrick
 I [2009-03-30 14:15:01 $2124]  INFO | : WEBrick 1.3.1
-I [2009-03-30 14:15:01 $2124]  INFO | : ruby 1.8.7 (2008-08-11) [i686-linux]
+I [2009-03-30 14:15:01 $2124]  INFO | : ruby 1.9.2 (2009-03-02) [i686-linux]
 D [2009-03-30 14:15:01 $2124] DEBUG | : TCPServer.new(0.0.0.0, 7000)
 D [2009-03-30 14:15:01 $2124] DEBUG | : Rack::Handler::WEBrick is mounted on /.
 I [2009-03-30 14:15:01 $2124]  INFO | : WEBrick::HTTPServer#start: pid=2124 port=7000</tt></pre>
@@ -552,8 +558,7 @@ you tremendously when it comes to writing your own applications.</p></div>
 This requires the <a href="http://rubyforge.org/projects/sqlite-ruby">sqlite-ruby</a>
 bindings.</p></div>
 <div class="paragraph"><p>You can try to <tt>gem install sqlite</tt>, which will complain if your system doesn&#8217;t
-provide bindings, in which case I have to refer you to
-TODO <a href="http://sqlite.rubyforge.org">http://sqlite.rubyforge.org</a></p></div>
+provide bindings, in which case I have to refer you to <a href="http://sqlite.org">http://sqlite.org</a>.</p></div>
 <div class="paragraph"><p>In order to use Sequel we also need a database connection.</p></div>
 <div class="paragraph"><p>So we create a new file at <em>model/init.rb</em> with following content:</p></div>
 <div class="listingblock">
@@ -563,7 +568,11 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->
 <pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">'sequel'</span>
+Sequel<span style="color: #990000">::</span>Model<span style="color: #990000">.</span>plugin<span style="color: #990000">(:</span>schema<span style="color: #990000">)</span>
 DB <span style="color: #990000">=</span> Sequel<span style="color: #990000">.</span>sqlite<span style="color: #990000">(</span><span style="color: #FF0000">'todolist.db'</span><span style="color: #990000">)</span></tt></pre></div></div>
+<div class="paragraph"><p>The <tt>:schema</tt> plugin is required since Sequel 3.0, if you run a version prior
+to 2.12 you may remove this line if it gives you any problems.</p></div>
 <div class="paragraph"><p>Next we edit <em>start.rb</em>, remove the <tt>Hello</tt> class, and add a require for the
 file, <em>start.rb</em> should look like this now:</p></div>
 <div class="listingblock">
@@ -611,6 +620,8 @@ http://www.lorenzobettini.it
 http://www.gnu.org/software/src-highlite -->
 <pre><tt><span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">'sequel'</span>
+Sequel<span style="color: #990000">::</span>Model<span style="color: #990000">.</span>plugin<span style="color: #990000">(:</span>schema<span style="color: #990000">)</span>
 DB <span style="color: #990000">=</span> Sequel<span style="color: #990000">.</span>sqlite<span style="color: #990000">(</span><span style="color: #FF0000">'todolist.db'</span><span style="color: #990000">)</span>
 <span style="font-weight: bold"><span style="color: #000080">require</span></span> <span style="color: #FF0000">'model/task'</span></tt></pre></div></div>
@@ -1255,6 +1266,73 @@ http://www.gnu.org/software/src-highlite -->
 <div class="paragraph"><p>Voilà, you now have acquired the Certificate of Ramazeness and all your friends
 and enemies envy you.</p></div>
 </div>
+<h2 id="_twelfth_step_configuring_configurable_configurability">Twelfth Step, configuring configurable configurability</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>To round up this tutorial a bit, let&#8217;s introduce you to configuration in Ramaze.
+There are a number of ways to configure Ramaze, but here we&#8217;ll just see the
+most common ones with some options you&#8217;ll most likely want to change.</p></div>
+<div class="paragraph"><p>First of all, you have been running your ramaze application always on the same
+port, <tt>7000</tt>, which prevents you from starting more than one instance or other
+applications.</p></div>
+<div class="paragraph"><p>To change the port, you can, for example:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 2.11.1
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt>Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>adapter<span style="color: #990000">.</span>port <span style="color: #990000">=</span> <span style="color: #993399">80</span></tt></pre></div></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">Running a server on a port below 1024 will require root privileges and is
+      generally not advised for applications that don&#8217;t drop their privileges
+      after establishing a connection.
+      Please have a look at <a href="http://wiki.ramaze.net/Deployment">http://wiki.ramaze.net/Deployment</a> for better ways
+      to deploy your site using a reverse proxy like apache, lighttpd, or
+      nginx.</td>
+</tr></table>
+</div>
+<div class="paragraph"><p>OK, a different port is fine, but how about some speed-boost? For this we will
+need a faster server like <a href="http://mongrel.rubyforge.org">Mongrel</a> or
+<a href="http://thin.rubyforge.org">Thin</a>.</p></div>
+<div class="paragraph"><p>You can install either one via:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>gem install thin
+gem install mongrel</tt></pre>
+</div></div>
+<div class="paragraph"><p>Now to the configuration:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 2.11.1
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt><span style="font-style: italic"><span style="color: #9A1900"># The default is WEBrick</span></span>
+Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>adapter<span style="color: #990000">.</span>adapter <span style="color: #990000">=</span> <span style="color: #990000">:</span>webrick
+<span style="font-style: italic"><span style="color: #9A1900"># How about using Mongrel instead?</span></span>
+Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>adapter<span style="color: #990000">.</span>adapter <span style="color: #990000">=</span> <span style="color: #990000">:</span>mongrel
+<span style="font-style: italic"><span style="color: #9A1900"># Or maybe Thin?</span></span>
+Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>adapter<span style="color: #990000">.</span>adapter <span style="color: #990000">=</span> <span style="color: #990000">:</span>thin</tt></pre></div></div>
+<div class="paragraph"><p>For the full performance, switch Ramaze into <tt>:live</tt> mode:</p></div>
+<div class="listingblock">
+<div class="content"><!-- Generator: GNU source-highlight 2.11.1
+by Lorenzo Bettini
+http://www.lorenzobettini.it
+http://www.gnu.org/software/src-highlite -->
+<pre><tt><span style="font-style: italic"><span style="color: #9A1900"># The default is :dev</span></span>
+Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>mode <span style="color: #990000">=</span> <span style="color: #990000">:</span>live
+<span style="font-style: italic"><span style="color: #9A1900"># And here comes :live</span></span>
+Ramaze<span style="color: #990000">.</span>options<span style="color: #990000">.</span>mode <span style="color: #990000">=</span> <span style="color: #990000">:</span>live</tt></pre></div></div>
+<div class="paragraph"><p>The major differences between <tt>:dev</tt> and <tt>:live</tt> are that in <tt>:live</tt> mode your
+code won&#8217;t be automatically reloaded if it has changed and we don&#8217;t run every
+request through <tt>Rack::Lint</tt>, which helps you to stay within the
+request/response specifications required by Rack.</p></div>
+</div>
 <h2 id="glossary">Glossary</h2>
 <div class="sectionbody">
 <div class="dlist glossary"><dl>
@@ -1330,7 +1408,7 @@ RSI
 <div id="footer">
 <div id="footer-text">
 Version 2.0<br />
-Last updated 2009-03-30 20:29:25 JST
+Last updated 2009-04-07 19:08:12 JST
 </div>
 </div>
 </body>

data/doc/tutorial/todolist.txt CHANGED Viewed

@@ -32,6 +32,15 @@ drop by on IRC on `irc.freenode.org` in the channel `#ramaze`.
 If you have trouble with some of the terms used in this tutorial you can
 consult the <<glossary, Glossary>> at the end of this document.
+We are also working on a book that describes Ramaze in more depth, called
+'Journey to Ramaze', it is still very much work in progress, but some of the
+contents might interest you.
+The repository for the book is at http://github.com/manveru/ramaze-book.
+Every once in a while, updates for the book will be available in HTML and PDF
+form at http://book.ramaze.net.
 == First Step, Create
 The last version of this tutorial assumed a generator to produce a skeleton in
@@ -87,7 +96,7 @@ tradition, we create a file at the root of your application directory called
 require 'rubygems'
 require 'ramaze'
-class Hello < Ramaze::Controller
+class MainController < Ramaze::Controller
   def index
     "Hello, World!"
   end
@@ -102,7 +111,7 @@ Now we run it:
 delta ~/tmp/tutorial % ruby start.rb
 D [2009-03-30 14:15:01 $2124] DEBUG | : Using webrick
 I [2009-03-30 14:15:01 $2124]  INFO | : WEBrick 1.3.1
-I [2009-03-30 14:15:01 $2124]  INFO | : ruby 1.8.7 (2008-08-11) [i686-linux]
+I [2009-03-30 14:15:01 $2124]  INFO | : ruby 1.9.2 (2009-03-02) [i686-linux]
 D [2009-03-30 14:15:01 $2124] DEBUG | : TCPServer.new(0.0.0.0, 7000)
 D [2009-03-30 14:15:01 $2124] DEBUG | : Rack::Handler::WEBrick is mounted on /.
 I [2009-03-30 14:15:01 $2124]  INFO | : WEBrick::HTTPServer#start: pid=2124 port=7000
@@ -141,8 +150,7 @@ This requires the http://rubyforge.org/projects/sqlite-ruby[sqlite-ruby]
 bindings.
 You can try to `gem install sqlite`, which will complain if your system doesn't
-provide bindings, in which case I have to refer you to
-TODO http://sqlite.rubyforge.org
+provide bindings, in which case I have to refer you to http://sqlite.org.
 In order to use Sequel we also need a database connection.
@@ -152,9 +160,14 @@ So we create a new file at 'model/init.rb' with following content:
 --------------------------------------------------------------------------------
 require 'sequel'
+Sequel::Model.plugin(:schema)
 DB = Sequel.sqlite('todolist.db')
 --------------------------------------------------------------------------------
+The `:schema` plugin is required since Sequel 3.0, if you run a version prior
+to 2.12 you may remove this line if it gives you any problems.
 Next we edit 'start.rb', remove the `Hello` class, and add a require for the
 file, 'start.rb' should look like this now:
@@ -202,6 +215,8 @@ Finally, add a line to your 'model/init.rb' that requires 'model/task.rb':
 --------------------------------------------------------------------------------
 require 'sequel'
+Sequel::Model.plugin(:schema)
 DB = Sequel.sqlite('todolist.db')
 require 'model/task'
@@ -832,35 +847,72 @@ What we do cover is adding it to your application, or the `<head>` in
 Voilà, you now have acquired the Certificate of Ramazeness and all your friends
 and enemies envy you.
-////
-That's just some experimental stuff, uncomment and create an 'image' folder to
-use it.
-[graphviz,"image/relations.png","dot"]
----------------------------------------------------------------------
-digraph relations {
-  "start.rb" -> "controller/task.rb";
-  "start.rb" -> "model/init.rb";
-  "model/init.rb" -> "model/task.rb";
-  "controller/task.rb" -> "layout/default.xhtml";
-  "controller/task.rb" -> "view/index.xhtml";
-  "controller/task.rb" -> "view/done.xhtml";
-  "layout/default.xhtml" -> "public/css/screen.css";
-  "Tasks Controller" -> "create action";
-  "Tasks Controller" -> "index action";
-  "Tasks Controller" -> "open action";
-  "Tasks Controller" -> "done action";
-  "Tasks Controller" -> "close action";
-  "Tasks Controller" -> "delete action";
-  "done action"  -> "Task.filter(:done => true)";
-  "index action" -> "Task.filter(:done => false)";
-}
----------------------------------------------------------------------
-image:image/relations.png[Relations of parts of the application]
-////
+== Twelfth Step, configuring configurable configurability
+To round up this tutorial a bit, let's introduce you to configuration in Ramaze.
+There are a number of ways to configure Ramaze, but here we'll just see the
+most common ones with some options you'll most likely want to change.
+First of all, you have been running your ramaze application always on the same
+port, `7000`, which prevents you from starting more than one instance or other
+applications.
+To change the port, you can, for example:
+[source,ruby]
+--------------------------------------------------------------------------------
+Ramaze.options.adapter.port = 80
+--------------------------------------------------------------------------------
+NOTE: Running a server on a port below 1024 will require root privileges and is
+      generally not advised for applications that don't drop their privileges
+      after establishing a connection.
+      Please have a look at http://wiki.ramaze.net/Deployment for better ways
+      to deploy your site using a reverse proxy like apache, lighttpd, or
+      nginx.
+OK, a different port is fine, but how about some speed-boost? For this we will
+need a faster server like http://mongrel.rubyforge.org[Mongrel] or
+http://thin.rubyforge.org[Thin].
+You can install either one via:
+--------------------------------------------------------------------------------
+gem install thin
+gem install mongrel
+--------------------------------------------------------------------------------
+Now to the configuration:
+[source,ruby]
+--------------------------------------------------------------------------------
+# The default is WEBrick
+Ramaze.options.adapter.adapter = :webrick
+# How about using Mongrel instead?
+Ramaze.options.adapter.adapter = :mongrel
+# Or maybe Thin?
+Ramaze.options.adapter.adapter = :thin
+--------------------------------------------------------------------------------
+For the full performance, switch Ramaze into `:live` mode:
+[source,ruby]
+--------------------------------------------------------------------------------
+# The default is :dev
+Ramaze.options.mode = :live
+# And here comes :live
+Ramaze.options.mode = :live
+--------------------------------------------------------------------------------
+The major differences between `:dev` and `:live` are that in `:live` mode your
+code won't be automatically reloaded if it has changed and we don't run every
+request through `Rack::Lint`, which helps you to stay within the
+request/response specifications required by Rack.
 [[glossary]]
 == Glossary

data/examples/app/blog/start.rb CHANGED Viewed

@@ -2,4 +2,4 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'app'
-Ramaze.start(:adapter => :webrick, :mode => :dev)
+Ramaze.start(:adapter => :webrick, :mode => :dev) if $0 == __FILE__

data/examples/app/todolist/model/init.rb CHANGED Viewed

@@ -1,4 +1,7 @@
 module TodoList
+  # yeah, we're lazy
+  Sequel::Model.plugin(:schema)
   # Uncomment the line for the DB you want to use.
   # Sqlite In memory, fastest, but cannot persist over restarts.

data/examples/templates/template_redcloth.rb CHANGED Viewed

@@ -42,13 +42,13 @@ __REDCLOTH__
   end
   def layout
-    <<__HTML__
+    <<'__HTML__'
 <html>
   <head>
     <title>Template::RedCloth <%= @place %></title>
   </head>
   <body>
-#{@content}
+    <%= @content %>
   </body>
 </html>
 __HTML__

data/lib/proto/layout/{default.nag → default.xhtml} RENAMED Viewed

File without changes

data/lib/proto/view/{index.nag → index.xhtml} RENAMED Viewed

File without changes

data/lib/proto/view/{page.nag → page.xhtml} RENAMED Viewed

File without changes

data/lib/ramaze/app.rb CHANGED Viewed

@@ -68,11 +68,11 @@ module Ramaze
     APP_LIST = {}
-    attr_reader :name, :location, :map, :options
+    attr_reader :name, :location, :url_map, :options
     def initialize(name, location)
       @name = name.to_sym
-      @map = Innate::URLMap.new
+      @url_map = Innate::URLMap.new
       self.location = location
       APP_LIST[@name] = self
@@ -95,16 +95,16 @@ module Ramaze
     def to_app
       files = Ramaze::Files.new(*public_roots)
-      app = Current.new(Route.new(@map), Rewrite.new(@map))
+      app = Current.new(Route.new(url_map), Rewrite.new(url_map))
       Rack::Cascade.new([files, app])
     end
     def map(location, object)
-      @map.map(location, object)
+      url_map.map(location, object)
     end
     def to(object)
-      return unless mapped = @map.to(object)
+      return unless mapped = url_map.to(object)
       [location, mapped].join('/').squeeze('/')
     end

data/lib/ramaze/cache.rb CHANGED Viewed

@@ -7,8 +7,9 @@ module Ramaze
   Cache = Innate::Cache
   class Cache
-    autoload :MemCache, 'ramaze/cache/memcache'
-    autoload :Sequel, 'ramaze/cache/sequel'
+    autoload :LocalMemCache, 'ramaze/cache/localmemcache'
+    autoload :MemCache,      'ramaze/cache/memcache'
+    autoload :Sequel,        'ramaze/cache/sequel'
     def self.clear_after_reload
       action.clear if respond_to?(:action)

data/lib/ramaze/cache/localmemcache.rb ADDED Viewed

@@ -0,0 +1,56 @@
+#          Copyright (c) 2009 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+require 'localmemcache'
+module Ramaze
+  class Cache
+    # Cache based on the localmemcache library which utilizes mmap to share
+    # strings in memory between ruby instances.
+    class LocalMemCache
+      include Cache::API
+      OPTIONS = {
+        :size_mb    => 1024,
+        :serialize  => true,
+        :serializer => ::Marshal, # something that responds to ::load and ::dump
+      }
+      # Connect to localmemcache
+      def cache_setup(host, user, app, name)
+        @namespace = [host, user, app, name].compact.join('-')
+        options = {:namespace => @namespace}.merge(OPTIONS)
+        @serialize = options.delete(:serialize)
+        @serializer = options.delete(:serializer)
+        @store = ::LocalMemCache.new(options)
+      end
+      # Wipe out _all_ data in localmemcached, use with care.
+      def cache_clear
+        ::LocalMemCache.clear_namespace(@namespace)
+      end
+      def cache_delete(*args)
+        super{|key| @store.delete(key.to_s) }
+      end
+      # NOTE:
+      #   * We have no way of knowing whether the value really is nil, we
+      #     assume you wouldn't cache nil and return the default instead.
+      def cache_fetch(*args)
+        super{|key|
+          value = @store[key.to_s]
+          @serializer.load(value) if value
+        }
+      end
+      def cache_store(*args)
+        super{|key, value| @store[key.to_s] = @serializer.dump(value) }
+      end
+    end
+  end
+end