RedCloth 4.1.0-universal-java

data/CHANGELOG

@@ -0,0 +1,103 @@
+=== 4.1.0 / October 31, 2008
+
+* JRuby support!  [olabini]
+  To run the tests with JRuby, you only need to: jruby -S rake
+  To compile the jruby version of the gem: jruby -S rake compile
+
+* Added textilize ERB utility method. [edraut]
+  Use it in an ERB template like this: <%=t my_textile_string %> or 
+  <%=r %{Some *textile* if you please!} %>
+
+* Fix extended blockcode stripping whitespace following blank line. #78
+
+
+=== 4.0.4 / October 1, 2008
+
+* Added some very basic support for images in LaTeX. [virtualfunction]
+
+* Fixed missed caps and inline modifiers wrapped in parentheses. #43, #45
+
+* Removed indication of quotes explicitly with square brackets.  Textile 2.0 does not support this and it wasn't in RedCloth 3. #46
+
+* Made percent signs less greedy.  They must surround a phrase or else they must be surrounded with square brackets, just like sup, sub, and del phrases. #47
+
+* Reduced link eagerness so it wouldn't include preceding quoted phrases. #48
+
+* Fixed compatibility issues with Ruby 1.9 [Keita Yamaguchi]. #52, 53, 54
+
+* Fixed an error when a link was badly nested in parentheses. #55
+
+* Fixed an error on superscript/subscript parenthetical phrase. #56
+
+* Fixed bold phrases starting with a number being recognized as unordered lists. #60
+
+* Fixed behavior of unclosed (multi-paragraph) quotes and incorrect handling of links inside double quotations. #59, #63
+
+* Fixed empty block HTML disappearing. #64
+
+
+=== 4.0.3 / August 18, 2008
+
+* Fix NoMethodError: private method gsub!' called for nil:NilClass when two dimensions followed by a space. #38
+
+* Fixed unititialized constant RedCloth::TextileDoc with Rails 2.1.  Came from a workaround for Rails bug #320 that was applied even when not necessary. #42
+
+
+=== 4.0.2 / August 15, 2008
+
+* Fixed link references/aliases not being recognized when they include hyphens. #36
+
+* Dimensions in feet and inches use correct typographic characters. #25
+
+* Limit overzealous superscript and subscript.  Sup/sub phrases must be surrounded by spaces or square brackets, as in Textile 2. #35
+
+* Fixed HTML before tables causing the opening table tag to be emitted twice. #33
+
+* Cleaned up unused code that was causing a warning. #28
+
+* Workaround for Rails 2.1 bug that loads a previous version of RedCloth before loading the unpacked gem.  Has since been fixed in edge rails. #30
+
+* Added a RedCloth::VERSION.to_s and .== methods so you can puts and compare RedCloth::VERSION just like in previous RedCloth releases. #26
+
+* Fixed HTML block ending tags terminating blocks prematurely. #22
+
+
+=== 4.0.1 / July 24, 2008
+
+* Fixed lines starting with dashes being recognized as a definition list when there were no definitions.
+
+* Created alias RedCloth.rb so Rails 2.1 gem dependency works on case-sensitive operating systems	.
+* Fixed parsing sentences that had two em dashes surrounded by spaces from becoming del phrases. #19
+
+* Fixed links including prior quoted phrases. #17
+
+
+=== 4.0.0 / July 21, 2008
+
+* 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/Manifest

