ramaze 2011.01.30 → 2011.07.25

data/lib/ramaze/helper/simple_captcha.rb

@@ -36,15 +36,14 @@ module Ramaze
         op = rand > 0.42 ? [ns[0], :+, ns[1]] : [ns[1], :-, ns[0]]
 
         question = op.join(' ')
-        answer = op[0].send(op[1], op[2])
+        answer   = op[0].send(op[1], op[2])
 
         [question, answer]
       }
 
       # Call the trait[:captcha] and store question/answer in session
       def simple_captcha
-        question, answer = ancestral_trait[:captcha].call
-
+        question, answer  = ancestral_trait[:captcha].call
         session[:CAPTCHA] = { :question => question, :answer => answer.to_s }
 
         question
@@ -56,6 +55,6 @@ module Ramaze
 
         answer.to_s.strip == captcha[:answer].to_s
       end
-    end
-  end
-end
+    end # SimpleCaptcha
+  end # Helper 
+end # Ramaze

data/lib/ramaze/helper/stack.rb

@@ -3,7 +3,7 @@
 
 module Ramaze
   module Helper
-
+    ##
     # provides an call/answer mechanism, this is useful for example in a
     # login-system.
     #
@@ -38,6 +38,7 @@ module Ramaze
     #     "Agent X is assigned to fight the RubyNinjas"
     #   end
     # end
+    #
     module Stack
       # redirect to another location and pushing the current location
       # on the session[:STACK]
@@ -50,11 +51,13 @@ module Ramaze
         redirect(this)
       end
 
+      ##
       # return to the last location on session[:STACK]
       # The optional alternative paramter will be used to redirect in case you
       # are not inside_stack?
       # If the session has no stack and no alternative is given this won't do
       # anything
+      #
       def answer(alternative = nil)
         if inside_stack?
           stack = session[:STACK]
@@ -70,6 +73,6 @@ module Ramaze
       def inside_stack?
         session[:STACK] and session[:STACK].any?
       end
-    end
-  end
-end
+    end # Stack
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/tagz.rb

@@ -4,16 +4,15 @@
 require 'tagz'
 
 module Ramaze
-
-  # Allows you to use some shortcuts for Tagz in your Controller.
-
-  # use this inside your controller to directly build Tagz
-  # Refer to the Tagz-documentation and testsuite for more examples.
-  # Usage:
-  #   tagz { h1_{ "Apples & Oranges" } }                   #=> "<h1>Apples &amp; Oranges</h1>"
-  #   tagz { h1_(:class => 'fruits&floots'){ 'Apples' } }  #=> "<h1 class=\"fruits&amp;floots\">Apples</h1>"
-
   module Helper
+    ##
+    # Allows you to use some shortcuts for Tagz in your Controller.
+    # use this inside your controller to directly build Tagz
+    # Refer to the Tagz-documentation and testsuite for more examples.
+    # Usage:
+    #   tagz { h1_{ "Apples & Oranges" } }  #=> "<h1>Apples &amp; Oranges</h1>"
+    #   tagz { h1_(:class => 'fruits&floots'){ 'Apples' } }
+    #
     Tagz = ::Tagz
-  end
-end
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/thread.rb

@@ -2,21 +2,24 @@
 # All files in this distribution are subject to the terms of the Ruby license.
 
 module Ramaze
-  module Helper::Thread
-    ##
-    # The thread method executes the specified block in a new thread.
-    #
-    # @param [Block] block The block that contains the code that will be executed in the new thread.
-    #
-    def thread &block
-      parent_thread = Thread.current
-      Thread.new do
-        begin
-          block.call
-        rescue Exception => e
-          parent_thread.raise(e)
+  module Helper
+    module Thread
+      ##
+      # The thread method executes the specified block in a new thread.
+      #
+      # @param [Block] block The block that contains the code that will be 
+      #  executed in the new thread.
+      #
+      def thread &block
+        parent_thread = Thread.current
+        Thread.new do
+          begin
+            block.call
+          rescue Exception => e
+            parent_thread.raise(e)
+          end
         end
       end
-    end
-  end
-end
+    end # Thread
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/ultraviolet.rb

@@ -11,9 +11,11 @@ module Ramaze
         :headers      => false, # ouput document with all headers
       }
 
+      ##
       # Parse and output the file at the given path.
       # Please head over to the Ultraviolet documentation for more information
       # on possible options.
+      #
       def ultraviolet(path, options = {})
         o = ancestral_trait[:ultraviolet].merge(options)
         output, syntax, lines, style, headers =
@@ -26,6 +28,7 @@ module Ramaze
         Uv.parse(code, output, syntax, lines, style, headers)
       end
 
+      ##
       # Return absolute path to the css of given name.
       #
       # Usually this will point to somewhere in the gem tree.
@@ -33,7 +36,7 @@ module Ramaze
       # It seems like Uv will add support for user-defined PATH in the future,
       # so we will, to be future-proof, traverse the Uv.path even though it
       # currently will only have one directory.
-
+      #
       def ultraviolet_css(theme)
         Uv.path.each do |path|
           Dir[path/"render/xhtml/files/css/*.css"].each do |css|
@@ -41,6 +44,6 @@ module Ramaze
           end
         end
       end
-    end
-  end
-end
+    end # UltraViolet
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/user.rb

@@ -4,8 +4,8 @@ module Ramaze
     # This helper provides a convenience wrapper for handling authentication
     # and persistence of users.
     #
-    # On every request, when you use the {UserHelper#user} method for the first time,
-    # we confirm the authentication and store the returned object in the
+    # On every request, when you use the {UserHelper#user} method for the first
+    # time, we confirm the authentication and store the returned object in the
     # request.env, usually this will involve a request to your database.
     #
     # @example Basic usage with User::authenticate
@@ -77,7 +77,7 @@ module Ramaze
     #
     # @example Using a lambda instead of User::authenticate
     #
-    #   # assumes all your controllers inhert from this one
+    #   # assumes all your controllers inherit from this one
     #
     #   class Controller < Ramaze::Controller
     #     trait :user_callback => lambda{|creds|
@@ -87,7 +87,7 @@ module Ramaze
     #
     # @example Using a different model instead of User
     #
-    #   # assumes all your controllers inhert from this one
+    #   # assumes all your controllers inherit from this one
     #
     #   class Controller < Ramaze::Controller
     #     trait :user_model => Account
@@ -99,36 +99,42 @@ module Ramaze
       # Using this as key in request.env
       RAMAZE_HELPER_USER = 'ramaze.helper.user'.freeze
 
+      ##
       # Use this method in your application, but do not use it in conditionals
       # as it will never be nil or false.
       #
-      # @return [Ramaze::Helper::User::Wrapper] wrapped return value from model or callback
+      # @return [Ramaze::Helper::User::Wrapper] wrapped return value from 
+      #  model or callback
       #
       # @api external
       # @author manveru
+      #
       def user
         env = request.env
         found = env[RAMAZE_HELPER_USER]
         return found if found
 
         model, callback = ancestral_trait.values_at(:user_model, :user_callback)
-        model ||= ::User
+        model ||= ::User unless callback
         env[RAMAZE_HELPER_USER] = Wrapper.new(model, callback)
       end
 
+      ##
       # shortcut for user._login but default argument are request.params
       #
-      # @param [Hash] creds the credentials that will be passed to callback or model
-      #
+      # @param [Hash] creds the credentials that will be passed to callback or 
+      #  model
       # @return [nil Hash] the given creds are returned on successful login
       #
       # @api external
       # @see Ramaze::Helper::User::Wrapper#_login
       # @author manveru
+      #
       def user_login(creds = request.params)
         user._login(creds)
       end
 
+      ##
       # shortcut for user._logout
       #
       # @return [nil]
@@ -136,19 +142,23 @@ module Ramaze
       # @api external
       # @see Ramaze::Helper::User::Wrapper#_logout
       # @author manveru
+      #
       def user_logout
         user._logout
       end
 
+      ##
       # @return [true false] whether the user is logged in already.
       #
       # @api external
       # @see Ramaze::Helper::User::Wrapper#_logged_in?
       # @author manveru
+      #
       def logged_in?
         user._logged_in?
       end
 
+      ##
       # Wrapper for the ever-present "user" in your application.
       # It wraps around an arbitrary instance and worries about authentication
       # and storing information about the user in the session.
@@ -157,6 +167,7 @@ module Ramaze
       # methods with an underscore.
       #
       # Patches and suggestions are highly appreciated.
+      #
       class Wrapper < BlankSlate
         attr_accessor :_model, :_callback, :_user
 
@@ -166,15 +177,21 @@ module Ramaze
           _login
         end
 
-        # @param [Hash] creds this hash will be stored in the session on successful login
+        ##
+        # @param [Hash] creds this hash will be stored in the session on 
+        #  successful login
         # @return [Ramaze::Helper::User::Wrapper] wrapped return value from
-        #                                         model or callback
+        #  model or callback
         # @see Ramaze::Helper::User#user_login
         # @author manveru
-        def _login(creds = _persistence)
-          if @_user = _would_login?(creds)
-            Current.session.resid!
-            self._persistence = creds
+        def _login(creds = nil)
+          if creds
+            if @_user = _would_login?(creds)
+              Current.session.resid!
+              self._persistence = {:credentials => creds}
+            end
+          elsif persistence = self._persistence
+            @_user = _would_login?(persistence[:credentials])
           end
         end
 
@@ -184,6 +201,8 @@ module Ramaze
         # This will not actually login, just check whether the credentials
         # would result in a user.
         def _would_login?(creds)
+          return unless creds
+
           if c = @_callback
             c.call(creds)
           elsif _model.respond_to?(:authenticate)
