ramaze 0.3.5 → 0.3.9

data/lib/ramaze/helper/auth.rb

@@ -8,9 +8,10 @@ module Ramaze
   # A simple way to do authentication. Please have a look at the docs for the
   # check_auth method for detailed information
 
-  module AuthHelper
+  module Helper::Auth
+    Helper::LOOKUP << self
 
-    # add AspectHelper and StackHelper on inclusion of AuthHelper
+    # add Helper::Aspect and Helper::Stack on inclusion of Helper::Auth
 
     def self.included(klass)
       klass.send(:helper, :aspect, :stack)
@@ -37,7 +38,7 @@ module Ramaze
         end
         %{
           #{open_element}
-            <form method="POST" action="#{Rs(:login)}>"
+            <form method="POST" action="#{Rs(:login)}">
               <ul style="list-style:none;">
                 <li>Username: <input type="text" name="username" /></li>
                 <li>Password: <input type="password" name="password" /></li>

data/lib/ramaze/helper/cache.rb

@@ -6,11 +6,12 @@ module Ramaze
   # This helper is providing easy access to a couple of Caches to use for
   # smaller amounts of data.
 
-  module CacheHelper
+  module Helper::Cache
+    C = Ramaze::Cache
 
     # Create the Cache.value_cache on inclusion if it doesn't exist yet.
     def self.included(klass)
-      Cache.add(:value_cache) unless Cache::CACHES.has_key?(:value_cache)
+      C.add(:value_cache) unless C::CACHES.has_key?(:value_cache)
     end
 
     # Example:
@@ -59,7 +60,7 @@ module Ramaze
     # for example heavy calculations or time-consuming queries.
 
     def value_cache
-      Cache.value_cache
+      C.value_cache
     end
 
     # action_cache holds rendered output of actions for which caching is enabled.
@@ -123,7 +124,7 @@ module Ramaze
     #   action_cache.delete '/path/to/action'
 
     def action_cache
-      Cache.actions
+      C.actions
     end
 
     # This refers to the class-trait of cached actions, you can

data/lib/ramaze/helper/cgi.rb

@@ -5,37 +5,39 @@ module Ramaze
 
   # Shortcuts to some CGI methods
 
-  module CgiHelper
-    private
-
+  module Helper::CGI
     # shortcut for CGI.escape
 
     def url_encode(*args)
-      CGI.escape(*args)
+      ::CGI.escape(*args.map{|arg| arg.to_s})
     end
 
     # shortcut for CGI.unescape
 
     def url_decode(*args)
-      CGI.unescape(*args)
+      ::CGI.unescape(*args.map{|arg| arg.to_s})
     end
 
     # shortcut for CGI.escapeHTML
 
     def html_escape(string)
-      CGI.escapeHTML(string)
+      ::CGI.escapeHTML(string.to_s)
     end
 
     # shortcut for CGI.unescapeHTML
 
     def html_unescape(string)
-      CGI.unescapeHTML(string)
+      ::CGI.unescapeHTML(string.to_s)
+    end
+
+    # safely escape all HTML and code
+    def c(string)
+      ::CGI.escapeHTML(string.to_s).gsub(/#/, '#')
     end
 
     # one-letter versions help in case like #{h foo.inspect}
     # ERb/ERuby/Rails compatible
-    alias h html_escape
     alias u url_encode
-
+    alias h c
   end
 end

data/lib/ramaze/helper/flash.rb

@@ -22,13 +22,38 @@ module Ramaze
   #
   # On the request after this, flash[:error] is gone.
 
-  module FlashHelper
-    private
-
+  module Helper::Flash
+    trait :tag => "<div class='flash' id='flash_%key'>%value</div>"
     # answers with Session.current.flash
 
     def flash
       Session.current.flash
     end
+
+    # Use in your template to display all flash messages that may be stored.
+    # For example, given you stored:
+    #
+    #   flash # => { :error => 'Pleae enter your name'
+    #                :info => 'Do you see the fnords?' }
+    #
+    # Then a flashbox would display:
+    #
+    #   <div class='flash' id='flash_error'>Please enter your name</div>
+    #   <div class='flash' id='flash_info'>Do you see the fnords?</div>
+    #
+    # This is designed to be customized permanently or per usage:
+    #
+    #   flashbox("<div class='flash_%key'>%value</div>")
+    #
+    # Where any occurrence of %key and %value will be replaced by the actual
+    # contents of each element of flash
+
+    def flashbox(tag = Helper::Flash.trait[:tag])
+      flash.map{|key, value|
+        [key.to_s, value.to_s]
+      }.sort.map{|(key, value)|
+        tag.gsub(/%key/, key.to_s).gsub(/%value/, value.to_s)
+      }.join("\n")
+    end
   end
 end

data/lib/ramaze/helper/formatting.rb

@@ -2,9 +2,7 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 module Ramaze
-  module FormattingHelper
-    private
-
+  module Helper::Formatting
     def number_format(n, delimiter = ',')
       delim_l, delim_r = delimiter == ',' ? %w[, .] : %w[. ,]
       h, r = n.to_s.split('.')

data/lib/ramaze/helper/identity.rb

@@ -1,14 +1,13 @@
 #          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
 # All files in this distribution are subject to the terms of the Ruby license.
 
-require 'tmpdir'
 require 'openid'
 require 'openid/store/filesystem'
 require 'openid/extensions/pape'
 
 module Ramaze
 
-  openid_store_file = File.join(Dir.tmpdir, 'openid-store')
+  openid_store_file = ::File.join(Dir.tmpdir, 'openid-store')
 
   # Constant for storing meta-information persistent
   OpenIDStore = OpenID::Store::Filesystem.new(openid_store_file)
@@ -17,7 +16,7 @@ module Ramaze
   # It provides a nice and simple way to provide and control access over the
   # OpenID authentication model.
 
-  module IdentityHelper
+  module Helper::Identity
 
     # Simple form for use or overwriting.
     # Has to provide the same functionality when overwritten or directly

data/lib/ramaze/helper/inform.rb

@@ -3,11 +3,10 @@
 
 module Ramaze
 
-  # Easy access to Inform
+  # Easy access to Log
 
-  module InformHelper
-
-    private
+  module Helper::Log
+    L = Ramaze::Log
 
     # The various (default) tags you can use are:
     #
@@ -32,8 +31,10 @@ module Ramaze
     #   # [2007-04-04 23:40:59] ERROR  hello.rb:23:in `index'
     #   # ... rest of backtrace ...
 
-    def inform tag, *args
-      Inform.send(tag, *args)
+    def log tag, *args
+      L.warn "Helper::Log is being deprecated, use Log directly instead"
+      L.send(tag, *args)
     end
+    alias inform log
   end
 end

data/lib/ramaze/helper/link.rb

@@ -2,43 +2,40 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 module Ramaze
-  # LinkHelper is included into the Controller by default
+  # Helper::Link is included into the Controller by default
   #
   # Usage is shown in spec/ramaze/helper/link.rb and the rdocs below.
 
-  module LinkHelper
-
-    private
+  module Helper::Link
+  private
 
     # Builds a basic <a> tag.
     #
-    # `title` is mandatory, the second hash of options will be transformed into
+    # `text` is mandatory, the second hash of options will be transformed into
     # arguments of the tag, :href is a special case and its segments will be
     # CGI.escaped.
     #
-    # If you pass no :href, the title will be run through Rs and its result is
+    # If you pass no :href, the text will be run through Rs and its result is
     # used instead. If you really want an empty href, use :href => ''
     #
     # Usage:
-    #   A('title')                      #> <a href="/title">title</a>
+    #   A('text')                       #> <a href="/text">text</a>
     #   A('foo/bar')                    #> <a href="/foo/bar">foo/bar</a>
     #   A('/foo?x=y')                   #> <a href="/foo?x=y">/foo?x=y</a>
-    #   A('title', :href => '/foo?x=y') #> <a href="/foo?x=y">title</a>
+    #   A('text', :href => '/foo?x=y')  #> <a href="/foo?x=y">text</a>
     #   A('Home', :href => Rs(:/))      #> <a href="/foo/bar">Home</a>
 
     def A(*args)
       hash = args.last.respond_to?(:to_hash) ? args.pop : {}
 
       hash[:href] ||= Rs(*args)
-      title = hash.delete(:title) ||
-              (args.last.respond_to?(:to_s) ? args.last : nil) ||
-              hash[:href]
-      hash[:href].to_s.sub!(/\A[^\/?]+/) {|m| CGI.escape(m) }
+      text = hash.delete(:text) || args.last || hash[:title] || hash[:href]
+      hash[:href] = hash[:href].to_s.gsub(/[^\/?;=]+/) {|m| CGI.escape(m) }
 
       args = ['']
       hash.each {|k,v| args << %(#{k}="#{v}") if k and v }
 
-      %(<a#{args.join(' ')}>#{title}</a>)
+      %(<a#{args.join(' ')}>#{text}</a>)
     end
 
     # Builds links out of segments.
@@ -63,18 +60,19 @@ module Ramaze
       args = args.flatten.inject{|s,v| s.merge!(v) }
 
       map = Global.mapping.invert
+
       atoms.map! do |atom|
         if atom.is_a?(Ramaze::Controller)
-          map[atom.class] || atom
+          map[atom.class]
         else
-          map[atom] || atom
-        end
+          map[atom]
+        end or atom.to_s
       end
 
       front = atoms.join('/').squeeze('/')
 
       if args
-        rear = args.inject('?'){|s,(k,v)| s << "#{k}=#{v};"}[0..-2]
+        rear = args.inject('?'){|s,(k,v)| s << "#{CGI.escape k.to_s}=#{CGI.escape v.to_s};"}[0..-2]
         front + rear
       else
         front

data/lib/ramaze/helper/markaby.rb

@@ -5,9 +5,7 @@ module Ramaze
 
   # Allows you to use some shortcuts for markaby in your Controller.
 
-  module MarkabyHelper
-    private
-
+  module Helper::Markaby
     # use this inside your controller to directly build Markaby
     # Refer to the Markaby-documentation and testsuite for more examples.
     # Usage:
@@ -16,7 +14,7 @@ module Ramaze
 
     def markaby(ivs = {}, helpers = nil, &block)
       builder = ::Markaby::Builder
-      builder.extend(Ramaze::Helper)
+      builder.extend(Ramaze::Helper::Methods)
       builder.send(:helper, :link)
 
       iv_hash = {}

data/lib/ramaze/helper/maruku.rb

@@ -1,5 +1,5 @@
 module Ramaze
-  module MarukuHelper
+  module Helper::Maruku
     def maruku(text)
       Maruku.new(text).to_html
     end

data/lib/ramaze/helper/nitroform.rb

@@ -4,11 +4,11 @@
 require 'nitro/helper/form'
 
 module Ramaze
+  module Helper
 
-  # This helper simply includes the Nitro::FormHelper so you can use its methods
-  # in your Controller.
+    # This helper simply includes the Nitro::FormHelper so you can use its methods
+    # in your Controller.
 
-  module NitroformHelper
-    include ::Nitro::FormHelper
+    Nitroform = ::Nitro::FormHelper
   end
 end

data/lib/ramaze/helper/pager.rb

@@ -82,7 +82,7 @@ module Ramaze
 #   .pager li.active {}
 
 class Pager
-  include Ramaze::LinkHelper
+  include Ramaze::Helper::Link
 
   # Items per page.
 
@@ -116,7 +116,7 @@ class Pager
   # key:: key used for getting the current page from GET paramaters
   #
   # Note:  You never have to create this class yourself, use the `paginate()`
-  # convenience method from the PagerHelper.
+  # convenience method from the Helper::Pager.
 
   def initialize(request, limit, total_count, key = trait[:key])
     raise 'limit should be > 0' unless limit > 0
@@ -255,7 +255,7 @@ private
 
   def target_uri(page)
     params = @request.params.merge(@key => page)
-    Rs(Action.current.method, params)
+    Rs(Action.current.name, params)
   end
 
   # Generate link for the first page.
@@ -309,9 +309,7 @@ end
 
 # Pager related helper methods.
 
-module PagerHelper
-
-private
+module Helper::Pager
 
   # Helper method that generates a collection of items and the
   # associated pager object.

data/lib/ramaze/helper/partial.rb

@@ -3,7 +3,7 @@
 
 module Ramaze
 
-  # = PartialHelper
+  # = Helper::Partial
   #
   # === Example Usage
   #
@@ -24,9 +24,7 @@ module Ramaze
   #     </body>
   #   </html>
 
-  module PartialHelper
-
-    private
+  module Helper::Partial
     module_function
 
     # Renders a url 'inline'.
@@ -37,46 +35,51 @@ module Ramaze
     def render_partial(url, options = {})
       saved = {}
       options.keys.each {|x| saved[x] = Request.current.params[x] }
-      saved_action = Action.current
 
       Request.current.params.update(options)
 
       Controller.handle(url)
     ensure
-      Thread.current[:action] = saved_action
       options.keys.each {|x| Request.current.params[x] = saved[x] }
     end
 
     # Render the template file in template_root of the
     # current controller.
 
-    def render_template(file, locals = {})
+    def render_template(file, vars = {})
       current = Action.current
       options = { :controller => current.controller,
                   :instance => current.instance.dup }
 
-      filename = options[:controller].template_root/file
+      roots = [options[:controller].template_paths].flatten
 
-      if File.exist?(filename)
-        options[:template] = filename
-      elsif files = Dir["#{filename}.*"] and files.any?
-        options[:template] = files.first
+      if (files = Dir["{#{roots.join(',')}}"/"{#{file},#{file}.*}"]).any?
+        options[:template] = files.first.squeeze '/'
       else
-        Inform.warn "render_template: #{filename} does not exist"
+        Log.warn "render_template: #{file} does not exist in the following directories: #{roots.join(',')}."
         return ''
       end
 
-      # use method_missing to provide access to locals, if any exist
-      options[:instance].meta_def(:method_missing) { |sym, *args|
-        return locals[sym] if locals.key?(sym)
-        super
-      } if locals.any?
+      binding = options[:instance].scope
+
+      vars.each do |name, value|
+        options[:instance].instance_variable_set("@#{name}", value)
 
-      options[:binding]  = options[:instance].instance_eval{ binding }
+        value = "ObjectSpace._id2ref(#{ value.object_id })"
+        eval "#{ name } = #{ value }", binding
+      end
+
+      options[:binding] = binding
 
       Ramaze::Action(options).render
-    ensure
-      Thread.current[:action] = current
     end
+
+    # shortcut to render_partial, accepts a method and contructs a link to the
+    # current controller, then calls render_partial on that
+
+    def render_action method, *params
+      render_partial(Rs(method), *params)
+    end
+
   end
 end