merb_footnotes 0.1

data/lib/merb_footnotes/notes/javascripts_note.rb

@@ -0,0 +1,16 @@
+require "#{File.dirname(__FILE__)}/files_note"
+
+module MerbFootnotes
+  module Notes
+    class JavascriptsNote < FilesNote
+      def title
+        "Javascripts (#{@files.length})"
+      end
+
+      protected
+        def scan_text(text)
+          text.scan(/<script[^>]+src\s*=\s*['"]([^>?'"]+\.js)/im).flatten
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/layout_note.rb

@@ -0,0 +1,33 @@
+# LAYOUT NOTE
+# Todo: make this note display the currently displayed layout
+
+require "#{File.dirname(__FILE__)}/view_note"
+
+module MerbFootnotes
+  module Notes
+    class LayoutNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @layout_path = find_layout
+      end
+
+      def row
+        :edit
+      end
+
+      def link
+        escape(Merb::Plugins.config[:merb_footnotes][:prefix] + @layout_path)
+      end
+
+      def valid?
+        prefix? and !@layout_path.blank?
+      end
+
+      protected
+        def find_layout
+          # TODO: find the real rendered layout
+          "#{Merb.root}/app/views/layout/application.html.#{Merb.template_engine}"
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/log_note.rb

@@ -0,0 +1,38 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class LogNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def content
+        ""
+        # TODO
+        # escape(log_tail).gsub("\n","<br />")
+      end
+
+      protected
+        def log_tail
+          filename = if Merb.logger.instance_variable_get('@log')
+            Merb.logger.instance_variable_get('@log').path
+          else 
+            Merb.logger.instance_variable_get('@logdev').filename
+          end
+          file_string = File.open(filename).read.to_s
+
+          # We try to select the specified action from the log
+          # If we can't find it, we get the last 100 lines
+          #
+          if rindex = file_string.rindex('Processing '+@controller.controller_class_name+'#'+@controller.action_name)
+            file_string[rindex..-1].gsub(/\e\[.+?m/, '')
+          else
+            lines = file_string.split("\n")
+            index = [lines.size-100,0].max
+            lines[index..-1].join("\n")
+          end
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/params_note.rb

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class ParamsNote < AbstractNote
+      def initialize(controller)
+        @params = controller.params
+      end
+
+      def title
+        "Params (#{@params.length})"
+      end
+
+      def content
+        escape(@params.inspect)
+      end
+    end
+  end
+end

data/lib/merb_footnotes/notes/partials_note.rb

@@ -0,0 +1,59 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+# View Note
+# this note should give you an easy linkback to the currently render view 
+# TODO: include all rendered partials by wrapping the partial call
+module MerbFootnotes
+  module Notes
+    class PartialsNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @partials = format_partials(@controller.footnotes[:partials])
+      end
+
+      def row
+        :edit
+      end
+
+      def title
+        "Partials (#{@partials.size})"
+      end
+
+      # def link
+      #   escape(Merb::Plugins.config[:merb_footnotes][:prefix] + filename)
+      # end
+
+      def content
+        mount_table(@partials.unshift([:partial, :arguments]))
+      end
+
+      def valid?
+        prefix?
+      end
+
+      protected        
+        def format_partials(partials)
+          display_list = []
+          partials.each do |r|
+            action = r.first
+            opts = r.last
+            
+            action = "<a href='#{get_path_for_partial(action)}'>#{action}</a>"
+            display_list << [action.to_s, opts.inspect]
+          end
+          display_list
+        end
+        
+        def get_path_for_partial(template)
+          template = template.to_s
+          if template =~ %r{^/}
+            template_path = File.dirname(template) / "_#{File.basename(template)}"
+          else
+            kontroller = (m = template.match(/.*(?=\/)/)) ? m[0] : @controller.controller_name
+            template_path = "#{kontroller}/_#{File.basename(template)}"
+          end
+          "#{Merb::Plugins.config[:merb_footnotes][:prefix]}/#{Merb.root}/app/views/#{template_path}.html.#{Merb.template_engine}"
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/queries_note.rb

@@ -0,0 +1,139 @@
+# TODO: fix instrumentation in order to populate the MerbFootNotes::Notes::QueriesNote.sql accessor
+
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class QueriesNote < AbstractNote
+      @@sql = []
+      
+      def self.sql
+        @@sql
+      end
+
+      def self.start!(controller)
+        @@sql = []
+      end
+
+      def self.to_sym
+        :queries
+      end
+
+      def title
+        "Queries (#{@@sql.length})"
+      end
+
+      def stylesheet
+        %{
+          #queries_debug_info table td, #queries_debug_info table th{border:1px solid #A00; padding:0 3px; text-align:center;}
+          #queries_debug_info table thead, #queries_debug_info table tbody {color:#A00;}
+          #queries_debug_info p {background-color:#F3F3FF; border:1px solid #CCC; margin:12px; padding:4px 6px;}
+          #queries_debug_info a:hover {text-decoration:underline;}
+        }
+      end
+
+      def javascript
+        %{
+          function queries_toogle(type, id){
+            s = document.getElementById('q'+type+'_'+id).style
+            s.display = (s.display != 'block') ? 'block' : 'none'
+            location.href = '#qtitle_'+id
+          }
+        }
+      end
+
+      def content
+        html = ''
+
+        @@sql.each_with_index do |item, i|
+          sql_links = []
+          sql_links << "<a href=\"#\" style=\"color:#A00;\" onclick=\"queries_toogle('table',#{i});return false\">explain</a>" if item.explain
+          sql_links << "<a href=\"#\" style=\"color:#00A;\" onclick=\"queries_toogle('trace',#{i});return false\">trace</a>" if item.trace
+
+          html << %{
+            <b id="qtitle_#{i}">#{escape(item.type.to_s.upcase)}</b> (#{sql_links.join(' | ')})<br />
+              #{print_name_and_time(item.name, item.time)}<br />
+              #{print_query(item.query)}<br />
+              #{print_explain(i, item.explain) if item.explain}
+            <p id="qtrace_#{i}" style="display:none;">#{parse_trace(item.trace) if item.trace}</p><br />
+          }
+        end
+
+        # return html
+        
+        # TODO: remove this
+        return "NOT WORKING"
+        
+      end
+
+      protected
+        def parse_explain(results)
+          table = []
+          table << results.fetch_fields.map{|f| f.name}
+          results.each{|row| table << row}
+          table
+        end
+
+        def parse_trace(trace)
+          trace.map do |t|
+            s = t.split(':')
+            "<a href=\"#{escape("#{Merb::Plugins.config[:merb_footnotes][:prefix]}#{Merb.root}/#{s[0]}&line=#{s[1].to_i}")}\">#{escape(t)}</a><br />"
+          end.join
+        end
+
+        def print_name_and_time(name, time)
+          "#{escape(name || 'SQL')} (#{sprintf('%f', time)}s)"
+        end
+
+        def print_query(query)
+          escape(query.to_s.gsub(/(\s)+/, ' ').gsub('`', ''))
+        end
+
+        def print_explain(i, explain)
+          mount_table(parse_explain(explain), :id => "qtable_#{i}", :style => 'margin:10px;display:none;')
+        end
+    end
+  end
+
+  module Extensions
+    class Sql
+      attr_accessor :type, :name, :time, :query, :explain, :trace
+
+      def initialize(type, name, time, query, explain)
+        @type = type
+        @name = name
+        @time = time
+        @query = query
+        @explain = explain
+
+        # Strip, select those ones from app and reject first two, because they are from the plugin
+        @trace = Kernel.caller.collect{|c| c.strip}.select{|i| i.gsub!(/^#{Merb.root}\//im, '') }[2..-1]
+      end
+    end
+
+    module AbstractAdapter
+      def log_silence
+        result = nil
+        if @logger
+          @logger.silence do
+            result = yield
+          end        
+        else
+          result = yield
+        end
+        result
+      end
+    end
+  end
+end
+
+# NOT WORKING
+
+# if MerbFootnotes::Notes::QueriesNote.included?
+#   ActiveRecord::ConnectionAdapters::AbstractAdapter.__send__ :include, MerbFootnotes::Extensions::AbstractAdapter
+#   ActiveRecord::ConnectionAdapters.local_constants.each do |adapter|
+#     next unless adapter =~ /.*[^Abstract]Adapter$/
+#     next if adapter =~ /SQLite.Adapter$/
+#     eval("ActiveRecord::ConnectionAdapters::#{adapter}").__send__ :include, MerbFootnotes::Extensions::QueryAnalyzer
+#   end
+# end

data/lib/merb_footnotes/notes/routes_note.rb

@@ -0,0 +1,35 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class RoutesNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @parsed_routes = parse_routes || []
+      end
+
+      def legend
+        "Routes for #{@controller.class.to_s}"
+      end
+
+      def content
+        mount_table(@parsed_routes.to_a.unshift([:name, :path, :params]))
+      end
+
+      protected
+        def parse_routes
+          routes_with_name = Merb::Router.named_routes.to_a
+
+          return Merb::Router.routes.collect do |route|
+            if route.params[:controller].to_s.include?(@controller.class.to_s.downcase)            
+              [
+                escape(route.name.to_s), 
+                route.segments.to_a.join, 
+                route.params.reject{|key, value| key == :controller}.inspect.gsub('\"', '')
+              ]
+            end
+          end
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/session_note.rb

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class SessionNote < AbstractNote
+      def initialize(controller)
+        @session = controller.session
+      end
+      
+      def title
+        "Session (#{@session.size})"
+      end
+
+      def content
+        escape(@session.inspect)
+      end
+    end
+  end
+end

data/lib/merb_footnotes/notes/stylesheets_note.rb

@@ -0,0 +1,16 @@
+require "#{File.dirname(__FILE__)}/files_note"
+
+module MerbFootnotes
+  module Notes
+    class StylesheetsNote < FilesNote
+      def title
+        "Stylesheets (#{@files.length})"
+      end
+
+      protected
+        def scan_text(text)
+          text.scan(/<link[^>]+href\s*=\s*['"]([^>?'"]+\.css)/im).flatten
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/view_note.rb

@@ -0,0 +1,37 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+# View Note
+# this note should give you an easy linkback to the currently render view 
+# TODO: include all rendered partials by wrapping the partial call
+module MerbFootnotes
+  module Notes
+    class ViewNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @filename = get_filename
+      end
+
+      def row
+        :edit
+      end
+
+      def title
+        "View"
+      end
+
+      def link
+        escape(Merb::Plugins.config[:merb_footnotes][:prefix] + @filename)
+      end
+
+
+      def valid?
+        prefix?
+      end
+
+      protected        
+        def get_filename
+          "#{Merb.root}/app/views/#{@controller.controller_name}/#{@controller.params[:action]}.html.#{Merb.template_engine}"
+        end
+    end
+  end
+end

data/spec/merb_footnotes_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_footnotes" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: merb_footnotes
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: Provides an extensible footnotes debugging bar to Merb development mode
+email: merbjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/merb-plugins-footnotes.rb
+- lib/merb_footnotes
+- lib/merb_footnotes/filter.rb
+- lib/merb_footnotes/formatter.rb
+- lib/merb_footnotes/instrumentation.rb
+- lib/merb_footnotes/notes
+- lib/merb_footnotes/notes/abstract_note.rb
+- lib/merb_footnotes/notes/controller_note.rb
+- lib/merb_footnotes/notes/cookies_note.rb
+- lib/merb_footnotes/notes/env_note.rb
+- lib/merb_footnotes/notes/files_note.rb
+- lib/merb_footnotes/notes/filters_note.rb
+- lib/merb_footnotes/notes/javascripts_note.rb
+- lib/merb_footnotes/notes/layout_note.rb
+- lib/merb_footnotes/notes/log_note.rb
+- lib/merb_footnotes/notes/params_note.rb
+- lib/merb_footnotes/notes/partials_note.rb
+- lib/merb_footnotes/notes/queries_note.rb
+- lib/merb_footnotes/notes/routes_note.rb
+- lib/merb_footnotes/notes/session_note.rb
+- lib/merb_footnotes/notes/stylesheets_note.rb
+- lib/merb_footnotes/notes/view_note.rb
+- spec/merb_footnotes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://merbjedi.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Provides an extensible footnotes debugging bar to Merb development mode
+test_files: []
+