rails-footnotes 4.0.0 → 4.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cef699250d373d045cef743a70b3f49c46fc82c
+  data.tar.gz: e6143856c34a3ae3201a9f0e2ba503b8caecade8
+SHA512:
+  metadata.gz: afb6c7f76465de26af156ee3bce87b54942fd499b3c8c5615b9029406cc517e27385e428bda91784e75eac6fb35029fa4bd9ea3c3ad9be5d15252eda82df5249
+  data.tar.gz: ee1985e69b29e36833dce2dfa455334ff8a981ea9f171a54c2ff5f81de52a8f07616a9fa59c38919ba7e6d23b2a10129ce23c2bffa1cdb90668f3e4fdda3d79c

data/CHANGELOG

@@ -1,3 +1,8 @@
+== Footnotes v4.0.1
+  * Fix bad count for log note
+  * More robust initializer (thanks kayhide)
+  * Ability to lock the notes on the top right instead of the footer (thanks joshuapaling)
+  * More readable notes (thanks joshuapaling)
 == Footnotes v4.0.0
   * Drop support for ruby 1.8
   * Drop support for rails < 3.2

data/README.rdoc

@@ -10,7 +10,7 @@ your backtrace lines.
 
 == Installation
 
-NOTE: Since this branch aims Rails 3.2+ support, if you want to use footnotes with Rails 2.3 you should use this branch:
+NOTE: Since this branch aims for Rails 3.2+ support, if you want to use footnotes with Rails 2.3 you should use this branch:
 
 https://github.com/josevalim/rails-footnotes/tree/rails2
 
@@ -36,9 +36,9 @@ This will create an initializer with default config and some examples.
         controller.action_name == 'edit' }
     end
 
-=== Editors links
+=== Editor links
 
-If you are not using Textmate as text editor, MacVim and Sublime Text 2 are also compatible.
+Textmate, MacVim and Sublime Text 2 are compatible.
 
 *MacVim*
 
@@ -46,9 +46,9 @@ In the rails-footnotes initializer do :
 
     f.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
 
-Where you are going to choose a prefix compatible with your text editor. The %s is
+Here you need to choose a prefix compatible with your text editor. The %s is
 replaced by the name of the file, the first %d is replaced by the line number and
-the second %d is replaced by the column.
+the second %d is replaced by the column number.
 
 Take note that the order in which the file name (%s), line number (%d) and column number (%d) appears is important.
 We assume that they appear in that order. "foo://line=%d&file=%s" (%d precedes %s) would throw out an error.
@@ -74,6 +74,15 @@ by turning footnotes stylesheet off:
 
     f.no_style = true
 
+You can also lock the footnotes to the top of the window, hidden by default, and accessible
+via a small button fixed to the top-right of your browser:
+
+    f.lock_top_right = true
+
+To set the font-size for the footnotes:
+
+    f.font_size = '13px'
+
 Another option is to allow multiple notes to be opened at the same time:
 
     f.multiple_notes = true
@@ -87,7 +96,7 @@ Finally, you can control which notes you want to show. The default are:
 Creating your notes to integrate with Footnotes is easy.
 
 1. Create a Footnotes::Notes::YourExampleNote class
-2. Implement the necessary methods (check abstract_note.rb file in lib/notes)
+2. Implement the necessary methods (check abstract_note.rb[link:lib/rails-footnotes/abstract_note.rb] file in lib/rails-footnotes)
 3. Append your example note in Footnotes::Filter.notes array (usually at the end of your environment file or in the initializer):
 
 For example, to create a note that shows info about the user logged in your application you just have to do:
@@ -127,10 +136,10 @@ Then put in your environment, add in your initializer:
 
   f.notes += [:current_user]
 
-== Display of the notes
+== Footnote position
 
 By default the notes will be showed at the bottom of your page (appended just before </body>).
-If you'd like these notes on a different place (perhaps for aesthetical reasons) you can edit one of your views and add:
+If you'd like the footnote, to be at a different place (perhaps for aesthetical reasons) you can edit one of your views and add:
   <div id="footnotes_holder"></div>
 at an appropriate place, your notes will now appear inside div#footnotes_holder
 

