Pistos-ramaze 2008.09 → 2008.12

data/lib/ramaze/contrib/file_cache.rb

@@ -1,65 +1,3 @@
-#
-# drop-in replacement for Ramaze's built-in MemoryCache built on the
-# filesystem.  # to use with sessions do
-#
-#   Ramaze::Global::cache_alternative[:sessions] = Ramaze::FileCache
-#
-# to use with everything do
-#
-#   Ramaze::Global::cache = Ramaze::FileCache
-#
+Ramaze::Log.warn("ramaze/contrib/file_cache is now ramaze/cache/file")
 
-module Ramaze::FileCache
-  require "fileutils"
-  require "socket"
-
-  Host = Socket.gethostname
-  Pid = Process.pid
-  Fu = FileUtils
-  Root = File.join Ramaze::APPDIR, "cache"
-
-  Fu.mkdir_p(Root) rescue nil
-
-  def self.[] key
-    path = File.join Root, key, "data"
-    Marshal.load(IO.read(path))
-  rescue
-    nil
-  end
-
-  def self.[]= key, value
-    tmp = File.join Root, key, "data.#{ Host }.#{ Pid }"
-    dirname = File.join Root, key
-    path = File.join Root, key, "data"
-    data = Marshal.dump value
-    Fu.rm_rf dirname rescue nil
-    Fu.mkdir_p dirname rescue nil
-    open(tmp, 'w'){|fd| fd.write data}
-    Fu.mv tmp, path
-  rescue
-    nil
-  end
-
-  def self.values_at *keys
-    keys.map{|key| self[key]}
-  end
-
-  def self.delete *keys
-    keys.map do |key|
-      dirname = File.join Root, key
-      Fu.rm_rf dirname rescue next
-    end
-  end
-
-  def self.clear
-    Dir["#{ Root }/*"].each{|entry| Fu.rm_rf entry}
-  end
-
-  def self.new
-    self
-  end
-
-  def self.to_sym
-    name.split(%r/::/).last.to_sym
-  end
-end
+require 'ramaze/cache/file'

data/lib/ramaze/contrib/sequel/image.rb

@@ -31,7 +31,7 @@
 #       #     Creates a square thumbnail of the image cropping the longest edge
 #       #     to match the shortest edge, resizes to +size+.
 #
-#       :agorithm => :thumbnail,
+#       :algorithm => :thumbnail,
 #
 #
 #       # Key specifies the filename and accessors, value are arguments to the

data/lib/ramaze/contrib.rb

@@ -49,7 +49,7 @@ module Ramaze
           const.startup if const.respond_to?(:startup)
           Log.dev "Loaded contrib: #{const}"
         rescue NameError
-          files = Dir["{contrib,#{BASEDIR/:ramaze/:contrib}}/#{name}.{so,bundle,rb}"]
+          files = Dir["{contrib,#{BASEDIR}/ramaze/contrib}/#{name}.{so,bundle,rb}"]
           raise LoadError, "#{mod_name} not found" unless files.any?
           require(files.first) ? retry : raise
         end

data/lib/ramaze/controller/resolve.rb

@@ -136,10 +136,15 @@ module Ramaze
 
       def resolve_template(path)
         path = path.to_s
-        path_converted = path.split('__').inject{|s,v| s/v}
+        path_converted = path.split('__').inject{|s,v| File.join(s, v) }
         possible_paths = [path, path_converted].compact
 
-        paths = template_paths.map{|pa| possible_paths.map{|a| pa/a } }.flatten.uniq
+        paths = template_paths.map{|pa|
+          possible_paths.map{|a|
+            File.join(pa, a)
+          }
+        }.flatten.uniq
+
         glob = "{#{paths.join(',')}}.{#{extension_order.join(',')}}"
 
         Dir[glob].first
@@ -153,7 +158,7 @@ module Ramaze
         if paths = view_root
           paths
         else
