rack-linkify 0.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.0 (December 3, 2009)
+* Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Wyatt M. Greene
+
+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.rdoc

@@ -0,0 +1,20 @@
+= Rack::Linkify
+
+== Description
+
+Dead links (like this one http://you.cant.click.this.com/) are magically
+transformed into live links! Rack::Linkify is very generous in what it
+considers a link; it will turn http://www.google.com, www.google.com, and
+just plain google.com into a link.
+
+Rack::Linkify can also turn text that looks like @this into a twitter link.
+
+== Usage
+
+URLs only:
+
+  use Rack::Linkify
+
+Enable Twitter links, too:
+
+  use Rack::Linkify, :twitter => true

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rubygems'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name          = "rack-linkify"
+    s.version       = "0.0.0"
+    s.add_dependency 'rack-plastic', '>= 0.0.3'
+    s.author        = "Wyatt Greene"
+    s.email         = "techiferous@gmail.com"
+    s.summary       = "Rack middleware that adds anchor tags to URLs in text."
+    s.description   = %Q{
+      Any URLs that occur in the text of the web page are automatically surrounded
+      by an anchor tag.
+    }
+    s.require_path  = "lib"
+    s.files         = []
+    s.files         << "README.rdoc"
+    s.files         << "LICENSE"
+    s.files         << "CHANGELOG"
+    s.files         << "Rakefile"
+    s.files         += Dir.glob("lib/**/*")
+    s.files         += Dir.glob("test/**/*")
+    s.homepage      = "http://github.com/techiferous/rack-linkify"
+    s.requirements  << "none"
+    s.has_rdoc      = false
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/lib/rack-linkify.rb

@@ -0,0 +1,74 @@
+require 'rack-plastic'
+
+module Rack
+  class Linkify < Plastic
+ 
+    def change_nokogiri_doc(doc)
+      find_candidate_links(doc)
+      doc
+    end
+    
+    def change_html_string(html)
+      linkify(html)
+    end
+
+    private
+    
+    def find_candidate_links(doc)
+      doc.at_css("body").traverse do |node|
+        if node.text?
+          update_text(node, mark_links(node.content))
+        end
+      end
+    end
+    
+    def linkify(html)
+      html.gsub!('beginninganchor1', '<a href="')
+      html.gsub!('beginninganchor2', '">')
+      html.gsub!('endinganchor', '</a>')
+      # if an href URL doesn't start with http://, let's add it:
+      html.gsub!(/href="((?!http)\S+)/, 'href="http://\1')
+      html
+    end
+ 
+    def mark_links(text)
+ 
+      new_text = text
+      
+      # A pattern-matching algorithm that would correctly detect URLs 100% of the time
+      # would be prohibitively complex. For example, if a URL in a sentence is followed
+      # by a comma, like http://www.google.com, we would want to match the URL but
+      # skip the comma. However, commas are allowed in URLs. So there are a lot
+      # of edge cases that make a complete solution very complex.
+      #
+      # The following strategy has the benefits of being relatively straightforword
+      # to implement as well as having high accuracy. Text is scanned for top-level
+      # domains, and if one is found it is assumed to be a URL.
+ 
+      common_gtlds = "com|net|org|edu|gov|info|mil|name|mobi|biz"
+ 
+      new_text.gsub!(/\b
+                      (\S+\.(#{common_gtlds}|[a-z]{2})\S*) # match words that contain common
+                      # top-level domains or country codes
+                      #
+                      (\.|\?|!|:|,\))* # if the URL ends in punctuation,
+                      # assume the punction is grammatical
+                      # and is not part of the URL
+                      \b/x,
+        # We mark the text with phrases like "beginninganchor1". That's because it's
+        # much easier to replace these strings later with anchor tags rather than work within
+        # Nokogiri's document structure to add a new node in the middle of the text.
+       'beginninganchor1\0beginninganchor2\0\3endinganchor')
+ 
+      # text that looks like @foo can become a twitter link
+      if options[:twitter]
+        new_text.gsub!(/(^|\s)(@(\w+))(\.|\?|!|:|,\))*\b/,
+         '\1beginninganchor1http://twitter.com/\3beginninganchor2\2endinganchor')
+      end
+ 
+      new_text
+
+    end
+ 
+  end
+end

data/test/rackapp/app.rb

@@ -0,0 +1,69 @@
+class App
+
+  def call(env)
+    response = Rack::Response.new
+    response['Content-Type'] = 'text/html'
+    response.write front_page
+    response.finish
+  end
+  
+  def front_page
+    %Q{
+      <!DOCTYPE html
+      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+        <head>
+          <title>Testing Rack::Linkify</title>
+        </head>
+        <body>
+          <div id="container">
+            <h1>Testing Rack::Linkify</h1>
+            <p>
+              This is a test of links in free-flowing text. <br />
+              Test a typical URL http://www.google.com <br />
+              Test a URL followed by a period http://www.google.com. <br />
+              Test a URL without the http www.google.com <br />
+              Test a URL without http and ending in a period www.google.com. <br />
+              Test a URL without www and followed by a comma google.com, <br />
+              Test a URL followed by a bang google.com! <br />
+              Test a URL followed by a hook google.com? <br />
+              Test a URL followed by an interrobang google.com?! <br />
+              Test another URL coderack.org <br />
+              Test a URL with a path google.com/foobar <br />
+              Test a longer URL google.com/foobar/index.html. <br />
+              Test a URL followed by a parenthesis google.com) <br />
+              Test a URL followed by a parenthesis and comma google.com), <br />
+              Test atypical gTLDs http://www.something.info, and http://del.icio.us <br />
+              Test more atypical gTLDs http://bit.ly/n0og http://www.wikio.co.uk <br />
+            </p>
+            <p>
+              Here are some more links:
+              <pre>
+                http://www.google.com
+                http://www.google.co.uk
+                www.google.com
+                google.com
+                http://localhost:3000/houses
+                http://oreilly.com/ruby/excerpts/ruby-learning-rails/ruby-guide-regular-expressions.html
+                http://www.regular-expressions.info/freespacing.html
+                http://www.perlmonks.org/?node_id=518444
+                localhost:3000/houses
+                oreilly.com/ruby/excerpts/ruby-learning-rails/ruby-guide-regular-expressions.html
+                www.regular-expressions.info/freespacing.html
+                www.perlmonks.org/?node_id=518444
+                http://maps.google.com/maps?f=q&source=s_q&hl=en&geocode=&q=375+Harvard+St,+Cambridge,+MA+02138&sll=42.398774,-71.117184&sspn=0.008097,0.019205&ie=UTF8&ll=42.372781,-71.112099&spn=0.008101,0.019205&z=16&iwloc=A
+              </pre>
+            <p>
+              here is a potential twitter address @techiferous <br />
+              here it is with punctuation @techiferous. <br />
+              will this work? @coderack?!?! <br />
+              and how about this? @techiferous) <br />
+            </p>
+          </div>
+        </body>
+      </html>
+    }
+  end
+  
+end

data/test/rackapp/config.ru

@@ -0,0 +1,6 @@
+require 'app'
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rack-linkify')
+
+use Rack::Linkify, :twitter => true
+
+run App.new

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rack-linkify
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Wyatt Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack-plastic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+description: "\n      Any URLs that occur in the text of the web page are automatically surrounded\n      by an anchor tag.\n    "
+email: techiferous@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/rack-linkify.rb
+- test/rackapp/app.rb
+- test/rackapp/config.ru
+has_rdoc: true
+homepage: http://github.com/techiferous/rack-linkify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that adds anchor tags to URLs in text.
+test_files: []
+