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

@@ -29,29 +29,30 @@ module Ramaze
         :wrap => 500
       }
-      # dirty html in, tidy html out
-      # To activate Tidy for everything outgoing (given that it is of
-      # Content-Type text/html) set
-      #   Global.tidy = true
-      # there is almost no speed-tradeoff but makes debugging a much
-      # nicer experience ;)
-      #
-      # Example:
-      #
-      #  include Ramaze::Tool::Tidy
-      #  puts tidy('<html></html>')
-      #
-      #  # results in something like:
-      #
-      #   <html>
-      #     <head>
-      #       <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
-      #       <title></title>
-      #     </head>
-      #     <body></body>
-      #   </html>
       class << self
+        # dirty html in, tidy html out
+        # To activate Tidy for everything outgoing (given that it is of
+        # Content-Type text/html) set
+        #   Global.tidy = true
+        # there is almost no speed-tradeoff but makes debugging a much
+        # nicer experience ;)
+        #
+        # Example:
+        #
+        #  include Ramaze::Tool::Tidy
+        #  puts tidy('<html></html>')
+        #
+        #  # results in something like:
+        #
+        #   <html>
+        #     <head>
+        #       <meta name="generator" content="HTML Tidy for Linux/x86 (vers 1 September 2005), see www.w3.org" />
+        #       <title></title>
+        #     </head>
+        #     <body></body>
+        #   </html>
         def tidy html, options = {}
           require 'tidy'
@@ -84,6 +85,8 @@ module Ramaze
           puts "you can find it at http://tidy.rubyforge.org/"
         end
+        # Enables being plugged into Dispatcher::Action::FILTER
         def call(response, options = {})
           return response unless trait[:enable]
           response.body = tidy(response.body, options)
@@ -91,7 +94,7 @@ module Ramaze
         end
       end
-      # calls self#tidy
+      # calls Tidy::tidy
       def tidy html, options = {}
         Ramaze::Tool::Tidy.tidy(html, options)

data/lib/ramaze/trinity/request.rb CHANGED

@@ -40,6 +40,9 @@ module Ramaze
       # 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:
@@ -66,20 +69,21 @@ module Ramaze
       #  end
       def params
-        ps = rack_params
-        temp = {}
+        return @ramaze_params if @ramaze_params
+        @rack_params ||= rack_params
+        @ramaze_params = {}
-        ps.each do |key, value|
+        @rack_params.each do |key, value|
           outer_key, inner_key = key.scan(/^(.+)\[(.*?)\]$/).first
           if outer_key and inner_key
-            temp[outer_key] ||= {}
-            temp[outer_key][inner_key] = value
+            @ramaze_params[outer_key] ||= {}
+            @ramaze_params[outer_key][inner_key] = value
           else
-            temp[key] = value
+            @ramaze_params[key] = value
           end
         end
-        temp
+        @ramaze_params
       end
     end
   end

data/lib/ramaze/trinity/session.rb CHANGED

@@ -27,6 +27,8 @@ module Ramaze
       result
     end
+    # Calls #inspect on the wrapped @hash
     def inspect
       @hash.inspect
     end
@@ -53,9 +55,13 @@ module Ramaze
     SESSION_KEY = '_ramaze_session_id'
-    IP_CACHE = Hash.new{|h,k| h[k] = []}
+    # Holds counter for IPs
+    IP_COUNT = Hash.new{|h,k| h[k] = []}
+    # Limit the number of sessions one IP is allowed to hold.
-    IP_CACHE_LIMIT = 1000
+    IP_COUNT_LIMIT = 1000
     class << self
@@ -81,12 +87,12 @@ module Ramaze
     def initialize request
       @session_id = (request.cookies[SESSION_KEY] || random_key)
-      ip_cache = IP_CACHE
       ip = request.remote_addr
-      ip_cache[ip] << @session_id
+      IP_COUNT[ip] << @session_id
-      if ip_cache[ip].size > IP_CACHE_LIMIT
-        sessions.delete(ip_cache[ip].shift)
+      if IP_COUNT[ip].size > IP_COUNT_LIMIT
+        sessions.delete(IP_COUNT[ip].shift)
       end
       @flash = Ramaze::SessionFlash.new
@@ -129,6 +135,8 @@ module Ramaze
       Digest::SHA256.hexdigest(h)
     end
+    # Inspect on Session.current
     def inspect
       current.inspect
     end
@@ -140,7 +148,7 @@ module Ramaze
     # and always just keep the current and previous key/value pairs.
     def finalize
