rack-webprofiler 0.1.0.pre.beta1 → 0.1.0.pre.beta2

data/lib/rack/web_profiler/collector/rack/request_collector.rb

@@ -18,11 +18,11 @@ ICON
       store :request_cookies, request.cookies
       store :request_get,     request.GET
       store :request_post,    get_request_post(request)
-      store :request_session, request.session
+      store :request_session, hash_to_s(request.session)
       store :request_cookies, request.cookies
       store :request_body,    get_request_body(request)
 
-      store :rack_env, {} # request.env.each { |k, v| v.inspect }
+      store :rack_env, hash_to_s(request.env)
 
       store :response_status,  response.status
       store :response_headers, response.headers
@@ -38,8 +38,6 @@ ICON
 
     template __FILE__, type: :DATA
 
-    is_enabled? -> { defined?(Rack) && !defined?(Rails) && !defined?(Sinatra) }
-
     class << self
       # Get request headers.
       #
@@ -57,22 +55,27 @@ ICON
       end
 
       def get_request_body(request)
-        return nil if request.body.nil?
-        request.body.gets
+        return nil if request.body.nil? || request.get?
+        body = request.body.dup
+        body.read
+      end
+
+      def hash_to_s(hash)
+        hash.collect {|k,v| [k, v.to_s]}
       end
     end
   end
 end
 
 __END__
-<% content_for :tab do %>
-  <%= data[:response_status] %> | <%= data[:request_method] %> <%= data[:request_path] %>
+<% tab_content do %>
+  <%=h data(:response_status) %>
 <% end %>
 
-<% content_for :panel do %>
+<% panel_content do %>
   <div class="block">
     <h3>GET</h3>
-    <% unless data[:request_get].empty? %>
+    <% unless data(:request_get).empty? %>
     <table>
       <thead>
         <tr>
@@ -81,10 +84,10 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:request_get].each do |k, v| %>
+      <% data(:request_get).each do |k, v| %>
         <tr>
-          <th><%= k %></th>
-          <td class="code"><%= v %></td>
+          <th><%=h k %></th>
+          <td class="code"><%=h v %></td>
         </tr>
       <% end %>
       </tbody>
@@ -96,7 +99,7 @@ __END__
 
   <div class="block">
     <h3>POST</h3>
-    <% if data[:request_post] && !data[:request_post].empty? %>
+    <% if data(:request_post) && !data(:request_post).empty? %>
     <table>
       <thead>
         <tr>
@@ -105,10 +108,10 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:request_post].each do |k, v| %>
+      <% data(:request_post).each do |k, v| %>
         <tr>
-          <th><%= k %></th>
-          <td class="code"><%= v %></td>
+          <th><%=h k %></th>
+          <td class="code"><%=h v %></td>
         </tr>
       <% end %>
       </tbody>
@@ -120,7 +123,7 @@ __END__
 
   <div class="block">
     <h3>Request headers</h3>
-    <% unless data[:request_headers].empty? %>
+    <% unless data(:request_headers).empty? %>
     <table>
       <thead>
         <tr>
@@ -129,10 +132,10 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:request_headers].sort.each do |k, v| %>
+      <% data(:request_headers).sort.each do |k, v| %>
         <tr>
-          <th><%= k %></th>
-          <td class="code"><%= v %></td>
+          <th><%=h k %></th>
+          <td class="code"><%=h v %></td>
         </tr>
       <% end %>
       </tbody>
@@ -144,8 +147,8 @@ __END__
 
   <div class="block">
     <h3>Request content</h3>
-    <% unless data[:request_body].nil? %>
-    <code><%= data[:request_body] %></code>
+    <% unless data(:request_body).nil? %>
+    <%=highlight code: data(:request_body) %>
     <% else %>
     <p><span class="text__no-value">No request content</span></p>
     <% end %>
@@ -153,7 +156,7 @@ __END__
 
   <div class="block">
     <h3>Response headers</h3>
-    <% unless data[:response_headers].empty? %>
+    <% unless data(:response_headers).empty? %>
     <table>
       <thead>
         <tr>
@@ -162,7 +165,7 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:response_headers].sort.each do |k, v| %>
+      <% data(:response_headers).sort.each do |k, v| %>
         <tr>
           <th><%= k %></th>
           <td class="code"><%= v %></td>
