rails6-footnotes 5.0.0

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require "rspec/core/rake_task"
+require 'rdoc/task'
+
+desc 'Default: run tests'
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate documentation for Footnotes.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Footnotes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/gemfiles/Gemfile.rails-3.2.22

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 3.2.22'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.0.0'
+

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.1.0'

data/gemfiles/Gemfile.rails-4.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 4.2.0'

data/gemfiles/Gemfile.rails-edge

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', :github => 'rails/rails'

data/lib/generators/rails_footnotes/install_generator.rb

@@ -0,0 +1,14 @@
+module RailsFootnotes
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Copy rails-footnotes initializer to your application."
+
+      def copy_initializer
+        template "rails_footnotes.rb", "config/initializers/rails_footnotes.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/rails_footnotes.rb

@@ -0,0 +1,26 @@
+Footnotes.setup do |f|
+  # Whether or not to enable footnotes
+  f.enabled = Rails.env.development?
+  # You can also use a lambda / proc to conditionally toggle footnotes, like
+  # f.enabled = -> { User.current.admin? }
+  # Beware of thread-safety though, Footnotes.enabled is NOT thread safe
+  # and should not be modified outside this initializer.
+
+  # Only toggle some notes :
+  # f.notes = [:session, :cookies, :params, :filters, :routes, :env, :queries, :log]
+
+  # Change the prefix :
+  # f.prefix = 'mvim://open?url=file://%s&line=%d&column=%d'
+
+  # 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 if defined?(Footnotes) && Footnotes.respond_to?(:setup)

data/lib/rails-footnotes.rb

@@ -0,0 +1,68 @@
+require 'rails'
+require 'action_controller'
+require 'rails-footnotes/abstract_note'
+require 'rails-footnotes/each_with_rescue'
+require 'rails-footnotes/filter'
+require 'rails-footnotes/notes/all'
+require 'rails-footnotes/extension'
+
+module Footnotes
+  mattr_accessor :before_hooks
+  @@before_hooks = []
+
+  mattr_accessor :after_hooks
+  @@after_hooks = []
+
+  mattr_accessor :enabled
+  @@enabled = false
+
+  class << self
+    delegate :notes, :to => Filter
+    delegate :notes=, :to => Filter
+
+    delegate :prefix, :to => Filter
+    delegate :prefix=, :to => Filter
+
+    delegate :no_style, :to => Filter
+    delegate :no_style=, :to => Filter
+
+    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.before(&block)
+    @@before_hooks << block
+  end
+
+  def self.after(&block)
+    @@after_hooks << block
+  end
+
+  def self.enabled?(controller)
+    if @@enabled.is_a? Proc
+      if @@enabled.arity == 1
+        @@enabled.call(controller)
+      else
+        @@enabled.call
+      end
+    else
+      !!@@enabled
+    end
+  end
+
+  def self.setup
+    yield self
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.send(:include, Footnotes::RailsFootnotesExtension)
+end
+
+load Rails.root.join('.rails_footnotes') if Rails.root && Rails.root.join('.rails_footnotes').exist?

data/lib/rails-footnotes/abstract_note.rb

