lesstile 0.2 → 0.3.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+doc

data/History.txt

@@ -5,3 +5,7 @@
 == 0.2 / 2008-02-08
 
 * Remove dependency on facets
+
+== 0.3 / 2008-04-17
+
+* Allow textile style links in text - "link":http://rhnh.net

data/Manifest.txt

@@ -2,6 +2,5 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/lesstile
 lib/lesstile.rb
 spec/spec_lesstile.rb

data/README.txt

@@ -10,6 +10,7 @@ Integrates with CodeRay for sexy syntax highlighting.
 == SYNOPSIS:
 
   comment = <<-EOS
+  "Ego Link":http://rhnh.net
   Wow, this post is awesome. I'd implement it like this:
 
   --- Ruby
@@ -35,9 +36,12 @@ Integrates with CodeRay for sexy syntax highlighting.
 
 * CodeRay (optional)
 
-== INSTALL:
+== INSTALL (pick one):
 
-  sudo gem install lesstile
+  sudo gem install lesstile                          # gem install
+  git clone git://github.com/xaviershay/lesstile.git # go from source
+
+Tested on ruby 1.8.6-339, 1.8.7-160 and 1.9.1-rc2
 
 == LICENSE:
 

data/Rakefile

@@ -1,21 +1,22 @@
-# -*- ruby -*-
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "lesstile"
+    gemspec.summary = "Format text using an exceedingly simple markup language - perfect for comments on your blog"
+    gemspec.description = <<-EOS
+Converts text formatted with an exceedingly simple markup language into XHTML (iron clad guarantee!) - perfect for comments on your blog. Textile isn't good for this because not only does it do too much (do commenters really need subscript?), but it can also output invalid HTML (try a <b> tag over multiple lines...). Whitelisting HTML is another option, but you still need some sort of parsing if you want syntax highlighting.
 
