ryanlowe-easy_format 0.1.0

data/CHANGELOG

@@ -0,0 +1,14 @@
+
+== 0.1.0
+
+May 26
+= added GitHub gemspec
+
+May 1 2008
+- moved to GitHub
+
+Dec 17 2007
+- handle nil and non-string properly
+
+Sep 25 2007
+- simple_format plugin created from code in existing projects

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2007-2008 Ryan Lowe
+
+http://ryanlowe.ca
+http://disruptiveagility.com
+
+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

@@ -0,0 +1,35 @@
+
+Hosted at GitHub since May 1, 2008
+http://github.com/ryanlowe/easy_format
+
+Was hosted at RubyForge
+http://rubyforge.org/projects/simple-format/
+
+
+= easy_format plugin for Ruby on Rails
+
+  easy_format is a Rails plugin that formats and escapes database
+  text for use in HTML views. The result looks a lot like text in
+  Gmail: line breaks are converted and links are linked.
+  
+  It will not support tags like BBCode; it just formats plain text.
+
+== Installation
+
+  It looks like Rails 2.1 will support "script/plugin install" with Git
+  repositories.  Until then you can put this plugin in vendor/plugins with:
+
+  git clone git://github.com/ryanlowe/easy_format.git
+
+  and delete the .git directory inside it before committing it to source control.
+
+  When Rails 2.1 supports Git you should be able to do:
+
+  script/plugin install git://github.com/ryanlowe/easy_format.git
+
+== Usage
+
+  <%= EasyFormat.format(@post.body) %>
+  
+  Note: HTML angle brackets are escaped by format() so
+  you do not need to use h() as well.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the easy_format plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the easy_format plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyFormat'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/easy_format.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "easy_format"
+  s.version = "0.1.0"
+  s.date = "2008-05-26"
+  s.summary = "Formats and escapes database text for safe use in Ruby on Rails views"
+  s.email = "rails@ryanlowe.ca"
+  s.homepage = "http://github.com/ryanlowe/easy_format"
+  s.description = "Formats and escapes database text for safe use in Ruby on Rails views"
+  s.has_rdoc = false
+  s.authors = ["Ryan Lowe"]
+  s.files = ["README", "CHANGELOG", "MIT-LICENSE","Rakefile", "easy_format.gemspec", "init.rb","lib/easy_format.rb",
+    "test/easy_format_test.rb","test/test_helper.rb"]
+  s.test_files = ["test/easy_format_test.rb","test/test_helper.rb"]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README","CHANGELOG"]
+  s.add_dependency("rails", ["> 2.0.0"])
+end

data/init.rb

@@ -0,0 +1 @@
+require 'easy_format'

data/lib/easy_format.rb

@@ -0,0 +1,71 @@
+class EasyFormat
+  def self.tab
+    '<span class="tab">&nbsp;</span>'
+  end
+  
+  def self.format(text, break_lines=true)
+    return "" if text.nil?
+    text = text.to_s
+    text.strip!
+    output = Array.new
+    lines = text.split($/)
+    for line in lines
+      line = escape_html(line)
+      line = replace_tabs(line)
+      line.strip!
+      line = link_urls(line)
+      output.push(line)
+    end
+    connector = break_lines ? "<br/>\n" : " "
+    output.join(connector)
+  end
+  
+  def self.replace_tabs(line)
+    tabbed = line.split(/\t/)
+    output = tabbed.join(" ").strip
+    output = tab+output if !tabbed[0].nil? and tabbed[0].strip.length < 1 and output.length > 0
+    output
+  end
+  
+  def self.link_urls(text)
+    protocols = ['http:','https:']
+    for protocol in protocols
+      re = Regexp.new(protocol+'(\S+)')
+      if text =~ re
+        md = re.match(text)
+        url, ending = strip_last_punctuation(md[1])
+        after = md.post_match
+        if after =~ re
+          after = link_urls(after)
+        end
+        output = md.pre_match
+        url = protocol+url
+        output += '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>'
+        output += ending
+        output += after
+        text = output
+      end
+    end
+    text
+  end
+  
+  def self.strip_last_punctuation(text)
+    url = text
+    ending = ""
+    re = /([[:punct:]])$/
+    if text =~ re
+      md = re.match(text)
+      url = md.pre_match
+      ending = md[1]
+      if ending == "/" #directory in URL
+        url += ending
+        ending = ""
+      end
+    end
+    [url, ending]
+  end
+  
+  def self.escape_html(text)
+    text.gsub(/[<]/,'&lt;').gsub(/[>]/,'&gt;')
+  end
+end

data/test/easy_format_test.rb

@@ -0,0 +1,147 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/easy_format'
+
+class EasyFormatTest < Test::Unit::TestCase
+
+  def test_corner_inputs
+    assert_equal "", EasyFormat.format(nil)
+    assert_equal "", EasyFormat.format("")
+    assert_equal "42", EasyFormat.format(42)
+  end
+
+  #
+  # line breaks
+  #
+  
+  def test_format_line_breaks
+    assert_equal "", EasyFormat.format("\n")
+    assert_equal "hello", EasyFormat.format("hello\n")
+    assert_equal "world!", EasyFormat.format("\nworld!")
+    
+    assert_equal "hello<br/>\nworld!", EasyFormat.format("hello\nworld!")
+    assert_equal "hello<br/>\n<br/>\nworld!", EasyFormat.format("hello\n\nworld!")
+    assert_equal "hello<br/>\n<br/>\n<br/>\nworld!", EasyFormat.format("hello\n\n\nworld!")
+  end
+  
+  def test_format_line_breaks
+    assert_equal "", EasyFormat.format("\n", false)
+    assert_equal "hello", EasyFormat.format("hello\n", false)
+    assert_equal "world!", EasyFormat.format("\nworld!", false)
+    
+    assert_equal "hello world!", EasyFormat.format("hello\nworld!", false)
+    assert_equal "hello  world!", EasyFormat.format("hello\n\nworld!", false)
+    assert_equal "hello   world!", EasyFormat.format("hello\n\n\nworld!", false)
+  end
+  
+  #
+  # tabs
+  # 
+  
+  def test_format_tabs
+    assert_equal '<span class="tab">&nbsp;</span>', EasyFormat.tab
+    
+    assert_equal "", EasyFormat.format("\t")
+    assert_equal "hello", EasyFormat.format("hello\t")
+    assert_equal "world!", EasyFormat.format("\tworld!")
+    
+    #tab beginning of line is replaced with non-breaking spaces
+    assert_equal "hello<br/>\n"+EasyFormat.tab+"world!", EasyFormat.format("hello\n\tworld!")
+    assert_equal "hello<br/>\n"+EasyFormat.tab+"world!", EasyFormat.format("hello\n \tworld!")
+    #except on a blank line
+    assert_equal "something<br/>\n<br/>\nanother", EasyFormat.format("something\n\t\nanother")
+    
+    #tab middle of line is replaced with a soft space
+    assert_equal "hello world!", EasyFormat.format("hello\tworld!")
+    assert_equal "hello  world!", EasyFormat.format("hello\t\tworld!")
+    assert_equal "hello   world!", EasyFormat.format("hello \t\tworld!")
+    
+    original = "Source Information:\n"+
+               " \tDwelling  \tWalters Cottage Robertsbridge Rd\n"+
+               " \tCensus Place\tMountfield, Sussex, England\n"+
+               " \tFamily History Library Film  \t1341245"
+    expected = "Source Information:<br/>\n"+
+               EasyFormat.tab+"Dwelling   Walters Cottage Robertsbridge Rd<br/>\n"+
+               EasyFormat.tab+"Census Place Mountfield, Sussex, England<br/>\n"+
+               EasyFormat.tab+"Family History Library Film   1341245"
+    assert_equal expected, EasyFormat.format(original)
+  end
+  
+  #
+  # urls
+  #
+  
+  def test_format_url_domain
+    url = "http://www.fanconcert.com"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format(url)
+    assert_equal 'Go here: <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("Go here: "+url)
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a> is cool!', EasyFormat.format(url+" is cool!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a> a lot!', EasyFormat.format("I really like "+url+" a lot!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("I really like "+url+"\n")
+  end
+  
+  def test_format_url_secure_domain
+    url = "https://www.fanconcert.com"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format(url)
+    assert_equal 'Go here: <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("Go here: "+url)
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a> is cool!', EasyFormat.format(url+" is cool!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a> a lot!', EasyFormat.format("I really like "+url+" a lot!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("I really like "+url+"\n")
+  end
+  
+  def test_format_url_directory
+    url = "http://www.fanconcert.com/search/"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format(url)
+    assert_equal 'Go here: <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("Go here: "+url)
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a> is cool!', EasyFormat.format(url+" is cool!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a> a lot!', EasyFormat.format("I really like "+url+" a lot!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("I really like "+url+"\n")
+  end
+  
+  def test_format_url_querystring
+    url = "http://www.fanconcert.com/search/concerts?after=now&close_to=1&proximity=200&artist_tagged_by=1"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format(url)
+    assert_equal 'Go here: <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("Go here: "+url)
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a> is cool!', EasyFormat.format(url+" is cool!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a> a lot!', EasyFormat.format("I really like "+url+" a lot!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("I really like "+url+"\n")
+  end
+  
+  def test_format_url_page
+    url = "http://www.normal.com/max.html"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format(url)
+    assert_equal 'Go here: <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("Go here: "+url)
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a> is cool!', EasyFormat.format(url+" is cool!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a> a lot!', EasyFormat.format("I really like "+url+" a lot!")
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>', EasyFormat.format("I really like "+url+"\n")
+  end
+  
+  def test_format_url_domain_ending_in_period
+    url = "http://www.cnn.com"
+    assert_equal 'I do not like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>.', EasyFormat.format("I do not like "+url+".")
+  end
+  
+  def test_format_url_domain_ending_in_punctuation
+    url = "http://www.cnn.com"
+    assert_equal 'I really like <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>!', EasyFormat.format("I really like "+url+"!")
+    assert_equal 'Have you been to <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>?', EasyFormat.format("Have you been to "+url+"?")
+  end
+  
+  def test_format_two_urls
+    url = "http://www.cnn.com"
+    assert_equal '<a class="external" href="'+url+'" title="'+url+'">'+url+'</a>? WTF is <a class="external" href="'+url+'" title="'+url+'">'+url+'</a>?', EasyFormat.format(url+"? WTF is "+url+"?")
+  end
+  
+#  def test_format_www
+#    www_url = "www.cnn.com"
+#    url = "http://"+www_url
+#    assert_equal 'I really like <a class="external" href="'+url+'" title="'+www_url+'">'+www_url+'</a>', EasyFormat.format("I really like "+www_url)
+#  end
+  
+  #
+  # escaping html
+  #
+  
+  def test_escape_html
+    assert_equal "&lt;b&gt;bold!&lt;/b&gt;", EasyFormat.escape_html("<b>bold!</b>")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+RAILS_ROOT = '.' unless defined?(RAILS_ROOT)

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: ryanlowe-easy_format
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Lowe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Formats and escapes database text for safe use in Ruby on Rails views
+email: rails@ryanlowe.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+files: 
+- README
+- CHANGELOG
+- MIT-LICENSE
+- Rakefile
+- easy_format.gemspec
+- init.rb
+- lib/easy_format.rb
+- test/easy_format_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/ryanlowe/easy_format
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Formats and escapes database text for safe use in Ruby on Rails views
+test_files: 
+- test/easy_format_test.rb
+- test/test_helper.rb