-      old = delete(:FLASH)
+      old = current.delete(:FLASH)
       current[:FLASH_PREVIOUS] = old if old
     end
   end
@@ -176,24 +184,32 @@ module Ramaze
       previous.merge(current)
     end
+    # flash[key] in your Controller
     def [](key)
       combined[key]
     end
+    # flash[key] = value in your Controller
     def []=(key, value)
       prev = session[:FLASH] || {}
       prev[key] = value
       session[:FLASH] = prev
     end
+    # Inspects the combined SessionFlash
     def inspect
       combined.inspect
     end
     private
+    # Session.current or {}
     def session
-      Ramaze::Session.current || {}
+      Session.current || {}
     end
   end
 end

data/lib/ramaze/version.rb CHANGED

@@ -5,7 +5,7 @@ module Ramaze #:nodoc:
   module Version #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 1
+    TINY  = 2
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/rake_tasks/maintaince.rake CHANGED

@@ -1,16 +1,15 @@
 desc "add copyright to all .rb files in the distribution"
 task 'add-copyright' do
   puts "adding copyright to files that don't have it currently"
+  puts COPYRIGHT
+  puts
   Dir['{lib,test}/**/*{.rb}'].each do |file|
     next if file =~ /_darcs/
     lines = File.readlines(file).map{|l| l.chomp}
     unless lines.first(COPYRIGHT.size) == COPYRIGHT
-      puts "fixing #{file}"
-      File.open(file, 'w+') do |f|
-        (COPYRIGHT + ["\n"] + lines).each do |line|
-          f.puts(line)
-        end
-      end
+      puts "#{file} seems to need attention, first 4 lines:"
+      puts lines[0..3]
+      puts
     end
   end
 end
@@ -202,9 +201,12 @@ task 'authors' do
   authors = []
   mapping = {}
   author_map = {
-    'm.fellinger@gmail.com' => 'Michael Fellinger',
-    'manveru@weez-int.com'  => 'Michael Fellinger',
-    'clive@crous.co.za'     => 'Clive Crous'
+    'm.fellinger@gmail.com'            => 'Michael Fellinger',
+    'manveru@weez-int.com'             => 'Michael Fellinger',
+    'clive@crous.co.za'                => 'Clive Crous',
+    'blueonyx@dev-area.net'            => 'Martin Hilbig',
+    'rff.rff@gmail.com'                => 'Gabriele Renzi',
+    'comp.lang.zenix+ramaze@gmail.com' => 'zenix',
   }
   changes.split("\n").grep(/^\w/).each do |line|
     splat  = line.split
@@ -215,14 +217,137 @@ task 'authors' do
     name   = author_map[email] if name.empty?
     mapping[name] = email
   end
+  pp mapping
   max = mapping.map{|k,v| k.size}.max
   File.open('doc/AUTHORS', 'w+') do |fp|
-    fp.puts("Following persons have contributed to Ramaze:")
+    fp.puts("Following persons (in alphabetical order) have contributed to Ramaze:")
     fp.puts
-    mapping.sort_by{|k,v| v}.each do |name, email|
+    mapping.sort_by{|k,v| k}.each do |name, email|
       fp.puts("#{name.ljust(max)} - #{email}")
     end
   end
 end