data/lib/generators/templates/rails_footnotes.rb

@@ -1,4 +1,4 @@
-Footnotes.setup do |f|
+defined?(Footnotes) && Footnotes.setup do |f|
   # Wether or not to enable footnotes
   f.enabled = Rails.env.development?
   # You can also use a lambda / proc to conditionally toggle footnotes
@@ -16,6 +16,12 @@ Footnotes.setup do |f|
   # Disable style :
   # f.no_style = true
 
+  # Lock notes to top right :
+  # f.lock_top_right = true
+
+  # Change font size :
+  # f.font_size = '11px'
+
   # Allow to open multiple notes :
   # f.multiple_notes = true
 end

data/lib/rails-footnotes.rb

@@ -29,6 +29,12 @@ module Footnotes
 
     delegate :multiple_notes, :to => Filter
     delegate :multiple_notes=, :to => Filter
+
+    delegate :lock_top_right, :to => Filter
+    delegate :lock_top_right=, :to => Filter
+
+    delegate :font_size, :to => Filter
+    delegate :font_size=, :to => Filter
   end
 
   def self.run!

data/lib/rails-footnotes/filter.rb

@@ -3,6 +3,8 @@ module Footnotes
     @@no_style = false
     @@multiple_notes = false
     @@klasses = []
+    @@lock_top_right = false
+    @@font_size = '11px'
 
     # Default link prefix is textmate
     @@prefix = 'txmt://open?url=file://%s&line=%d&column=%d'
@@ -16,7 +18,9 @@ module Footnotes
     # :notes          => Class variable that holds the notes to be processed
     # :prefix         => Prefix appended to FootnotesLinks
     # :multiple_notes => Set to true if you want to open several notes at the same time
-    cattr_accessor :no_style, :notes, :prefix, :multiple_notes
+    # :lock_top_right => Lock a btn to toggle notes to the top right of the browser
+    # :font_size      => CSS font-size property
+    cattr_accessor :no_style, :notes, :prefix, :multiple_notes, :lock_top_right, :font_size
 
     class << self
       include Footnotes::EachWithRescue
@@ -136,18 +140,34 @@ module Footnotes
 
       def insert_styles
         #TODO More customizable(reset.css, from file etc.)
+        if @@lock_top_right
+          extra_styles = <<-STYLES
+            #footnotes_debug {position: fixed; top: 0px; right: 0px; width: 100%; z-index: 10000; margin-top: 0;}
+            #footnotes_debug #toggle_footnotes {position: absolute; right: 0; top: 0; background: #fff; border: 1px solid #ccc; color: #9b1b1b; font-size: 20px; text-align: center; padding: 8px; opacity: 0.9;}
+            #footnotes_debug #toggle_footnotes:hover {opacity: 1;}
+            #footnotes_debug #all_footnotes {display: none; padding: 15px; background: #fff; box-shadow: 0 0 5px rgba(0,0,0,0.4);}
+            #footnotes_debug fieldset > div {max-height: 500px; overflow: scroll;}
+          STYLES
+        else
+          extra_styles = <<-STYLES
+            #footnotes_debug #toggle_footnotes {display: none;}
+          STYLES
+        end
         insert_text :before, /<\/head>/i, <<-HTML
         <!-- Footnotes Style -->
         <style type="text/css">
-          #footnotes_debug {font-size: 11px; font-weight: normal; margin: 2em 0 1em 0; text-align: center; color: #444; line-height: 16px;}
+          #footnotes_debug {font-size: #{@@font_size}; font-family: Consolas, monaco, monospace; font-weight: normal; margin: 2em 0 1em 0; text-align: center; color: #444; line-height: 16px; background: #fff;}
           #footnotes_debug th, #footnotes_debug td {color: #444; line-height: 18px;}
           #footnotes_debug a {color: #9b1b1b; font-weight: inherit; text-decoration: none; line-height: 18px;}
-          #footnotes_debug table {text-align: center;}
-          #footnotes_debug table td {padding: 0 5px;}
+          #footnotes_debug table {text-align: left; width: 100%;table-layout: fixed;}
+          #footnotes_debug table td {padding: 5px; border-bottom: 1px solid #ccc;}
+          #footnotes_debug table th {padding: 5px; border-bottom: 1px solid #ccc;}
+          #footnotes_debug table tr:nth-child(2n) td {background: #eee;}
           #footnotes_debug tbody {text-align: left;}
           #footnotes_debug .name_values td {vertical-align: top;}
           #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;}
+          #{extra_styles}
           /* Aditional Stylesheets */
           #{@notes.map(&:stylesheet).compact.join("\n")}
         </style>
@@ -158,13 +178,19 @@ module Footnotes
       def insert_footnotes
         # Fieldsets method should be called first
         content = fieldsets
-
+        element_style = ''
+        if @@lock_top_right
+          element_style = 'style="display: none;"'
+        end
         footnotes_html = <<-HTML
         <!-- Footnotes -->
         <div style="clear:both"></div>
         <div id="footnotes_debug">
-          #{links}
-          #{content}
+          <a id="toggle_footnotes" href="#" onclick="Footnotes.toggle('all_footnotes'); return false;">fn</a>
+          <div id="all_footnotes" #{element_style}>
+            #{links}
+            #{content}
+          </div>
           <script type="text/javascript">
             var Footnotes = function() {
 

data/lib/rails-footnotes/notes/log_note.rb

@@ -19,18 +19,22 @@ module Footnotes
       end
 
       def title
-        "Log (#{log.count("\n")})"
+        "Log (#{log.count})"
       end
 
       def content
-        result = escape(log.gsub(/\e\[.+?m/, '')).gsub("\n", '<br />')
+        result = '<table>'
+          log.each do |l|
+            result << "<tr><td>#{l.gsub(/\e\[.+?m/, '')}</td></tr>"
+          end
+        result << '</table>'
         # Restore formatter
         Rails.logger = self.class.original_logger
         result
       end
 
       def log
-        self.class.logs.join("\n")
+        self.class.logs
       end
 
     end

data/lib/rails-footnotes/notes/queries_note.rb

@@ -33,18 +33,25 @@ module Footnotes
       end
 
       def content
-        html = ''
+        html = '<table>'
         self.events.each_with_index do |event, index|
           sql_links = []
           sql_links << "<a href=\"javascript:Footnotes.toggle('qtrace_#{index}')\" style=\"color:#00A;\">trace</a>"
 
           html << <<-HTML
-            <b id="qtitle_#{index}">#{escape(event.type.to_s.upcase)}</b> (#{sql_links.join(' | ')})<br />
-            <span id="sql_#{index}">#{print_query(event.payload[:sql])}</span><br />
-            #{print_name_and_time(event.payload[:name], event.duration / 1000.0)}&nbsp;
-            <p id="qtrace_#{index}" style="display:none;">#{parse_trace(event.trace)}</p><br />
+          <tr>
+            <td>
+              <b id="qtitle_#{index}">#{escape(event.type.to_s.upcase)}</b> (#{sql_links.join(' | ')})
+              <p id="qtrace_#{index}" style="display:none;">#{parse_trace(event.trace)}</p><br />
+            </td>
+            <td>
+              <span id="sql_#{index}">#{print_query(event.payload[:sql])}</span>
+            </td>
+            <td>#{print_name_and_time(event.payload[:name], event.duration / 1000.0)}</td>
+          </tr>
           HTML
         end
+        html << '</table>'
         return html
       end
 

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-footnotes
 version: !ruby/object:Gem::Version
-  version: 4.0.0
-  prerelease: 
+  version: 4.0.1
 platform: ruby
 authors:
 - Roman V. Babenko
@@ -13,54 +12,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Every Rails page has footnotes that gives information about your application
@@ -127,27 +120,26 @@ files:
 - spec/views/partials/index.html.erb
 homepage: http://github.com/josevalim/rails-footnotes
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rails-footnotes
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Every Rails page has footnotes that gives information about your application
   and links back to your editor.
 test_files:
@@ -165,3 +157,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/views/partials/_foo.html.erb
 - spec/views/partials/index.html.erb
+has_rdoc: