kiss 0.9.4 → 1.0

data/lib/kiss/action.rb

@@ -2,30 +2,24 @@ class Kiss
   class Action
     include Kiss::TemplateMethods
   
-    # Class Methods
-  
-    class << self
-      # Sets reference back to controller (Kiss instance).
-      def set_controller(controller)
-        @@controller = controller
-      end
-    end
-    
-    # Instance Methods
-  
     # Raises custom error message for missing methods, specifying current action
     # more clearly than standard error message.
     def method_missing(meth)
-      raise NoMethodError, "undefined method `#{meth}' for action `#{@action}'"
+      raise NoMethodError, "undefined method `#{meth}'"
+    end
+  
+    def controller
+      @controller
     end
   
     # Creates a new action instance from controller data.
-    def initialize
-      @action = @@controller.action
+    def initialize(controller)
+      @controller = controller
+      @action = @controller.action
     
       @data = {}
       @forms = {}
-      @template_dir = @@controller.template_dir
+      @template_dir = @controller.template_dir
     end
   
     # Invokes controller's file_cache, setting exception class to Kiss::TemplateFileNotFound,
@@ -35,10 +29,6 @@ class Kiss
       controller.file_cache(path,fnf_file_type,fnf_exception_class,&block)
     end
   
-    def controller
-      @@controller
-    end
-  
     def forms
       @forms
     end
@@ -46,50 +36,39 @@ class Kiss
     # Returns true is `form' param matches current action path.
     def form_action_match
       form = params['form']
-      return false unless form =~ /^\w+(\/\w+)*$/s
+      return false unless form =~ /^\/?\w+(\/\w+)*$/s
       return form == @action || @action =~ /\/#{form}/
     end
   
     # Returns object from specified table, with id matching first argument (or argument of specified index).
-    def arg_object(table,index = 0)
-      result = dbm[table][arg(index)]
-      raise "#{table.to_s.singularize} not found" unless result
-    
+    def arg_object(table,index = 0,desired_values = {})
+      id = arg(index)
+      result = dbm[table].where(:id => id).first || (raise "#{table.to_s.singularize} id=#{id} not found")
+      desired_values.each_pair do |key,value|
+        unless result[key] == value
+          raise "#{table.to_s.singularize} id=#{id} does not have #{key} == #{value.inspect}"
+        end
+      end
       result
     end
   
     # Returns arg_object, or new object of specified table if arg_object is not found.
-    def arg_object_or_new(table,*args)
-      return (arg_object(table,*args) ) rescue dbm[table].new
+    def arg_object_or_new(table,index = 0,desired_values = {})
+      begin
+        arg_object(table,index,desired_values)
+      rescue => e
+        dbm[table].new(desired_values)
+      end
     end
   
     # Validates param of specified key against specified format.
     def validate_param(key, format, required = false)
-      value = @params[key]
-      print_key = key.gsub('_',' ')
-    
-      case (Kiss.validate_value(value, format, required))
-      when :missing:
-        raise "required param '#{key}' is missing"
-      when :invalid:
-        raise "param '#{key}' is invalid"
-      end
-    
-      value
+      Kiss.validate_value(@params[key], format, required, "param '#{key}'")
     end
   
     # Validates argument of specified index against specified format.
-    def validate_arg(index, options)
-      value = @args[index]
-    
-      case (Kiss.validate_value(value, format, required))
-      when :missing:
-        raise "required arg #{index} is missing"
-      when :invalid:
-        raise "arg #{index} is invalid"
-      end
-      
-      value
+    def validate_arg(index, format, required = false)
+      Kiss.validate_value(@args[index], format, required, "arg #{index}")
     end
   
     # Creates and invokes new Kiss::Mailer instance to send email message via sendmail.
@@ -120,7 +99,6 @@ class Kiss
     # Convert specified action path by prefixing current action_subdir,
     # unless specified path starts with slash (/).
     def app_absolute_path(path)
-      debug path
       path = controller.action_subdir + '/' + path if path !~ /\A\//
       path
     end
@@ -132,10 +110,10 @@ class Kiss
       elsif options[:text]
         return options[:text].to_s
       end
-    
+      
       @base_url ||= app(action_subdir + '/')
       @layout = options.is_a?(Hash) && options.has_key?(:layout) ? options[:layout] : 