+task 'release' => ['distribute'] do
+  sh 'rubyforge login'
+  sh 'rubyforge add_release ramaze ramaze #{VERS} pkg/ramaze-#{VERS}.gem'
+  require 'open-uri'
+  require 'hpricot'
+  url = "http://rubyforge.org/frs/?group_id=3034"
+  doc = Hpricot(open(url))
+  a = (doc/:a).find{|a| a[:href] =~ /release_id/}
+  version = a.inner_html
+  release_id = Hash[*a[:href].split('?').last.split('=').flatten]['release_id']
+  sh "rubyforge add_file ramaze ramaze #{release_id} pkg/ramaze-#{VERS}.tar.gz"
+  sh "rubyforge add_file ramaze ramaze #{release_id} pkg/ramaze-#{VERS}.tar.bz2"
+end
+desc "list all undocumented methods"
+task 'undocumented-module' do
+  require 'strscan'
+  require 'term/ansicolor'
+  class String
+    include Term::ANSIColor
+  end
+  class SimpleDoc
+    def initialize(string)
+      @s = StringScanner.new(string)
+    end
+    def scan
+      comment = false
+      total, missing = [], []
+      until @s.eos?
+        unless @s.scan(/^\s*#.*/)
+          comment = true if @s.scan(/^=begin$/)
+          comment = false if comment and @s.scan(/^=end$/)
+          unless comment
+            if @s.scan(/(?:class ).*/)
+              #p @s.matched
+            elsif @s.scan(/(?:module ).*/)
+              #p @s.matched
+            elsif @s.scan(/(?:def )[\w?!*+\/-]+(?=[\(\s])/)
+              total << @s.matched.split.last
+              prev = @s.pre_match.split("\n")
+              prev.delete_if{|s| s.strip.empty?}
+              unless prev.last =~ /^\s*#.*/
+                missing << @s.matched.split.last
+              end
+            else
+              @s.scan(/./m)
+            end
+          end
+        end
+      end
+      return total, missing
+    end
+  end
+  all = {}
+  files = Dir['lib/**/*.rb']
+  files.each do |file|
+    t, m = SimpleDoc.new(File.read(file)).scan
+    all[file] = [t, m]
+  end
+  failed = all.reject{|k,(t,m)| m.size == 0}
+  max = failed.keys.sort_by{|f| f.size}.last.size
+  colors = {
+    (0..25  ) => :blue,
+    (25..50 ) => :green,
+    (50..75 ) => :yellow,
+    (75..100) => :red,
+  }
+  puts "\nAll undocumented methods\n\n"
+  failed.sort.each do |file, (t, m)|
+    ts, ms = t.size, m.size
+    tss, mss = ts.to_s, ms.to_s
+    ratio = ((ms.to_f/ts)*100).to_i
+    color = colors.find{|k,v| k.include?(ratio)}.last
+    complete = ms.to_f/ts.to_f
+    mthc = "method"
+    if ratio != 100
+      puts "#{file.ljust(max)}\t[#{[mss, tss].join('/').center(8)}]".send(color)
+      mthc = "methods" if ts > 1
+      if $VERBOSE
+        puts "Of #{tss} #{mthc}, #{mss} still needs documenting (#{100 - ratio}% documented, #{ratio}% undocumented)".send(color)
+        mthc = "method"
+        mthc = "methods" if ms > 1
+        print "#{mthc.capitalize}: "
+      end
+      puts m.join(', ')
+      puts
+    end
+  end
+  puts "The colors mean percentages of documentation left (ratio of undocumented methods to total):"
+  colors.sort_by{|k,v| k.begin}.each do |r, color|
+    print "[#{r.inspect}] ".send(color)
+  end
+  puts
+end
+task 'undocumented' do
+	$VERBOSE = false
+	Rake::Task['undocumented-module'].execute
+end
+task 'undocumented-verbose' do
+	$VERBOSE = true
+	Rake::Task['undocumented-module'].execute
+end

data/spec/examples/templates/template_liquid.rb CHANGED

@@ -13,10 +13,13 @@ describe 'Template Liquid' do
   %w[/internal /external].each do |url|
     it url do
-      html = get(url).body
+      name = url.gsub(/^\//, '')
+      response = get(url)
+      response.status.should == 200
+      html = response.body
       html.should_not == nil
-      html.should =~ %r{<title>Template::Liquid (internal|external)</title>}
-      html.should =~ %r{<h1>The (internal|external) Template for Liquid</h1>}
+      html.should =~ %r(<title>Template::Liquid #{name}</title>)
+      html.should =~ %r(<h1>The #{name} Template for Liquid</h1>)
     end
   end
 end

data/spec/examples/todolist.rb CHANGED

@@ -8,7 +8,6 @@ require 'main'
 # fix the paths to template and public for the spec
 class MainController
   template_root 'examples/todolist/template'
-  public_root 'examples/todolist/public'
 end
 describe 'todolist' do
@@ -47,7 +46,7 @@ describe 'todolist' do
   end
   it 'should start' do
-    ramaze :port => 7080
+    ramaze :public_root => 'examples/todolist/public', :port => 7080
     get('/').status.should == 200
   end

data/spec/helper/minimal.rb CHANGED

@@ -1,5 +1,10 @@
 require 'timeout'
+begin
+  require 'rubygems'
+rescue LoadError => ex
+end
 base = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 $:.unshift base.gsub(/^#{Dir.pwd}/, '.')
@@ -8,13 +13,8 @@ $context_runner = false
 require 'ramaze'
-begin
-  require 'rubygems'
-rescue LoadError => ex
-end
 require 'spec'
-if Spec::VERSION::FULL_VERSION < "0.9.1 (r1880)"
-  puts "please update rspec >= 0.9.1"
+if Spec::VERSION::FULL_VERSION < "1.0.3 (r2035)"
+  puts "please update rspec >= 1.0.3"
   exit 1
 end