sinatra-footnotes 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 214783285ead66416d306c66355500bcb314603c
+  data.tar.gz: fa8c328067f09b58e3384d0aba746716dfb692d2
+SHA512:
+  metadata.gz: a6eb18d3a39196bf28a0fadda858bb747d99017672365c9a8004f708bf729a05ee850f35d8943994774063feaa0832325fd4fc1a8da429a00738eb81666e41b5
+  data.tar.gz: dc2f36b6771f77c80eba9fae45675a1e7adb57fed47909c62073735831c582922976ea35d42e794fd3a17ab8a08cece290819819e9679a00a34be934cbffcb49

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-footnotes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Stutzman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Sinatra Footnotes
+
+Every page has footnotes that give information about your application. Based on Rails Footnotes by José Valim (https://github.com/josevalim/rails-footnotes)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-footnotes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-footnotes
+
+## Usage
+
+Add this line to your Sinatra application file:
+
+    require 'sinatra-footnotes'

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sinatra-footnotes.rb

@@ -0,0 +1,98 @@
+require 'sinatra-footnotes/version'
+require 'sinatra/base'
+require 'active_support/core_ext'
+
+dir = File.dirname(__FILE__)
+%w[session cookies params sinatra_routes env assigns].each do |prefix|
+  require File.join(dir, 'sinatra-footnotes', 'notes', "#{prefix}_note.rb")
+end
+
+module Sinatra
+  module Footnotes
+    module Helpers
+      # Process notes to get javascript code to close them.
+      #
+      def close_helper(note)
+        "Footnotes.hide(document.getElementById('#{note.to_sym}_debug_info'));\n"
+      end
+
+      # Helper that creates the link and javascript code when note is clicked
+      #
+      def link_helper(note)
+        onclick = note.onclick
+        unless href = note.link
+          href = '#'
+          onclick ||= "Footnotes.hideAllAndToggle('#{note.to_sym}_debug_info');return false;" if note.has_fieldset?
+        end
+
+        "<a href=\"#{href}\" onclick=\"#{onclick}\">#{note.title}</a>"
+      end
+
+      def each_with_rescue(notes)
+        notes.each do |note|
+          begin
+            yield note
+          rescue Exception => e
+            STDERR.puts "FootNotes #{note.to_s.camelize}NoteException"
+            STDERR.puts e
+          end
+        end
+      end
+
+      def fieldsets(notes)
+        content = ''
+        each_with_rescue(notes) do |note|
+          next unless note.has_fieldset?
+          content << <<-HTML
+            <fieldset id="#{note.to_sym}_debug_info" style="display: none">
+              <legend>#{note.legend}</legend>
+              <div>#{note.content}</div>
+            </fieldset>
+          HTML
+        end
+        content
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Footnotes::Helpers
+
+      app.after do
+        style_path = File.join(
+          File.dirname(__FILE__), 'sinatra-footnotes', 'style.html')
+        response.body.push File.read(style_path)
+
+        response.body.push '<!-- Footnotes -->'
+        response.body.push '<div style="clear:both"></div>'
+        response.body.push '<div id="footnotes_debug">'
+        response.body.push 'Show:'
+
+        notes = []
+        notes.push ::Footnotes::Notes::SessionNote.new(self)
+        notes.push ::Footnotes::Notes::CookiesNote.new(self.request)
+        notes.push ::Footnotes::Notes::ParamsNote.new(self)
+        notes.push ::Footnotes::Notes::SinatraRoutesNote.new(app)
+        notes.push ::Footnotes::Notes::EnvNote.new(self)
+        notes.push(::Footnotes::Notes::AssignsNote.new(self).tap do |note|
+          note.ignored_assigns = [:@default_layout, :@app, :@template_cache,
+                                  :@env, :@request, :@response, :@params,
+                                  :@preferred_extension, :@_out_buf]
+        end)
+
+        response.body.push notes.map { |note| link_helper(note) }.join(' | ')
+        response.body.push '<br />'
+
+        response.body.push fieldsets(notes)
+
+        script_path = File.join(
+          File.dirname(__FILE__), 'sinatra-footnotes', 'script.html')
+        response.body.push(File.read(script_path))
+
+        response.body.push '</div>'
+        response.body.push '<!-- End Footnotes -->'
+      end
+    end
+  end
+
+  register Footnotes
+end

data/lib/sinatra-footnotes/notes/abstract_note.rb

@@ -0,0 +1,179 @@
+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.
+      #
+      protected
+        # 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) }
+#          array = array.collect { |a| a.collect { |b| c = b.to_s; escape(c) unless c == ""}}
+          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/sinatra-footnotes/notes/assigns_note.rb

@@ -0,0 +1,60 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class AssignsNote < AbstractNote
+      @@ignored_assigns = [
+                            :@real_format,
+                            :@before_filter_chain_aborted,
+                            :@performed_redirect,
+                            :@performed_render,
+                            :@_params,
+                            :@_response,
+                            :@url,
+                            :@template,
+                            :@_request,
+                            :@db_rt_before_render,
+                            :@db_rt_after_render,
+                            :@view_runtime
+                          ]
+      cattr_accessor :ignored_assigns, :instance_writter => false
+
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def title
+        "Assigns (#{assigns.size})"
+      end
+
+      def valid?
+        assigns
+      end
+
+      def content
+        rows = []
+        assigns.each do |key|
+          rows << [ key, escape(assigned_value(key)) ]
+        end
+        mount_table(rows.unshift(['Name', 'Value']), :class => 'name_values', :summary => "Debug information for #{title}")
+      end
+
+      protected
+
+        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            
+          return assign
+        end
+
+        def assigned_value(key)
+          @controller.instance_variable_get(key).inspect
+        end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class CookiesNote < AbstractNote
+      def initialize(controller)
+        @cookies = (controller.__send__(:cookies) || {}).symbolize_keys
+      end
+
+      def title
+        "Cookies (#{@cookies.length})"
+      end
+
+      def content
+        mount_table_for_hash(@cookies, :summary => "Debug information for #{title}")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class EnvNote < AbstractNote
+      def initialize(controller)
+        @env = controller.request.env.dup
+      end
+
+      def content
+        env_data = @env.to_a.sort.unshift([:key, :value]).map do |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>']
+          else
+            [k, escape(v.to_s)]
+          end
+        end
+
+        # Create the env table
+        mount_table(env_data)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class ParamsNote < AbstractNote
+      def initialize(controller)
+        @params = controller.params.symbolize_keys
+      end
+
+      def title
+        "Params (#{@params.length})"
+      end
+
+      def content
+        mount_table_for_hash(@params, :summary => "Debug information for #{title}")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class SessionNote < AbstractNote
+      def initialize(controller)
+        session = controller.session
+        if session
+          if session.respond_to? :to_hash
+            # rails >= 2.3
+            session = session.to_hash
+          else
+            #rails < 2.3
+            session = session.data
+          end
+        end
+        @session = (session || {}).symbolize_keys
+      end
+
+      def title
+        "Session (#{@session.length})"
+      end
+
+      def content
+        mount_table_for_hash(@session, :summary => "Debug information for #{title}")
+      end
+    end
+  end
+end

data/lib/sinatra-footnotes/notes/sinatra_routes_note.rb

@@ -0,0 +1,52 @@
+require "#{File.dirname(__FILE__)}/abstract_note"
+
+module Footnotes
+  module Notes
+    class SinatraRoutesNote < AbstractNote
+      def initialize(controller)
+        @controller = controller
+        @parsed_routes = parse_routes(controller)
+      end
+
+      def title
+        "Routes (#{@parsed_routes.size})" # don't show 'SinatraRoutes'
+      end
+
+      def legend
+        'Routes'
+      end
+
+      def content
+        #mount_table(@parsed_routes.unshift([:path, :name, :options, :requirements]), :summary => "Debug information for #{title}")
+        mount_table(@parsed_routes.unshift([:method, :path]), :summary => "Debug information for #{title}")
+      end
+
+      protected
+      def parse_routes(controller)
+        # thanks to cldwalker's tux gem for this code to interpret Sinatra routes
+        routes = controller.routes.inject([]) {|arr, (k,v)|
+          arr += v.map {|regex,params,*|
+            path = params.empty? ? regex.inspect :
+              params.inject(regex.inspect) {|s,e| s.sub(/\([^()]+\)/, ":#{e}") }
+            [k, (str = path[%r{/\^(.*)\$/}, 1]) ? str.tr('\\', '') : path]
+          }
+        }
+        
+        # still need to pull the regex syntax out
+        routes = routes.map do |method_and_path|
+          method, path = method_and_path
+          path =
+            path.to_s.gsub("\\/", "/").gsub(%r[^/\\A], "").gsub(%r[\\z/$], "")
+          [method, path]
+        end
+        
+        # don't show HEAD requests
+        routes = routes.reject! do |method_and_path|
+          method_and_path[0] == 'HEAD'
+        end
+        
+        routes
+      end
+    end
+  end
+end

data/lib/sinatra-footnotes/script.html

@@ -0,0 +1,45 @@
+<script type="text/javascript">
+  var Footnotes = function() {
+
+    function hideAll(){
+      Footnotes.hide(document.getElementById('assigns_debug_info'));
+      Footnotes.hide(document.getElementById('params_debug_info'));
+      Footnotes.hide(document.getElementById('sinatra_routes_debug_info'));
+      Footnotes.hide(document.getElementById('session_debug_info'));
+      Footnotes.hide(document.getElementById('cookies_debug_info'));
+      Footnotes.hide(document.getElementById('env_debug_info'));
+    }
+  
+    function hideAllAndToggle(id) {
+      hideAll();
+      toggle(id)
+  
+      location.href = '#footnotes_debug';
+    }
+  
+    function toggle(id){
+      var el = document.getElementById(id);
+      if (el.style.display == 'none') {
+        Footnotes.show(el);
+      } else {
+        Footnotes.hide(el);
+      }
+    }
+  
+    function show(element) {
+      element.style.display = 'block'
+    }
+  
+    function hide(element) {
+      element.style.display = 'none'
+    }
+  
+    return {
+      show: show,
+      hide: hide,
+      toggle: toggle,
+      hideAllAndToggle: hideAllAndToggle
+    }
+  }();
+/* Additional Javascript */
+</script>

data/lib/sinatra-footnotes/style.html

@@ -0,0 +1,15 @@
+<!-- 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 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 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;}
+  /* Aditional Stylesheets */
+
+</style>
+<!-- End Footnotes Style -->

