RedCloth 4.0.4 → 4.1.0

data/CHANGELOG

@@ -1,4 +1,17 @@
-*4.0.4 (October 1, 2008)*
+=== 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]
 
@@ -23,14 +36,14 @@
 * Fixed empty block HTML disappearing. #64
 
 
-*4.0.3 (August 18, 2008)*
+=== 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)*
+=== 4.0.2 / August 15, 2008
 
 * Fixed link references/aliases not being recognized when they include hyphens. #36
 
@@ -49,7 +62,7 @@
 * Fixed HTML block ending tags terminating blocks prematurely. #22
 
 
-*4.0.1 (July 24, 2008)*
+=== 4.0.1 / July 24, 2008
 
 * Fixed lines starting with dashes being recognized as a definition list when there were no definitions.
 
@@ -59,7 +72,7 @@
 * Fixed links including prior quoted phrases. #17
 
 
-*4.0.0 (July 21, 2008)*
+=== 4.0.0 / July 21, 2008
 
 * New SuperRedCloth (RedCloth 4.0) is a total rewrite using Ragel for the parsing.
 

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/Rakefile

@@ -1,207 +1,135 @@
-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)
+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
-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"
+  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 = 'jruby'
+    else
+      self.files += %w[attributes inline scan].map {|f| "ext/redcloth_scan/redcloth_#{f}.c"}
     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.rubyforge_project = 'redcloth'
-        
-        s.files = PKG_FILES
-        
-        s.require_paths << "lib/case_sensitive_require"
-        #s.autorequire = "redcloth"  # no no no this is tHe 3v1l
-        s.extensions = FileList["ext/**/extconf.rb"].to_a
-        s.executables = ["redcloth"]
-    end
+#### Pre-compiled extensions for alternative platforms
 
-Rake::GemPackageTask.new(spec) do |p|
-    p.need_tar = true
-    p.gem_spec = spec
+def move_extensions
+  Dir["ext/**/*.{bundle,so,jar}"].each { |file| mv file, "lib/" }
 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(RUBY_PLATFORM =~ /win32/ ? 'nmake' : 'make')
+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
-  cp ext_so, "lib"
+  classpath ? "-cp #{classpath}" : ""
 end
 
-task "lib" do
-  directory "lib"
-end
+ext = "ext/redcloth_scan"
 
-["#{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] >= 3)
-      sh %{ragel #{source} -#{@code_style} -o #{name}}
-    else
-      STDERR.puts "Ragel 6.3 or greater is required to generate #{name}."
-      exit(1)
+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
-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
+when /java/
 
-Win32Spec = Gem::Specification.new do |s|
-  s.name = NAME
-  s.version = VERS
-  s.platform = 'x86-mswin32-60'
-  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.rubyforge_project = 'redcloth'
-
-  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
+  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
   
-WIN32_PKG_DIR = "pkg/#{NAME}-#{VERS}-mswin32"
-
-file WIN32_PKG_DIR => [:package] do
-  cp_r "pkg/#{NAME}-#{VERS}", "#{WIN32_PKG_DIR}"
+else
+  filename = "#{ext}/redcloth_scan.#{Config::CONFIG['DLEXT']}"
+  file filename => FileList["#{ext}/redcloth_scan.c", "#{ext}/redcloth_inline.c", "#{ext}/redcloth_attributes.c"]
 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
+task :compile => [filename]
 
-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, "../"
-    }
+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
 
-CLEAN.include WIN32_PKG_DIR
+# 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"]
 
-desc "Build and install the RedCloth gem on your system"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+# 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
 
-desc "Uninstall the RedCloth gem from your system"
-task :uninstall => [:clean] do
-  sh %{sudo gem uninstall #{NAME}}
+# 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)",
@@ -238,3 +166,40 @@ task :optimize do
   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