-          view_root(Global.view_root / Global.mapping.invert[self])
+          view_root(File.join(Global.view_root, Global.mapping.invert[self]))
         end
       end
 

data/lib/ramaze/controller.rb

@@ -67,13 +67,17 @@ module Ramaze
 
       # if trait[:automap] is set and controller is not in Global.mapping yet
       # this will build a new default mapping-point, MainController is put
-      # at '/' by default.
+      # at '/' by default. For other Class names, String#snake_case is called,
+      # e.g. FooBarController is mapped at '/foo_bar'.
 
       def mapping
         global_mapping = Global.mapping.invert[self]
+
         return global_mapping if global_mapping
+
         if ancestral_trait[:automap] && self.to_s !~ /#<Class:/
           name = self.to_s.gsub('Controller', '').gsub('::', '/').clone
+          return if name.empty?
           name == 'Main' ? '/' : "/#{name.snake_case}"
         end
       end
@@ -262,6 +266,10 @@ module Ramaze
         action.render
       end
 
+      # By default, returns all ancestors of current Controller that have
+      # Ramaze::Controller as their ancestor. Optional argument parent
+      # can be used return ancestors that have parent as an ancestor.
+
       def relevant_ancestors(parent = Ramaze::Controller)
         ancestors.select do |anc|
           anc.ancestors.include?(parent)

data/lib/ramaze/current/request.rb

@@ -28,10 +28,14 @@ module Ramaze
       super
     end
 
+    # the full request URI provided by Rack::Request e.g. http://localhost:7000/controller/action?foo=bar.xhtml
+
     def request_uri
       env['REQUEST_URI'] || path_info
     end
 
+    # the IP address(s) making the request provided by Rack::Request. You shouldn't trust it
+
     def ip
       if addr = env['HTTP_X_FORWARDED_FOR']
         addr.split(',').last.strip
@@ -47,9 +51,8 @@ module Ramaze
     ipv6 = %w[ fc00::/7 fe80::/10 fec0::/10 ::1 ]
     LOCAL = (ipv4 + ipv6).map{|a| IPAddr.new(a)} unless defined?(LOCAL)
 
-    # --
-    # Mongrel somehow puts together multiple IPs when proxy is involved.
-    # ++
+    # returns true if the IP address making the request is from local network.
+    # Optional argument address can be used to check any IP address.
 
     def local_net?(address = ip)
       addr = IPAddr.new(address)
@@ -63,6 +66,15 @@ module Ramaze
       [key, *rest].map{|k| params[k.to_s] }
     end
 
+    # Sets any arguments passed as @instance_variables for the current action.
+    #
+    # Usage:
+    #   request.params # => {'name' => 'manveru', 'q' => 'google', 'lang' => 'de'}
+    #   to_ivs(:name, :q)
+    #   @q    # => 'google'
+    #   @name # => 'manveru'
+    #   @lang # => nil
+
     def to_ivs(*args)
       instance = Action.current.instance
       args.each do |arg|
@@ -71,81 +83,77 @@ module Ramaze
       end
     end
 
-    unless method_defined?(:rack_params)
-      alias rack_params params
-
-      # Wrapping Request#params to support a one-level hash notation.
-      # It doesn't support anything really fancy, so be conservative in its use.
-      #
-      # See if following provides something useful for us:
-      # http://redhanded.hobix.com/2006/01/25.html
-      #
-      # Example Usage:
-      #
-      #  # Template:
-      #
-      #  <form action="/paste">
-      #    <input type="text" name="paste[name]" />
-      #    <input type="text" name="paste[syntax]" />
-      #    <input type="submit" />
-      #  </form>
-      #
-      #  # In your Controller:
-      #
-      #  def paste
-      #    name, syntax = request['paste'].values_at('name', 'syntax')
-      #    paste = Paste.create_with(:name => name, :syntax => syntax)
-      #    redirect '/'
-      #  end
-      #
-      #  # Or, easier:
-      #
-      #  def paste
-      #    paste = Paste.create_with(request['paste'])
-      #    redirect '/'
-      #  end
-
-      def params
-        return {} if put?
-        return @ramaze_params if @ramaze_params
-
-        begin
-          @rack_params ||= rack_params
-        rescue EOFError => ex
-          @rack_params = {}
-          Log.error(ex)
-        end
+    # Wrapping Request#params to support a one-level hash notation.
+    # It doesn't support anything really fancy, so be conservative in its use.
+    #
+    # See if following provides something useful for us:
+    # http://redhanded.hobix.com/2006/01/25.html
+    #
+    # Example Usage:
+    #
+    #  # Template:
+    #
+    #  <form action="/paste">
+    #    <input type="text" name="paste[name]" />
+    #    <input type="text" name="paste[syntax]" />
+    #    <input type="submit" />
+    #  </form>
+    #
+    #  # In your Controller:
+    #
+    #  def paste
+    #    name, syntax = request['paste'].values_at('name', 'syntax')
+    #    paste = Paste.create_with(:name => name, :syntax => syntax)
+    #    redirect '/'
+    #  end
+    #
+    #  # Or, easier:
+    #
+    #  def paste
+    #    paste = Paste.create_with(request['paste'])
+    #    redirect '/'
+    #  end
+
+    def params
+      return {} if put?
+      return @ramaze_params if @ramaze_params
+
+      begin
+        @rack_params ||= super
+      rescue EOFError => ex
+        @rack_params = {}
+        Log.error(ex)
+      end
 
-        @ramaze_params = {}
+      @ramaze_params = {}
 
-        @rack_params.each do |key, value|
-          if key =~ /^(.*?)(\[.*\])/
-            prim, nested = $~.captures
-            ref = @ramaze_params
+      @rack_params.each do |key, value|
+        if key =~ /^(.*?)(\[.*\])/
+          prim, nested = $~.captures
+          ref = @ramaze_params
 
-            keys = nested.scan(/\[([^\]]+)\]/).flatten
-            keys.unshift prim
+          keys = nested.scan(/\[([^\]]+)\]/).flatten
+          keys.unshift prim
 
-            keys.each_with_index do |k, i|
-              if i + 1 >= keys.size
-                ref[k] = value
+          keys.each_with_index do |k, i|
+            if i + 1 >= keys.size
+              ref[k] = value
+            else
+              # in case the value is a string we cannot let it be ref next
+              # time, so throw it away
+              if ref[k].is_a?(String)
+                ref = ref[k] = {}
               else
-                # in case the value is a string we cannot let it be ref next
-                # time, so throw it away
-                if ref[k].is_a?(String)
-                  ref = ref[k] = {}
-                else
-                  ref = ref[k] ||= {}
-                end
+                ref = ref[k] ||= {}
               end
             end
-          else
-            @ramaze_params[key] = value
           end
+        else
+          @ramaze_params[key] = value
         end
-
-        @ramaze_params
       end
+
+      @ramaze_params
     end
 
     # Interesting HTTP variables from env
@@ -156,12 +164,18 @@ module Ramaze
       }
     end
 
+    # Returns a string presentation of the request, useful for debugging
+    # parameters of the action.
+
     def to_s
       p, c, e = params.inspect, cookies.inspect, http_vars.inspect
       %{#<Ramaze::Request params=#{p} cookies=#{c} env=#{e}>}
     end
     alias inspect to_s
 
+    # Pretty prints current action with parameters, cookies and
+    # enviroment variables.
+
     def pretty_print pp
       p, c, e = params, cookies, http_vars
       pp.object_group(self){
@@ -198,6 +212,9 @@ module Ramaze
       URI("#{scheme}://#{host}#{path}")
     end
 
+    # Returns and array of locales from env['HTTP_ACCEPT_LANGUAGE].
+    # e.g. ["fi", "en", "ja", "fr", "de", "es", "it", "nl", "sv"]
+
     def locales
       env['HTTP_ACCEPT_LANGUAGE'].to_s.split(/(?:,|;q=[\d.,]+)/)
     end

data/lib/ramaze/current/session/hash.rb

@@ -9,8 +9,8 @@ module Ramaze
 
       # Sets @hash to an empty Hash
 
-      def initialize sess
-        @session = sess
+      def initialize(session)
+        @session = session
         @hash = {}
       end
 
@@ -18,11 +18,8 @@ module Ramaze
       # Session.current.sessions if anything changes.
 
       def method_missing(*args, &block)
-        old = @hash.dup
         result = @hash.send(*args, &block)
-        unless old == @hash
-          Cache.sessions[@session.session_id] = self
-        end
+        Cache.sessions[@session.session_id] = self
         result
       end
 
@@ -48,11 +45,10 @@ module Ramaze
 
       # Unmarshal cookie data to a hash and verify its integrity.
       def unmarshal(cookie)
-        if cookie
-          data, digest = cookie.split('--')
-          return nil unless digest == generate_digest(data)
-          Marshal.load(data.unpack('m').first)
-        end
+        return unless cookie
+        data, digest = cookie.split('--')
+        return nil unless digest == generate_digest(data)
+        Marshal.load(data.unpack('m').first)
       end
 
       # Generate the inline SHA512 message digest. Larger (128 bytes) than SHA256

data/lib/ramaze/current/session.rb

@@ -96,7 +96,7 @@ module Ramaze
     def initialize(sess_or_request = Current.request)
       return unless Global.sessions
 
-      if sess_or_request.is_a?(Request)
+      if sess_or_request.respond_to?(:cookies)
         request = sess_or_request
         @session_id = request.cookies[SESSION_KEY] || Session.random_key
       else
@@ -125,10 +125,8 @@ module Ramaze
     # existing already, the session itself is an instance of SessionHash
 
     def current
-      unless @current
-        @current = ( sessions[session_id] ||= Session::Hash.new(self) )
-      end
-      @current
+      return @current if @current
+      @current = ( sessions[session_id] ||= Session::Hash.new(self) )
     end
 
     # shortcut to Cache.sessions

data/lib/ramaze/dispatcher/action.rb

@@ -35,6 +35,8 @@ module Ramaze
           ex
         end
 
+        # Logs the request via Log#info unless it's boring.
+
         def log(path)
           case path
           when *Global.boring

data/lib/ramaze/dispatcher/file.rb

@@ -64,7 +64,8 @@ module Ramaze
           joined = ::File.join(Global.public_root, path)
 
           if ::File.directory?(joined)
-            Dir[joined/"{#{INDICES.join(',')}}"].first || joined
+            glob = ::File.join(joined, "{#{INDICES.join(',')}}")
+            Dir[glob].first || joined
           else
             joined
           end
@@ -78,6 +79,10 @@ module Ramaze
 
         private
 
+        # Shortcut for Ramaze::Dispatcher::File#expand_path(path).
+        # Returns the absolute path of passed argument e.g.
+        # "/Users/rikur/ramaze_tests/public/foo.txt"
+
         def expand(path)
           ::File.expand_path(path)
         end

data/lib/ramaze/helper/aspect.rb

@@ -76,7 +76,7 @@ module Ramaze
   class Action
 
     # overwrites the default Action hook and runs the neccesary blocks in its
-    # scope. before actions are run starting from Ramaze::Controller down the
+    # scope before actions are run, starting from Ramaze::Controller down the
     # ancestor chain.
     def before_process
       common_aspect(:before)
@@ -84,7 +84,7 @@ module Ramaze
 
 
     # overwrites the default Action hook and runs the neccesary blocks in its
-    # scope. before actions are run starting from Ramaze::Controller down the
+    # scope after actions are run, starting from Ramaze::Controller down the
     # ancestor chain.
     def after_process
       common_aspect(:after)

data/lib/ramaze/helper/form.rb

@@ -219,16 +219,19 @@ module Ramaze
 
   # Form for instances of the model class
   class InstanceForm < Form
-    # <input type='text' name='name' value='value' />
+    # returns <input type='text' name='name' value='value' />
     def field_input(name, value)
       "<input type='text' name='#{name}' value='#{value}'/>"
     end
 
+    # returns <textarea name='name'>#{value}</textarea>
+
     def field_textarea(name, value)
       "<textarea name='#{name}'>#{value}</textarea>"
     end
 
-    # <input type="text" name="name" value="value" />
+    # returns <input type="text" name="name" value="value" />
+
     def field_integer(name, value)
       field_input(name, value)
     end

data/lib/ramaze/helper/formatting.rb

@@ -111,6 +111,10 @@ module Ramaze
     end
     alias autolink auto_link
 
+    # takes a string and optional argument for outputting compliance HTML
+    # instead of XHTML.
+    # e.g nl2br "a\nb\n\c" #=> 'a<br />b<br />c'
+
     def nl2br(string, xhtml = true)
       br = xhtml ? '<br />' : '<br>'
       string.gsub(/\n/, br)

data/lib/ramaze/helper/gravatar.rb

@@ -1,12 +1,29 @@
 module Ramaze
   module Helper
     module Gravatar
+
+      # fetches a gravatar from http//www.gravatar.com based on 'email'
+      # and 'size'. Falls back to 'fallback_path' if no gravatar is found.
+      # default 'fallback_path' is "/images/gravatar_default.jpg".
+      # example:
+      #
+      # class GravatarController < Ramaze::Controller
+      #    helper :gravatar
+      #
+      #    def index
+      #      @gravatar_thumbnail_src = gravatar(session[:email] || 'riku@helloit.fi')
+      #    end
+      # end
+      #
+      #  /view/gravatar/index.html:
+      #  <img src="#{@gravatar_thumbnail_src}" />
+
       def gravatar(email, size = 32, fallback_path = "/images/gravatar_default.jpg")
         emailhash = Digest::MD5.hexdigest(email)
 
         fallback = Request.current.domain
         fallback.path = fallback_path
-        default = h(fallback.to_s)
+        default = Rack::Utils.escape(fallback.to_s)
 
         return "http://www.gravatar.com/avatar.php?gravatar_id=#{emailhash}&default=#{default}&size=#{size}"
       end

data/lib/ramaze/helper/httpdigest.rb

@@ -5,50 +5,79 @@ module Ramaze
   module Helper
     module HttpDigest
 
-      @session_nonce = "authentication_digest_nonce"
+      UUID_GENERATOR = UUID.new
+
+      SESSION_NONCE = 'httpdigest_authentication_nonce'
+      SESSION_OPAQUE = 'httpdigest_authentication_opaque'
 
       def httpdigest_logout
-        session.delete( @session_nonce )
+        session.delete( SESSION_NONCE )
+        session.delete( SESSION_OPAQUE )
+      end
+
+      def httpdigest_headers uid, realm
+        session[ SESSION_NONCE ] = UUID_GENERATOR.generate
+        session[ SESSION_OPAQUE ][ realm ][ uid ] = UUID_GENERATOR.generate
+        response['WWW-Authenticate'] =
+          %|Digest realm="#{realm}",| +
+          %|qop="auth,auth-int",| +
+          %|nonce="#{session[SESSION_NONCE]}",| +
+          %|opaque="#{session[SESSION_OPAQUE][realm][uid]}"|
       end
 
       def httpdigest(uid, realm)
-        session_opaque = "authentication_digest_opaque_#{uid}"
+        session[ SESSION_OPAQUE ] ||= {}
+        session[ SESSION_OPAQUE ][ realm ] ||= {}
 
-        session[session_opaque] ||= UUID.new
+        if request.env['HTTP_AUTHORIZATION']
 
-        authorized = false
+          authorized = false
 
-        if session[@session_nonce] and request.env['HTTP_AUTHORIZATION']
+          if session[ SESSION_NONCE ] and session[ SESSION_OPAQUE ][ realm ][ uid ]
 
-          auth_split = request.env['HTTP_AUTHORIZATION'].split
-          authentication_type = auth_split[0]
-          authorization = Rack::Auth::Digest::Params.parse( auth_split[1..-1].join(' ') )
-          digest_response, username, nonce, nc, cnonce, qop =
-            authorization.values_at(*%w[response username nonce nc cnonce qop])
+            auth_split = request.env['HTTP_AUTHORIZATION'].split
+            authentication_type = auth_split[0]
+            authorization = Rack::Auth::Digest::Params.parse( auth_split[1..-1].join(' ') )
 
-          if authentication_type == 'Digest'
-            if nonce == session[@session_nonce]
-              ha1 = yield(username)
-              ha2 = MD5.hexdigest("#{request.request_method}:#{request.fullpath}")
-              md5 = MD5.hexdigest([ha1, nonce, nc, cnonce, qop, ha2].join(':'))
+            digest_response, username, nonce, nc, cnonce, qop, opaque =
+              authorization.values_at(*%w[response username nonce nc cnonce qop opaque])
 
-              authorized = digest_response == md5
+            if authentication_type == 'Digest'
+              if nonce == session[SESSION_NONCE] and opaque == session[SESSION_OPAQUE][realm][uid]
+                h1 = nil
+                if respond_to?( :httpdigest_lookup_password )  
+                  ha1 = httpdigest_lookup_password( username )
+                else
+                  if respond_to?( :httpdigest_lookup_plaintext_password )
+                    ha1 = MD5.hexdigest( "#{username}:#{realm}:#{httpdigest_lookup_plaintext_password( username )}" )
+                  else
+                    if block_given?
+                      ha1 = yield( username )
+                    else
+                      raise "No password lookup handler found"
+                    end
+                  end
+                end
+                ha2 = MD5.hexdigest([request.request_method,request.fullpath].join(':'))
+                md5 = MD5.hexdigest([ha1, nonce, nc, cnonce, qop, ha2].join(':'))
+
+                authorized = digest_response == md5
+              end
             end
+
           end
-        end
 
-        unless authorized
-          session[@session_nonce] = UUID.new
-          response['WWW-Authenticate'] =
-            %|Digest realm="#{realm}",| +
-            %|qop="auth,auth-int",| +
-            %|nonce="#{session[@session_nonce]}",| +
-            %|opaque="#{session[session_opaque]}"|
-          if respond_to?( :httpdigest_failure )
-            httpdigest_failure
-          else
+          unless authorized
+            httpdigest_headers( uid, realm )
             respond('Unauthorized', 401)
           end
+
+        else
+
+          httpdigest_headers( uid, realm )
+          httpdigest_failure if respond_to?( :httpdigest_failure )
+          respond('Unauthorized', 401)
+
         end
 
         authorization["username"]

data/lib/ramaze/helper/maruku.rb

@@ -1,3 +1,5 @@
+require 'maruku'
+
 module Ramaze
   module Helper::Maruku
     def maruku(text)

data/lib/ramaze/helper/paginate.rb

@@ -165,9 +165,8 @@ module Ramaze
           text = h(text.to_s)
 
           params = Ramaze::Request.current.params.merge(@var.to_s => n)
-          name = Ramaze::Action.stack.first.name
-          name = '/' if name == 'index' # make nicer...
-          hash[:href] = Rs(name, params)
+          name = Ramaze::Request.current.request_path
+          hash[:href] = R(name, params)
 
           g.a(hash){ text }
         end