merb_footnotes 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jacques Crocker
+
+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.

data/README

@@ -0,0 +1,14 @@
+merb_footnotes
+==============
+
+
+
+
+
+Problems:
+--------
+- Filters
+- Components
+- Controller
+- Queries
+- Layout

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_footnotes"
+GEM_VERSION = "0.1"
+AUTHOR = "Jacques Crocker"
+EMAIL = "merbjedi@gmail.com"
+HOMEPAGE = "http://merbjedi.com/"
+SUMMARY = "Provides an extensible footnotes debugging bar to Merb development mode"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/merb-plugins-footnotes.rb

@@ -0,0 +1,79 @@
+# 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.
+
+if defined?(Merb::Plugins)
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_footnotes] = {
+    :prefix => RUBY_PLATFORM.include?('darwin') ? 'txmt://open?url=file://' : "file://",
+    :multiple_notes => false, 
+    :no_style => false,
+    :notes => [
+      # :components, 
+      :controller, 
+      :view, 
+      :layout, 
+      :partials, 
+      :stylesheets, 
+      :javascripts, 
+      :session, 
+      :cookies, 
+      :params, 
+      :filters, 
+      :routes, 
+      :env, 
+      :queries, 
+      :log
+    ]
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    if Merb.env?(:development) || Merb::Plugins.config[:merb_footnotes][:force]
+      Dir[File.join(File.dirname(__FILE__), 'merb_footnotes', 'notes','*.rb')].each do |note|
+        require note
+      end
+      require 'merb_footnotes/filter'
+      require 'merb_footnotes/formatter'
+      require 'merb_footnotes/instrumentation'
+      
+      if Merb::Config[:adapter] != 'irb'
+        Merb.logger.info "Instrumenting with Merb Internals with Merb Footnotes"
+        ::Merb::Controller.extend(MerbFootnotes::Instrumentation::Merb::Controller)
+        if defined?(::DataMapper)
+          ::DataMapper::Repository.extend(MerbFootnotes::Instrumentation::DataMapper::Repository)
+        end
+      else
+        Merb.logger.info "Not instrumenting with Merb Footnotes (adapter is '#{Merb::Config[:adapter]}')"
+      end
+      
+      Merb::Controller.before do
+        MerbFootnotes::Filter.start!(self) # self is the currently executing controller
+      end
+      Merb::Controller.after do 
+        filter = MerbFootnotes::Filter.new(self) # self is the currently executing controller
+        filter.add_footnotes!
+        filter.close!(self)
+      end
+    end
+  end
+  
+  Merb::BootLoader.after_app_loads do
+  end  
+end

data/lib/merb_footnotes/filter.rb

@@ -0,0 +1,258 @@
+module MerbFootnotes
+  class Filter
+
+    def self.notes
+      @@notes ||= begin
+        note_list = Merb::Plugins.config[:merb_footnotes][:notes].to_a
+        if Merb::Plugins.config[:merb_footnotes][:append_notes].is_a? Array
+          # Use custom list if set
+          note_list += Merb::Plugins.config[:merb_footnotes][:append_notes]
+        end
+        note_list.flatten.compact
+      end
+    end
+
+    # Calls the class method start! in each note
+    # Sometimes notes need to set variables or clean the environment to work properly
+    # This method allows this kind of setup
+    #
+    def self.start!(controller)
+      each_with_rescue(self.notes) do |note|
+        klass = eval("MerbFootnotes::Notes::#{note.to_s.camel_case}Note") if note.is_a?(Symbol) || note.is_a?(String)
+        if klass.respond_to?(:start!)
+          klass.start!(controller) 
+        end
+      end
+    end
+
+    # Process notes, discarding only the note if any problem occurs
+    #
+    def self.each_with_rescue(notes)
+      delete_me = []
+
+      notes.each do |note|
+        begin
+          yield note
+        rescue Exception => e
+          # Discard note if it has a problem
+          log_error("Footnotes #{note.to_s.camel_case}Note Exception", e)
+          delete_me << note
+          next
+        end
+      end
+
+      delete_me.each{ |note| notes.delete(note) }
+    end
+
+    # Logs the error using specified title and format
+    #
+    def self.log_error(title, exception)
+      Merb.logger.error "#{title}: #{exception}\n#{exception.backtrace.join("\n")}"
+    end
+
+    def initialize(controller)
+      @controller = controller
+      @body = controller.body
+      @notes = []
+    end
+
+    def add_footnotes!
+      add_footnotes_without_validation! if valid?
+    rescue Exception => e
+      # Discard footnotes if there are any problems
+      self.class.log_error("Footnotes Exception", e)
+    end
+
+    # Calls the class method close! in each note
+    # Sometimes notes need to finish their work even after being read
+    # This method allows this kind of work
+    #
+    def close!(controller)
+      each_with_rescue(@notes) do |note|
+        note.class.close!(controller)
+      end
+    end
+
+    protected
+      def valid?
+        unless @footnotes_rendered
+          valid_content_type? && @body.is_a?(String) && !xhr?
+          @footnotes_rendered = true
+        end
+      end
+
+      def add_footnotes_without_validation!
+        initialize_notes!
+        insert_styles unless Merb::Plugins.config[:merb_footnotes][:no_style]
+        insert_footnotes
+      end
+
+      def initialize_notes!
+        each_with_rescue(self.class.notes) do |note|
+          note = eval("MerbFootnotes::Notes::#{note.to_s.camel_case}Note").new(@controller) if note.is_a?(Symbol) || note.is_a?(String)
+          @notes << note if note.respond_to?(:valid?) && note.valid?
+        end
+      end
+
+      def valid_content_type?
+        c = @controller.content_type.to_s
+        (c.nil? || c =~ /html/)
+      end
+
+      def xhr?
+        @controller.request.xhr?
+      end
+
+      #
+      # Insertion methods
+      #
+
+      def insert_styles
+        insert_text :before, /<\/head>/i, <<-HTML
+        <!-- Footnotes Style -->
+        <style type="text/css">
+          #footnotes_debug {margin: 2em 0 1em 0; text-align: center; color: #444; line-height: 16px;}
+          #footnotes_debug a {text-decoration: none; color: #444; line-height: 18px;}
+          #footnotes_debug table {text-align: center;}
+          #footnotes_debug table td {padding: 0 5px;}
+          #footnotes_debug tbody {text-align: left;}
+          #footnotes_debug legend {background-color: #FFF;}
+          #footnotes_debug fieldset {text-align: left; border: 1px dashed #aaa; padding: 0.5em 1em 1em 1em; margin: 1em 2em; color: #444; background-color: #FFF;}
+          /* Aditional Stylesheets */
+          #{@notes.map{|s| s.stylesheet}.compact.join("\n")}
+        </style>
+        <!-- End Footnotes Style -->
+        HTML
+      end
+
+      def insert_footnotes
+        # Fieldsets method should be called first
+        content = fieldsets
+
+        footnotes_html = <<-HTML
+        <!-- Footnotes -->
+        <div style="clear:both"></div>
+        <div id="footnotes_debug">
+          #{links}
+          #{content}
+          <script type="text/javascript">
+            function footnotes_close(){
+              #{close unless Merb::Plugins.config[:merb_footnotes][:multiple_notes]}
+            }
+            function footnotes_toogle(id){
+              s = document.getElementById(id).style;
+              before = s.display;
+              footnotes_close();
+              s.display = (before != 'block') ? 'block' : 'none'
+              location.href = '#footnotes_debug';
+            }
+            /* Additional Javascript */
+            #{@notes.map{|n| n.javascript}.compact.join("\n")}
+          </script>
+        </div>
+        <!-- End Footnotes -->
+        HTML
+        if @body =~ %r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}
+          # Insert inside the "footnotes_holder" div if it exists
+          insert_text :after, %r{<div[^>]+id=['"]footnotes_holder['"][^>]*>}, footnotes_html
+        else
+          # Otherwise, try to insert as the last part of the html body
+          insert_text :before, /<\/body>/i, footnotes_html
+        end
+      end
+
+      # Process notes to gets their links
+      #
+      def links
+        links = Hash.new([])
+        order = []
+        each_with_rescue(@notes) do |note|
+          order << note.row
+          links[note.row] += [link_helper(note)]
+        end
+
+        html = ''
+        order.uniq!
+        order.each do |row|
+          html << "#{row.is_a?(String) ? row : row.to_s.camel_case}: #{links[row].join(" | \n")}<br />"
+        end
+        html
+      end
+
+      # Process notes to get their content
+      #
+      def fieldsets
+        content = ''
+        each_with_rescue(@notes) do |note|
+          next unless note.fieldset?
+          content << <<-HTML
+            <fieldset id="#{note.to_sym}_debug_info" style="display: none">
+              <legend>#{note.legend}</legend>
+              <div>#{note.content}</div>
+            </fieldset>
+          HTML
+        end
+        content
+      end
+
+      # Process notes to get javascript code to close them all
+      # This method is used with multiple_notes is false
+      #
+      def close
+        javascript = ''
+        each_with_rescue(@notes) do |note|
+          next unless note.fieldset?
+          javascript << close_helper(note)
+        end
+        javascript
+      end
+
+      #
+      # Helpers
+      #
+
+      # Helper that creates the javascript code to close the note
+      #
+      def close_helper(note)
+        "document.getElementById('#{note.to_sym}_debug_info').style.display = 'none'\n"
+      end
+
+      # Helper that creates the link and javascript code when note is clicked
+      #
+      def link_helper(note)
+        onclick = note.onclick
+        unless href = note.link
+          href = '#'
+          onclick ||= "footnotes_toogle('#{note.to_sym}_debug_info');return false;" if note.fieldset?
+        end
+
+        "<a href=\"#{href}\" onclick=\"#{onclick}\">#{note.title}</a>"
+      end
+
+      # Inserts text in to the body of the document
+      # +pattern+ is a Regular expression which, when matched, will cause +new_text+
+      # to be inserted before or after the match.  If no match is found, +new_text+ is appended
+      # to the body instead. +position+ may be either :before or :after
+      #
+      def insert_text(position, pattern, new_text)
+        index = case pattern
+          when Regexp
+            if match = @body.match(pattern)
+              match.offset(0)[position == :before ? 0 : 1]
+            else
+              @body.size
+            end
+          else
+            pattern
+          end
+        @body.insert index, new_text
+      end
+
+      # Instance each_with_rescue method
+      # 
+      def each_with_rescue(*args, &block)
+        self.class.each_with_rescue(*args, &block)
+      end
+
+  end
+end

data/lib/merb_footnotes/formatter.rb

@@ -0,0 +1,63 @@
+# 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.
+
+module MerbFootnotes::Formatter
+  # def self.pretty(value)
+  #   CGI.escapeHTML(PP.pp(value, ''))
+  # end
+  
+  def self.strip_root(text)
+    pattern = /^#{Regexp.quote Merb.root}\/?/o
+    if text =~ pattern
+      result = text.sub(pattern, '')
+      in_app = result !~ /^gems\//
+      return [in_app, result]
+    end
+    
+    [false, text]
+  end
+  
+  # TODO: Refactor
+  def self.editor_link_line(line, show_filename_only = false)
+    filename, number, extra = line.match(/^(.+?):(\d+)(?::in\b(.*?))?/)[1, 2]
+    in_app, line = strip_root(line)
+    name = if line.size > 87
+      "…#{CGI.escapeHTML line.sub(/^.*?(.{84})$/, '\1')}"
+    else 
+      line
+    end
+    name = if in_app
+      if name =~ /`/
+        name.sub(/^(.*?)\s+`(.*?)'$/, %q(<span class='tuneup-app-line'>\1</span> `<b class='tuneup-app-line'>\2</b>'))
+      else
+        %(<span class='tuneup-app-line'>#{name}</span>)
+      end
+    else
+      name.sub(/([^\/\\]+\.\S+:\d+:in)\s+`(.*?)'$/, %q(\1 `<b>\2</b>'))
+    end
+    
+    if show_filename_only
+      name = name.to_s.split("/").last
+    end
+    
+    %(<a title='%s' href='txmt://open/?url=file://%s&line=%d'>%s</a>%s) % [CGI.escapeHTML(line), filename, number, name, extra]
+  end
+end