@@ -198,7 +217,7 @@ module Ramaze
         # @see Ramaze::Helper::User#user_logout
         # @author manveru
         def _logout
-          _persistence.clear
+          (_persistence || {}).clear
           Current.request.env['ramaze.helper.user'] = nil
         end
 
@@ -210,12 +229,12 @@ module Ramaze
           !!_user
         end
 
-        def _persistence=(creds)
-          Current.session[:USER] = creds
+        def _persistence=(obj)
+          Current.session[:USER] = obj
         end
 
         def _persistence
-          Current.session[:USER] || {}
+          Current.session[:USER]
         end
 
         # Refer everything not known
@@ -225,6 +244,6 @@ module Ramaze
           _user.send(meth, *args, &block)
         end
       end
-    end
-  end
-end
+    end # User
+  end # Helper
+end # Ramaze

data/lib/ramaze/helper/xhtml.rb

@@ -8,8 +8,8 @@ module Ramaze
     #
     #   css 'reset', 'screen', :only => 'ie'
     #
-    # This would result in a stylesheet named "reset.css" being loaded only when the user
-    # is using Internet Explorer.
+    # This would result in a stylesheet named "reset.css" being loaded only when
+    # the user is using Internet Explorer.
     #
     module XHTML
       LINK_TAG = '<link href=%p media=%p rel="stylesheet" type="text/css" />'
@@ -17,12 +17,15 @@ module Ramaze
 
       ##
       # Generate a CSS tag based on the name, media type and a hash containing
-      # additional options. For example, if we want to load the stylesheet only when the user
-      # is using Internet Explorer we would have to add a key 'only' with a value of 'ie' to the hash.
+      # additional options. For example, if we want to load the stylesheet only
+      # when the user is using Internet Explorer we would have to add a key
+      # 'only' with a value of 'ie' to the hash.
       #
       # @param [String] name The name of the CSS file to load.
-      # @param [String] media The media type for which the stylesheet should be loaded.
-      # @param [Hash] options A hash containing additional options for the stylesheet tag.
+      # @param [String] media The media type for which the stylesheet should be
+      #  loaded.
+      # @param [Hash] options A hash containing additional options for the 
+      #  stylesheet tag.
       # @example
       #
       #   # A very basic example.
@@ -46,14 +49,18 @@ module Ramaze
             LINK_TAG % [name, media]
           else
             prefix = options[:prefix] || 'css'
-            LINK_TAG % ["#{Ramaze.options.prefix.chomp("/")}/#{prefix}/#{name}.css", media]
+            LINK_TAG % [
+              "#{Ramaze.options.prefix.chomp("/")}/#{prefix}/#{name}.css", 
+              media
+            ]
           end
         end
       end
 
       ##
-      # The css_for method can be used when you want to load multiple stylesheets and don't
-      # want to call the css() method over and over again.
+      # The css_for method can be used when you want to load multiple
+      # stylesheets and don't want to call the css() method over and over
+      # again.
       #
       # @example
       # 
@@ -64,8 +71,9 @@ module Ramaze
       #   css_for ['reset', 'print'], ['960', 'print']
       #
       # @see css()
-      # @param [Array] args An array containing either the names of all stylesheets to load or a collection of arrays
-      # of which each array defines the name, media and additional parameters.
+      # @param [Array] args An array containing either the names of all 
+      #  stylesheets to load or a collection of arrays of which each array 
+      #  defines the name, media and additional parameters.
       # @return [String]
       #
       def css_for(*args)
@@ -73,8 +81,8 @@ module Ramaze
       end
 
       ##
-      # Generates a Javascript tag that loads an external Javascript file. This tag can't be used for loading inline
-      # javascript files.
+      # Generates a Javascript tag that loads an external Javascript file. This 
+      # tag can't be used for loading inline Javascript files.
       #
       # @example
       #
@@ -84,11 +92,12 @@ module Ramaze
       #   # Let's change the directory to "some_other_directory"
       #   js 'jquery', :prefix => 'some_other_directory'
       #
-      # @param [String] name The name of the Javascript file that should be loaded.
-      # @param [Hash] options Hash that can contain a :prefix key that defines the directory in which the JS file
-      # is located. By default this key is set to "js".
+      # @param [String] name The name of the Javascript file that should be 
+      #  loaded.
+      # @param [Hash] options Hash that can contain a :prefix key that defines
+      #  the directory in which the JS file is located. By default this key is
+      #  set to "js".
       # @return [String]
-      # TODO:  The js() method 2nd argument is a hash but only supports the :prefix key. Perhaps changing this hash into a string would be better - Yorick
       # 
       def js(name, options={})
         if name =~ /^http/ # consider it external full url
@@ -112,6 +121,6 @@ module Ramaze
       def js_for(*args)
         args.map{|arg| js(*arg) }.join("\n")
       end
-    end
-  end
-end
+    end # XHTML
+  end # Helper 
+end # Ramaze