RedCloth 4.2.3 → 4.2.4.pre1

data/lib/redcloth.rb

@@ -5,15 +5,16 @@
 # appears to be fixed in Edge Rails [51e4106].
 Object.send(:remove_const, :RedCloth) if Object.const_defined?(:RedCloth) && RedCloth.is_a?(Class)
 
-module RedCloth
-  class NotCompiledError < LoadError; end
-end
-
+require 'rbconfig'
 begin
-  require 'redcloth_scan'
-rescue LoadError
-  raise RedCloth::NotCompiledError, "RedCloth uses native extensions. It's extremely fast but must be compiled. Installing the RedCloth gem is the easiest method."
+  prefix = Config::CONFIG['arch'] =~ /mswin|mingw/ ? "#{Config::CONFIG['MAJOR']}.#{Config::CONFIG['MINOR']}/" : ''
+  lib = "#{prefix}redcloth_scan"
+  require lib
+rescue LoadError => e
+  e.message << %{\nCouldn't load #{lib}\nThe $LOAD_PATH was:\n#{$LOAD_PATH.join("\n")}}
+  raise e
 end
+
 require 'redcloth/version'
 require 'redcloth/textile_doc'
 require 'redcloth/formatters/base'

data/lib/redcloth/formatters/latex_entities.yml

@@ -180,10 +180,10 @@ lsquor: ","
 "8218": ","
 #DOUBLE LOW-9 QUOTATION MARK
 #requires fontenc:T1
-ldquor: ,,
+ldquor: ',,'
 #DOUBLE LOW-9 QUOTATION MARK
 #requires fontenc:T1
-"8222": ,,
+"8222": ',,'
 #LATIN SMALL LIGATURE FF
 "64256": ff
 #LATIN SMALL LIGATURE FI
@@ -197,9 +197,9 @@ ldquor: ,,
 #LATIN SMALL LIGATURE FL
 "64258": fl
 #DOUBLE HIGH-REVERSED-9 QUOTATION MARK
-"8223": ``
+"8223": '``'
 #SINGLE HIGH-REVERSED-9 QUOTATION MARK
-"8219": `
+"8219": '`'
 #VERTICAL ELLIPSIS
 "8942": \vdots{}
 #HYPHEN BULLET
@@ -502,17 +502,17 @@ raquo: \guillemotright{}
 #requires fontenc:T1
 "187": \guillemotright{}
 #LEFT SINGLE QUOTATION MARK
-lsquo: `
+lsquo: '`'
 #LEFT SINGLE QUOTATION MARK
-"8216": `
+"8216": '`'
 #RIGHT SINGLE QUOTATION MARK
 rsquo: "'"
 #RIGHT SINGLE QUOTATION MARK
 "8217": "'"
 #LEFT DOUBLE QUOTATION MARK
-ldquo: ``
+ldquo: '``'
 #LEFT DOUBLE QUOTATION MARK
-"8220": ``
+"8220": '``'
 #RIGHT DOUBLE QUOTATION MARK
 rdquo: "''"
 #RIGHT DOUBLE QUOTATION MARK

data/lib/redcloth/version.rb

@@ -2,10 +2,10 @@ module RedCloth
   module VERSION
     MAJOR = 4
     MINOR = 2
-    TINY  = 3
-    RELEASE_CANDIDATE = nil
+    TINY  = 4
+    RELEASE_CANDIDATE = "pre1"
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
+    STRING = [MAJOR, MINOR, TINY, RELEASE_CANDIDATE].join('.')
     TAG = "REL_#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('_')}".upcase.gsub(/\.|-/, '_')
     FULL_VERSION = "#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('.')}"
     
@@ -26,8 +26,9 @@ module RedCloth
   description = "Textile parser for Ruby."
 
   if RedCloth.const_defined?(:EXTENSION_LANGUAGE)
-    DESCRIPTION = "#{NAME}-#{VERSION::FULL_VERSION}-#{EXTENSION_LANGUAGE} - #{description}\n#{URL}"
+    SUMMARY = "#{NAME}-#{VERSION::FULL_VERSION}-#{EXTENSION_LANGUAGE}"
   else
-    DESCRIPTION = "#{NAME}-#{VERSION::FULL_VERSION} - #{description}\n#{URL}"
+    SUMMARY = "#{NAME}-#{VERSION::FULL_VERSION}"
   end
+  DESCRIPTION = SUMMARY + " - #{description}\n#{URL}"
 end

data/redcloth.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+redcloth_dir = Dir.pwd =~ /redcloth\/tmp/ ? File.expand_path("../../../..", Dir.pwd) : File.expand_path("..", __FILE__)
+$LOAD_PATH.unshift File.join(redcloth_dir, 'lib')
+require "redcloth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "RedCloth"
+  s.version     = RedCloth::VERSION.to_s
+  s.authors     = ["Jason Garber", "why the lucky stiff", "Ola Bini"]
+  s.description = "Textile parser for Ruby."
+  s.summary     = RedCloth::SUMMARY
+  s.email       = "redcloth-upwards@rubyforge.org"
+  s.homepage    = "http://redcloth.org"
+  s.rubyforge_project = "redcloth"
+
+  s.rubygems_version   = "1.3.7"
+  s.default_executable = "redcloth"
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ["COPYING", "README", "CHANGELOG"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+
+  s.files -= Dir['ext/**/*']
+  s.files -= Dir['ragel/*']
+  s.files -= Dir['lib/redcloth.jar']
+  s.files -= Dir['lib/**/*.dll']
+  s.files -= Dir['lib/**/*.bundle']
+  s.files -= Dir['lib/**/*.so']
+  
+  s.platform = RUBY_PLATFORM[/java/] || 'ruby'
+  case s.platform.to_s
+  when /java/
+    s.files += ['lib/redcloth_scan.jar']
+  else # MRI or Rubinius
+    s.files += %w[attributes inline scan].map {|f| "ext/redcloth_scan/redcloth_#{f}.c"}
+    s.files += ["ext/redcloth_scan/redcloth.h"]
+    s.extensions = Dir['ext/**/extconf.rb']
+    s.add_development_dependency('rvm')
+  end
+
+  s.add_development_dependency('rake', '~> 0.8.7')
+  s.add_development_dependency('rspec', '~> 2.1')
+  s.add_development_dependency('diff-lcs')
+  s.add_development_dependency('rake-compiler', '~> 0.7.1')
+end

data/spec/benchmark_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Benchmarking", :type => :formatter do
+  version = RedCloth::VERSION.is_a?(Module) ? RedCloth::VERSION::STRING : RedCloth::VERSION
+  platform = RedCloth.const_defined?(:EXTENSION_LANGUAGE) ? RedCloth::EXTENSION_LANGUAGE : (version < "4.0.0" ? "ruby-regex" : "C")
+  
+  it "should not be too slow" do
+    puts "Benchmarking version #{version} compiled in #{platform}..."
+    fixtures.each do |name, doc|
+      if doc['html']
+        RedCloth.new(doc['in']).to_html
+      end
+    end
+  end
+end

data/spec/fixtures/code.yml

@@ -219,18 +219,18 @@ html: '<pre><code>Can I talk about &lt;h2&gt;Headings&lt;/h2&gt; here?</code></p
 name: escape latex standard symbols 
 in: "standard symbols # $ % & _ { }" 
 latex: "standard symbols \\# \\$ \\% \\& \\_ \\{ \\}\n\n" 
---- 
+---
 name: escape latex text symbols 
 in: "text symbols \\ ~ ^" 
 latex: "text symbols \\textbackslash{} \\~{} \\^{}\n\n" 
---- 
+---
 name: named html entities to latex 
 in: "&hellip; &frac12;" 
-latex: "\ldots{} \sfrac{1}{2}\n\n" 
---- 
+latex: "\\ldots{} \\sfrac{1}{2}\n\n" 
+---
 name: numeric html entities to latex 
 in: "&#8230; &#189;" 
-latex: "\ldots{} \sfrac{1}{2}\n\n"
+latex: "\\ldots{} \\sfrac{1}{2}\n\n"
 ---
 name: unclosed pre tag
 in: '<pre><code>This is a pre that will go unfinished'
@@ -249,7 +249,7 @@ latex: "\\verb@some_method(some_params, some => test);@ Oh dear this fails\n\n"
 ---
 name: code preserves initial square brackets
 description: usually square brackets are used for the language (English, French, Spanish...), but that doesn't make sense for code and apparently is needed for some computer languages.
-in: @[project]_dff.skjd@ 
+in: "@[project]_dff.skjd@"
 html: <p><code>[project]_dff.skjd</code></p>
 ---
 name: following also bracketed code in same line

data/spec/fixtures/table.yml

@@ -348,7 +348,7 @@ html: |-
   </table>
 ---
 name: with cell attributes
-in: |[en]. lang-ok|{color:red;}. style-ok|(myclass). class-ok|
+in: "|[en]. lang-ok|{color:red;}. style-ok|(myclass). class-ok|"
 html: |-
   <table>
   	<tr>
@@ -359,7 +359,7 @@ html: |-
   </table>
 ---
 name: with improper cell attributes
-in: |[en]lang-bad|{color:red;}style-bad|(myclass)class-bad|
+in: "|[en]lang-bad|{color:red;}style-bad|(myclass)class-bad|"
 html: |-
   <table>
   	<tr>

data/spec/fixtures/textism.yml

@@ -150,14 +150,14 @@ in: ~a phrase~
 html: <p><sub>a phrase</sub></p>
 latex: "\\textsubscript{a phrase}\n\n"
 ---
-in: %(myclass)SPAN%
+in: "%(myclass)SPAN%"
 html: <p><span class="myclass"><span class="caps">SPAN</span></span></p>
 no_span_caps_html: <p><span class="myclass">SPAN</span></p>
 ---
-in: %{color:red}red%
+in: "%{color:red}red%"
 html: <p><span style="color:red;">red</span></p>
 ---
-in: %[fr]rouge%
+in: "%[fr]rouge%"
 html: <p><span lang="fr">rouge</span></p>
 ---
 in: _(big)red_

data/spec/fixtures/threshold.yml

@@ -588,7 +588,7 @@ html: |-
 ---
 name: tables
 desc: Tables can be constructed using | “pipe” symbols to separate cells.
-in: |a|simple|table|
+in: "|a|simple|table|"
 html: |-
   <table>
   	<tr>
@@ -619,7 +619,7 @@ html: |-
 ---
 name: cell attributes
 desc: Attributes may be applied separately to individual cells, rows, and entire tables. Cell attributes are placed within each cell.
-in: |a|{color:red}. styled|cell|
+in: "|a|{color:red}. styled|cell|"
 html: |-
   <table>
   	<tr>
@@ -663,7 +663,7 @@ html: |-
 ---
 name: vertical alignment
 desc: Special alignment symbols are available for vertical alignment within table cells.
-in: |^. top alignment|
+in: "|^. top alignment|"
 html: |-
   <table>
   	<tr>

data/spec/spec_helper.rb

@@ -1,42 +1,36 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'redcloth'
 require 'yaml'
-
-class FormatterExampleGroup < Spec::Example::ExampleGroup
   
-  def self.examples_from_yaml(&block)
-    formatter = description.downcase
-    define_method("format_as_#{formatter}", &block)
-    
-    fixtures.each do |name, doc|
-      if doc[formatter]
-        example("should output #{formatter} for #{name}") do
-          output = method("format_as_#{formatter}").call(doc)
-          output.should == doc[formatter]
-        end
-      else
-        example("should not raise errors when rendering #{formatter} for #{name}") do
-          lambda { method("format_as_#{formatter}").call(doc) }.should_not raise_error
-        end
-      end
-    end
-  end
+def examples_from_yaml(&block)
+  formatter = description.downcase
+  define_method("format_as_#{formatter}", &block)
   
-  def self.fixtures
-    return @fixtures if @fixtures
-    @fixtures = {}
-    Dir[File.join(File.dirname(__FILE__), *%w[fixtures *.yml])].each do |testfile|
-      testgroup = File.basename(testfile, '.yml')
-      num = 0
-      YAML::load_documents(File.open(testfile)) do |doc|
-        name = doc['name'] || num
-        @fixtures["#{testgroup} #{name}"] = doc
-        num += 1
+  fixtures.each do |name, doc|
+    if doc[formatter]
+      example("should output #{formatter} for #{name}") do
+        output = method("format_as_#{formatter}").call(doc)
+        output.should == doc[formatter]
+      end
+    else
+      example("should not raise errors when rendering #{formatter} for #{name}") do
+        lambda { method("format_as_#{formatter}").call(doc) }.should_not raise_error
       end
     end
-    @fixtures
   end
-  
 end
 
-Spec::Example::ExampleGroupFactory.register(:formatter, FormatterExampleGroup)
+def fixtures
+  return @fixtures if @fixtures
+  @fixtures = {}
+  Dir[File.join(File.dirname(__FILE__), *%w[fixtures *.yml])].each do |testfile|
+    testgroup = File.basename(testfile, '.yml')
+    num = 0
+    YAML::load_documents(File.open(testfile)) do |doc|
+      name = doc['name'] || num
+      @fixtures["#{testgroup} #{name}"] = doc
+      num += 1
+    end
+  end
+  @fixtures
+end

data/tasks/compile.rake

@@ -0,0 +1,47 @@
+CLEAN.include [
+  'tmp',
+  '**/*.{o,obj,class,pdb,lib,def,exp,log,rbc}',
+  'ext/redcloth_scan/**/redcloth_*.rb', 
+  'ext/redcloth_scan/Makefile',  'ext/redcloth_scan/extconf.rb',
+]
+CLOBBER.include [
+  'pkg',
+  '**/*.{c}',
+  'lib/*.{bundle,so,o,obj,pdb,lib,def,exp,jar}', 
+  'lib/redcloth_scan.rb', 
+]
+
+# Load the Gem specification for the current platform (Ruby or JRuby).
+def gemspec(platform = RUBY_PLATFORM[/java/] || 'ruby')
+  Gem::Specification.load(File.expand_path('../../redcloth.gemspec', __FILE__))
+end
+
+require 'rake/extensiontask'
+require 'rake/javaextensiontask'
+require File.dirname(__FILE__) + '/ragel_extension_task'
+
+if defined?(JRUBY_VERSION)
+  Rake::JavaRagelExtensionTask.new('redcloth_scan', gemspec)
+else  
+  extconf = "ext/redcloth_scan/extconf.rb"
+  file extconf do
+    FileUtils.mkdir(File.dirname(extconf)) unless File.directory?(File.dirname(extconf))
+    File.open(extconf, "w") do |io|
+      io.write(<<-EOF)
+require 'mkmf'
+CONFIG['warnflags'].gsub!(/-Wshorten-64-to-32/, '') if CONFIG['warnflags']
+$CFLAGS << ' -O0 -Wall' if CONFIG['CC'] =~ /gcc/
+dir_config("redcloth_scan")
+have_library("c", "main")
+create_makefile("redcloth_scan")
+      EOF
+    end
+  end
+
+  Rake::RagelExtensionTask.new("redcloth_scan", gemspec) do |ext|    
+    if ENV['RUBY_CC_VERSION']
+      ext.cross_compile = true
+      ext.cross_platform = ['i386-mingw32', 'i386-mswin32-60']
+    end
+  end
+end

data/tasks/gems.rake

@@ -0,0 +1,38 @@
+Rake::Task['build'].prerequisites.unshift('compile')
+
+namespace :build do
+    desc "Generate Windows binary gems"
+    task :win do
+      unless File.directory?(File.expand_path('~/.rake-compiler'))
+        STDERR.puts <<-EOM
+
+  You must install Windows rubies to ~/.rake-compiler with:
+
+    rake-compiler cross-ruby VERSION=1.8.6-p398
+    # (Later 1.9.1 patch levels don't compile on mingw) 
+    rake-compiler cross-ruby VERSION=1.9.1-p243
+  EOM
+        exit(1)
+      end
+      # rvm and mingw ruby versions have to match to avoid errors
+      sh "rvm ruby-1.8.6-p398@redcloth rake cross compile RUBY_CC_VERSION=1.8.6"
+      sh "rvm ruby-1.9.1-p243@redcloth rake cross compile RUBY_CC_VERSION=1.9.1"
+      # This will copy the .so files to the proper place
+      sh "rake cross native gem RUBY_CC_VERSION=1.8.6:1.9.1"
+    end
+
+    desc 'Generate JRuby binary gem'
+    task :jruby do
+      sh "rvm jruby@redcloth rake java gem"
+    end
+
+    desc "Build ruby, windows, and jruby gems into the pkg directory"
+    task :all => [
+      "rvm:bundle",
+      :clobber,
+      :spec,
+      :jruby,
+      :win,
+      :build
+    ]
+end

data/tasks/ragel_extension_task.rb

@@ -0,0 +1,127 @@
+module Rake
+  module RagelGenerationTasks
+    RAGEL_INCLUDE_PATTERN = /include \w+ "([^"]+)";/
+    RAGEL_VERSION_COMMAND = "ragel -v"
+    
+    attr_accessor :rl_dir
+    attr_accessor :machines
+    
+    def init(name = nil, gem_spec = nil)
+      super
+      
+      @rl_dir = "ragel"
+      @machines = %w(scan inline attributes)
+    end
+    
+    def lang
+      raise NotImplementedError
+    end
+    
+    def source_files
+      @source_files ||= machines.map {|m| target(m) }
+    end
+    
+    def define
+      super
+      define_ragel_tasks
+    end
+    
+    def define_ragel_tasks
+      machines.each do |machine|
+        file target(machine) => [*ragel_sources(machine)] do
+          mkdir_p(File.dirname(target(machine))) unless File.directory?(File.dirname(target(machine)))
+          ensure_ragel_version
+          sh "ragel #{flags} #{lang_ragel(machine)} -o #{target(machine)}"
+        end
+        
+        file extconf => [target(machine)] if lang == 'c'
+      end
+    end
+
+    def target(machine)
+      {
+        'scan' => {
+          'c'    => "#{@ext_dir}/redcloth_scan.c",
+          'java' => "#{@ext_dir}/RedclothScanService.java",
+          'rb'   => "#{@ext_dir}/redcloth_scan.rb"
+        },
+        'inline' => {
+          'c'    => "#{@ext_dir}/redcloth_inline.c",
+          'java' => "#{@ext_dir}/RedclothInline.java",
+          'rb'   => "#{@ext_dir}/redcloth_inline.rb"
+        },
+        'attributes' => {
+          'c'    => "#{@ext_dir}/redcloth_attributes.c",
+          'java' => "#{@ext_dir}/RedclothAttributes.java",
+          'rb'   => "#{@ext_dir}/redcloth_attributes.rb"
+        }
+      }[machine][lang]
+    end
+
+    def lang_ragel(machine)
+      "#{@rl_dir}/redcloth_#{machine}.#{lang}.rl"
+    end
+
+    def ragel_sources(machine)
+      deps = [lang_ragel(machine), ragel_file_dependencies(lang_ragel(machine))].flatten.dup
+      deps += ["#{@ext_dir}/redcloth.h"] if lang == 'c'
+      deps
+      # FIXME: merge that header file into other places so it can be eliminated?
+    end
+    
+    def ragel_file_dependencies(ragel_file)
+      found = find_ragel_includes(ragel_file)
+      found + found.collect {|file| ragel_file_dependencies(file)}
+    end
+    
+    def find_ragel_includes(file)
+      File.open(file).grep(RAGEL_INCLUDE_PATTERN) { $1 }.map do |file|
+        "#{@rl_dir}/#{file}"
+      end
+    end
+
+    def flags
+      code_style_flag = preferred_code_style ? " -" + preferred_code_style : ""
+      "-#{host_language_flag}#{code_style_flag}"
+    end
+
+    def host_language_flag
+      {
+        'c'      => 'C',
+        'java'   => 'J',
+        'rb'     => 'R'
+      }[lang]
+    end
+
+    def preferred_code_style
+      {
+        'c'      => 'T0',
+        'java'   => nil,
+        'rb'     => 'F1'
+      }[lang]
+    end
+
+    def ensure_ragel_version
+      @ragel_v ||= `ragel -v`[/(version )(\S*)/,2].split('.').map{|s| s.to_i}
+      raise unless @ragel_v[0] > 6 || (@ragel_v[0] == 6 && @ragel_v[1] >= 3)
+    rescue
+      STDERR.puts "Ragel 6.3 or greater is required."
+      exit(1)
+    end
+    
+  end
+  class RagelExtensionTask < ExtensionTask
+    include RagelGenerationTasks
+
+    def lang
+      "c"
+    end
+  end  
+  class JavaRagelExtensionTask < JavaExtensionTask
+    include RagelGenerationTasks
+    
+    def lang
+      "java"
+    end
+  end
+end