ramaze 0.2.1 → 0.3.0

data/doc/LEGAL

@@ -20,3 +20,7 @@ lib/ramaze/spec/helper/simple_http.rb
 lib/ramaze/template/xslt.rb
   License: Ruby
   Author: Stephan Maka
+
+lib/vendor/bacon.rb
+  License: MIT
+  Author: Christian Neukirchen

data/doc/meta/announcement.txt

@@ -1,47 +1,80 @@
-This time we are proud to announce Version 0.2.0 of the Ramaze framework, a
-light and modular open source web framework.
+This time we are proud to announce Version 0.3.0 of Ramaze, the light and
+modular open source web framework.
 
-This release features a lot of work directly from our community and i am really
-greatful for everybody who helped in testing, patching and contributing new
-exciting features.
+This release features a lot of work directly from our community and we are
+really greatful for everybody who helped in testing, patching and contributing
+new exciting features.
 
-An extensive set of specs and docs is covering almost every detail of the
-implementation and usage. It is under development by a growing community and in
-production-use at companies.
+Our extensive set of specs and docs now covers almost every detail of
+implementation and usage. Ramaze is under development by a growing community
+and in production use at companies.
 
-Special (alphabetic) thanks go to:
 
-Aman 'tmm1' Gupta      - tons of patches, specs and support
-Jonathan 'Kashia' Buch - patches for localization
-Riku Räisänen          - as usual, extensive testing
-Pistos                 - submitted his first patch
-Stephan Maka           - XSLT templating, implementation, specs and examples
+Home page:   http://ramaze.net
+Screencasts: http://ramaze.net/screencasts
 
+View source: http://source.ramaze.net
+Darcsweb:    http://darcs.ramaze.net
 
-Home page: http://ramaze.rubyforge.org
 IRC: #ramaze on irc.freenode.net
 
 
-Short summary of changes from 0.1.4 to 0.2.0:
+Simple example:
+
+  require 'ramaze'
+
+  class MainController
+    def index
+      'Hello, World!'
+    end
+  end
+
+  Ramaze.start
+
+
+Special (alphabetic) thanks go to:
+
+Aman 'tmm1' Gupta      - lots of patches and friendly support
+Antonio Cangiano       - Article: http://tiny.cc/tRLfm
+Carlo Zottmann         - First patch!
+Jonathan 'Kashia' Buch - patches for gettext and Og support
+Pistos                 - PR through awesome screencasts
+
+
+Selected summary of the 118 patches from 0.2.1 to 0.3.0:
+
+  - Specs switched from RSpec to bacon; Ramaze now runs on Ruby 1.9.
+
+  - /lib/proto (pregenerated base source code) updated to a new structure.
+
+  - Oddities in gem version of bin/ramaze fixed (hopefully? :) )
+
+  - Layouts fixed so the method on the right controller is called.
+
+  - contrib/facebook and simple facebook app example added.
 
-  - Contrib facility, for simple experimental user-contributions
+  - Lambda router support added to contrib/route.
 
-  - Routes
+  - examples/rapaste added.
 
-  - As always, lots of bugfixes
+  - gettext contrib added; localize ramaze via gettext.
 
-  - complete XSLT templating system, usage and specs
+  - Adapter for Thin Ruby webserver added.
 
-  - Improved localization filter
+  - Index files can now be put into public directories and subdirectories.
 
-  - Added gzip filter
+  - examples/blog switched from Og to Sequel.
 
-  - Support for the new upcoming nagoro templating engine.
+  - view/ is now the subdirectory for templates; if not found, Ramaze falls
+    back to template/.
 
-  - Tool::Tidy is gone for good
+  - Default error pages updated: colour gradient removed; textmate link added;
+    Javascript optimized; CSS tweaked.
 
+  - Templates are no longer searched for in public/.
 
-A complete Changelog is available at http://manveru.net/ramaze/doc/CHANGELOG
+A complete Changelog is available at
+http://darcs.ramaze.net/ramaze/doc/CHANGELOG
 
 
 Known issues:
@@ -49,36 +82,35 @@ Known issues:
   - none yet, waiting for your reports :)
 
 
-Features:
+Ramaze Features:
   - Builds on top of the Rack library, which provides easy use of adapters like
-    Mongrel, WEBrick, CGI or FCGI.
+    Mongrel, WEBrick, LiteSpeed, Thin, CGI or FCGI.
 