@@ -177,7 +180,7 @@ __END__
 
   <div class="block">
     <h3>Session</h3>
-    <% unless data[:request_session].empty? %>
+    <% unless data(:request_session).empty? %>
     <table>
       <thead>
         <tr>
@@ -186,7 +189,7 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:request_session].each do |k, v| %>
+      <% data(:request_session).each do |k, v| %>
         <tr>
           <th><%= k %></th>
           <td class="code"><%= v %></td>
@@ -201,7 +204,7 @@ __END__
 
   <div class="block">
     <h3>Cookies</h3>
-    <% unless data[:request_cookies].empty? %>
+    <% unless data(:request_cookies).empty? %>
     <table>
       <thead>
         <tr>
@@ -210,10 +213,10 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:request_cookies].each do |k, v| %>
+      <% data(:request_cookies).each do |k, v| %>
         <tr>
-          <th><%= k %></th>
-          <td class="code"><%= v %></td>
+          <th><%=h k %></th>
+          <td class="code"><%=h v %></td>
         </tr>
       <% end %>
       </tbody>
@@ -225,7 +228,7 @@ __END__
 
   <div class="block">
     <h3>Env</h3>
-    <% if data[:rack_env] && !data[:rack_env].empty? %>
+    <% if data(:rack_env) && !data(:rack_env).empty? %>
     <table>
       <thead>
         <tr>
@@ -234,10 +237,10 @@ __END__
         </tr>
       <thead>
       <tbody>
-      <% data[:rack_env].each do |k, v| %>
+      <% data(:rack_env).sort.each do |k, v| %>
         <tr>
-          <th><%= k %></th>
-          <td class="code"><%= v %></td>
+          <th><%=h k %></th>
+          <td class="code"><%=h v %></td>
         </tr>
       <% end %>
       </tbody>

data/lib/rack/web_profiler/collector/ruby_collector.rb

@@ -41,21 +41,21 @@ ICON
 end
 
 __END__
-<% content_for :tab do %>
-  <%= data[:ruby_version] %>
+<% tab_content do %>
+  <%=h data(:ruby_version) %>
 <% end %>
 
-<% content_for :panel do %>
+<% panel_content do %>
   <div class="block">
     <h3>Ruby informations</h3>
     <table>
       <tr>
         <th>Version</th>
-        <td><%= "#{data[:ruby_version]}p#{data[:ruby_patchlevel]} (#{data[:ruby_release_date]} revision #{data[:ruby_revision]}) [#{data[:ruby_platform]}]" %></td>
+        <td><%=h "#{data(:ruby_version)}p#{data(:ruby_patchlevel)} (#{data(:ruby_release_date)} revision #{data(:ruby_revision)}) [#{data(:ruby_platform)}]" %></td>
       </tr>
       <tr>
         <th>Documentation</th>
-        <td><a href="<%= data[:ruby_doc_url] %>"><%= data[:ruby_doc_url] %></a></td>
+        <td><a href="<%=h data(:ruby_doc_url) %>"><%= data(:ruby_doc_url) %></a></td>
       </tr>
     </table>
   </div>
@@ -67,13 +67,15 @@ __END__
         <tr>
           <th>Name</th>
           <th>Version</th>
+          <th>Summary</th>
         </tr>
       <thead>
       <tbody>
-      <% data[:gems_list].sort!{|a,b| a[:name] <=> b[:name] }.each do |g| %>
+      <% data(:gems_list).sort!{|a,b| a[:name] <=> b[:name] }.each do |g| %>
         <tr>
-          <th><%= g[:name] %></th>
+          <th><a href="<%= g[:homepage] %>"><%= g[:name] %></a></th>
           <td><%= g[:version] %></td>
+          <td><%= g[:summary] %></td>
         </tr>
       <% end %>
       </tbody>

data/lib/rack/web_profiler/collector/time_collector.rb

@@ -20,6 +20,6 @@ ICON
 end
 
 __END__
-<% content_for :tab do %>
-  <%= (data[:runtime] * 1000.0).round(2) %> ms
+<% tab_content do %>
+  <%= (data(:runtime) * 1000.0).round(2) %> ms
 <% end %>

