rails-footnotes 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17a75b7b28fb30e688b8b5466cdcfcad2caff8ae
-  data.tar.gz: 81da40faf684a045622be143b6cf5f473e9c85d1
+  metadata.gz: c61d1012a1a550bca3eedf9abf4fe4b6a23b3c01
+  data.tar.gz: 2235e0403ee8ea795a32fd37951ec5200c381f4c
 SHA512:
-  metadata.gz: d688deb98a29198e04918043a9b22a6b19d00baba867fd8801b861be5cb57bc9ff6236f626ffcdea55217f0218dc394639d3a80f7b72e530d6ea21250d00e46a
-  data.tar.gz: 2fbca717ff0cf9f56386400743ddbfe2660048e9822e56bda337d06f710ad0b2969208fcc5d0571411bdb96dc0af905637990183717d57fca4a2a161c36f180f
+  metadata.gz: 6732c4cb0de50eb31926df957fb298580021f0c41d814f5e6a77fcba6e7fe1e8be3569c25af77ca4490b67656eb98799d8a391e79dbddfb75fcc2e9b7d6d7c46
+  data.tar.gz: fb79deb960ae52b71542003c1e33bc03357fe494fff99eda615cb3c136276c1e667d771af749fb4d44a62c5d2b226b3352262e8259ac8696ce06057fe5f9c458

data/CHANGELOG

@@ -1,3 +1,8 @@
+== Footnotes v4.1.0 ==
+  * Allow footnotes url prefix to be a lambda ( Thanks Jamie Lawrence )
+  * Sexier assigns note ( Thanks Joshua Paling )
+  * Fix issues with environment keys not being the same type causing some gems to break ( Thanks Austin Ziegler )
+
 == Footnotes v4.0.2
   * Fix bad display of footnotes table
   * Fix error with the queries note under Rails 4.1.2 (thanks Panayotis Matsinopoulos)

data/README.rdoc

@@ -65,6 +65,18 @@ We assume that they appear in that order. "foo://line=%d&file=%s" (%d precedes %
 
 5. Go to RCDefaultApp (OS System Preferences > DefaultApps). Go to URL section, select "tmxt" extension, and set default applicaiton to "SublHandler".
 
+*Use* *with* *Vagrant* (*and* *other* *virtual* *machines*)
+
+If you're running your app in Vagrant, you'll find that the edit links won't work because the paths point to the Vagrant directory not your native directory. To solve this, you can use a lambda for the prefix and modify the pathname accordingly.
+
+For example,
+
+    f.prefix = ->(*args) do
+      filename = args[0].sub '/vagrant', '/Users/jamie/projects/myproject'
+      "subl://open?url=file://#{filename}&line=#{args[1]}&column=#{args[2]}"
+    end
+
+replaces the vm directory /vagrant with OS X directory where the code is being edited.
 
 *Footnotes* *Display* *Options*
 
@@ -91,6 +103,8 @@ Finally, you can control which notes you want to show. The default are:
 
     f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log, :general]
 
+Setting <tt>f.notes = []</tt> will show none of the available notes, although the supporting CSS and JavaScript will still be included. To completely disable all rails-footnotes content on a page, include <tt>params[:footnotes] = 'false'</tt> in the request.
+
 == Creating your own notes
 
 Creating your notes to integrate with Footnotes is easy.

data/lib/rails-footnotes/filter.rb

@@ -47,7 +47,11 @@ module Footnotes
         if args.empty?
           @@prefix
         else
-          format(@@prefix, *args)
+          if @@prefix.respond_to? :call
+            @@prefix.call *args
+          else
+            format(@@prefix, *args)
+          end
         end
       end
 
@@ -161,8 +165,10 @@ module Footnotes
           #footnotes_debug a {color: #9b1b1b; font-weight: inherit; text-decoration: none; line-height: 18px;}
           #footnotes_debug table {text-align: left; width: 100%;}
           #footnotes_debug table td {padding: 5px; border-bottom: 1px solid #ccc;}
+          #footnotes_debug table td strong {color: #9b1b1b;}
           #footnotes_debug table th {padding: 5px; border-bottom: 1px solid #ccc;}
           #footnotes_debug table tr:nth-child(2n) td {background: #eee;}
+          #footnotes_debug table tr:nth-child(2n + 1) td {background: #fff;}
           #footnotes_debug tbody {text-align: left;}
           #footnotes_debug .name_values td {vertical-align: top;}
           #footnotes_debug legend {background-color: #fff;}

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

@@ -13,7 +13,8 @@ module Footnotes
                             :@_request,
                             :@db_rt_before_render,
                             :@db_rt_after_render,
-                            :@view_runtime
+                            :@view_runtime,
+                            :@marked_for_same_origin_verification
                           ]
       cattr_accessor :ignored_assigns, :instance_writter => false
       @@ignored_assigns_pattern = /^@_/
@@ -37,7 +38,13 @@ module Footnotes
 
       protected
         def to_table
-          @to_table ||= assigns.inject([]) {|rr, var| rr << [var, escape(assigned_value(var))]}.unshift(['Name', 'Value'])
+          table = assigns.inject([]) do |rr, var|
+            class_name = assigned_value(var).class.name
+            var_name = var.to_s
+            rr << ["<strong>#{var.to_s}</strong>" + "<br /><em>#{class_name}</em>", escape(assigned_value(var).inspect)]
+          end
+
+          table.unshift(['Name', 'Value'])
         end
 
         def assigns
@@ -45,8 +52,9 @@ module Footnotes
         end
 
         def assigned_value(key)
-          @controller.instance_variable_get(key).inspect
+          @controller.instance_variable_get(key)
         end