-require 'rubygems'
-require 'hoe'
-require 'spec/rake/spectask'
-require './lib/lesstile.rb'
-
-Hoe.new('lesstile', Lesstile::VERSION) do |p|
-  p.rubyforge_name = 'lesstile'
-  p.author = 'Xavier Shay'
-  p.email = 'xavier@rhnh.net'
-  p.summary = 'Format text using an exceedingly simple markup language - perfect for comments on your blog'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.remote_rdoc_dir = ""
+Integrates with CodeRay for sexy syntax highlighting.
+    EOS
+    gemspec.email = "contact@rhnh.net"
+    gemspec.homepage = "http://github.com/xaviershay/lesstile"
+    gemspec.authors = ["Xavier Shay"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end
 
+require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new do |t|
   t.warning = false
   t.rcov = false

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/lesstile.rb

@@ -1,7 +1,10 @@
 require 'cgi'
+require 'uri'
 
 class Lesstile
-  VERSION = '0.2'
+  VERSION = '0.3'
+
+  CodeDetectionRegex = /---\s*?([\w\s\._+()-]*?)\s*?\n(.*?)---\n/m
 
   class << self
     # Returns lesstile formatted text as valid XHTML
@@ -16,13 +19,12 @@ class Lesstile
       text.gsub!(/\r\n/, "\n")
       text = CGI::escapeHTML(text)
 
-      code_regex = /---\s*?(\w*?)\s*?\n(.*?)---\n/m
       output = ""
 
-      while match = text.match(code_regex)
+      while match = text.match(CodeDetectionRegex)
         captures = match.captures
         code = captures[1]
-        lang = blank?(captures[0]) ? nil : captures[0].downcase.intern
+        lang = blank?(captures[0]) ? nil : captures[0].downcase.strip.intern
 
         output += options[:text_formatter][match.pre_match] + options[:code_formatter][code, lang]
         text = match.post_match
@@ -35,7 +37,13 @@ class Lesstile
     def default_options
       {
         :code_formatter => lambda {|code, lang| "<pre><code>#{code}</code></pre>" },
-        :text_formatter => lambda {|text| text.gsub(/\n/, "<br />\n") }
+        :text_formatter => lambda {|text| 
+          text = text.dup
+          text.gsub!(/\n/, "<br />\n")
+          text.gsub!('&quot;', '"')
+          text.gsub!(Regexp.new('"([^"]+)":(' + URI.regexp.to_s + ')'), '<a href="\2">\1</a>')
+          text
+        }
       }
     end
 

data/spec/spec_lesstile.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'spec'
 require File.dirname(__FILE__) + '/../lib/lesstile'
 
@@ -6,7 +7,7 @@ describe "Lesstile#format_as_xhtml" do
     @lesstile = Lesstile
     @format = lambda {|text| 
       @lesstile.format_as_xhtml(text, 
-        :code_formatter => lambda {|code, lang| "|#{code}|" },
+        :code_formatter => lambda {|code, lang| "|#{"(#{lang})" if lang}#{code}|" },
         :text_formatter => lambda {|text| text }
       )
     }
@@ -25,6 +26,18 @@ describe "Lesstile#format_as_xhtml" do
   it "surrounds code blocks in appropriate tags" do
     @format["---\nhello\n---\n"].should == "|hello\n|"
   end
+  
+  it "parses code blocks with language specified" do
+    @format["--- abc\nhello\n---\n"].should == "|(abc)hello\n|"
+  end
+  
+  # spaces, dashes, plusses, normal, underscore, brackets, numbers, dots
+  ["Ruby on Rails", "Objective-C", "Objective-C++", 
+   "Python", "_SQL_", "(X)HTML", "CSS3", "Javascript1.2"].each do |language|
+    it "parses code blocks with language #{language}" do
+      @format["--- #{language}\nhello\n---\n"].should == "|(#{language.downcase})hello\n|"
+    end
+  end
 
   it "parses code blocks at end of input" do
     @format["---\nhello\n---"].should == "|hello\n|"
@@ -44,6 +57,30 @@ describe "Lesstile#format_as_xhtml" do
   it 'escapes html' do
     @format["<a>&---\nyo<---"].should == "&lt;a&gt;&amp;|yo&lt;|"
   end
+
+  it 'escapes quotes' do 
+    @format['"'].should == "&quot;"
+  end
+end
+
+describe 'Lesstile default text formatter' do
+  before(:all) do
+    @format = lambda {|text| Lesstile.default_options[:text_formatter][text] }
+  end
+
+  it 'recognises links in text' do
+    @format[CGI::escapeHTML('"a link":http://example.com "<link":http://example.com linkage')].should == 
+      '<a href="http://example.com">a link</a> <a href="http://example.com">&lt;link</a> linkage'
+  end
+
+  it 'does not recognise blank links' do
+    text = '"":http://example.com'
+    @format[CGI::escapeHTML(text)].should == text
+  end
+
+  it 'unescapes " since it is not dangerous in plain text and allows us to use a simple regex for link formatting' do
+    @format["&quot;"].should == '"'
+  end
 end
 
 describe "Lesstile#format_with_xhtml with default formatters" do

metadata

@@ -1,50 +1,46 @@
 --- !ruby/object:Gem::Specification 
 name: lesstile
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-platform: ""
+  version: 0.3.0
+platform: ruby
 authors: 
 - Xavier Shay
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-02-08 00:00:00 +11:00
+date: 2009-10-28 00:00:00 +11:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.0
-    version: 
-description: "Integrates with CodeRay for sexy syntax highlighting.  == SYNOPSIS:  comment = <<-EOS Wow, this post is awesome. I'd implement it like this:  --- Ruby def hello_world puts \"hello world!\" end ---"
-email: xavier@rhnh.net
-executables: 
-- lesstile
+dependencies: []
+
+description: |
+  Converts text formatted with an exceedingly simple markup language into XHTML (iron clad guarantee!) - perfect for comments on your blog. Textile isn't good for this because not only does it do too much (do commenters really need subscript?), but it can also output invalid HTML (try a <b> tag over multiple lines...). Whitelisting HTML is another option, but you still need some sort of parsing if you want syntax highlighting.
+  
+  Integrates with CodeRay for sexy syntax highlighting.
+
+email: contact@rhnh.net
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
 - README.txt
 files: 
+- .gitignore
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/lesstile
+- VERSION
 - lib/lesstile.rb
 - spec/spec_lesstile.rb
 has_rdoc: true
-homepage: by Xavier Shay (http://rhnh.net)
+homepage: http://github.com/xaviershay/lesstile
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -61,10 +57,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: lesstile
-rubygems_version: 0.9.5
+rubyforge_project: 
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Format text using an exceedingly simple markup language - perfect for comments on your blog
-test_files: []
-
+test_files: 
+- spec/spec_lesstile.rb