data/lib/rack/web_profiler/collector/view.rb

@@ -0,0 +1,44 @@
+module Rack
+  class WebProfiler::Collector::View < WebProfiler::View
+
+    def context
+      @context ||= Context.new
+    end
+
+    # Helpers
+    module Helpers
+
+      def tab_content
+        if block_given?
+          @tab_content ||= capture(&Proc.new)
+        elsif !@tab_content.nil?
+          @tab_content
+        end
+      end
+
+      def panel_content
+        if block_given?
+          @panel_content ||= capture(&Proc.new)
+        elsif !@panel_content.nil?
+          @panel_content
+        end
+      end
+
+      def data(k)
+        return nil if @collection.nil?
+
+        datas = @collection.datas[@collector.name.to_sym][:datas]
+        return datas[k] if datas.has_key?(k)
+
+        nil
+      end
+    end
+
+    protected
+
+    class Context
+      include WebProfiler::View::CommonHelpers
+      include Helpers
+    end
+  end
+end

data/lib/rack/web_profiler/collector.rb

@@ -6,24 +6,13 @@ module Rack
   class WebProfiler::Collector
     autoload :RubyCollector, "rack/web_profiler/collector/ruby_collector"
     autoload :TimeCollector, "rack/web_profiler/collector/time_collector"
+    autoload :View, "rack/web_profiler/collector/view"
 
     module Rack
       autoload :RackCollector,    "rack/web_profiler/collector/rack/rack_collector"
       autoload :RequestCollector, "rack/web_profiler/collector/rack/request_collector"
     end
 
-    module Rails
-      autoload :ActiveRecordCollector, "rack/web_profiler/collector/rails/active_record_collector"
-      autoload :LoggerCollector,       "rack/web_profiler/collector/rails/logger_collector"
-      autoload :RailsCollector,        "rack/web_profiler/collector/rails/rails_collector"
-      autoload :RequestCollector,      "rack/web_profiler/collector/rails/request_collector"
-    end
-
-    module Sinatra
-      autoload :RequestCollector, "rack/web_profiler/collector/sinatra/request_collector"
-      autoload :SinatraCollector, "rack/web_profiler/collector/sinatra/sinatra_collector"
-    end
-
     # DSL
     module DSL
       def self.included(base)
@@ -104,8 +93,10 @@ module Rack
       attr_reader :datas
 
       def initialize
-        @datas  = Hash.new
-        @status = nil
+        @datas      = Hash.new
+        @status     = nil
+        @show_tab   = true
+        @show_panel = true
       end
 
       # Store a value.
@@ -129,13 +120,35 @@ module Rack
         @status
       end
 
+      #
+      #
+      # @param b [Boolean, nil]
+      #
+      # @return [Boolean]
+      def show_panel(b = nil)
+        @show_panel = !!b unless b.nil?
+        @show_panel
+      end
+
+      #
+      #
+      # @param b [Boolean, nil]
+      #
+      # @return [Boolean]
+      def show_tab(b = nil)
+        @show_tab = !!b unless b.nil?
+        @show_tab
+      end
+
       # Transform DataStorage to an Hash
       #
       # @return [Hash<Symbol, Object>]
       def to_h
         {
-          datas: @datas,
-          status: @status
+          datas:      @datas,
+          status:     @status,
+          show_panel: @show_panel,
+          show_tab:   @show_tab,
         }
       end
     end

data/lib/rack/web_profiler/config.rb

@@ -13,16 +13,6 @@ module Rack
       # Rack
       # Rack::WebProfiler::Collector::Rack::RackCollector,
       Rack::WebProfiler::Collector::Rack::RequestCollector,
-
-      # Rails
-      # Rack::WebProfiler::Collector::Rails::ActiveRecordCollector,
-      # Rack::WebProfiler::Collector::Rails::LoggerCollector,
-      Rack::WebProfiler::Collector::Rails::RailsCollector,
-      Rack::WebProfiler::Collector::Rails::RequestCollector,
-
-      # Sinatra
-      Rack::WebProfiler::Collector::Sinatra::RequestCollector,
-      Rack::WebProfiler::Collector::Sinatra::SinatraCollector,
     ].freeze
     def initialize
       @collectors = Rack::WebProfiler::Collectors.new

