RedCloth 3.0.4 → 4.0.0

data/CHANGELOG

@@ -0,0 +1,17 @@
+= RedCloth 4.0
+
+* New SuperRedCloth (RedCloth 4.0) is a total rewrite using Ragel for the parsing.
+* Markdown support has been removed.
+* Single newlines become <br> tags, just as in traditional RedCloth and other Textile parsers.
+* HTML special characters are automatically escaped inside code signatures, like Textile 2.  This means you can simply write @<br />@ and the symbols are escaped whereas in RedCloth 3 you had to write @&lt;br /&gt;@ to make the code fragment readable.
+* The restrictions parameter is observed just like previous versions (except :hard_breaks is now the default).
+* Arguments to RedCloth#to_html are called so extensions made for prior versions can work.  Note: extensions need to be included rather than defined directly within the RedCloth class as was previously possible.
+* Custom block tags can be implemented as in the previous version, though the means of implementing them differs.
+* HTML embedded in the Textile input does not often need to be escaped from Textile parsing.
+* The parser will not wrap lines that begin with a space in paragraph tags.
+* Rudimentary support for LaTeX is built in.
+* RedCloth::VERSION on a line by itself inserts the version number into the output.
+* Output (less newlines and tabs) is identical to Textile 2 except a few cases where the RedCloth
+  way was preferable.
+* Over 500 tests prevent regression
+* It's 40 times faster than the previous version.

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Jason Garber
+
+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 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,156 @@
+= RedCloth - Textile parser for Ruby
+
+Homepage::  http://redcloth.org
+Author::    Jason Garber
+Copyright:: (c) 2008 Jason Garber
+License::   MIT
+
+(See http://redcloth.org/textile/ for a Textile reference.)
+
+= RedCloth
+
+RedCloth is a Ruby library for converting Textile into HTML.
+
+== Installing
+
+RedCloth can be installed via RubyGems:
+
+  sudo gem install RedCloth
+
+Or can be compiled from its Ragel source with <tt>rake compile</tt>.  Ragel 6.2 
+or greater is required to build RedCloth.
+
+== What is Textile?
+
+Textile is a simple formatting style for text
+documents, loosely based on some HTML conventions.
+
+== Sample Textile Text
+
+ h2. This is a title
+
+ h3. This is a subhead
+
+ This is a bit of paragraph.
+
+ bq. This is a blockquote.
+
+= Writing Textile
+
+A Textile document consists of paragraphs.  Paragraphs
+can be specially formatted by adding a small instruction
+to the beginning of the paragraph.
+
+ h3.     Header 3.
+ bq.     Blockquote.
+ #       Numeric list.
+ *       Bulleted list.
+
+== Quick Phrase Modifiers
+
+Quick phrase modifiers are also included, to allow formatting
+of small portions of text within a paragraph.
+
+ _emphasis_
+ __italicized__
+ *strong*
+ **bold**
+ ??citation??
+ -deleted text-
+ +inserted text+
+ ^superscript^
+ ~subscript~
+ @code@
+ %(classname)span%
+
+ ==notextile== (leave text alone)
+
+== Links
+
+To make a hypertext link, put the link text in "quotation 
+marks" followed immediately by a colon and the URL of the link.
+
+Optional: text in (parentheses) following the link text, 
+but before the closing quotation mark, will become a title 
+attribute for the link, visible as a tool tip when a cursor is above it.
+
+Example:
+
+ "This is a link (This is a title)":http://www.textism.com
+
+Will become:
+
+ <a href="http://www.textism.com" title="This is a title">This is a link</a>
+
+== Images
+
+To insert an image, put the URL for the image inside exclamation marks.
+
+Optional: text that immediately follows the URL in (parentheses) will 
+be used as the Alt text for the image. Images on the web should always 
+have descriptive Alt text for the benefit of readers using non-graphical 
+browsers.
+
+Optional: place a colon followed by a URL immediately after the 
+closing ! to make the image into a link.
+
+Example:
+
+ !http://www.textism.com/common/textist.gif(Textist)!
+
+Will become:
+
+ <img src="http://www.textism.com/common/textist.gif" alt="Textist" />
+
+With a link:
+
+ !/common/textist.gif(Textist)!:http://textism.com
+
+Will become:
+
+ <a href="http://textism.com"><img src="/common/textist.gif" alt="Textist" /></a>
+
+== Defining Acronyms
+
+HTML allows authors to define acronyms via the tag. The definition appears as a 
+tool tip when a cursor hovers over the acronym. A crucial aid to clear writing, 
+this should be used at least once for each acronym in documents where they appear.
+
+To quickly define an acronym in Textile, place the full text in (parentheses) 
+immediately following the acronym.
+
+Example:
+
+ ACLU(American Civil Liberties Union)
+
+Will become:
+
+ <acronym title="American Civil Liberties Union">ACLU</acronym>
+
+== Adding Tables
+
+In Textile, simple tables can be added by separating each column by
+a pipe.
+
+    |a|simple|table|row|
+    |And|Another|table|row|
+
+Styles are applied with curly braces.
+
+    table{border:1px solid black}.
+    {background:#ddd;color:red}. |a|red|row|
+
+== Using RedCloth
+
+RedCloth is simply an extension of the String class, which can handle
+Textile formatting.  Use it like a String and output HTML with its
+RedCloth#to_html method.
+
+ doc = RedCloth.new "
+
+ h2. Test document
+
+ Just a simple test."
+
+ puts doc.to_html
+

data/Rakefile

@@ -0,0 +1,238 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'fileutils'
+include FileUtils
+require 'lib/redcloth/version'
+
+NAME = RedCloth::NAME
+SUMMARY = RedCloth::DESCRIPTION
+VERS = RedCloth::VERSION::STRING
+CLEAN.include ['ext/redcloth_scan/*.{bundle,so,obj,pdb,lib,def,exp,c,o,xml}', 'ext/redcloth_scan/Makefile', '**/.*.sw?', '*.gem', '.config']
+CLOBBER.include ['lib/*.{bundle,so,obj,pdb,lib,def,exp}']
+
+desc "Does a full compile, test run"
+task :default => [:compile, :test]
+
+desc "Compiles all extensions"
+task :compile => [:redcloth_scan] do
+  if Dir.glob(File.join("lib","redcloth_scan.*")).length == 0
+    STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+    STDERR.puts "Gem actually failed to build.  Your system is"
+    STDERR.puts "NOT configured properly to build redcloth."
+    STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+    exit(1)
+  end
+end
+
+desc "Packages up RedCloth."
+task :package => [:clean, :compile]
+
+desc "Releases packages for all RedCloth packages and platforms."
+task :release => [:package, :rubygems_win32]
+
+desc "Run all the tests"
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/test_*.rb']
+    t.verbose = true
+end
+
+# Run specific tests or test files
+# 
+# rake test:parser
+# => Runs the full TestParser unit test
+# 
+# rake test:parser:textism
+# => Runs the tests matching /textism/ in the TestParser unit test
+rule "" do |t|
+  # test:file:method
+  if /test:(.*)(:([^.]+))?$/.match(t.name)
+    arguments = t.name.split(":")[1..-1]
+    file_name = arguments.first
+    test_name = arguments[1..-1] 
+    
+    if File.exist?("test/test_#{file_name}.rb")
+      run_file_name = "test_#{file_name}.rb"
+    end
+    
+    sh "ruby -Ilib:test test/#{run_file_name} -n /#{test_name}/" 
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc/rdoc'
+    # rdoc.options += RDOC_OPTS
+    # rdoc.template = "extras/flipbook_rdoc.rb"
+    rdoc.main = "README"
+    rdoc.title = "RedCloth Documentation"
+    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/**/*.rb', 'ext/**/*.c']
+end
+
+PKG_FILES = %w(CHANGELOG COPYING README Rakefile) +
+  Dir.glob("{bin,doc,test,lib,extras}/**/*") + 
+  Dir.glob("ext/**/*.{h,c,rb,rl}") + 
+  %w[attributes inline scan].map {|f| "ext/redcloth_scan/redcloth_#{f}.c"}
+
+spec =
+    Gem::Specification.new do |s|
+        s.name = NAME
+        s.version = VERS
+        s.platform = Gem::Platform::RUBY
+        s.has_rdoc = true
+        s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+        s.summary = SUMMARY
+        s.description = s.summary
+        s.author = "Jason Garber"
+        s.email = 'redcloth-upwards@rubyforge.org'
+        s.homepage = 'http://redcloth.org/'
+
+        s.files = PKG_FILES
+        
+        s.require_path = "lib"
+        #s.autorequire = "redcloth"  # no no no this is tHe 3v1l
+        s.extensions = FileList["ext/**/extconf.rb"].to_a
+        s.executables = ["redcloth"]
+    end
+
+Rake::GemPackageTask.new(spec) do |p|
+    p.need_tar = true
+    p.gem_spec = spec
+end
+
+extension = "redcloth_scan"
+ext = "ext/redcloth_scan"
+ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+ext_files = FileList[
+  "#{ext}/redcloth_scan.c",
+  "#{ext}/redcloth_inline.c",
+  "#{ext}/redcloth_attributes.c",
+  "#{ext}/extconf.rb",
+  "#{ext}/Makefile",
+  "lib"
+] 
+
+file ext_so => ext_files do
+  Dir.chdir(ext) do
+    sh(PLATFORM =~ /win32/ ? 'nmake' : 'make')
+  end
+  cp ext_so, "lib"
+end
+
+task "lib" do
+  directory "lib"
+end
+
+["#{ext}/redcloth_scan.c","#{ext}/redcloth_inline.c","#{ext}/redcloth_attributes.c"].each do |name|
+  @code_style ||= "T0"
+  source = name.sub(/\.c$/, '.rl')
+  file name => [source, "#{ext}/redcloth_common.rl", "#{ext}/redcloth.h"] do
+    @ragel_v ||= `ragel -v`[/(version )(\S*)/,2].split('.').map{|s| s.to_i}
+    if @ragel_v[0] > 6 || (@ragel_v[0] == 6 && @ragel_v[1] >= 2)
+      sh %{ragel #{source} -#{@code_style} -o #{name}}
+    else
+      STDERR.puts "Ragel 6.2 or greater is required to generate #{name}."
+      exit(1)
+    end
+  end
+end
+
+desc "Builds just the #{extension} extension"
+task extension.to_sym => ["#{ext}/Makefile", ext_so ]
+
+file "#{ext}/Makefile" => ["#{ext}/extconf.rb", "#{ext}/redcloth_scan.c","#{ext}/redcloth_inline.c","#{ext}/redcloth_attributes.c"] do
+  Dir.chdir(ext) do ruby "extconf.rb" end
+end
+
+Win32Spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERS
+  s.platform = 'mswin32'
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+  s.summary = SUMMARY 
+  s.description = s.summary
+  s.author = "Jason Garber"
+  s.email = 'redcloth-upwards@rubyforge.org'
+  s.homepage = 'http://redcloth.org/'
+
+  s.files = PKG_FILES + ["lib/redcloth_scan.so"]
+
+  s.require_path = "lib"
+  #s.autorequire = "redcloth"  # no no no this is tHe 3v1l
+  s.extensions = []
+  s.bindir = "bin"
+end
+  
+WIN32_PKG_DIR = "pkg/#{NAME}-#{VERS}-mswin32"
+
+file WIN32_PKG_DIR => [:package] do
+  cp_r "pkg/#{NAME}-#{VERS}", "#{WIN32_PKG_DIR}"
+end
+
+desc "Cross-compile the redcloth_scan extension for win32"
+file "redcloth_scan_win32" => [WIN32_PKG_DIR] do
+  cp "extras/mingw-rbconfig.rb", "#{WIN32_PKG_DIR}/ext/redcloth_scan/rbconfig.rb"
+  sh "cd #{WIN32_PKG_DIR}/ext/redcloth_scan/ && ruby -I. extconf.rb && make"
+  mv "#{WIN32_PKG_DIR}/ext/redcloth_scan/redcloth_scan.so", "#{WIN32_PKG_DIR}/lib"
+end
+
+desc "Build the binary RubyGems package for win32"
+task :rubygems_win32 => ["redcloth_scan_win32"] do
+  Dir.chdir("#{WIN32_PKG_DIR}") do
+    Gem::Builder.new(Win32Spec).build
+    verbose(true) {
+      cp Dir["*.gem"].first, "../"
+    }
+  end
+end
+
+CLEAN.include WIN32_PKG_DIR
+
+desc "Build and install the RedCloth gem on your system"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+end
+
+desc "Uninstall the RedCloth gem from your system"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+RAGEL_CODE_GENERATION_STYLES = {
+  'T0' => "Table driven FSM (default)",
+  'T1' => "Faster table driven FSM",
+  'F0' => "Flat table driven FSM",
+  'F1' => "Faster flat table-driven FSM",
+  'G0' => "Goto-driven FSM",
+  'G1' => "Faster goto-driven FSM",
+  'G2' => "Really fast goto-driven FSM"
+}
+
+desc "Find the fastest code generation style for Ragel"
+task :optimize do
+  require 'extras/ragel_profiler'
+  results = []
+  RAGEL_CODE_GENERATION_STYLES.each do |style, name|
+    @code_style = style
+    profiler = RagelProfiler.new(style + " " + name)
+    
+    # Hack to get everything to invoke again.  Could use #execute, but then it 
+    # doesn't execute prerequisites the second+ time
+    Rake::Task.tasks.each {|t| t.instance_eval "@already_invoked = false" }
+    
+    Rake::Task['clobber'].invoke
+    
+    profiler.measure(:compile) do
+      Rake::Task['compile'].invoke
+    end
+    profiler.measure(:test) do
+      Rake::Task['test'].invoke
+    end
+    profiler.ext_size(ext_so)
+    
+  end
+  puts RagelProfiler.results
+end

data/bin/redcloth

@@ -1,3 +1,28 @@
-#!/usr/bin/ruby18
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'optparse'
 require 'redcloth'
-puts RedCloth.new( ARGF.read ).to_html
+
+if %w(--version -v).include? ARGV.first
+  puts "#{RedCloth::NAME} #{RedCloth::VERSION::STRING}"
+  exit(0)
+end
+
+output_as = "html"
+opts = OptionParser.new do |opts|
+    opts.banner = "Usage: redcloth [options] [redcloth_formatted.txt]"
+    opts.separator "If no file specified, STDIN will be used. If you are typing input, you can send an EOF by pressing ^D (^Z on Windows)"
+    opts.separator ""
+    opts.on("-o", "--output STYLE", "Output format (defaults to #{output_as})") do |o|
+        output_as = o
+    end
+end
+opts.parse! ARGV
+
+red = RedCloth.new( ARGF.read )
+out_meth = "to_#{ output_as }"
+if red.respond_to? out_meth
+    puts red.method( out_meth ).call
+else
+    abort "** No to_#{ output_as } method found for the `#{ output_as }' format"
+end