lesstile 0.1

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1 / 2007-12-24
+
+* Initial release. Hooray!

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/lesstile
+lib/lesstile.rb
+spec/spec_lesstile.rb

data/README.txt

@@ -0,0 +1,66 @@
+= lesstile
+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.
+
+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
+  ---
+
+  --- HTML
+  <strong>Look, HTML code</strong>
+  ---
+
+  ---
+  just some normal code
+  ---
+  EOS
+
+  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:
+
+* Facets
+* CodeRay (optional)
+
+== INSTALL:
+
+  sudo gem install lesstile
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Xavier Shay
+
+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/Rakefile

@@ -0,0 +1,27 @@
+# -*- 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.extra_deps << ['facets', '>= 1.0']
+  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

data/lib/lesstile.rb

@@ -0,0 +1,46 @@
+require 'facets/string/nchar'
+require 'cgi'
+
+class Lesstile
+  VERSION = '0.1'
+
+  class << self
+    # Returns lesstile formatted text as valid XHTML
+    #
+    # 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_xhtml(text, options = {})
+      options = default_options.merge(options)
+
+      text += "\n" unless text.ends_with?("\n")
+      text.gsub!(/\r\n/, "\n")
+      text = CGI::escapeHTML(text)
+
+      code_regex = /---\s*?(\w*?)\s*?\n(.*?)---\n/m
+      output = ""
+
+      while match = text.match(code_regex)
+        captures = match.captures
+        code = captures[1]
+        lang = captures[0].blank? ? nil : captures[0].downcase.intern
+
+        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
+  
+    def default_options
+      {
+        :code_formatter => lambda {|code, lang| "<pre><code>#{code}</code></pre>" },
+        :text_formatter => lambda {|text| text.gsub(/\n/, "<br />\n") }
+      }
+    end
+  end
+
+  # A formatter that syntax highlights code using CodeRay
+  CodeRayFormatter = lambda {|code, lang| CodeRay.scan(CGI::unescapeHTML(code), lang).html(:line_numbers => :table).div }
+end

data/spec/spec_lesstile.rb

@@ -0,0 +1,59 @@
+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
+
+  it "normal text unchanged" do
+    @format["hello"].should == "hello"
+  end
+
+  it "does not modify the input parameter" do
+    text = 'hello---\nRAR---'
+    @format[text]
+    text.should == 'hello---\nRAR---'
+  end
+
+  it "surrounds code blocks in appropriate tags" do
+    @format["---\nhello\n---\n"].should == "|hello\n|"
+  end
+
+  it "parses code blocks at end of input" do
+    @format["---\nhello\n---"].should == "|hello\n|"
+  end
+  it "parses code blocks inside text" do
+    @format["yo\n---\nhello\n---\n"].should == "yo\n|hello\n|"
+  end
+
+  it "parses multiple code blocks" do
+    @format["yo\n---\nhello\n---\nnya\n---\nmore code\n---\n"].should == "yo\n|hello\n|nya\n|more code\n|"
+  end
+
+  it "parses unclosed code blocks" do
+    @format["yo\n---\nhello"].should == "yo\n---\nhello"
+  end
+
+  it 'escapes html' do
+    @format["<a>&---\nyo<---"].should == "&lt;a&gt;&amp;|yo&lt;|"
+  end
+end
+
+describe "Lesstile#format_with_xhtml with default formatters" do
+  before(:all) do
+    @lesstile = Lesstile
+    @format = @lesstile.method(:format_as_xhtml)
+  end
+
+  it 'adds br and code tags' do
+    @format["hello\nyou---\na\nb\n---\nmore text\nyeah"].should == 
+      "hello<br />\nyou<pre><code>a\nb\n</code></pre>more text<br />\nyeah"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: lesstile
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ""
+authors: 
+- Xavier Shay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-26 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+- !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
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/lesstile
+- lib/lesstile.rb
+- spec/spec_lesstile.rb
+has_rdoc: true
+homepage: by Xavier Shay (http://rhnh.net)
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: lesstile
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Format text using an exceedingly simple markup language - perfect for comments on your blog
+test_files: []
+