data/lib/rack/web_profiler/controller.rb

@@ -10,55 +10,61 @@ module Rack
     #
     # @param request [Rack::WebProfiler::Request]
     def initialize(request)
-      @request      = request
-      @contents_for = {}
+      @request = request
     end
 
     # List the webprofiler history.
+    #
+    # @return [Rack::Response]
     def index
       @collections = Rack::WebProfiler::Model::CollectionRecord.order(Sequel.desc(:created_at))
                                                             .limit(20)
 
+      return json(@collections, 200, {only: [:token, :http_method, :http_status, :url, :ip]}) if prefer_json?
+      return json(@collections, to_json_opts: {only: [:token, :http_method, :http_status, :url, :ip]}) if prefer_json?
       erb "panel/index.erb", layout: "panel/layout.erb"
     end
 
     # Show the webprofiler panel.
+    #
+    # @param token [String] The collection token
+    #
+    # @return [Rack::Response]
     def show(token)
       @collection = Rack::WebProfiler::Model::CollectionRecord[token: token]
-      return error404 if @collection.nil?
+      return not_found if @collection.nil?
 
       @collectors = Rack::WebProfiler.config.collectors.all
       @collector  = nil
 
       unless @request.params['panel'].nil?
         @collector = @collectors[@request.params['panel'].to_sym]
-      end
-
-      if @collector.nil?
+      else
         @collector = @collectors.values.first
       end
+      return not_found if @collector.nil?
 
-      @current_panel = @collector.name
-
-      # @todo return json if request.content_type ask json (same for xml?)
-      # @example json(@collectors) if @request.media_type.include? "json"
-
+      return json(@collection) if prefer_json?
       erb "panel/show.erb", layout: "panel/layout.erb"
     end
 
-    # Print the webprofiler toolbar
+    # Print the webprofiler toolbar.
+    #
+    # @param token [String] The collection token
+    #
+    # @return [Rack::Response]
     def show_toolbar(token)
       @collection = Rack::WebProfiler::Model::CollectionRecord[token: token]
       return erb nil, status: 404 if @collection.nil?
 
       @collectors = Rack::WebProfiler.config.collectors.all
-      # @todo process the callector views
-      # @collectors = Rack::WebProfiler::Collector.render_tabs(@record)
 
       erb "profiler.erb"
     end
 
     # Clean the webprofiler.
+    #
+    # @return [Rack::Response]
     def delete
       Rack::WebProfiler::Model.clean
 
@@ -67,30 +73,62 @@ module Rack
 
     private
 
+    # Is "application/json" reponse is prefered?
+    #
+    # @return [Boolean]
+    #
+    # @private
+    def prefer_json?
+      prefered_http_accept == "application/json"
+    end
+
+    # Returns the prefered Content-Type response between html and json.
+    #
+    # @return [String]
+    #
+    # @private
+    def prefered_http_accept
+      Rack::Utils.best_q_match(@request.env["HTTP_ACCEPT"], %w[text/html application/json])
+    end
+
+    # Redirection.
+    #
+    # @param path [string]
+    #
+    # @return [Rack::Response]
+    #
+    # @private
     def redirect(path)
       Rack::Response.new([], 302, {
         "Location" => "#{@request.base_url}#{path}",
       })
     end
 
+    # 404 page.
+    #
+    # @return [Rack::Response]
+    #
+    # @private
+    def not_found
+      erb "404.erb", layout: "panel/layout.erb", status: 404
+    end
+
     # Render a HTML reponse from an ERB template.
     #
     # @param path [String] Path to the ERB template
+    # @option layout [String, nil] Path to the ERB layout
+    # @option variables [Hash, nil] List of variables to the view
+    # @option status [Integer] HTTP status code
     #
     # @return [Rack::Response]
-    def erb(path, layout: nil, status: 200)
-      content = ""
-
-      unless path.nil?
-        templates = [read_template(path)]
-        templates << read_template(layout) unless layout.nil?
+    #
+    # @private
+    def erb(path, layout: nil, variables: nil, status: 200)
+      v = WebProfiler::View.new(path, layout: layout)
 
-        content = templates.inject(nil) do |prev, temp|
-          _render_erb(temp) { prev }
-        end
-      end
+      variables ||= binding
 