-  - Supports a wide range of templating-engines like:
-      Amrita2, Erubis, Haml, Liquid, Markaby, Remarkably and its own engine
-      called Ezamar.
+  - Supports a wide range of templating-engines like: Amrita2, Erubis, Haml,
+    Liquid, Markaby, Remarkably and its own engine called Ezamar and (still
+    unofficial) Nagoro.
 
-  - Highly modular structure, you can just use the parts you like. This also
-      means that it's very simple to add your own customizations.
+  - Highly modular structure: you can just use the parts you like. This also
+    means that it's very simple to add your own customizations.
 
   - A variety of helpers is already available, giving you things like advanced
-      caching, OpenID-authentication or aspect-oriented programming for your
-      controllers.
+    caching, OpenID-authentication or aspect-oriented programming for your
+    controllers.
 
-  - It is possible to use the ORM you like, be it ActiveRecord, Og, Kansas or
-      something more simplistic like a wrapper around YAML::Store.
+  - It is possible to use the ORM you like, be it Sequel, DataMapper,
+    ActiveRecord, Og, Kansas or something more simplistic like DBI, or a
+    wrapper around YAML::Store.
 
-  - Good documentation: although we don't have 100% (dcov says around 75%)
-      documentation right now, just about every part of Ramaze is covered with
-      basic and advanced docs.
-      There are a variety of examples and a tutorial available.
+  - Good documentation: although we don't have 100% documentation right now
+    (dcov says around 75%), just about every part of Ramaze is covered with
+    basic and advanced docs. There are a variety of examples, screencasts and a
+    tutorial available.
 