@@ -0,0 +1,57 @@
+bin/redcloth
+CHANGELOG
+COPYING
+ext/mingw-rbconfig.rb
+ext/redcloth_scan/extconf.rb
+ext/redcloth_scan/redcloth.h
+ext/redcloth_scan/redcloth_attributes.c.rl
+ext/redcloth_scan/redcloth_attributes.java.rl
+ext/redcloth_scan/redcloth_attributes.rl
+ext/redcloth_scan/redcloth_common.c.rl
+ext/redcloth_scan/redcloth_common.java.rl
+ext/redcloth_scan/redcloth_common.rl
+ext/redcloth_scan/redcloth_inline.c.rl
+ext/redcloth_scan/redcloth_inline.java.rl
+ext/redcloth_scan/redcloth_inline.rl
+ext/redcloth_scan/redcloth_scan.c.rl
+ext/redcloth_scan/redcloth_scan.java.rl
+ext/redcloth_scan/redcloth_scan.rl
+extras/ragel_profiler.rb
+lib/case_sensitive_require/RedCloth.rb
+lib/redcloth/erb_extension.rb
+lib/redcloth/formatters/base.rb
+lib/redcloth/formatters/html.rb
+lib/redcloth/formatters/latex.rb
+lib/redcloth/formatters/latex_entities.yml
+lib/redcloth/textile_doc.rb
+lib/redcloth/version.rb
+lib/redcloth.rb
+Manifest
+Rakefile
+README
+RedCloth.gemspec
+setup.rb
+test/basic.yml
+test/code.yml
+test/definitions.yml
+test/extra_whitespace.yml
+test/filter_html.yml
+test/filter_pba.yml
+test/helper.rb
+test/html.yml
+test/images.yml
+test/instiki.yml
+test/links.yml
+test/lists.yml
+test/poignant.yml
+test/sanitize_html.yml
+test/table.yml
+test/test_custom_tags.rb
+test/test_erb.rb
+test/test_extensions.rb
+test/test_formatters.rb
+test/test_parser.rb
+test/test_restrictions.rb
+test/textism.yml
+test/threshold.yml
+test/validate_fixtures.rb

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,205 @@
+require 'lib/redcloth/version'
+
+begin
+  require 'rubygems'
+  gem 'echoe', '>=2.7.11'
+  require 'echoe'
+rescue LoadError
+  abort "You'll need to have `echoe' installed to use RedCloth's Rakefile"
+end
+
+e = Echoe.new('RedCloth', RedCloth::VERSION.to_s) do |p|
+  p.summary = RedCloth::DESCRIPTION
+  p.author = "Jason Garber"
+  p.email = 'redcloth-upwards@rubyforge.org'
+  p.clean_pattern += ['ext/redcloth_scan/**/*.{bundle,so,obj,pdb,lib,def,exp,c,o,xml,class,jar,java}', 'lib/*.{bundle,so,o,obj,pdb,lib,def,exp,jar}', 'ext/redcloth_scan/Makefile']
+  p.url = "http://redcloth.org"
+  p.project = "redcloth"
+  p.rdoc_pattern = ['README', 'COPING', 'CHANGELOG', 'lib/**/*.rb', 'doc/**/*.rdoc']
+  p.ignore_pattern = /^(pkg|site|projects|doc|log)|CVS|\.log/
+  p.ruby_version = '>=1.8.4'
+  p.extension_pattern = nil
+  
+  
+  if RUBY_PLATFORM =~ /mingw|mswin|java/
+    p.need_tar_gz = false
+  else
+    p.need_zip = true
+    p.need_tar_gz = true
+    p.extension_pattern = ["ext/**/extconf.rb"]
+  end
+
+  p.eval = proc do
+    case RUBY_PLATFORM
+    when /mingw/
+      self.files += ['lib/redcloth_scan.so']
+      self.platform = 'x86-mswin32-60'
+    when /java/
+      self.files += ['lib/redcloth_scan.jar']
+      self.platform = 'universal-java'
+    else
+      self.files += %w[attributes inline scan].map {|f| "ext/redcloth_scan/redcloth_#{f}.c"}
+    end
+  end
+
+end
+
+#### Pre-compiled extensions for alternative platforms
+
+def move_extensions
+  Dir["ext/**/*.{bundle,so,jar}"].each { |file| mv file, "lib/" }
+end
+
+def java_classpath_arg
+  # A myriad of ways to discover the JRuby classpath
+  classpath = begin
+    require 'java'
+    # Already running in a JRuby JVM
+    Java::java.lang.System.getProperty('java.class.path')
+  rescue LoadError
+    ENV['JRUBY_PARENT_CLASSPATH'] || ENV['JRUBY_HOME'] && FileList["#{ENV['JRUBY_HOME']}/lib/*.jar"].join(File::PATH_SEPARATOR)
+  end
+  classpath ? "-cp #{classpath}" : ""
+end
+
+ext = "ext/redcloth_scan"
+
+case RUBY_PLATFORM
+when /mingw/
+  
+  filename = "lib/redcloth_scan.so"
+  file filename => FileList["#{ext}/redcloth_scan.c", "#{ext}/redcloth_inline.c", "#{ext}/redcloth_attributes.c"] do
+    cp "ext/mingw-rbconfig.rb", "#{ext}/rbconfig.rb"
+    Dir.chdir("ext/redcloth_scan") do
+      ruby "-I. extconf.rb"
+      system(PLATFORM =~ /mswin/ ? 'nmake' : 'make')
+    end
+    move_extensions
+    rm "#{ext}/rbconfig.rb"
+  end
+
+when /java/
+
+  filename = "lib/redcloth_scan.jar"
+  file filename => FileList["#{ext}/RedclothScanService.java", "#{ext}/RedclothInline.java", "#{ext}/RedclothAttributes.java"] do
+    sources = FileList["#{ext}/**/*.java"].join(' ')
+    sh "javac -target 1.5 -source 1.5 -d #{ext} #{java_classpath_arg} #{sources}"
+    sh "jar cf lib/redcloth_scan.jar -C #{ext} ."
+    move_extensions
+  end
+  
+else
+  filename = "#{ext}/redcloth_scan.#{Config::CONFIG['DLEXT']}"
+  file filename => FileList["#{ext}/redcloth_scan.c", "#{ext}/redcloth_inline.c", "#{ext}/redcloth_attributes.c"]
+end
+
+task :compile => [filename]
+
+def ragel(target_file, source_file)
+  host_language = (target_file =~ /java$/) ? "J" : "C"
+  code_style = (host_language == "C") ? " -" + (@code_style || "T0") : ""
+  ensure_ragel_version(target_file) do
+    sh %{ragel #{source_file} -#{host_language}#{code_style} -o #{target_file}}
+  end
+end
+
+# Make sure the .c files exist if you try the Makefile, otherwise Ragel will have to generate them.
+file "#{ext}/Makefile" => ["#{ext}/extconf.rb", "#{ext}/redcloth_scan.c","#{ext}/redcloth_inline.c","#{ext}/redcloth_attributes.c","#{ext}/redcloth_scan.o","#{ext}/redcloth_inline.o","#{ext}/redcloth_attributes.o"]
+
+# Ragel-generated C files
+file "#{ext}/redcloth_scan.c" =>  ["#{ext}/redcloth_scan.c.rl",   "#{ext}/redcloth_scan.rl", "#{ext}/redcloth_common.c.rl",   "#{ext}/redcloth_common.rl",  "#{ext}/redcloth.h"] do
+  ragel "#{ext}/redcloth_scan.c", "#{ext}/redcloth_scan.c.rl"
+end
+file "#{ext}/redcloth_inline.c" =>  ["#{ext}/redcloth_inline.c.rl",   "#{ext}/redcloth_inline.rl", "#{ext}/redcloth_common.c.rl",   "#{ext}/redcloth_common.rl",  "#{ext}/redcloth.h"] do
+  ragel "#{ext}/redcloth_inline.c", "#{ext}/redcloth_inline.c.rl"
+end
+file "#{ext}/redcloth_attributes.c" =>  ["#{ext}/redcloth_attributes.c.rl",   "#{ext}/redcloth_attributes.rl", "#{ext}/redcloth_common.c.rl",   "#{ext}/redcloth_common.rl",  "#{ext}/redcloth.h"] do
+  ragel "#{ext}/redcloth_attributes.c", "#{ext}/redcloth_attributes.c.rl"
+end
+
+# Ragel-generated Java files
+file "#{ext}/RedclothScanService.java" =>  ["#{ext}/redcloth_scan.java.rl",   "#{ext}/redcloth_scan.rl", "#{ext}/redcloth_common.java.rl",   "#{ext}/redcloth_common.rl"] do
+  ragel "#{ext}/RedclothScanService.java", "#{ext}/redcloth_scan.java.rl"
+end
+file "#{ext}/RedclothInline.java" =>  ["#{ext}/redcloth_inline.java.rl",   "#{ext}/redcloth_inline.rl", "#{ext}/redcloth_common.java.rl",   "#{ext}/redcloth_common.rl", "#{ext}/redcloth_scan.java.rl"] do
+  ragel "#{ext}/RedclothInline.java", "#{ext}/redcloth_inline.java.rl"
+end
+file "#{ext}/RedclothAttributes.java" =>  ["#{ext}/redcloth_attributes.java.rl",   "#{ext}/redcloth_attributes.rl", "#{ext}/redcloth_common.java.rl",   "#{ext}/redcloth_common.rl", "#{ext}/redcloth_scan.java.rl"] do
+  ragel "#{ext}/RedclothAttributes.java", "#{ext}/redcloth_attributes.java.rl"
+end
+
+
+#### Optimization
+
+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
+
+
+#### Custom testing tasks
+
+task :test => [:compile]
+
+# 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
+
+def ensure_ragel_version(name)
+  @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] >= 3)
+    yield
+  else
+    STDERR.puts "Ragel 6.3 or greater is required to generate #{name}."
+    exit(1)
+  end
+end