lesstile 0.3.0 → 1.0.0

data/.gitignore

@@ -1,2 +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,7 +44,7 @@ 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 and 1.9.1-rc2
+Tested on ruby 1.8.6-339, 1.8.7-160, 1.9.1-rc2, and 1.9.2-p0
 
 == LICENSE:
 

data/Rakefile

@@ -1,21 +1,3 @@
-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.
-
-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
@@ -23,5 +5,5 @@ Spec::Rake::SpecTask.new do |t|
   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,7 @@ require 'cgi'
 require 'uri'
 
 class Lesstile
-  VERSION = '0.3'
+  VERSION = '1.0'
 
   CodeDetectionRegex = /---\s*?([\w\s\._+()-]*?)\s*?\n(.*?)---\n/m
 
@@ -26,13 +26,25 @@ class Lesstile
         code = captures[1]
         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
       {
@@ -62,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

@@ -2,17 +2,7 @@ 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| "|#{"(#{lang})" if 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
@@ -63,6 +53,34 @@ 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] }

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lesstile
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Xavier Shay
@@ -9,12 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-28 00:00:00 +11:00
+date: 2010-09-15 00:00:00 +01:00
 default_executable: 
 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.
+  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.
 
@@ -31,7 +37,6 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- VERSION
 - lib/lesstile.rb
 - spec/spec_lesstile.rb
 has_rdoc: true
@@ -44,21 +49,27 @@ rdoc_options:
 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: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Format text using an exceedingly simple markup language - perfect for comments on your blog

data/VERSION

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