rails-footnotes 3.7.8 → 3.7.9

data/README.rdoc

@@ -59,17 +59,36 @@ this code temporarily disables notes for all controllers
         controller.action_name == 'edit' }
     end
 
-If you are not using Textmate as text editor, in your environment.rb or
-in an initializer do:
+If you are not using Textmate as text editor, MacVim and Sublime Text 2 are also compatible.
 
-    Footnotes::Filter.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+*MacVim*
+
+In your environment.rb or in an initializer do:
 
-for MacVim
+    Footnotes::Filter.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
 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.
 
+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.
+
+*Sublime* *Text* *2*
+
+1. Keep the Textmate prefix, Footnotes::Filter.prefix = 'txmt://open?url=file://%s&line=%d&column=%d'
+
+2. Install {subl-hanlder}[https://github.com/asuth/subl-handler]
+
+3. Open subl-handler. Go to preferences (SublHandler > Preferences), and point "Path to subl" to your installed instance. (EG, /Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl). Note: do not escape the whitespaces, subl-handler accounts for those.
+
+4. Install {RCDefault}[http://www.rubicode.com/Software/RCDefaultApp]. It's OSX 10.2, but it works.
+
+5. Go to RCDefaultApp (OS System Preferences > DefaultApps). Go to URL section, select "tmxt" extension, and set default applicaiton to "SublHandler".
+
+
+*Footnotes* *Display* *Options*
+
 By default, footnotes are appended at the end of the page with default stylesheet. If you want
 to change their position, you can define a div with id "footnotes_holder" or define your own stylesheet
 by turning footnotes stylesheet off:

data/lib/rails-footnotes.rb

@@ -13,16 +13,7 @@ module Footnotes
     @@after_hooks << block
   end
 
-  # The footnotes are applied by default to all actions. You can change this
-  # behavior commenting the after_filter line below and putting it in Your
-  # application. Then you can cherrypick in which actions it will appear.
-  #
-  module RailsFootnotesExtension
-    def self.included(base)
-      base.prepend_before_filter Footnotes::BeforeFilter
-      base.after_filter Footnotes::AfterFilter
-    end
-  end
+  autoload :RailsFootnotesExtension, 'rails-footnotes/extension'
 
   def self.run!
     require 'rails-footnotes/footnotes'

data/lib/rails-footnotes/extension.rb

@@ -0,0 +1,8 @@
+module Footnotes
+  module RailsFootnotesExtension
+    def self.included(base)
+      base.prepend_before_filter Footnotes::BeforeFilter
+      base.after_filter Footnotes::AfterFilter
+    end
+  end
+end

data/lib/rails-footnotes/filter.rb

@@ -52,8 +52,11 @@ module Footnotes
     def initialize(controller)
       @controller = controller
       @template = controller.instance_variable_get(:@template)
-      @body = controller.response.body
       @notes = []
+
+      revert_pos(controller.response_body) do
+        @body = controller.response.body
+      end
     end
 
     def add_footnotes!
@@ -91,6 +94,13 @@ module Footnotes
         end
       end
 
+      def revert_pos(file)
+        return yield unless file.respond_to?(:pos) && file.respond_to?(:pos=)
+        original = file.pos
+        yield
+        file.pos = original
+      end
+
       def performed_render?
         @controller.instance_variable_get(:@performed_render) || # rails 2.x
           (@controller.respond_to?(:performed?) && @controller.performed?) # rails3, will break on redirect??

data/lib/rails-footnotes/version.rb

@@ -1,3 +1,3 @@
 module Footnotes
-  VERSION = "3.7.8"
+  VERSION = "3.7.9"
 end

data/spec/footnotes_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 require 'action_controller'
 require 'action_controller/test_case'
+require "tempfile"
 
 class FootnotesController < ActionController::Base
   attr_accessor :template, :performed_render
@@ -36,6 +37,25 @@ describe "Footnotes" do
     index.should eql 334
   end
 
+  context "response_body is file" do
+    before do
+      @file = Tempfile.new("test")
+      @file.write "foobarbaz"
+      @file.rewind
+    end
+
+    after do
+      @file.close!
+    end
+
+    it "should not change file position" do
+      @controller.response_body = @file
+      expect {
+        @footnotes = Footnotes::Filter.new(@controller)
+      }.not_to change{ @controller.response_body.pos }
+    end
+  end
+
   #TODO doe's not pased with 1.8.7
   if RUBY_VERSION >= '1.9.0'
     it "foonotes_included" do

metadata

@@ -1,83 +1,75 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rails-footnotes
-version: !ruby/object:Gem::Version 
-  hash: 11
+version: !ruby/object:Gem::Version
+  version: 3.7.9
   prerelease: 
-  segments: 
-  - 3
-  - 7
-  - 8
-  version: 3.7.8
 platform: ruby
-authors: 
+authors:
 - Roman V. Babenko
-- "Jos\xC3\xA9 Valim"
+- José Valim
 - Keenan Brock
 - Duane Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id003
-description: Every Rails page has footnotes that gives information about your application and links back to your editor.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Every Rails page has footnotes that gives information about your application
+  and links back to your editor.
+email:
 - romanvbabenko@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec.example
 - .travis.yml
@@ -97,6 +89,7 @@ files:
 - lib/rails-footnotes/backtracer.rb
 - lib/rails-footnotes/before_filter.rb
 - lib/rails-footnotes/each_with_rescue.rb
+- lib/rails-footnotes/extension.rb
 - lib/rails-footnotes/filter.rb
 - lib/rails-footnotes/footnotes.rb
 - lib/rails-footnotes/notes/all.rb
@@ -130,38 +123,30 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/josevalim/rails-footnotes
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rails-footnotes
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Every Rails page has footnotes that gives information about your application and links back to your editor.
-test_files: 
+summary: Every Rails page has footnotes that gives information about your application
+  and links back to your editor.
+test_files:
 - spec/abstract_note_spec.rb
 - spec/footnotes_spec.rb
 - spec/notes/assigns_note_spec.rb