-      Rack::Response.new(content, status, {
+      Rack::Response.new(v.result(variables), status, {
         "Content-Type" => "text/html",
       })
     end
@@ -98,49 +136,16 @@ module Rack
     # Render a JSON response from an Array or a Hash.
     #
     # @param data [Array, Hash] Data
+    # @param status [Integer]
+    # @param opts [Hash]
     #
     # @return [Rack::Response]
-    def json(data = {})
-      Rack::Response.new(data.to_json, 200, {
+    #
+    # @private
+    def json(data = {}, status: 200, to_json_opts: {})
+      Rack::Response.new(data.send(:to_json, opts), status, {
         "Content-Type" => "application/json",
       })
     end
-
-    def error404
-      erb "404.erb", layout: "panel/layout.erb", status: 404
-    end
-
-    def _render_erb(template)
-      ERB.new(template).result(binding)
-    end
-
-    def partial(path)
-      return "" if path.nil?
-      ERB.new(read_template(path)).result(binding)
-    end
-
-    def render_collector(collector, data)
-      @data = data
-      return "" if collector.nil?
-      ERB.new(read_template(collector.template)).result(binding)
-    end
-
-    def content_for(name)
-      name = name.to_sym
-
-      if block_given?
-        @contents_for[name] = Proc.new
-      elsif @contents_for[name].respond_to?(:call)
-        @contents_for[name].call
-      end
-    end
-
-    def read_template(template)
-      unless template.empty?
-        path = ::File.expand_path("../../templates/#{template}", __FILE__)
-        return ::File.read(path) if ::File.exist?(path)
-      end
-      template
-    end
   end
 end

data/lib/rack/web_profiler/engine.rb

@@ -2,7 +2,7 @@ module Rack
   #
   class WebProfiler::Engine
     class << self
-      # Process
+      # Process request.
       #
       # @param request [Rack::WebProfiler::Request]
       # @param body
@@ -22,7 +22,7 @@ module Rack
         response = Rack::Response.new([], status, headers)
 
         response.header["X-RackWebProfiler-Token"] = @token
-        response.header["X-RackWebProfiler-Url"]   = @url
+        response.header["X-RackWebProfiler-Url"]   = WebProfiler::Router.url_for_profiler(record.token)
 
         if defined? Rails and body.is_a? ActionDispatch::Response::RackBody
           body = body.body
@@ -37,12 +37,21 @@ module Rack
         response
       end
 
+      # Process an exception.
+      #
+      # @param request [Rack::WebProfiler::Request]
+      #
+      # @return [Rack::Response]
+      def process_exception(request)
+        process(request, [], 500, {})
+      end
+
       private
 
       # Collect
       #
-      # @param request
-      # @param response
+      # @param request [Rack::WebProfiler::Request]
+      # @param response [Rack::Response]
       def collect!(request, response)
         processor = Processor.new(request, response)
         processor.save!
@@ -61,7 +70,7 @@ module Rack
       #
       # @return [String]
       def template
-        @template ||= ERB.new(::File.read(::File.expand_path("../../templates/async.erb", __FILE__)))
+        @template ||= WebProfiler::View.new("async.erb")
       end
 
       class Processor
@@ -85,7 +94,7 @@ module Rack
 
         def create_record!
           @record ||= WebProfiler::Model::CollectionRecord.create({
-            url:           @request.path,
+            url:           @request.url,
             ip:            @request.ip,
             http_method:   @request.request_method,
             http_status:   @response.status,

data/lib/rack/web_profiler/model/collection_record.rb

@@ -5,6 +5,7 @@ module Rack
     plugin :schema
     plugin :hook_class_methods
     plugin :serialization
+    plugin :json_serializer
     plugin :timestamps
 
     # Attributes:

data/lib/rack/web_profiler/request.rb

@@ -1,7 +1,7 @@
 module Rack
   #
   class WebProfiler::Request < Rack::Request
-    attr_reader :runtime
+    attr_reader :runtime, :exception
 
     def start_runtime!
       @request_start ||= Time.now.to_f
@@ -10,5 +10,9 @@ module Rack
     def save_runtime!
       @runtime ||= Time.now.to_f - @request_start
     end
+
+    def save_exception(e)
+      @exception = e
+    end
   end
 end