+
     end
   end
 end

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

@@ -6,15 +6,15 @@ module Footnotes
       end
 
       def content
-        env_data = @env.to_a.sort.unshift([:key, :value]).map do |k,v|
+        env_data = @env.map { |k, v|
           case k
           when 'HTTP_COOKIE'
             # Replace HTTP_COOKIE for a link
-            [k, '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>']
+            [k.to_s, '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>']
           else
-            [k, escape(v.to_s)]
+            [k.to_s, escape(v.to_s)]
           end
-        end
+        }.sort.unshift([ :key, escape('value') ])
 
         # Create the env table
         mount_table(env_data)

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "4.0.2"
+  VERSION = "4.1.0"
 end

data/spec/env_note_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'action_controller'
+require 'action_controller/test_case'
+
+class FootnotesEnvController < ActionController::Base
+  attr_accessor :template, :performed_render
+end
+
+describe Footnotes::Notes::EnvNote do
+  let(:controller) {
+    FootnotesEnvController.new.tap { |c|
+      c.template = Object.new
+      c.request = ActionController::TestRequest.new
+      c.response = ActionController::TestResponse.new
+      c.response_body = %Q(<html><body></body></html>)
+      c.params = {}
+    }
+  }
+
+  subject { described_class.new(controller) }
+
+  before do
+    @notes = Footnotes::Filter.notes
+    Footnotes::Filter.notes = [ :env ]
+  end
+
+  after do
+    Footnotes::Filter.notes = @notes
+  end
+
+  it '#to_sym is :env' do
+    expect(subject.to_sym).to eq(:env)
+  end
+
+  context 'with non-spec env keys' do
+    before :each do
+      controller.request.env.replace(:non_spec => 'symbol_env')
+    end
+
+    it 'does not raise an exception' do
+      expect { subject.content }.not_to raise_error
+    end
+
+    it 'includes the environment row' do
+      expect(subject).to receive(:mount_table).
+        with([ [ :key, 'value' ], [ 'non_spec', 'symbol_env' ] ])
+      subject.content
+    end
+  end
+
+  it 'includes values for all of the keys except HTTP_COOKIE' do
+    env = controller.request.env.dup
+    env.delete('HTTP_COOKIE')
+
+    env_data = env.map { |k, v| [ k.to_s, subject.escape(v.to_s) ] }.
+      sort.
+      unshift([ :key, 'value' ])
+
+    expect(subject).to receive(:mount_table).with(env_data)
+    subject.content
+  end
+
+  it 'gets a link for HTTP_COOKIE' do
+    controller.request.env.replace('HTTP_COOKIE' => 'foo')
+    expect(subject).to receive(:mount_table).
+      with([
+        [ :key, 'value' ],
+        [ 'HTTP_COOKIE',
+          '<a href="#" style="color:#009" onclick="Footnotes.hideAllAndToggle(\'cookies_debug_info\');return false;">See cookies on its tab</a>' ]
+    ])
+    subject.content
+  end
+end

data/spec/notes/assigns_note_spec.rb

@@ -18,7 +18,11 @@ describe Footnotes::Notes::AssignsNote do
   its(:title) {should eql 'Assigns (2)'}
 
   specify {note.send(:assigns).should eql [:@action_has_layout, :@status]}
-  specify {note.send(:to_table).should eql [['Name', 'Value'], [:@action_has_layout, "true"], [:@status, "200"]]}
+  specify {note.send(:to_table).should eql [
+    ["Name", "Value"],
+    ["<strong>@action_has_layout</strong><br /><em>TrueClass</em>", "true"],
+    ["<strong>@status</strong><br /><em>Fixnum</em>", "200"]
+  ]}
 
   describe "Ignored Assigns" do
     before(:each) {Footnotes::Notes::AssignsNote.ignored_assigns = [:@status]}
@@ -32,7 +36,11 @@ describe Footnotes::Notes::AssignsNote do
 
   it "should call #mount_table method with correct params" do
     note.should_receive(:mount_table).with(
-      [['Name', 'Value'], [:@action_has_layout, "true"], [:@status, "200"]], {:summary=>"Debug information for Assigns (2)"})
+      [
+        ["Name", "Value"],
+        ["<strong>@action_has_layout</strong><br /><em>TrueClass</em>", "true"],
+        ["<strong>@status</strong><br /><em>Fixnum</em>", "200"]
+      ], {:summary=>"Debug information for Assigns (2)"})
     note.content
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-footnotes
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Roman V. Babenko
@@ -12,48 +12,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Every Rails page has footnotes that gives information about your application
@@ -64,9 +64,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec.example
-- .travis.yml
+- ".gitignore"
+- ".rspec.example"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
@@ -107,6 +107,7 @@ files:
 - spec/controllers/footnotes_controller_spec.rb
 - spec/controllers/log_note_controller_spec.rb
 - spec/controllers/partials_note_controller_spec.rb
+- spec/env_note_spec.rb
 - spec/fixtures/html_download.html
 - spec/footnotes_spec.rb
 - spec/notes/assigns_note_spec.rb
@@ -126,12 +127,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -146,6 +147,7 @@ test_files:
 - spec/controllers/footnotes_controller_spec.rb
 - spec/controllers/log_note_controller_spec.rb
 - spec/controllers/partials_note_controller_spec.rb
+- spec/env_note_spec.rb
 - spec/fixtures/html_download.html
 - spec/footnotes_spec.rb
 - spec/notes/assigns_note_spec.rb
@@ -156,4 +158,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/views/partials/_foo.html.erb
 - spec/views/partials/index.html.erb
-has_rdoc: