rails-footnotes 3.7.2 → 3.7.3

data/.gitignore

@@ -1,9 +1,11 @@
 .*
 !.gitignore
 !.gitmodules
+!*.example
 *.gem
 .bundle
 Gemfile.lock
 pkg/*
+coverage
 tags
 doc

data/.rspec.example

@@ -0,0 +1 @@
+--color

data/.watchr.example

@@ -0,0 +1,13 @@
+ROOT_PATH = File.dirname(__FILE__)
+
+def run_spec(file)
+  system "rspec #{file}" if File.exist?(File.join(ROOT_PATH, file))
+end
+
+watch('spec/.*_spec\.rb') {|m| run_spec m[0] }
+watch('spec/notes/.*_spec\.rb') {|m| run_spec m[0] }
+
+watch('lib/rails-footnotes/(.*)\.rb') {|m| run_spec("spec/#{m[1]}_spec.rb") }
+watch('lib/rails-footnotes/notes/.*_note\.rb') {|m| run_spec("spec/notes/#{m[1]}") }
+
+watch('Gemfile') {|m| run_spec("spec") }

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 #
 if RUBY_PLATFORM =~ /darwin/
   group :test do
-    gem "autotest-growl"
+    gem 'simplecov', '>= 0.4.0', :require => false
   end
 end

data/README.rdoc

@@ -38,6 +38,14 @@ add something like this to config/initializers/footnotes.rb:
     # ... other init code
   end
 
+=== Post initialization
+
+If you want to add alternate logic to config footnotes without commit it to SCM, add your code to .footnotes:
+
+    Footnotes::Filter.notes = []
+
+this code temporarily disables notes for all controllers
+
 === Hooks
 
     Footnotes.setup do |config|
@@ -50,7 +58,7 @@ add something like this to config/initializers/footnotes.rb:
 If you are not using Textmate as text editor, in your environment.rb or
 in an initializer do:
 
-    Footnotes::Filter.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+    Footnotes::Filter.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
 
 for MacVim
 
@@ -68,11 +76,6 @@ Another option is to allow multiple notes to be opened at the same time:
 
     Footnotes::Filter.multiple_notes = true
 
-If you have New Relic RPM installed, you may want to turn off query explains
-(explains can slows things down)
-
-    Footnotes::Notes::QueriesNote.sql_explain = false
-
 Finally, you can control which notes you want to show. The default are:
 
     Footnotes::Filter.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]

data/Rakefile

@@ -1,16 +1,15 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
-require 'rake/testtask'
+require "rspec/core/rake_task"
 require 'rake/rdoctask'
 
 desc 'Default: run tests'
-task :default => :test
+task :default => :spec
 
 desc 'Run tests for Footnotes.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rcov = false
 end
 
 desc 'Generate documentation for Footnotes.'

data/lib/rails-footnotes.rb

@@ -26,11 +26,12 @@ module Footnotes
 
   def self.run!
     require 'rails-footnotes/footnotes'
-    require 'rails-footnotes/backtracer'
-
-    Dir[File.join(File.dirname(__FILE__), 'rails-footnotes', 'notes', '*.rb')].each { |note| require note }
+    require 'rails-footnotes/abstract_note'
+    require 'rails-footnotes/notes/all'
 
     ActionController::Base.send(:include, RailsFootnotesExtension)
+
+    load Rails.root.join('.footnotes') if Rails.root.join('.footnotes').exist?
   end
 
   def self.setup

data/lib/rails-footnotes/{notes/abstract_note.rb → abstract_note.rb}

@@ -86,13 +86,13 @@ module Footnotes
 
       # 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
 
@@ -123,7 +123,7 @@ module Footnotes
 
       # Some helpers to generate notes.
       #
-      protected
+      public
         # Return if Footnotes::Filter.prefix exists or not.
         # Some notes only work with prefix set.
         #
@@ -171,7 +171,7 @@ module Footnotes
           newstring = ""
           hash.each do |key, value|
             newstring << "#{key.to_s}=\"#{value.gsub('"','\"')}\" "
-          end 
+          end
           return newstring
         end
     end

data/lib/rails-footnotes/footnotes.rb

@@ -29,12 +29,6 @@ module Footnotes
     # Show notes
     @@notes += [ :assigns, :session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general ]
 
-    # Change queries for rpm note when available
-    # if defined?(NewRelic)
-    #  @@notes.delete(:queries)
-    #  @@notes << :rpm
-    # end
-
     # :no_style       => If you don't want the style to be appended to your pages
     # :notes          => Class variable that holds the notes to be processed
     # :prefix         => Prefix appended to FootnotesLinks

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

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), '*_note.rb')].each {|note| require note}

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class AssignsNote < AbstractNote
@@ -44,11 +42,11 @@ module Footnotes
         def assigns
           assign = []
           ignored = @@ignored_assigns
-          
+
           @controller.instance_variables.each {|x| assign << x.intern }
           @controller.protected_instance_variables.each {|x| ignored << x.intern } if @controller.respond_to? :protected_instance_variables
-           
-          assign -= ignored            
+
+          assign -= ignored
           return assign
         end
 

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class ControllerNote < AbstractNote
@@ -12,47 +10,32 @@ module Footnotes
       end
 
       def link
-        if controller_filename && controller_line_number
-          escape(Footnotes::Filter.prefix(controller_filename, controller_line_number + 1, 3))
-        end
+        Footnotes::Filter.prefix(controller_filename, controller_line_number + 1, 3)
       end
 
       def valid?
-        prefix?
+        prefix? && File.exists?(self.controller_filename)
       end
 
       protected
-        # Some controller classes come with the Controller:: module and some don't
-        # (anyone know why? -- Duane)
+        def controller_path
+          @controller_path = @controller.class.name.underscore
+        end
+
         def controller_filename
-          return @controller_filename if defined?(@controller_filename)
-          controller_name=@controller.class.to_s.underscore
-          controller_name='application' if controller_name=='application_controller'
-          if ActionController::Routing.respond_to? :controller_paths
-            @controller_filename=nil
-            ActionController::Routing.controller_paths.each do |controller_path|
-              full_controller_path = File.join(File.expand_path(controller_path), "#{controller_name}.rb")
-              @controller_filename=full_controller_path if File.exists?(full_controller_path)
-            end
-            #raise "File not found"
-          else
-            @controller_filename=File.join(File.expand_path(Rails.root), 'app', 'controllers', "#{controller_name}.rb").sub('/controllers/controllers/', '/controllers/')
-          end
-          @controller_filename
+          @controller_filename ||= Gem.find_files(self.controller_path).first # tnx https://github.com/MasterLambaster
         end
 
         def controller_text
-          if controller_filename
-            @controller_text ||= IO.read(controller_filename)
-          end
+          @controller_text ||= IO.read(controller_filename)
         end
 
         def action_index
-          (controller_text =~ /def\s+#{@controller.action_name}[\s\(]/) if controller_text
+          (controller_text =~ /def\s+#{@controller.action_name}[\s\(]/)
         end
 
         def controller_line_number
-          lines_from_index(controller_text, action_index) || 0 if controller_text
+          lines_from_index(controller_text, action_index) || 0
         end
 
         def lines_from_index(string, index)
@@ -69,4 +52,4 @@ module Footnotes
         end
     end
   end
-end
+end

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

@@ -1,10 +1,8 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class CookiesNote < AbstractNote
       def initialize(controller)
-        @cookies = (controller.__send__(:cookies) || {}).symbolize_keys
+        @cookies = (controller.__send__(:cookies) || {}).dup.symbolize_keys
       end
 
       def title

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class EnvNote < AbstractNote

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class FilesNote < AbstractNote
@@ -41,4 +39,4 @@ module Footnotes
         end
     end
   end
-end
+end

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class FiltersNote < AbstractNote
@@ -35,12 +33,12 @@ module Footnotes
             mock_controller.action_name = action
 
             #remove conditions (this would call a Proc on the mock_controller)
-            filter.options.merge!(:if => nil, :unless => nil) 
+            filter.options.merge!(:if => nil, :unless => nil)
 
-            filter.__send__(:should_run_callback?, mock_controller)   
+            filter.__send__(:should_run_callback?, mock_controller)
           }.map(&:to_sym)
         end
-        
+
         def parse_method(method = '')
           escape(method.inspect.gsub(RAILS_ROOT, ''))
         end
@@ -50,4 +48,4 @@ module Footnotes
   module Extensions
     class MockController < Struct.new(:action_name); end
   end
-end
+end

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class GeneralNote < AbstractNote
@@ -16,4 +14,4 @@ module Footnotes
       end
     end
   end
-end
+end

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/files_note"
-
 module Footnotes
   module Notes
     class JavascriptsNote < FilesNote
@@ -13,4 +11,4 @@ module Footnotes
         end
     end
   end
-end
+end

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class LayoutNote < AbstractNote

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

@@ -1,14 +1,12 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class LogNote < AbstractNote
       @@log = []
-      
+
       def self.log(message)
         @@log << message
       end
-      
+
       def initialize(controller)
         @controller = controller
       end
@@ -20,7 +18,7 @@ module Footnotes
       def content
         escape(log.gsub(/\e\[.+?m/, '')).gsub("\n", '<br />')
       end
-      
+
       def log
         unless @log
           @log = @@log.join('')
@@ -39,7 +37,7 @@ module Footnotes
           logged_message
         end
       end
-      
+
       Rails.logger.extend LoggingExtensions
     end
   end

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class ParamsNote < AbstractNote

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/log_note"
-
 module Footnotes
   module Notes
     class PartialsNote < LogNote

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class QueriesNote < AbstractNote

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class RoutesNote < AbstractNote
@@ -48,7 +46,7 @@ module Footnotes
       #
       def filtered_routes(filter = {})
         return [] unless filter.is_a?(Hash)
-        return routes.reject do |r| 
+        return routes.reject do |r|
           filter_diff = filter.diff(r.requirements)
           route_diff  = r.requirements.diff(filter)
           (filter_diff == filter) || (filter_diff != route_diff)

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/abstract_note"
-
 module Footnotes
   module Notes
     class SessionNote < AbstractNote

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

@@ -1,5 +1,3 @@
-require "#{File.dirname(__FILE__)}/files_note"
-
 module Footnotes
   module Notes
     class StylesheetsNote < FilesNote
@@ -13,4 +11,4 @@ module Footnotes
         end
     end
   end
-end
+end