rack-footnotes 0.0.1

data/README.md

@@ -0,0 +1,22 @@
+# Rack FootNotes
+
+Rack::FootNotes is a very simple middleware I coded to add footnotes to prototypes created with [jlong/serve](http://github.com/jlong/serve)
+
+## Usage
+
+Create a `notes` folder in your serve project's root. Add a text file with notes for every route you want to display notes in. I.e: if you want to show notes for `http://0.0.0.0:4000/foo/bar/`, add them to `notes/foo/bar.txt`
+
+Then, load Rack::FootNotes in your `config.ru`:
+
+    gem 'rack-footnotes'
+    require 'rack/footnotes'
+    use Rack::FootNotes, {
+      :notes_path => 'notes',
+      :extra_css => "text-align: center;"
+    }
+
+There are three options:
+
+* `:notes_path`, the folder where you want to store your notes
+* `:css`, the CSS for the div containing the notes (don't change this unless necessary)
+* `:extra_css`, styles that will be added to the default CSS. Use it to change the background color, font-face, etc...

data/lib/rack/footnotes.rb

@@ -0,0 +1,31 @@
+require "rack"
+
+class Rack::FootNotes
+
+  VERSION = "0.0.1"
+
+  def initialize(app, options = {}, &block)
+    @app = app
+    @options = {
+      :notes_path => 'notes',
+      :css => "position: fixed; bottom: 0; left: 0; width: 100%; padding: 1em; background-color: rgba(245,242,137,0.6); margin: 0 auto;",
+      :extra_css => ""
+    }.merge(options)
+    instance_eval(&block) if block_given?
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+
+    route = env['PATH_INFO']
+    file = Dir.pwd + "/#{@options[:notes_path]}" + route.gsub(/\/$/,'') + '.txt'
+    if File.exists?(file)
+      note = File.readlines(file).to_s
+      body.body.gsub!("</body>","<div id='racknotes'>#{note}</div><style>#racknotes { #{@options[:css]} #{@options[:extra_css]} }</style></body>")
+    end
+
+    @response = Rack::Response.new(body, status, headers)
+    @response.to_a
+  end
+
+end

data/rack-footnotes.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = %q{rack-footnotes}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ale Muñoz"]
+  s.date = %q{2010-12-23}
+  s.description = %q{Rack middleware to insert text comments into pages. First created to be used with jlong's serve, but should work with pretty much every rack app}
+  s.files = ["lib/rack/footnotes.rb", "rack-footnotes.gemspec", "README.md"]
+  s.homepage = %q{http://github.com/bomberstudios/rack-footnotes}
+  s.require_paths = ["lib"]
+  s.has_rdoc = false
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Rack middleware to insert text comments into pages}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: rack-footnotes
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Ale Mu\xC3\xB1oz"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Rack middleware to insert text comments into pages. First created to be used with jlong's serve, but should work with pretty much every rack app
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rack/footnotes.rb
+- rack-footnotes.gemspec
+- README.md
+has_rdoc: false
+homepage: http://github.com/bomberstudios/rack-footnotes
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack middleware to insert text comments into pages
+test_files: []
+