lesstile 0.3 → 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+doc
+*.gemspec

data/History.txt

@@ -9,3 +9,9 @@
 == 0.3 / 2008-04-17
 
 * Allow textile style links in text - "link":http://rhnh.net
+
+== 1.0 / 2010-09-15
+
+* Added #format_as_html method
+* Switch to semantic versioning
+* Removed dependency on Jeweler

data/README.txt

@@ -3,7 +3,7 @@ by Xavier Shay (http://rhnh.net)
 
 == 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.
+Converts text formatted with an exceedingly simple markup language into valid HTML (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.
 
@@ -28,9 +28,12 @@ Integrates with CodeRay for sexy syntax highlighting.
   ---
   EOS
 
+  Lesstile.format_as_html(comment)
+  Lesstile.format_as_html(comment, :code_formatter => Lesstile::CodeRayFormatter) # Requires code ray
+  Lesstile.format_as_html(comment, :code_formatter => lambda {|code, lang| "Code in #{lang}: #{code}" })
+
+  # Also XHTML, for the old schoolers
   Lesstile.format_as_xhtml(comment)
-  Lesstile.format_as_xhtml(comment, :code_formatter => Lesstile::CodeRayFormatter) # Requires code ray
-  Lesstile.format_as_xhtml(comment, :code_formatter => lambda {|code, lang| "Code in #{lang}: #{code}" })
 
 == REQUIREMENTS:
 
@@ -41,6 +44,8 @@ Integrates with CodeRay for sexy syntax highlighting.
   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, 1.9.1-rc2, and 1.9.2-p0
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -1,26 +1,9 @@
-# -*- ruby -*-
-
-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 = ""
-end
-
 Spec::Rake::SpecTask.new do |t|
   t.warning = false
   t.rcov = false
   t.spec_files = FileList['spec/spec_*.rb']
 end
 
-task :test => :spec
-# vim: syntax=Ruby
+task :test    => :spec
+task :default => :spec

data/lib/lesstile.rb

@@ -2,7 +2,9 @@ require 'cgi'
 require 'uri'
 
 class Lesstile
-  VERSION = '0.3'
+  VERSION = '1.0'
+
+  CodeDetectionRegex = /---\s*?([\w\s\._+()-]*?)\s*?\n(.*?)---\n/m
 
   class << self
     # Returns lesstile formatted text as valid XHTML
@@ -17,44 +19,42 @@ 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]
 
-        output += options[:text_formatter][match.pre_match] + options[:code_formatter][code, lang]
         text = match.post_match
       end
       
       output += options[:text_formatter][text.chomp]
       output
     end
+
+    # Returns lesstile formatted text as valid HTML5
+    #
+    # options (all optional):
+    # * <tt>text_formatter</tt>: A callback function used to format text.
+    # * <tt>code_formatter</tt>: A callback function used to format code. Typically used for syntax highlighting.
+    def format_as_html(text, options = {})
+      format_as_xhtml(text, options)
+    end
   
     def default_options
       {
         :code_formatter => lambda {|code, lang| "<pre><code>#{code}</code></pre>" },
         :text_formatter => lambda {|text| 
-          text = text.gsub(/\n/, "<br />\n")
-          uris = URI.extract(text)
-
-          buffer = ""
-          uris.each do |uri|
-            pivot = text.index(uri)
-            pre = text[0..pivot-1]
-            m = pre.match(/&quot;(.*)&quot;:$/)
-            link = m ? m.captures.first : nil
-            if link
-              buffer += m.pre_match + "<a href='#{uri.to_s}'>#{link}</a>"
-            else
-              buffer += pre + uri
-            end  
-            text = text[pivot+uri.length..-1]
-          end
-          buffer += text
-          buffer
+          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
@@ -74,5 +74,7 @@ class Lesstile
   end
 
   # A formatter that syntax highlights code using CodeRay
-  CodeRayFormatter = lambda {|code, lang| CodeRay.scan(CGI::unescapeHTML(code), lang).html(:line_numbers => :table).div }
+  CodeRayFormatter = lambda {|code, lang| 
+    CodeRay.scan(CGI::unescapeHTML(code), lang).html(:line_numbers => :table).div 
+  }
 end

data/spec/spec_lesstile.rb

@@ -1,17 +1,8 @@
+require 'rubygems'
 require 'spec'
 require File.dirname(__FILE__) + '/../lib/lesstile'
 
-describe "Lesstile#format_as_xhtml" do
-  before(:all) do
-    @lesstile = Lesstile
-    @format = lambda {|text| 
-      @lesstile.format_as_xhtml(text, 
-        :code_formatter => lambda {|code, lang| "|#{code}|" },
-        :text_formatter => lambda {|text| text }
-      )
-    }
-  end
-
+describe 'an html formatter', :shared => true do
   it "normal text unchanged" do
     @format["hello"].should == "hello"
   end
@@ -25,6 +16,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|"
@@ -50,14 +53,51 @@ describe "Lesstile#format_as_xhtml" do
   end
 end
 
+describe "Lesstile#format_as_xhtml" do
+  before(:all) do
+    @lesstile = Lesstile
+    @format = lambda {|text| 
+      @lesstile.format_as_xhtml(text, 
+        :code_formatter => lambda {|code, lang| "|#{"(#{lang})" if lang}#{code}|" },
+        :text_formatter => lambda {|text| text }
+      )
+    }
+  end
+
+  it_should_behave_like 'an html formatter'
+end
+
+describe "Lesstile#format_as_html" do
+  before(:all) do
+    @lesstile = Lesstile
+    @format = lambda {|text| 
+      @lesstile.format_as_html(text, 
+        :code_formatter => lambda {|code, lang| "|#{"(#{lang})" if lang}#{code}|" },
+        :text_formatter => lambda {|text| text }
+      )
+    }
+  end
+
+  it_should_behave_like 'an html formatter'
+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['"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"
+    @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
 

metadata

@@ -1,37 +1,38 @@
 --- !ruby/object:Gem::Specification 
 name: lesstile
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-platform: ""
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
 authors: 
 - Xavier Shay
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-04-17 00:00:00 +10:00
+date: 2010-09-15 00:00:00 +01: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.5.1
-    version: 
-description: "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 def hello_world puts \"hello world!\" end ---"
-email: xavier@rhnh.net
+dependencies: []
+
+description: |
+  Converts text formatted with an exceedingly simple markup language into valid HTML (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
@@ -39,31 +40,38 @@ files:
 - 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 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: lesstile
-rubygems_version: 0.9.5
+rubyforge_project: 
+rubygems_version: 1.3.7
 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