@@ -0,0 +1,178 @@
+module Footnotes
+  module Notes
+    # This is the abstract class for notes.
+    # You can overwrite all instance public methods to create your notes.
+    #
+    class AbstractNote
+
+      # Class methods. Do NOT overwrite them.
+      #
+      class << self
+        # Returns the symbol that represents this note.
+        # It's the name of the class, underscored and without _note.
+        #
+        # For example, for ControllerNote it will return :controller.
+        #
+        def to_sym
+          @note_sym ||= self.title.underscore.to_sym
+        end
+
+        # Returns the title that represents this note.
+        # It's the name of the class without Note.
+        #
+        # For example, for ControllerNote it will return Controller.
+        #
+        def title
+          @note_title ||= self.name.match(/^Footnotes::Notes::(\w+)Note$/)[1]
+        end
+
+        # Return true if Note is included in notes array.
+        #
+        def included?
+          Footnotes::Filter.notes.include?(self.to_sym)
+        end
+
+        # Action to be called to start the Note.
+        # This is applied as a before_filter.
+        #
+        def start!(controller = nil)
+        end
+
+        # Action to be called after the Note was used.
+        # This is applied as an after_filter.
+        #
+        def close!(controller = nil)
+        end
+      end
+
+      # Initialize notes.
+      # Always receives a controller.
+      #
+      def initialize(controller = nil)
+      end
+
+      # Returns the symbol that represents this note.
+      #
+      def to_sym
+        self.class.to_sym
+      end
+
+      # Specifies in which row should appear the title.
+      # The default is :show.
+      #
+      def row
+        :show
+      end
+
+      # Returns the title to be used as link.
+      # The default is the note title.
+      #
+      def title
+        self.class.title
+      end
+
+      # If has_fieldset? is true, create a fieldset with the value returned as legend.
+      # By default, returns the title of the class (defined above).
+      #
+      def legend
+        self.class.title
+      end
+
+      # If content is defined, has_fieldset? returns true and the value of content
+      # is displayed when the Note is clicked. See has_fieldset? below for more info.
+      #
+      # def content
+      # end
+
+      # 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
+
+      # Insert here any additional stylesheet.
+      # This is directly inserted into a <style> tag.
+      #
+      def stylesheet
+      end
+
+      # Insert here any additional javascript.
+      # This is directly inserted into a <script> tag.
+      #
+      def javascript
+      end
+
+      # Specifies when should create a note for it.
+      # By default, it's valid.
+      #
+      def valid?
+        true
+      end
+
+      # Specifies when should create a fieldset for it, considering it's valid.
+      #
+      def has_fieldset?
+        self.respond_to?(:content)
+      end
+
+      # Some helpers to generate notes.
+      #
+      public
+        # Return if Footnotes::Filter.prefix exists or not.
+        # Some notes only work with prefix set.
+        #
+        def prefix?
+          !Footnotes::Filter.prefix.blank?
+        end
+
+        # Escape HTML special characters.
+        #
+        def escape(text)
+          text.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+        end
+
+        # Gets a bidimensional array and create a table.
+        # The first array is used as label.
+        #
+        def mount_table(array, options = {})
+          header = array.shift
+          return '' if array.empty?
+
+          header = header.collect{|i| escape(i.to_s.humanize) }
+          rows = array.collect{|i| "<tr><td>#{i.join('</td><td>')}</td></tr>" }
+
+          <<-TABLE
+          <table #{hash_to_xml_attributes(options)}>
+            <thead><tr><th>#{header.join('</th><th>')}</th></tr></thead>
+            <tbody>#{rows.join}</tbody>
+          </table>
+          TABLE
+        end
+
+        # Mount table for hash, using name and value and adding a name_value class
+        # to the generated table.
+        #
+        def mount_table_for_hash(hash, options={})
+          rows = []
+          hash.each do |key, value|
+            rows << [ key.to_sym.inspect, escape(value.inspect) ]
+          end
+          mount_table(rows.unshift(['Name', 'Value']), {:class => 'name_value'}.merge(options))
+        end
+
+        def hash_to_xml_attributes(hash)
+          newstring = ""
+          hash.each do |key, value|
+            newstring << "#{key.to_s}=\"#{value.gsub('"','\"')}\" "
+          end
+          return newstring
+        end
+    end
+  end
+end

data/lib/rails-footnotes/each_with_rescue.rb

@@ -0,0 +1,36 @@
+module Footnotes
+  module EachWithRescue
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      # Process notes, discarding only the note if any problem occurs
+      #
+      def each_with_rescue(collection)
+        delete_me = []
+
+        collection.each do |item|
+          begin
+            yield item
+          rescue Exception => e
+            raise e if Rails.env.test?
+            # Discard item if it has a problem
+            log_error("Footnotes #{item.to_s.camelize} Exception", e)
+            delete_me << item
+            next
+          end
+        end
+
+        delete_me.each { |item| collection.delete(item) }
+        return collection
+      end
+
+      # Logs the error using specified title and format
+      #
+      def log_error(title, exception)
+        Rails.logger.error "#{title}: #{exception}\n#{exception.backtrace.join("\n")}"
+      end
+    end
+  end
+end