manveru-ramaze 2008.10 → 2008.12

data/benchmark/run.rb

@@ -176,7 +176,7 @@ class RamazeBenchmark
 
     # benchmarks
     __DIR__ = File.expand_path(File.dirname(__FILE__))
-    Dir[__DIR__/"suite"/"*.rb"].each do |filename|
+    Dir[__DIR__('suite/*.rb')].each do |filename|
       @adapters.each do |adapter|
         @paths.each do |path|
           benchmark(filename, adapter, path) if @target.match(filename)

data/examples/app/blog/spec/blog.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'hpricot', 'sequel'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 require 'start'
 
 describe 'Blog' do
@@ -83,5 +83,5 @@ describe 'Blog' do
     (check_page/'div.entry').size.should == 1
   end
 
-  FileUtils.rm_f(__DIR__/'../blog.db')
+  FileUtils.rm_f(__DIR__('../blog.db'))
 end

data/examples/app/rapaste/spec/rapaste.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'hpricot', 'uv', 'sequel'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 require 'start'
 
 describe 'RaPaste' do

data/examples/app/rapaste/start.rb

@@ -7,7 +7,7 @@ require 'uv'
 
 Ramaze::Log.debug "Initializing UltraViolet..."
 
-Uv.copy_files "xhtml", __DIR__/"public"
+Uv.copy_files "xhtml", __DIR__("public")
 Uv.init_syntaxes
 
 UV_PRIORITY_NAMES = %w[ ruby plain_text html css javascript yaml diff ]
@@ -16,7 +16,7 @@ STYLE = 'iplastic'
 
 Ramaze::Log.debug "done."
 
-DB_FILE = "#{__DIR__}/rapaste.sqlite" # for specs
+DB_FILE = __DIR__("rapaste.sqlite") # for specs
 DB = Sequel.connect("sqlite://#{DB_FILE}")
 
 require 'model/paste'

data/examples/app/todolist/spec/todolist.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'hpricot'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 require 'start'
 
 describe 'todolist' do

data/examples/app/whywiki/spec/whywiki.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'bluecloth', 'hpricot'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 
 Db = Ramaze::YAMLStoreCache.new("#{base}/testwiki.yaml")
 require 'start'

data/examples/app/wikore/spec/wikore.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'hpricot', 'sequel'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 require 'start'
 
 describe 'Wikore' do

data/examples/app/wikore/src/model.rb

@@ -5,7 +5,7 @@ begin
   when :memory
     DB = Sequel.sqlite
   else
-    DB_FILE = __DIR__/'wikore.db'
+    DB_FILE = __DIR__('wikore.db')
     DB = Sequel.connect("sqlite://#{DB_FILE}")
   end
 rescue NoMethodError

data/examples/app/wiktacular/spec/wiktacular.rb

@@ -3,7 +3,7 @@ require 'ramaze/spec/helper'
 
 spec_require 'hpricot', 'bluecloth'
 
-$LOAD_PATH.unshift base = __DIR__/'..'
+$LOAD_PATH.unshift base = __DIR__('..')
 require 'start'
 
 describe 'wiktacular' do

data/examples/app/wiktacular/src/model.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 require 'cgi'
 
 class WikiEntry
-  ENTRIES_DIR = __DIR__/'../mkd'
+  ENTRIES_DIR = __DIR__('../mkd')
   class << self
     def [](name)
       if File.exist?(ENTRIES_DIR/File.basename(File.expand_path(name)))

data/examples/basic/partial.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'ramaze'
+
+# This is a small extension to the hello world example, showing how to use the
+# <render> tag of Ezamar.
+#
+# Browse to /more and /even_more
+
+pipeline = Ramaze::Template::Ezamar::TRANSFORM_PIPELINE
+pipeline.put_after(::Ezamar::Element, ::Ezamar::RenderPartial)
+pipeline.uniq!
+
+class MainController < Ramaze::Controller
+  def index
+    "Hello, World!"
+  end
+
+  def more
+    @tail = request[:tail] || 'the standard'
+    'More of <render src="/index" /> #@tail'
+  end
+
+  def even_more
+    '<render src="/more" tail="This is even more" />'
+  end
+end
+
+Ramaze.start

data/examples/misc/ramaise.rb

@@ -15,7 +15,7 @@
 %w(rubygems ramaze bluecloth rubypants haml).each{|lib| require lib }
 
 class BlogPost
-  DIR = __DIR__/:entries
+  DIR = __DIR__(:entries)
 
   def initialize filename
     raise 'Invalid BlogPost filename' unless File.exists?(filename)
@@ -129,4 +129,4 @@ class MainController < Ramaze::Controller
 
 end
 
-Ramaze.start :sessions => false #, :adapter => :mongrel, :port => 3000
+Ramaze.start :sessions => false #, :adapter => :mongrel, :port => 3000

data/examples/templates/template_amrita2.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Amrita2
 
   def index

data/examples/templates/template_erubis.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Erubis
 
   def index

data/examples/templates/template_ezamar.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
 
   def index
     %{ #{A 'Home', :href => :/} | #{A(:internal)} | #{A(:external)} }

data/examples/templates/template_haml.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Haml
 
   def index
@@ -29,7 +29,7 @@ class MainController < Ramaze::Controller
       = A("#@place/one/two/three")
       %br/
       = A("#@place/one?foo=bar")
-    %div 
+    %div
       The arguments you have passed to this action are:
       - if @args.empty?
         none

data/examples/templates/template_liquid.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Liquid
 
   def index

data/examples/templates/template_markaby.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/'template'
+  view_root __DIR__('template')
   engine :Markaby
 
   helper :markaby
@@ -33,7 +33,7 @@ class MainController < Ramaze::Controller
             br
           end
           div do
-            text "The arguments you have passed to this action are:" 
+            text "The arguments you have passed to this action are:"
             if @args.empty?
               text "none"
             else

data/examples/templates/template_nagoro.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Nagoro
 
   def index

data/examples/templates/template_redcloth.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :RedCloth
   layout :layout
 

data/examples/templates/template_remarkably.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'ramaze'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Remarkably
 
   include Remarkably::Common
@@ -31,7 +31,7 @@ class MainController < Ramaze::Controller
           br
         end
         div do
-          text "The arguments you have passed to this action are:" 
+          text "The arguments you have passed to this action are:"
           if args.empty?
             "none"
           else

data/examples/templates/template_tenjin.rb

@@ -2,7 +2,7 @@ require "rubygems"
 require "ramaze"
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :Tenjin
 
   def index

data/examples/templates/template_xslt.rb

@@ -3,7 +3,7 @@ require 'ramaze'
 require 'ramaze/gestalt'
 
 class MainController < Ramaze::Controller
-  view_root __DIR__/:template
+  view_root __DIR__(:template)
   engine :XSLT
 
   def index

data/lib/proto/public/dispatch.fcgi

@@ -4,8 +4,8 @@ require 'rubygems'
 require 'ramaze'
 
 # FCGI doesn't like you writing to stdout
-Ramaze::Log.loggers = [ Ramaze::Logger::Informer.new( File.join(__DIR__, '..', 'ramaze.fcgi.log') ) ]
+Ramaze::Log.loggers = [ Ramaze::Logger::Informer.new( __DIR__("../ramaze.fcgi.log") ) ]
 Ramaze::Global.adapter = :fcgi
 
-$0 = File.join(__DIR__, '..', 'start.rb')
+$0 = __DIR__("../start.rb")
 require $0

data/lib/proto/spec/main.rb

@@ -1,12 +1,12 @@
 require 'ramaze'
 require 'ramaze/spec/helper'
 
-require __DIR__/'../start'
+require __DIR__('../start')
 
 describe MainController do
   behaves_like 'http', 'xpath'
-  ramaze :view_root => __DIR__/'../view',
-         :public_root => __DIR__/'../public'
+  ramaze :view_root => __DIR__('../view'),
+         :public_root => __DIR__('../public')
 
   it 'should show start page' do
     got = get('/')

data/lib/ramaze/action.rb

@@ -110,17 +110,21 @@ module Ramaze
     end
 
     # Try to figure out a sane name for current action.
+
     def name
       File.basename((self[:method] || self[:template]).to_s).split('.').first
     end
 
     # combined path to current action, from path and params
+
     def extended_path
       (path == "index" && !params.empty? ? params : Array[path, *params]).join('/')
     end
 
+    # same as Ramaze::Action#extended_path, with mapping of the current controller prepended.
+
     def full_path
-      self.controller.mapping/extended_path
+      File.join(self.controller.mapping, extended_path)
     end
 
     # Hook for AspectHelper
@@ -133,6 +137,8 @@ module Ramaze
     def after_process
     end
 
+    # Returns true if current request is valid REST request.
+
     def valid_rest?
       return true unless rest = controller.trait[:REST]
       meth = Request.current.request_method

data/lib/ramaze/cache/file.rb

@@ -0,0 +1,71 @@
+module Ramaze
+  # Persist cache contents to the filesystem.
+  # By default this will create a `/cache` directory in your APPDIR
+  #
+  # Usage for sessions only:
+  #
+  #     Ramaze::Global::cache_alternative[:sessions] = Ramaze::FileCache
+  #
+  # Usage for everything:
+  #
+  #     Ramaze::Global::cache = Ramaze::FileCache
+
+  class FileCache
+    attr_accessor :root, :subdir
+    attr_reader :host, :pid
+
+    def initialize(root = Ramaze::Global.root, subdir = 'cache')
+      @root, @subdir = root, subdir
+      @host = Socket.gethostname
+      @pid = $$
+
+      FileUtils.mkdir_p(dir)
+    end
+
+    def dir(*further)
+      File.join(root, subdir, *further)
+    end
+
+    def [](key)
+      Marshal.load(File.read(dir(key.to_s, 'data')))
+    rescue
+      nil
+    end
+
+    def []=(key, value)
+      key = key.to_s
+      tmp_name = dir(key, "data.#{host}.#{pid}")
+      key_name = dir(key, 'data')
+      dir_name = dir(key)
+
+      data = Marshal.dump(value)
+
+      FileUtils.rm_rf(dir_name)
+      FileUtils.mkdir_p(dir_name)
+
+      File.open(tmp_name, 'w'){|fd| fd.write(data) }
+
+      FileUtils.mv(tmp_name, key_name)
+
+      return value
+    end
+
+    def values_at(*keys)
+      keys.map{|key| self[key] }
+    end
+
+    def delete(*keys)
+      keys.map do |key|
+        FileUtils.rm_rf(dir(key.to_s))
+      end
+    end
+
+    def clear
+      Dir[dir('*')].each{|entry| FileUtils.rm_rf(entry) }
+    end
+
+    def to_sym
+      name.split('::').last.to_sym
+    end
+  end
+end

data/lib/ramaze/cache.rb

@@ -6,6 +6,7 @@ require 'ramaze/cache/memory'
 module Ramaze
   autoload :YAMLStoreCache, "ramaze/cache/yaml_store.rb"
   autoload :MemcachedCache, "ramaze/cache/memcached.rb"
+  autoload :FileCache, "ramaze/cache/file.rb"
 
   # This is the wrapper of all caches, providing mechanism
   # for switching caching from one adapter to another.

data/lib/ramaze/contrib/email.rb

@@ -67,6 +67,8 @@ Message-Id: #{id}
         send_smtp( email, recipient, subject )
       end
 
+      # the raw mail sending method used by Ramaze::EmailHelper
+
       def send_smtp( email, recipient, subject )
         options = trait.values_at(:smtp_server, :smtp_port, :smtp_helo_domain,
                                   :smtp_username, :smtp_password, :smtp_auth_type)

data/lib/ramaze/contrib/facebook.rb

@@ -1,4 +1,4 @@
-require __DIR__/:facebook/:facebook
+require __DIR__('facebook/facebook')
 
 module Ramaze
   module Helper::Facebook
@@ -20,4 +20,4 @@ module Ramaze
     end
     alias fb facebook
   end
-end
+end

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/controller.rb

@@ -67,7 +67,8 @@ 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]
@@ -265,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)