RubyGems - ramaze - Versions diffs - 0.1.1 → 0.1.2 - Mend

ramaze 0.1.1 → 0.1.2

Files changed (89) hide show

data/Rakefile +14 -29
data/bin/ramaze +2 -3
data/doc/AUTHORS +5 -2
data/doc/CHANGELOG +262 -9
data/doc/FAQ +6 -6
data/doc/meta/announcement.txt +5 -19
data/doc/tutorial/todolist.html +47 -57
data/doc/tutorial/todolist.mkd +47 -55
data/examples/memleak_detector.rb +31 -0
data/examples/todolist/src/controller/main.rb +14 -13
data/examples/todolist/src/element/page.rb +2 -2
data/examples/todolist/src/model.rb +2 -2
data/examples/todolist/todolist.db +0 -4
data/examples/whywiki/main.rb +2 -2
data/examples/whywiki/template/edit.xhtml +1 -1
data/examples/whywiki/template/show.xhtml +3 -3
data/lib/proto/src/controller/main.rb +18 -1
data/lib/proto/template/index.xhtml +11 -2
data/lib/ramaze.rb +1 -1
data/lib/ramaze/action.rb +104 -5
data/lib/ramaze/action/render.rb +54 -0
data/lib/ramaze/adapter.rb +2 -1
data/lib/ramaze/adapter/mongrel.rb +13 -4
data/lib/ramaze/cache.rb +17 -8
data/lib/ramaze/cache/memcached.rb +1 -5
data/lib/ramaze/controller.rb +51 -18
data/lib/ramaze/controller/resolve.rb +19 -14
data/lib/ramaze/dispatcher.rb +13 -16
data/lib/ramaze/dispatcher/action.rb +2 -3
data/lib/ramaze/dispatcher/error.rb +8 -3
data/lib/ramaze/dispatcher/file.rb +1 -4
data/lib/ramaze/error.rb +5 -5
data/lib/ramaze/global.rb +7 -1
data/lib/ramaze/global/globalstruct.rb +1 -3
data/lib/ramaze/helper/aspect.rb +8 -10
data/lib/ramaze/helper/cgi.rb +21 -3
data/lib/ramaze/helper/identity.rb +4 -6
data/lib/ramaze/helper/link.rb +4 -4
data/lib/ramaze/helper/pager.rb +316 -0
data/lib/ramaze/helper/partial.rb +37 -0
data/lib/ramaze/helper/stack.rb +1 -1
data/lib/ramaze/inform.rb +9 -0
data/lib/ramaze/inform/hub.rb +5 -0
data/lib/ramaze/inform/informer.rb +12 -6
data/lib/ramaze/inform/informing.rb +32 -7
data/lib/ramaze/inform/knotify.rb +21 -0
data/lib/ramaze/inform/xosd.rb +58 -24
data/lib/ramaze/sourcereload.rb +30 -1
data/lib/ramaze/template.rb +33 -12
data/lib/ramaze/template/amrita2.rb +21 -20
data/lib/ramaze/template/erubis.rb +18 -14
data/lib/ramaze/template/ezamar.rb +15 -26
data/lib/ramaze/template/ezamar/element.rb +1 -1
data/lib/ramaze/template/ezamar/engine.rb +45 -36
data/lib/ramaze/template/ezamar/morpher.rb +3 -3
data/lib/ramaze/template/ezamar/render_partial.rb +26 -0
data/lib/ramaze/template/haml.rb +23 -18
data/lib/ramaze/template/liquid.rb +5 -3
data/lib/ramaze/template/markaby.rb +14 -11
data/lib/ramaze/template/remarkably.rb +11 -5
data/lib/ramaze/tool/localize.rb +12 -4
data/lib/ramaze/tool/tidy.rb +26 -23
data/lib/ramaze/trinity/request.rb +11 -7
data/lib/ramaze/trinity/session.rb +24 -8
data/lib/ramaze/version.rb +1 -1
data/rake_tasks/maintaince.rake +136 -11
data/spec/examples/templates/template_liquid.rb +6 -3
data/spec/examples/todolist.rb +1 -2
data/spec/helper/minimal.rb +7 -7
data/spec/ramaze/action/basics.rb +19 -0
data/spec/ramaze/action/render.rb +18 -0
data/spec/ramaze/controller.rb +1 -1
data/spec/ramaze/controller/template_resolving.rb +1 -1
data/spec/ramaze/dispatcher/file.rb +24 -0
data/spec/ramaze/error.rb +28 -29
data/spec/ramaze/helper/cgi.rb +43 -0
data/spec/ramaze/helper/pager.rb +27 -0
data/spec/ramaze/helper/partial.rb +38 -0
data/spec/ramaze/helper/template/partial.xhtml +1 -0
data/spec/ramaze/inform/informer.rb +1 -1
data/spec/ramaze/localize.rb +1 -1
data/spec/ramaze/morpher.rb +3 -3
data/spec/ramaze/request.rb +1 -3
data/spec/ramaze/template.rb +9 -7
data/spec/ramaze/template/haml.rb +2 -1
metadata +21 -7
data/examples/todolist/public/404.jpg +0 -0
data/examples/todolist/public/error.xhtml +0 -74
data/lib/ramaze/controller/render.rb +0 -90