-  - Friendly community: lastly, but still quite important, there are people from
-      all over the world using Ramaze, so you can get almost instant help and
-      info.
+  - Friendly community: there are people from all over the world using Ramaze,
+    so you can get almost instant help and info.
 
 
-For more information please come to http://ramaze.rubyforge.org or ask directly
-on IRC (irc://irc.freenode.net/#ramaze)
+For more information please come to http://ramaze.net or ask directly on IRC
+irc://irc.freenode.net/#ramaze
 
-Thank you,
-Michael 'manveru' Fellinger and the Ramaze community
+Thank you, Michael 'manveru' Fellinger and the Ramaze community

data/examples/blog/README

@@ -1,3 +1,3 @@
-a simple blog engine which uses Og as the persistence layer.
-Og uses sqlite as the default DBMS engine and will create the database 
+A simple blog engine that uses Sequel as the persistence layer.
+Sequel uses sqlite as the default DBMS engine and will create the database
 automatically on startup.

data/examples/blog/spec/blog.rb

@@ -1,50 +1,44 @@
 require 'ramaze'
 require 'ramaze/spec/helper'
 
-# if these libraries are missing there is no sense in running the tests,
-# cause they won't work at all. 
-testcase_requires 'og'
-testcase_requires 'hpricot'
-
-# Og sets this in the global namespace and uses the STDERR to write messages
-# We can replace it with Ramaze's logger that does The Right Thing (TM)
-class Logger
-  @@global_logger = Ramaze::Inform
-end
-$:.unshift 'examples/blog'
+spec_require 'hpricot', 'sequel'
+
+$LOAD_PATH.unshift base = __DIR__/'..'
 require 'start'
 
-# fix the paths to template and public for the spec
-# this is not needed usually, but this tests are also part of ramaze's suite
-class MainController
-  template_root __DIR__ / '../template'
-end
+describe 'Blog' do
+  behaves_like 'http'
+  ramaze :public_root   => base/:public,
+         :template_root => base/:template
 
-describe 'blog' do
+  after do
+    Entry.each{|e| e.delete unless e.id == 1 }
+  end
 
-  def check_page(name)
-    page = get('/'+name)
+  def check_page(name = '')
+    page = get("/#{name}")
     page.status.should == 200
-    page.body.should_not be_nil
+    page.body.should.not == nil
 
     doc = Hpricot(page.body)
     doc.at('title').inner_html.should == 'bl_Og'
     doc.at('h1').inner_html.should == 'bl_Og'
 
-    doc.search('div#entries').length.should == 1
+    doc.search('div#entries').size.should == 1
 
     doc
   end
 
-  it 'should start' do
-    ramaze :public_root => 'examples/blog/public', :port => 7001
-    get('/').status.should == 200
+  def create_page(title,content)
+    page = post('/create','title'=>title,'content'=>content)
+    page.status.should == 303
+    page.location.should == '/'
   end
 
   it 'should have main page' do
-    doc = check_page('')
+    doc = check_page
     doc.at('div#actions>a').inner_html.should == 'new entry'
-    doc.search('div.entry').length.should == 1
+    doc.search('div.entry').size.should == 1
   end
 
   it 'should have new entry page' do
@@ -54,18 +48,12 @@ describe 'blog' do
     form.at('textarea').inner_html.should == ''
     form.at('input[@type=submit]')['value'].should == 'Add Entry'
   end
-
-  def create_page(title,content)
-    page = post('/create','title'=>title,'content'=>content)
-    page.status.should == 303
-    page.location.should == '/'
-  end
   
   it 'should add new pages' do
     create_page('new page', 'cool! a new page')
-    doc = check_page('')
+    doc = check_page
     entry = doc.search('div.entry')
-    entry.length.should == 2
+    entry.size.should == 2
     entry = entry.last
 
     entry.at('div.title').inner_html == 'new page'
@@ -74,11 +62,11 @@ describe 'blog' do
 
   it 'should edit existing pages' do
     create_page('new page', 'cool! a new page')
-    post('/save','oid'=>'2','title'=>'new title','content'=>'bla bla')
-    doc = check_page('')
-    entry = doc.search('div.entry')
-    entry.length.should == 2
-    entry = entry.first
+    post('/save','id'=>'2','title'=>'new title','content'=>'bla bla')
+    doc = check_page
+    entries = doc/'div.entry'
+    entries.size.should == 2
+    entry = entries.first
 
     entry.at('div.title').inner_html == 'new title'
     entry.at('div.content').inner_html == 'bla bla'
@@ -86,17 +74,14 @@ describe 'blog' do
 
   it 'should delete existing pages' do
     create_page("page to delete", 'content')
-    check_page('').search('div.entry').length.should == 2
-    page = get('/delete/2')
+    entries = check_page/'div.entry'
+    entries.size.should == 2
+    delete_link = entries.last.at("a:contains('delete')")
+    page = get(delete_link[:href])
     page.status.should == 303
     page.location.should == '/'
-    check_page('').search('div.entry').length.should == 1
-  end
-
-  after do
-    Entry.all.each do |e|
-      e.delete unless e.oid == 1
-    end
+    (check_page/'div.entry').size.should == 1
   end
 
+  FileUtils.rm_f(__DIR__/'../blog.db')
 end

data/examples/blog/src/controller.rb

@@ -1,25 +1,27 @@
-class MainController < Controller
+class MainController < Ramaze::Controller
   def index
-    @entries = Entry.all :order => 'created DESC'
+    @entries = Entry.order(:created.DESC).all
   end
-  def delete oid
-    Entry.delete oid
+
+  def delete id
+    entry = Entry[id]
+    entry.delete
     redirect :/
   end
-  def edit oid
-    @entry = Entry[oid]
+
+  def edit id
+    @entry = Entry[id]
+    redirect_referrer unless @entry
   end
+
   def create
-    Entry.create request['title'], request['content']
+    Entry.add(*request[:title, :content])
     redirect :/
   end
+
   def save
-    redirect_referer unless oid = request['oid']
-    entry = Entry[oid]
-    entry.title = request['title']
-    entry.content = request['content']
-    entry.updated = Time.now
-    entry.save
+    redirect_referer unless  entry = Entry[request[:id]]
+    entry.update(*request[:title, :content])
     redirect :/
   end
 end

data/examples/blog/src/model.rb

@@ -1,12 +1,30 @@
-class Entry
-  property :created, Time
-  property :updated, Time
-  property :title, String
-  property :content, String
-  def initialize title, content
-    @created=Time.now
-    @updated=Time.now
-    @title=title
-    @content=content
+require 'sequel'
+
+DB = Sequel("sqlite:///#{__DIR__}/../blog.db")
+
+class Entry < Sequel::Model(:entry)
+  set_schema do
+    primary_key :id
+
+    time :created
+    time :updated
+    text :title
+    text :content
   end
+
+  def self.add(title, content)
+    create :title => title, :content => content,
+      :created => Time.now, :updated => Time.now
+  end
+
+  def update(title = title, content = content)
+    self.title, self.content, self.updated = title, content, Time.now
+    save
+  end
+end
+
+Entry.create_table! unless Entry.table_exists?
+
+if Entry.empty?
+  Entry.add 'Blog created', 'Exciting news today, this blog was created'
 end

data/examples/blog/start.rb

@@ -1,17 +1,7 @@
-$DBG = true # turn on debugging in Og
-
 require 'ramaze'
-require 'og'
-
-include Ramaze
 
 require 'src/model'
 require 'src/view'
 require 'src/controller'
 
-Og.setup :evolve_schema => :full
-
-Entry.create "Blog created", "Exciting news today, this blog was created!" if
-  Entry.count == 0
-
 Ramaze.start

data/examples/blog/template/edit.xhtml

@@ -3,7 +3,7 @@
   <div id="entries">
     <div class="entry">
       <form method="post" action="#{R self,:save}">
-        <input name="oid" type="hidden" value="#{@entry.oid}"/>
+        <input name="id" type="hidden" value="#{@entry.id}"/>
         <div class="header">
           <div class="title">
             <input name="title" type="text" value="#{@entry.title}"/>

data/examples/blog/template/index.xhtml

@@ -7,8 +7,8 @@
         <div class="title">#{entry.title}</div>
         <div class="created">Created: #{entry.created}</div>
         <ul>
-					<li>#{A 'edit', :href => Rs(:edit, entry.oid)}</li>
-					<li>#{A 'delete', :href => Rs(:delete, entry.oid)}</li>
+					<li>#{A 'edit', :href => Rs(:edit, entry.id)}</li>
+					<li>#{A 'delete', :href => Rs(:delete, entry.id)}</li>
 				</ul>
       </div>
       <div class="content">#{entry.content}</div>

data/examples/facebook.rb

@@ -0,0 +1,152 @@
+require 'rubygems'
+require 'ramaze'
+
+Ramaze.contrib :facebook
+
+# Settings for your facebook app
+#   SERVER: where this ramaze app is running
+#   URL: the apps.facebook.com url to your app
+#   KEY: API key for your app
+#   SECRET: Secret key for your app
+#   ID: Your app's ID (from the about page url)
+#   ADMINS: uids of facebook users that are admins
+#   SESSION: an admin's session key
+#
+# These vars are used by the Facebook Helper are are also useful
+# within your controller and templates. For example,
+#   <a href="#{Facebook::URL}/search">click here to search</a>
+#
+# In addition, set the following options on your app's 'Edit Settings' page:
+#   Callback URL: http://myapp.domain.com:7000/ (trailing slash required)
+#   Canvas Page URL: ramazing
+#   Can your app be added on Facebook: Yes
+#   Who can add your app: Users
+#   Post-Add URL: http://apps.facebook.com/ramazing/install
+#   Post-Remove URL: http://myapp.domain.com:7000/uninstall
+#   Side Nav URL: http://apps.facebook.com/ramazing
+
+module Facebook
+  SERVER  = 'http://myapp.domain.com:7000'
+  URL     = 'http://apps.facebook.com/ramazing'
+  KEY     = 'b32f58685c06a7f8107bc7915354bd89'
+  SECRET  = 'e0f9........................9429'
+  ID      = 2502696782
+  ADMINS  = [ 15601088 ]
+  SESSION = ''
+end unless defined? Facebook::ID
+
+# The facebook helper (included your controller using +helper :facebook+)
+# defines a +facebook+ object, which is also aliased to +fb+.
+#
+# POST parameters sent by the facebook servers can be accessed via fb.params
+# and also fb[]. Wherever possible, values will be converted to native ruby
+# types (Time objects, true/false, arrays)
+#
+#   fb.params = { :api_key => "b32f58685c06a7f8107bc7915354bd89",
+#                 :added => true,
+#                 :profile_update_time => Mon Oct 15 15:07:28 -0400 2007,
+#                 :friends => [1,2,3],
+#                 :session_key => "f7bed6aefaa5467b3a6344f2-15601088",
+#                 :time => Sat Dec 01 02:02:50 -0500 2007,
+#                 :user => 15601088,
+#                 :position_fix => false,
+#                 :expires => 0,
+#                 :in_canvas => true }
+#
+#   fb[:user] == facebook[:user] == facebook.params[:user]
+#
+# The facebook object can also be used to make API calls. Native ruby types (true, false, strings, hashes and arrays)
+# will be returned. If facebook returns an array with only one element, that element will be returned instead.
+#
+#   facebook.auth.createToken # => "41b5dc65792ba4bf405faf857a17267c"
+#   fb.users.getInfo :uids => 15601088, :fields => [:name] # => {"name"=>"Aman Gupta", "uid"=>15601088}
+#   fb.profile.setFBML :uid => 15601088, :markup => 'Hi!'  # => true
+#
+# API calls will use the current viewing users' session key (from fb[:session_key]) if present,
+# or Facebook::SESSION, which should be set to one of the admin's keys. You can also provide another
+# session key yourself from your users database:
+#
+#   fb.feed.publishActionOfUser :session_key => "the user's session key", :title => 'is using Ramaze!'
+#
+# Finally, you can use the following facebook object methods:
+#
+#   facebook.valid? # verify fb_sig, if invalid fb.params will return {}
+#   facebook.redirect '/url' # redirect to /url using <fb:redirect/>
+#   facebook.addurl # return the add url for the current app
+#   facebook.addurl '/url' # add url for app that redirects to /url after successful install
+
+class MainController < Ramaze::Controller
+  helper :formatting # for time_diff
+  helper :facebook
+
+  before_all {
+    # show some information about current user in logs
+    # INFO   Facebook {:user=>15601088, :in_canvas=>true, :added=>true}
+    inform :info, "Facebook " + fb.params.reject{|k,v| k.to_s !~ /^(in|is|user|added)/}.inspect if fb[:user]
+
+    # suggest setting SESSION key if one is not set, and current user is an admin
+    # INFO   Set a default session key: SESSION = 'b3638446fa02466210c49f42-15601088'
+    if Facebook::SESSION.empty? and Facebook::ADMINS.include? fb[:user]
+      inform :info, "Set a default session key: SESSION = '#{fb[:session_key]}'"
+    end
+    nil
+  }
+
+  def install
+    inform :info, "#{fb[:user]} installed app" if request['installed'] == '1'
+    facebook.profile.setFBML :uid => fb[:user], :markup => "Isn't this a great surprise!?"
+    facebook.redirect request['next'] || '/'
+  end
+
+  def uninstall
+    inform :info, "#{fb[:user]} uninstalled app"
+  end
+
+  def main
+    fb.redirect '/index' unless fb[:user]
+    @userinfo = facebook.users.getInfo :uids => facebook[:user], :fields => [:name, :pic_square]
+    %q(
+      Hey there #{@userinfo['name']}. You look like this: <img src="#{@userinfo['pic_square']}"/>. <br/>
+      You updated your profile #{time_diff fb[:profile_update_time]} ago. You have #{fb[:friends].size} friends. <br/>
+      <p>
+        <?r unless fb[:added] ?>
+          I know you already logged in, but you should really <a href="#{facebook.addurl}">add this app</a>.
+          You'll get a real nifty surprise on your profile if you do.
+        <?r else ?>
+          Now that you added this app, I can access your profile and news feed. <br/>
+          Did you see the cool surprise I left on <a href="http://www.facebook.com/profile.php?id=#{fb[:user]}">your profile</a>?
+        <?r end ?>
+      </p>
+    )
+  end
+
+  def index
+    facebook.redirect '/main' if facebook[:user]
+    %q(
+      This is a great app. Here are some reasons you'll like it:
+      <ul>
+        <li>It's on facebook</li>
+        <li>It's written in Ramaze</li>
+      </ul>
+      <a href="#{Facebook::URL}/main" requirelogin="true">Login</a> to start using it. Or, to
+      get the full benefit, you should <a href="#{facebook.addurl '/main'}">add it</a> so we have
+      access to your newsfeed and can add a box to your profile.
+    )
+  end
+
+  def layout
+    %q(
+      <fb:dashboard>
+        <?r unless fb[:added] ?>
+          <fb:create-button href="#{facebook.addurl '/main'}">Add App</fb:create-button>
+        <?r end ?>
+      </fb:dashboard>
+      <div id="content" style="margin: 0 2em 2em 2em">
+        #@content
+      </div>
+    )
+  end
+  layout :layout
+end
+
+Ramaze.start :adapter => :mongrel