merb_footnotes 0.1

data/lib/merb_footnotes/instrumentation.rb

@@ -0,0 +1,134 @@
+# Copyright (c) 2008 FiveRuns Corporation
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+require 'pp'
+module MerbFootnotes
+  module Instrumentation
+    
+     def self.pretty(value)
+       CGI.escapeHTML(PP.pp(value, ''))
+     end
+          
+     def self.format_sql(query, statement, attributes = nil)
+       values = query.bind_values + (attributes ? attributes.values : [])
+       [statement, "<b>Values:</b> " + CGI.escapeHTML(values.inspect)].join("<br/>")
+     end
+     
+     def self.attrs_for(query)
+       [
+         [ :repository, query.repository.name ],
+         [ :model,      query.model           ],
+         [ :fields,     query.fields          ],
+         [ :links,      query.links           ],
+         [ :conditions, query.conditions      ],
+         [ :order,      query.order           ],
+         [ :limit,      query.limit           ],
+         [ :offset,     query.offset          ],
+         [ :reload,     query.reload?         ],
+         [ :unique,     query.unique?         ]
+       ]
+     end
+     
+     def self.format_query(query)
+       rows = attrs_for(query).map do |set|
+         %(<tr><th>%s</th><td><pre>%s</pre></td></tr>) % set.map { |item|
+           pretty item
+         }
+       end
+       "<table>%s</table>" % rows.join
+     end
+
+     module Merb
+       module Controller
+         def new(*args, &block)
+           super.extend(Ext)
+         end
+
+         module Ext
+           
+           def footnotes
+             @_footnotes || {}
+           end
+
+           def add_footnote(bucket, content)
+             @_footnotes ||= {}
+             @_footnotes[bucket.to_sym] ||= []
+             @_footnotes[bucket.to_sym] << content
+             return @footnotes
+           end
+           
+           def render(thing = nil, *args)
+             self.add_footnote("renders", [thing, args])
+             super
+           end
+
+           def partial(template, *args)
+             self.add_footnote("partials", [template, args])
+             return super
+           end
+           
+           # PRIVATE API CALL. BAD BAD. MUST FIX
+           def _call_filters(filters)
+             if filters.empty?
+               super
+             else
+               filters.each do |filter|
+                 self.add_footnote("filters", filter)
+                end
+               super
+             end
+           end
+         end
+       end
+     end
+
+     module DataMapper
+
+       module Repository
+
+         def new(*args, &block)
+           super.extend(Ext)
+         end
+
+         module Ext
+           def read_many(query)
+             ::Merb.logger.info("LOGGING READ MANY QUERY")
+             super
+           end
+
+           def read_one(query)
+             ::Merb.logger.info("LOGGING READ ONE QUERY")
+             super
+           end
+
+           def update(attributes, query)
+             ::Merb.logger.info("LOGGING UPDATE QUERY")
+             super
+           end
+
+           def delete(query)
+             ::Merb.logger.info("LOGGING DELETE QUERY")
+             super
+           end
+         end
+       end
+     end
+   end
+end

data/lib/merb_footnotes/notes/abstract_note.rb

@@ -0,0 +1,166 @@
+module MerbFootnotes
+  module Notes
+    # This is the abstrac class for notes.
+    #
+    class AbstractNote
+
+      class << self
+        # Returns the symbol that represents this note.
+        # It's the name of the class, underscored and without _note.
+        #
+        # For example, for ControllerNote it will return :controller.
+        #
+        def to_sym
+          @note_sym ||= self.title.to_const_path.to_sym
+        end
+
+        # Returns the title that represents this note.
+        # It's the name of the class without Note.
+        #
+        # For example, for ControllerNote it will return Controller.
+        #
+        def title
+          @note_title ||= self.name.match(/^MerbFootnotes::Notes::(\w+)Note$/)[1]
+        end
+
+        # Return true if Note is included in notes array.
+        #
+        def included?
+          MerbFootnotes::Filter.notes.include?(self.to_sym)
+        end
+
+        # Action to be called to start the Note.
+        # This is applied as a before_filter.
+        #
+        def start!(controller = nil)
+        end
+
+        # Action to be called after the Note was used.
+        # This is applied as an after_filter.
+        #
+        def close!(controller = nil)
+        end
+      end
+
+      # Initialize notes.
+      # Always receives a controller.
+      #
+      def initialize(controller = nil)
+      end
+
+      # Returns the symbol that represents this note.
+      #
+      def to_sym
+        self.class.to_sym
+      end
+
+      # Specifies in which row should appear the title.
+      # The default is :show.
+      #
+      def row
+        :show
+      end
+
+      # If valid?, create a tab on Footnotes Footer with the title returned.
+      # By default, returns the title of the class (defined above).
+      #
+      def title
+        self.class.title
+      end
+
+      # If fieldset?, create a fieldset with the value returned as legend.
+      # By default, returns the title of the class (defined above).
+      #
+      def legend
+        self.class.title
+      end
+
+      # If content is defined, fieldset? returns true and the value of content
+      # is displayed when the Note is clicked. See fieldset? below for more info.
+      #
+      # def content
+      # end
+
+      # Set href field for Footnotes links.
+      # If it's nil, Footnotes will use '#'.
+      # 
+      def link
+      end
+
+      # Set onclick field for Footnotes links.
+      # If it's nil, Footnotes will make it open the fieldset.
+      # 
+      def onclick
+      end
+
+      # Insert here any additional stylesheet.
+      # This is directly inserted into a <style> tag.
+      #
+      def stylesheet
+      end
+
+      # Insert here any additional javascript.
+      # This is directly inserted into a <script> tag.
+      #
+      def javascript
+      end
+
+      # Specifies when should create a note for it.
+      # By default, it's valid.
+      #
+      def valid?
+        true
+      end
+
+      # Specifies when should create a fieldset for it, considering it's valid.
+      #
+      def fieldset?
+        self.respond_to?(:content)
+      end
+
+      # Return if this note is incuded in MerbFootnotes::Filter.notes.
+      #
+      def included?
+        self.class.included?
+      end
+
+      # Some helpers to generate notes.
+      #
+      protected
+        # Return if MerbFootnotes::Filter.prefix exists or not.
+        # Some notes only work with prefix set.
+        #
+        def prefix?
+          Merb::Plugins.config[:merb_footnotes][:prefix]
+        end
+
+        # Escape HTML special characters.
+        #
+        def escape(text)
+          text.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+        end
+
+        # Gets a bidimensional array and create a table.
+        # The first array is used as label.
+        #
+        def mount_table(array, options = {})
+          header = array.shift
+          return '' if array.empty?
+
+          header = header.collect{|i| escape(Extlib::Inflection.humanize(i.to_s)) }
+          rows = array.compact.collect{|i| "<tr><td>#{i.join('</td><td>')}</td></tr>" }
+
+          <<-TABLE
+          <table #{hash_to_xml_attributes(options)}>
+            <thead><tr><th>#{header.join('</th><th>')}</th></tr></thead>
+            <tbody>#{rows.join}</tbody>
+          </table>
+          TABLE
+        end
+
+        def hash_to_xml_attributes(hash)
+          return hash.collect{ |key, value| "#{key.to_s}=\"#{value.gsub('"','\"')}\"" }.join(' ')
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/controller_note.rb