@@ -0,0 +1,31 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+require 'ramaze'
+# you can access it now with http://localhost:7000/
+# This should output
+# Hello, World!
+# in your browser
+class MainController < Ramaze::Controller
+  def index
+    "Hello, World!"
+  end
+end
+def check
+  os = []
+  ObjectSpace.each_object{|o| os << o }
+  p os.inject(Hash.new(0)){|s,v| s[v.class] += 1; s}.sort_by{|k,v| v}
+end
+Thread.new do
+  loop do
+    check
+    sleep 5
+  end
+end
+Ramaze::Inform.loggers.clear
+Ramaze.start :adapter => :mongrel, :sourcereload => false

data/examples/todolist/src/controller/main.rb CHANGED

@@ -1,14 +1,19 @@
 #          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
 # All files in this distribution are subject to the terms of the Ruby license.
-class MainController < Controller
+# Default url mappings are:
+#  a controller called Main is mapped on the root of the site: /
+#  a controller called Something is mapped on: /something
+# If you want to override this, add a line like this inside the class
+#  map '/otherurl'
+# this will force the controller to be mounted on: /otherurl
-  helper :aspect
+class MainController < Controller
   def index
     @tasks = []
-    TodoList.original.each do |title, parameters|
-      if parameters[:done]
+    TodoList.original.each do |title, value|
+      if value[:done]
         status = 'done'
         toggle = A('Open Task', :href => Rs(:open, title))
       else
@@ -25,7 +30,7 @@ class MainController < Controller
     if title = request['title']
       title.strip!
       if title.empty?
-        error("Please enter a title")
+        failed("Please enter a title")
         redirect '/new'
       end
       TodoList[title] = {:done => false}
@@ -44,22 +49,18 @@ class MainController < Controller
     TodoList.delete title
   end
-  after(:create, :open, :close, :delete){ redirect_index }
-  def redirect_index
-    redirect(Rs())
-  end
+  helper :aspect
+  after(:create, :open, :close, :delete){ redirect(Rs()) }
   private
-  def error(message)
+  def failed(message)
     flash[:error] = message
   end
   def task_status title, status
-    p title
     unless task = TodoList[title]
-      error "No such Task: `#{title}'"
+      failed "No such Task: `#{title}'"
       redirect_referer
     end

data/examples/todolist/src/element/page.rb CHANGED

@@ -3,7 +3,7 @@
 class Page < Ezamar::Element
   def render
-    %(
+    %{
     <html>
       <head>
         <title>TodoList</title>
@@ -26,6 +26,6 @@ class Page < Ezamar::Element
         #{content}
       </body>
     </html>
-    )
+    }
   end
 end

data/examples/todolist/src/model.rb CHANGED

@@ -9,6 +9,6 @@ TodoList = Ramaze::Store::Default.new('todolist.db')
   'Laundry'     => {:done => false},
   'Wash dishes' => {:done => false},
-}.each do |task, parameters|
-  TodoList[task] = parameters
+}.each do |title, value|
+  TodoList[title] = value
 end

data/examples/todolist/todolist.db CHANGED

@@ -1,9 +1,5 @@
 ---
 Wash dishes:
   :done: false
-foobar:
-  :done: false
 Laundry:
   :done: false
-implement:
-  :done: false

data/examples/whywiki/main.rb CHANGED

@@ -16,7 +16,7 @@ class WikiController < Controller
   end
   def show page = 'Home'
-    @page = page
+    @page = CGI.unescape(page)
     @text = Db[page].to_s
     @text.gsub!(/\[\[(.*?)\]\]/) do |m|
@@ -28,7 +28,7 @@ class WikiController < Controller
   end
   def edit page = 'Home'
-    @page = page
+    @page = CGI.unescape(page)
     @text = Db[page]
   end

data/examples/whywiki/template/edit.xhtml CHANGED

@@ -2,7 +2,7 @@
   <head>
     <title>MicroWiki Edit #{@page}</title>
   </head>
-    #{ link(R(self), :title => "&lt; Home") }
+    #{ A("&lt; Home", :href => R(self)) }
   <body>
     <h1>Edit #{@page}</h1>
     <form method="POST" action="#{R(self, :save)}">

data/examples/whywiki/template/show.xhtml CHANGED