-        (extension == 'rhtml' ? "/_layout" : nil)
+        (extension == 'rhtml' ? Kiss.layout : nil)
     
       content = options[:content].is_a?(String) ? options[:content] : process({
         :template => action,
@@ -151,7 +129,7 @@ class Kiss
         # clear layout
         # (however, layout template is allowed to set @layout to something else)
         @layout = nil
-      
+        
         # process layout file
         content = erubis(layout_path,binding,content)
       end
@@ -177,21 +155,21 @@ class Kiss
       attrs[:name] ||= @action
       form_name = attrs[:name]
       raise "page contains multiple forms named '#{form_name}'" if @forms.has_key?(form_name)
-    
+      
       # create form
       uri = app + request.path_info
       @forms[form_name] = @form = Kiss::Form.new({
         :action => uri,
         :request => self
       }.merge(attrs))
-  
+      
       # add data from controller to form
       if params['form'] == @form.name
         @form.submitted = true
         @form.params = params
       end
-  
-      return @form
+      
+      @form
     end
   
     # Returns most recently added form.

data/lib/kiss/bench.rb

@@ -0,0 +1,54 @@
+class Kiss
+  # Generates HTML reports on exceptions raised from the app,
+  # showing the backtrace with clickable stack frames with 
+  # TextMate links to source files, plus login hash, last SQL,
+  # GET/POST params, cookies, and Rack environment variables.
+  module Bench
+    def prepend_benchmarks(body)
+      html = <<-EOT
+<style>
+.kiss_bench {
+  text-align: left;
+  padding: 3px 7px;
+  border: 1px solid #ec4;
+  border-top: 1px solid #fff4bb;
+  border-bottom: 1px solid #d91;
+  background-color: #ffe590;
+  font-size: 12px;
+  color: #101;
+}
+.kiss_bench a {
+  color: #930;
+  text-decoration: none;
+}
+.kiss_bench a:hover {
+  color: #930;
+  text-decoration: underline;
+}
+</style>
+EOT
+      html += @benchmarks.map do |item|
+        start_link = context_link(item[:start_context])
+        end_link = context_link(item[:end_context])
+        
+        <<-EOT
+<div class="kiss_bench">
+<tt><b>#{item[:label].to_s.gsub(/\</,'&lt;')} duration: #{sprintf("%0.3f",item[:end_time].to_f - item[:start_time].to_f)} s</b></tt>
+<small style="line-height: 105%; display: block; padding-bottom: 3px">kiss bench<br/>started at #{start_link}<br/>ended at #{end_link || 'controller completion'}</small>
+</div>
+EOT
+      end.join
+      
+      body.each {|p| html += p }
+      html
+    end
+    
+    def context_link(context)
+      return nil unless context
+      
+      filename, line, method = context.split(/:/)
+      textmate_url = "txmt://open?url=file://" + h(Kiss.absolute_path(filename)) + '&amp;line=' + line
+      %Q(<a href="#{textmate_url}">#{filename}:#{line}</a> #{method})
+    end
+  end
+end

data/lib/kiss/controller_accessors.rb

@@ -1,13 +1,45 @@
 class Kiss
-  module ControllerAccessors
+  module KissAccessors
     def environment
-      controller.environment
+      Kiss.environment
+    end
+    
+    def db
+      Kiss.db
     end
+    alias_method :database, :db
   
+    def upload_dir
+      Kiss.upload_dir
+    end
+    
+    def pub(*args)
+      Kiss.pub(*args)
+    end
+  end
+  
+  module ControllerAccessors
+    def debug(object)
+      controller.debug(object, Kernel.caller[0])
+    end
+    
+    def bench(label = nil)
+      controller.bench(label, Kernel.caller[0])
+    end
+    
+    def dbm
+      controller.dbm
+    end
+    alias_method :models, :dbm
+    
+    def file_cache(*args,&block)
+      controller.file_cache(*args,&block)
+    end
+    
     def params
       controller.params
     end
-  
+    
     def args
       controller.args
     end
@@ -24,10 +56,6 @@ class Kiss
       controller.request
     end
   
-    def pub(*args)
-      controller.pub(*args)
-    end
-  
     def set_login_expires(*args)
       controller.set_login_expires(*args)
     end
@@ -52,20 +80,10 @@ class Kiss
       controller.login_session_valid?
     end
   
-    def db
-      controller.db
-    end
-    alias_method :database, :db
-  
-    def dbm
-      controller.dbm
-    end
-    alias_method :models, :dbm
-  
     def app(*args)
-      controller.app(*args)
+      controller.app_url(*args)
     end
-  
+    
     def host
       controller.host
     end
@@ -73,17 +91,13 @@ class Kiss
     def action
       controller.action
     end
-    
-    def extension
-      controller.extension
-    end
   
     def action_subdir
       controller.action_subdir
     end
-  
-    def upload_dir
-      controller.upload_dir
+    
+    def extension
+      controller.extension
     end
   
     def arg(index)
@@ -97,5 +111,7 @@ class Kiss
     def new_email
       controller.new_email
     end
+    
+    include KissAccessors
   end
 end

data/lib/kiss/debug.rb

@@ -0,0 +1,45 @@
+class Kiss
+  # Generates HTML reports on exceptions raised from the app,
+  # showing the backtrace with clickable stack frames with 
+  # TextMate links to source files, plus login hash, last SQL,
+  # GET/POST params, cookies, and Rack environment variables.
+  module Debug
+    def prepend_debug(body)
+      html = <<-EOT
+<style>
+.kiss_debug {
+text-align: left;
+padding: 3px 7px;
+border: 1px solid #ebe;
+border-top: 1px solid #fdf;
+border-bottom: 1px solid #d6d;
+background-color: #fbf;
+font-size: 12px;
+color: #101;
+}
+.kiss_debug a {
+color: #707;
+text-decoration: none;
+}
+.kiss_debug a:hover {
+color: #707;
+text-decoration: underline;
+}
+</style>
+EOT
+      html += @debug_messages.map do |object,context|
+        filename, line, method = context.split(/:/)
+        textmate_url = "txmt://open?url=file://" + h(Kiss.absolute_path(filename)) + '&amp;line=' + line
+        <<-EOT
+<div class="kiss_debug">
+<tt><b>#{object.gsub(/\</,'&lt;')}</b></tt>
+<br><small>kiss debug output at <a href="#{textmate_url}">#{filename}:#{line}</a> #{method}</small>
+</div>
+EOT
+      end.join
+    
+      body.each {|p| html += p }
+      html
+    end
+  end
+end

data/lib/kiss/exception_report.rb

@@ -1,14 +1,18 @@
 class Kiss
-  # Generates HTML exception reports for Rack::ShowExceptions and 
-  # Rack::LogExceptions.
+  # Generates HTML reports on exceptions raised from the app,
+  # showing the backtrace with clickable stack frames with 
+  # TextMate links to source files, plus login hash, last SQL,
+  # GET/POST params, cookies, and Rack environment variables.
   class ExceptionReport
     @@context = 7
     
     class << self
-      def generate(env, exception)
-        req = Rack::Request.new(env)
-        path = (req.script_name + req.path_info).squeeze("/")
-        url = req.scheme + '://' + req.host + path
+      def generate(exception, env = nil, cache = nil, sql = nil)
+        if env
+          req = Rack::Request.new(env)
+          path = (req.script_name + req.path_info).squeeze("/")
+          url = (req.scheme + '://' + req.host + path) rescue 'n/a'
+        end
       
         backtrace = exception.backtrace
         #backtrace.shift while lines[0] =~ /\/lib\/kiss(\/|\.rb)/
@@ -38,9 +42,11 @@ class Kiss
           end
         }.compact
         
-        env["rack.errors"].puts "#{exception.class}: #{exception.message}"
-        env["rack.errors"].puts exception.backtrace.map { |l| "\t" + l }
-        env["rack.errors"].flush
+        if env
+          env["rack.errors"].puts "#{exception.class}: #{exception.message}"
+          env["rack.errors"].puts exception.backtrace.map { |l| "\t" + l }
+          env["rack.errors"].flush
+        end
         
         db_query = begin (Sequel::MySQL::Database.last_query) rescue nil end
         
@@ -48,25 +54,19 @@ class Kiss
         @@erubis.result(binding)
       end
     
-      def absolute_path(filename)
-        filename = ( filename =~ /\A\// ? '' : (Dir.pwd + '/') ) + filename
-      end
-    
       def textmate_href(frame)
-        "txmt://open?url=file://"+(h(absolute_path(frame.filename)))+"&amp;line="+(h frame.lineno)
+        "txmt://open?url=file://"+(h(Kiss.absolute_path(frame.filename)))+"&amp;line="+(h frame.lineno)
       end
-
-      def h(obj)                  # :nodoc:
-        case obj
-        when String
-          Rack::Utils.escape_html(obj).gsub(/^(\s+)/) {'&nbsp;' * $1.length}
-        else
-          Rack::Utils.escape_html(obj.inspect)
-        end
+      
+      def h(*args)
+        Kiss.h(*args)
       end
 
       # :stopdoc:
 
+  # adapted from Rack::ShowExceptions
+  # Used under the MIT license
+  #
   # adapted from Django <djangoproject.com>
   # Copyright (c) 2005, the Lawrence Journal-World
   # Used under the modified BSD license:
@@ -86,7 +86,7 @@ class Kiss
     body { font:small sans-serif; }
     body>div { border-bottom:1px solid #ddd; }
     h1 { font-weight:normal; font-size: 18px; font-style: italic; color: #d96 }
-    h2 { margin-bottom:.8em; }
+    h2 { font-size: 16px; margin-bottom:.8em; }
     h2 span { font-size:80%; color:#000; font-weight:normal; }
     h3 { margin:1em 0 .5em 0; }
     h4 { margin:0 0 .5em 0; font-weight: normal; }
@@ -117,17 +117,18 @@ class Kiss
     div.commands a { color:black; text-decoration:none; }
     #summary { background: #ffd; }
     #summary h2 { font-weight: normal; color: #a10; font-size: 14px; font-weight: bold }
-    #summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
-    #summary ul#quicklinks li { float: left; padding: 0 1em; }
-    #summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
+    #summary ul#quicklinks { list-style-type: none; margin: 0 -8px 2em -8px; font-size: 12px }
+    #summary ul#quicklinks li { float: left; padding: 0 8px; }
+    #summary ul#quicklinks>li+li { border-left: 1px #999 solid; }
+    #summary .info th,#summary .info td { padding-top: 6px }
     #explanation { background:#eee; }
     #template, #template-not-exist { background:#f6f6f6; }
     #template-not-exist ul { margin: 0 0 0 20px; }
     #traceback { background:#eee; }
     #requestinfo { background:#f6f6f6; padding-left:120px; }
     #summary table { border:none; background:transparent; }
-    #requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
-    #requestinfo h3 { margin-bottom:-1em; }
+    #requestinfo h2, #requestinfo h3 { position:relative; left:-100px; }
+    #requestinfo h3 { width:100px; margin-right:-100px; margin-bottom:-1.1em; }
     .error { background: #ffc; }
     .specific { color:#cc3300; font-weight:bold; }
   </style>
@@ -188,23 +189,25 @@ class Kiss
   <a name="summary"></a>
   <h1><%=h exception.class %></h1>
   <h2><code><%=(h exception.message).gsub(/\n/,'<br>') %></code></h2>
-  <table><tr>
+  <% if env %>
+  <table class="info"><tr>
     <th>Ruby</th>
     <td><code><%=h frames.first.filename %></code>: in <code><%=h frames.first.function %></code>, <a href="<%= textmate_href(frames.first) %>">line <%=h frames.first.lineno %></a></td>
   </tr><tr>
     <th>Web</th>
     <td><code><%=h req.request_method %> <%=h(url)%></code></td>
-  </tr></table>
-
-  <h3>Jump to:</h3>
-  <ul id="quicklinks">
-    <li><a href="#cache">Cache</a></li>
-    <li><a href="#db-query">DB Query</a></li>
+  </tr><tr>
+    <th>More</th>
+    <td><ul id="quicklinks">
     <li><a href="#get-info">GET</a></li>
     <li><a href="#post-info">POST</a></li>
+    <li><a href="#cache">Cache</a></li>
+    <li><a href="#last-sql">Last SQL</a></li>
     <li><a href="#cookie-info">Cookies</a></li>
     <li><a href="#env-info">ENV</a></li>
-  </ul>
+  </ul></td>
+  </tr></table>
+  <% end %>
 </div>
 
 <div id="traceback">
@@ -241,16 +244,9 @@ class Kiss
   </ul>
 </div>
 
+<% if env %>
 <div id="requestinfo">
   <h2>Additional information</h2>
-    
-  <a name="cache"></a>
-  <h3 id="cache">Cache</h3>
-    <p><code><%=h Kiss.exception_cache.inspect %></code></p>
-    
-  <a name="db-query"></a>
-  <h3 id="db-query">DB Query</h3>
-    <p><% if db_query %><code><%=(h db_query).gsub(/\n/,'<br/>') %></code><% else %>No database queries executed.<% end %></p>
 
   <a name="get-info"></a>
   <h3 id="get-info">GET</h3>
@@ -297,6 +293,14 @@ class Kiss
   <% else %>
     <p>No POST data.</p>
   <% end %>
+    
+  <a name="cache"></a>
+  <h3 id="cache">Cache</h3>
+    <p><code><%=h cache.inspect %></code></p>
+    
+  <a name="last-sql"></a>
+  <h3 id="last-sql">Last SQL</h3>
+    <p><% if sql %><code><%=(h sql).gsub(/\n/,'<br/>') %></code><% else %>n/a<% end %></p>
 
   <a name="cookie-info"></a>
   <h3 id="cookie-info">Cookies</h3>
@@ -341,6 +345,7 @@ class Kiss
     </table>
 
 </div>
+<% end %>
 
 <div id="explanation">
   <p>