@@ -0,0 +1,57 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class ControllerNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def row
+        :edit
+      end
+
+      def link
+        escape(
+          Merb::Plugins.config[:merb_footnotes][:prefix] +
+          controller_filename +
+          (index_of_method ? "&line=#{controller_line_number + 1}&column=3" : '')
+        )
+      end
+
+      def valid?
+        prefix?
+      end
+
+      protected
+        # Some controller classes come with the Controller:: module and some don't
+        # (anyone know why? -- Duane)
+        def controller_filename
+          File.join(File.expand_path(Merb.root), 'app', 'controllers', "#{@controller.controller_name}.rb")
+        end
+
+        def controller_text
+          @controller_text ||= IO.read(controller_filename)
+        end
+
+        def index_of_method
+          (controller_text =~ /def\s+#{@controller.action_name}[\s\(]/)
+        end
+
+        def controller_line_number
+          lines_from_index(controller_text, index_of_method)
+        end
+
+        def lines_from_index(string, index)
+          lines = string.to_a
+          running_length = 0
+          lines.each_with_index do |line, i|
+            running_length += line.length
+            if running_length > index
+              return i
+            end
+          end
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/cookies_note.rb

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

data/lib/merb_footnotes/notes/env_note.rb

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class EnvNote < AbstractNote
+      def initialize(controller)
+        @env = controller.request.env.dup
+      end
+
+      def content
+        # Replace HTTP_COOKIE for a link
+        @env['HTTP_COOKIE'] = '<a href="#" style="color:#009" onclick="footnotes_toogle(\'cookies_debug_info\');return false;" />See cookies on its tab</a>'
+
+        # Create the env table
+        mount_table(@env.to_a.sort.unshift([:key, :value]))
+      end
+    end
+  end
+end

data/lib/merb_footnotes/notes/files_note.rb

@@ -0,0 +1,40 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class FilesNote < AbstractNote
+      def initialize(controller)
+        @files = scan_text(controller.body)
+        parse_files!
+      end
+
+      def row
+        :edit
+      end
+
+      def content
+        @files.empty? ? "" : "<ul><li>#{@files.join("</li><li>")}</li></ul>"
+      end
+
+      def valid?
+        prefix?
+      end
+
+      protected
+        def scan_text(text)
+          []
+        end
+
+        def parse_files!
+          @files.collect! do |filename|
+            if filename =~ %r{^/}
+              full_filename = File.join(File.expand_path(Merb.root), 'public', filename)
+              %{<a href="#{Merb::Plugins.config[:merb_footnotes][:prefix]}#{full_filename}">#{filename}</a>}
+            else
+              %{<a href="#{filename}">#{filename}</a>}
+            end
+          end
+        end
+    end
+  end
+end

data/lib/merb_footnotes/notes/filters_note.rb

@@ -0,0 +1,46 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module MerbFootnotes
+  module Notes
+    class FiltersNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @filters = parse_filters.compact
+      end
+
+      def legend
+        "Filter chain for #{@controller.class.to_s}"
+      end
+      
+      def title
+        "Filters (#{@filters.size})"
+      end
+
+      def content
+        mount_table(@filters.unshift([:filter, :arguments]))
+      end
+      
+      protected
+      def parse_filters
+        filters = @controller.footnotes[:filters] || []
+        sets = filters.map do |filter|
+          filter_action = filter.first
+          filter_args = filter.last
+          
+          filter_display = if filter_action.is_a?(Proc)
+            where = filter_action.inspect[/@(.+)>$/, 1]
+            "Block in "+MerbFootnotes::Formatter.editor_link_line(where, true).to_s
+          elsif filter_action.is_a? Symbol
+            # TODO: somehow figure out how to display the line #
+            # @controller.method(filter.first).inspect[/@(.+)>$/, 1].to_s rescue "Unknown"
+            "#{@controller.class.to_s}::#{filter_action.to_s}"
+          end
+          
+          unless filter_display.to_s.include? "merb-plugins-footnotes.rb"
+            [filter_display, (filter.last||{}).inspect]
+          end
+        end
+      end
+    end
+  end
+end