@@ -6,14 +6,14 @@
       a.nonexists{ color: #f00; }
     </style>
   </head>
-    #{ link(R(self), :title => "&lt; Home") unless @page == "Home" }
+    #{ A("&lt; Home", :href => R(self)) unless @page == "Home" }
   <body>
     <h1>#{@page}</h1>
     <?r if @text.empty? ?>
-      #{ link(R(self, :edit, CGI.escape(@page)), :title => "Create #{@page}?") }
+      #{ A("Create #{@page}?",:href => R(self, :edit, CGI.escape(@page))) }
     <?r else ?>
     <div>
-      #{ link(R(self, :edit, CGI.escape(@page)), :title => "Edit #{@page}") }
+      #{ A("Edit #{@page}?", :href => R(self, :edit, CGI.escape(@page))) }
       #{@text}
     </div>
     <?r end ?>

data/lib/proto/src/controller/main.rb CHANGED

@@ -1,8 +1,25 @@
 #          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
 # All files in this distribution are subject to the terms of the Ruby license.
+# Default url mappings are:
+#  a controller called Main is mapped on the root of the site: /
+#  a controller called Something is mapped on: /something
+# If you want to override this, add a line like this inside the class
+#  map '/otherurl'
+# this will force the controller to be mounted on: /otherurl
 class MainController < Controller
+  # the index action is called automatically when no other action is specified
   def index
-    "Hello, World"
+    @welcome = "Welcome to Ramaze!"
   end
+  # the string returned at the end of the function is used as the html body
+  # if there is no template for the action. if there is a template, the string
+  # is silently ignored
+  def notemplate
+    "there is no template associated with this action"
+  end
 end

data/lib/proto/template/index.xhtml CHANGED

@@ -1,6 +1,15 @@
 <Page>
-  <h1>Welcome to Ramaze</h1>
+  <h1>#{@welcome}</h1>
+  <p>Ramaze is working correctly with this application, now you can start working</p
   <p>
-    blah, blah, blah
+    To start you can modify:
+    <ol>
+      <li><code>template/index.xhtml</code>, which this text</li>
+      <li><code>src/elements/page.rb</code>, which is the Element around this text</li>
+      <li><code>src/controllers/main.rb</code>, where you can change the header of this page and the        <a href="/notemplate">notemplate</a> action</li>
+      <li><code>src/model.rb</code>, which is the the persistent backend for your app</li>
+    </ol>
   </p>
+  <p>You can also read the tutorial in the <code>doc/</code> directory of ramaze or browse the <a href="http://ramaze.rubyforge.org/rdoc/files/doc/README.html">rdocs</a><p>
 </Page>

data/lib/ramaze.rb CHANGED

@@ -30,7 +30,7 @@ module Ramaze
   # Each of these classes will be called ::startup upon Ramaze.startup
   trait :essentials => [
-    Global, Controller, Session, SourceReload, Adapter
+    Global, Cache, Controller, Session, SourceReload, Adapter
   ]
   class << self

data/lib/ramaze/action.rb CHANGED

@@ -5,17 +5,116 @@ module Ramaze
   unless defined?(Action) # prevent problems for SourceReload
+    members = %w[method params template controller path binding engine instance]
     # The Action holds information that is essential to render the action for a
     # request.
-    class Action < Struct.new('Action', :controller, :method, :params, :template, :binding)
-      def to_s
-        %{#<Action method=#{method.inspect}, params=#{params.inspect} template=#{template.inspect}>}
+    class Action < Struct.new('Action', *members)
+    end
+  end
+  require 'ramaze/action/render'
+  class Action
+    class << self
+      # Instantiate with given Hash, takes both string/symbol keys.
+      # Only keys that match members of the Action-Struct are used.
+      def create(hash = {})
+        i = new
+        members.each do |key|
+          i.send("#{key}=", (hash[key] || hash[key.to_sym]))
+        end
+        i
       end
-      def params=(*par)
-        self[:params] = par.flatten.map{|pa| CGI.unescape(pa)}
+      # Thread.current[:action] returns the instance of Action you are currently in.
+      def current
+        Thread.current[:action]
       end
     end
+    # nicer representation of the Action
+    def to_s
+      m, p, t = method.inspect, params.inspect, template.inspect
+      %{#<Action method=#{m}, params=#{p} template=#{t}>}
+    end
+    # Set the method, will be converted to a string and set to nil if empty.
+    def method=(meth)
+      meth = meth.to_s
+      self[:method] = (meth.empty? ? nil : meth)
+    end
+    # runs all parameters assigned through flatten and CGI::unescape
+    def params=(*par)
+      self[:params] = par.flatten.compact.map{|pa| CGI.unescape(pa.to_s)}
+    end
+    # Use this as key for caches.
+    def relaxed_hash
+      [controller, method, params, template, path].hash
+    end
+    # A Hash representation of Action
+    def to_hash
+      hash = {}
+      members.each{|m| hash[m.to_sym] = send(m)}
+      hash
+    end
+    # Determines based on controller.trait[:engine] and the template extensions
+    # which engine has to be used.
+    # Defaults to Template::Ezamar
+    def engine
+      return self[:engine] if self[:engine]
+      default = controller.trait.fetch(:engine, Template::Ezamar)
+      return default unless template
+      engines = Template::ENGINES
+      return default if engines.empty?
+      ext = File.extname(template).gsub(/^\./, '')
+      ext_engine = engines.find{|e| e.last.include?(ext)}.first
+      self[:engine] = (ext_engine || default)
+    end
+    # Returns an instance of controller, will be cached on first access.
+    def instance
+      self[:instance] ||= controller.new
+    end
+    # Returns a binding of the instance, will be cached on first access.
+    def binding
+      self[:binding] ||= instance.instance_eval{ binding }
+    end
+    # Hook for AspectHelper
+    def before_process
+    end
+    # Hook for AspectHelper
+    def after_process
+    end
+  end
+  # Shortcut to create new instances of Action via Action::fill
+  def self.Action(hash = {})
+    Action.create(hash)
   end
 end

data/lib/ramaze/action/render.rb ADDED

@@ -0,0 +1,54 @@
+#          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+module Ramaze
+  class Action
+    # Render this instance of Action, this will (eventually) pass itself to
+    # Action#engine.transform
+    # Usage, given that Foo is a Controller and has the method/template
+    # for index:
+    #  > Action(:controller => Foo).render
+    #  #> 'bar'
+    def render
+      Inform.debug("The Action: #{self}")
+      Thread.current[:action] = self
+      if should_cache?
+        cached_render
+      else
+        uncached_render
+      end
+    end
+    def cached_render
+      action_cache = Cache.actions
+      if out = action_cache[relaxed_hash]
+        Inform.debug("Using Cached version")
+        return out
+      end
+      Inform.debug("Compiling Action")
+      action_cache[relaxed_hash] = uncached_render
+    end
+    def uncached_render
+      [ before_process,
+        engine.transform(self),
+        after_process,
+      ].join
+    end
+    def should_cache?
+      ctrait = controller.trait
+      actions_cached = ctrait[:actions_cached]
+      [ Global.cache_all,
+        ctrait[:cache_all],
+        actions_cached.map{|k| k.to_s}.include?(method),
+      ].any?
+    end
+  end
+end

data/lib/ramaze/adapter.rb CHANGED

@@ -85,7 +85,8 @@ module Ramaze
           end
         end
       rescue Timeout::Error
-        Global.adapters.list.each{|a| a.kill!}
+        Global.adapters.list.each{|a| a.kill! }
+        # Hard exit! because it won't be able to kill Webrick otherwise
         exit!
       end

data/lib/ramaze/adapter/mongrel.rb CHANGED

@@ -1,11 +1,20 @@
 #          Copyright (c) 2006 Michael Fellinger m.fellinger@gmail.com
 # All files in this distribution are subject to the terms of the Ruby license.
-require 'ramaze/adapter'
-require 'mongrel'
-require 'rack/handler/mongrel'
 module Ramaze
+  if ENV['SWIFT']
+    require 'swiftcore/swiftiplied_mongrel'
+    Inform.debug "Using Swiftiplied Mongrel"
+  elsif ENV['EVENT']
+    require 'swiftcore/evented_mongrel'
+    Inform.debug "Using Evented Mongrel"
+  else
+    require 'mongrel'
+  end
+  require 'ramaze/adapter'
+  require 'rack/handler/mongrel'
   module Adapter
     class Mongrel < Base
       class << self

data/lib/ramaze/cache.rb CHANGED

@@ -12,18 +12,27 @@ module Ramaze
   class Cache
     include Enumerable
-    CACHES = {}
+    CACHES = {} unless defined?(CACHES)
-    # This will define a method to access a new cache directly over
-    # sinleton-methods on Cache
+    class << self
-    def self.add *keys
-      keys.each do |key|
-        CACHES[key] = new
-        self.class.class_eval do
-          define_method(key){ CACHES[key] }
+      def startup(options)
+        Cache.add :compiled, :actions, :patterns, :resolved, :shield
+      end
+      # This will define a method to access a new cache directly over
+      # sinleton-methods on Cache
+      def add *keys
+        keys.each do |key|
+          CACHES[key] = new
+          self.class.class_eval do
+            define_method(key){ CACHES[key] }
+          end
         end
+        Inform.debug("Added caches for: #{keys.join(', ')}")
       end
     end
     def initialize(cache = Global.cache)