data/lib/sinatra-footnotes/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Footnotes
+    VERSION = "0.1"
+  end
+end

data/sinatra-footnotes.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra-footnotes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-footnotes"
+  gem.version       = Sinatra::Footnotes::VERSION
+  gem.authors       = ["Daniel Stutzman"]
+  gem.email         = ["dtstutz@gmail.com"]
+  gem.description   = "Every page has footnotes that give information about your application."
+  gem.summary       = "Every page has footnotes that give information about your application."
+  gem.homepage      = "https://github.com/danielstutzman/sinatra-footnotes"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "sinatra"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "i18n" # needed for active_support
+end

data/test_sinatra_app.rb

@@ -0,0 +1,8 @@
+require 'sinatra'
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + "/lib")
+require 'sinatra-footnotes'
+
+get "/" do
+  @a = 1
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-footnotes
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Daniel Stutzman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Every page has footnotes that give information about your application.
+email:
+- dtstutz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra-footnotes.rb
+- lib/sinatra-footnotes/notes/abstract_note.rb
+- lib/sinatra-footnotes/notes/assigns_note.rb
+- lib/sinatra-footnotes/notes/cookies_note.rb
+- lib/sinatra-footnotes/notes/env_note.rb
+- lib/sinatra-footnotes/notes/params_note.rb
+- lib/sinatra-footnotes/notes/session_note.rb
+- lib/sinatra-footnotes/notes/sinatra_routes_note.rb
+- lib/sinatra-footnotes/script.html
+- lib/sinatra-footnotes/style.html
+- lib/sinatra-footnotes/version.rb
+- sinatra-footnotes.gemspec
+- test_sinatra_app.rb
+homepage: https://github.com/danielstutzman/sinatra-footnotes
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Every page has footnotes that give information about your application.
+test_files: []
+has_rdoc: