RedCloth 4.1.9 → 4.2.0

data/lib/redcloth.rb

@@ -1,5 +1,3 @@
-$:.unshift(File.dirname(__FILE__))
-
 # If this is a frozen gem in Rails 2.1 and RedCloth 3.x was already
 # loaded by Rails' ActionView::Helpers::TextHelper, the user will get
 # "redcloth_scan.bundle: Class is not a module (TypeError)"
@@ -7,7 +5,15 @@ $:.unshift(File.dirname(__FILE__))
 # appears to be fixed in Edge Rails [51e4106].
 Object.send(:remove_const, :RedCloth) if Object.const_defined?(:RedCloth) && RedCloth.is_a?(Class)
 
-require 'redcloth_scan'
+module RedCloth
+  class NotCompiledError < LoadError; end
+end
+
+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."
+end
 require 'redcloth/version'
 require 'redcloth/textile_doc'
 require 'redcloth/formatters/base'

data/lib/redcloth/formatters/html.rb

@@ -43,12 +43,12 @@ module RedCloth::Formatters::HTML
       "#{"\n" if opts[:nest] > 1}#{"\t" * (opts[:nest] - 1)}<#{m}#{pba(opts)}>\n"
     end
     define_method("#{m}_close") do |opts|
-      "#{li_close}#{"\t" * (opts[:nest] - 1)}</#{m}>#{"\n" if opts[:nest] <= 1}"
+      "#{"\t" * (opts[:nest] - 1)}</#{m}>#{"\n" if opts[:nest] <= 1}"
     end
   end
   
   def li_open(opts)
-    "#{li_close unless opts.delete(:first)}#{"\t" * opts[:nest]}<li#{pba(opts)}>#{opts[:text]}"
+    "#{"\t" * opts[:nest]}<li#{pba(opts)}>#{opts[:text]}"
   end
   
   def li_close(opts=nil)

data/lib/redcloth/formatters/latex.rb

@@ -2,8 +2,8 @@ require 'yaml'
 
 module RedCloth::Formatters::LATEX
   include RedCloth::Formatters::Base
-  
-  ENTITIES = YAML::load(File.read(File.dirname(__FILE__)+'/latex_entities.yml')) 
+
+  ENTITIES = YAML::load(File.read(File.dirname(__FILE__)+'/latex_entities.yml'))
 
   module Settings
     # Maps CSS style names to latex formatting options
@@ -13,20 +13,29 @@ module RedCloth::Formatters::LATEX
   end
 
   RedCloth::TextileDoc.send(:include, Settings)
-  
+
   # headers
-  { :h1 => 'section*',
-    :h2 => 'subsection*',
-    :h3 => 'subsubsection*',
-    :h4 => 'textbf',
-    :h5 => 'textbf',
+  { :h1 => 'section',
+    :h2 => 'subsection',
+    :h3 => 'subsubsection',
+    :h4 => 'paragraph',
+    :h5 => 'subparagraph',
     :h6 => 'textbf',
   }.each do |m,tag| 
     define_method(m) do |opts| 
-      "\\#{tag}{#{opts[:text]}}\n\n" 
+      case opts[:align]
+      when 'left' then
+        "\\begin{flushleft}\\#{tag}{#{opts[:text]}}\\end{flushleft}\n\n" 
+      when 'right' then
+        "\\begin{flushright}\\#{tag}{#{opts[:text]}}\\end{flushright}\n\n" 
+      when 'center' then
+        "\\begin{center}\\#{tag}{#{opts[:text]}}\\end{center}\n\n" 
+      else
+        "\\#{tag}{#{opts[:text]}}\n\n"
+      end
     end 
   end 
-  
+
   # commands 
   { :strong => 'textbf',
     :em => 'emph',
@@ -34,41 +43,51 @@ module RedCloth::Formatters::LATEX
     :b  => 'textbf',
     :ins => 'underline',
     :del => 'sout',
-    :acronym => 'MakeUppercase',
-    :caps => 'MakeUppercase',
   }.each do |m,tag|
     define_method(m) do |opts|
       "\\#{tag}{#{opts[:text]}}"
     end
   end
-  
-  { :sup => '\ensuremath{^\textrm{#1}}',
-    :sub => '\ensuremath{_\textrm{#1}}',
+
+  # inline code
+  def code(opts)
+    opts[:block] ? opts[:text] : "\\verb@#{opts[:text]}@"
+  end
+
+  # acronyms
+  def acronym(opts)
+    "#{opts[:title]} (#{opts[:text]})"
+  end
+
+  # sub/superscripts
+  { :sup => '\textsuperscript{#1}',
+    :sub => '\textsubscript{#1}',
   }.each do |m, expr|
     define_method(m) do |opts|
       expr.sub('#1', opts[:text])
     end
   end
-  
+
   # environments
   { :pre  => 'verbatim',
-    :code => 'verbatim',
     :cite => 'quote',
     }.each do |m, env|
     define_method(m) do |opts|
       begin_chunk(env) + opts[:text] + end_chunk(env)
     end
   end
-  
+
   # ignore (or find a good solution later)
   [ :span,
     :div,
+    :caps
     ].each do |m|
     define_method(m) do |opts|
       opts[:text].to_s
     end
   end
-  
+
+  # lists
   { :ol => 'enumerate',
     :ul => 'itemize',
     }.each do |m, env|
@@ -77,22 +96,33 @@ module RedCloth::Formatters::LATEX
       "\\begin{#{env}}\n"
     end
     define_method("#{m}_close") do |opts|
-      "#{li_close}\\end{#{env}}\n\n"
+      "\\end{#{env}}\n\n"
     end
   end
-  
+
   def li_open(opts)
-    "#{li_close unless opts.delete(:first)}\t\\item #{opts[:text]}"
+    "  \\item #{opts[:text]}"
   end
-  
+
   def li_close(opts=nil)
     "\n"
   end
-  
+
+  # paragraphs
   def p(opts)
-    opts[:text] + "\n\n"
+    case opts[:align]
+    when 'left' then
+      "\\begin{flushleft}#{opts[:text]}\\end{flushleft}\n\n" 
+    when 'right' then
+      "\\begin{flushright}#{opts[:text]}\\end{flushright}\n\n" 
+    when 'center' then
+      "\\begin{center}#{opts[:text]}\\end{center}\n\n" 
+    else
+      "#{opts[:text]}\n\n"
+    end
   end
-  
+
+  # tables
   def td(opts)
     column = @table_row.size
     if opts[:colspan]
@@ -105,12 +135,12 @@ module RedCloth::Formatters::LATEX
     @table_row.push(opts[:text])
     return ""
   end
-  
+
   def tr_open(opts)
     @table_row = []
     return ""
   end
-  
+
   def tr_close(opts)
     multirow_columns = @table_multirow.find_all {|c,n| n > 0}
     multirow_columns.each do |c,n|
@@ -122,7 +152,7 @@ module RedCloth::Formatters::LATEX
     @table.push(@table_row)
     return ""
   end
-  
+
   # We need to know the column count before opening tabular context.
   def table_open(opts)
     @table = []
@@ -130,16 +160,21 @@ module RedCloth::Formatters::LATEX
     @table_multirow_next = {}
     return ""
   end
-  
+
+  # FIXME: need caption and label elements similar to image -> figure
   def table_close(opts)
-    output = "\\begin{tabular}{ #{"l " * @table[0].size }}\n"
+    output  = "\\begin{table}\n"
+    output << "  \\centering\n"
+    output << "  \\begin{tabular}{ #{"l " * @table[0].size }}\n"
     @table.each do |row|
-      output << "  #{row.join(" & ")} \\\\\n"
+      output << "    #{row.join(" & ")} \\\\\n"
     end
-    output << "\\end{tabular}\n"
+    output << "  \\end{tabular}\n"
+    output << "\\end{table}\n"
     output
   end
 
+  # code blocks
   def bc_open(opts)
     opts[:block] = true
     begin_chunk("verbatim") + "\n"
@@ -149,6 +184,7 @@ module RedCloth::Formatters::LATEX
     end_chunk("verbatim") + "\n"
   end
 
+  # block quotations
   def bq_open(opts)
     opts[:block] = true
     "\\begin{quotation}\n"
@@ -157,7 +193,8 @@ module RedCloth::Formatters::LATEX
   def bq_close(opts)
     "\\end{quotation}\n\n"
   end
-  
+
+  # links
   def link(opts)
     "\\href{#{opts[:href]}}{#{opts[:name]}}"
   end
@@ -174,71 +211,74 @@ module RedCloth::Formatters::LATEX
     # Resolve CSS styles if any have been set
     styling = opts[:class].to_s.split(/\s+/).collect { |style| latex_image_styles[style] }.compact.join ','
     # Build latex code
-    [ "\\begin{figure}[htp]",
+    [ "\\begin{figure}",
+      "  \\centering",
       "  \\includegraphics[#{styling}]{#{opts[:src]}}",
      ("  \\caption{#{escape opts[:title]}}" if opts[:title]),
      ("  \\label{#{escape opts[:alt]}}" if opts[:alt]),
       "\\end{figure}",
     ].compact.join "\n"
   end
-  
+
+  # footnotes
   def footno(opts)
     # TODO: insert a placeholder until we know the footnote content.
     # For this to work, we need some kind of post-processing...
     "\\footnotemark[#{opts[:text]}]"
   end
-  
+
   def fn(opts)
     "\\footnotetext[#{opts[:id]}]{#{opts[:text]}}"
   end
-  
+
+  # inline verbatim
   def snip(opts)
-    "\\begin{verbatim}#{opts[:text]}\\end{verbatim}"
+    "\\verb`#{opts[:text]}`"
   end
-  
+
   def quote1(opts)
     "`#{opts[:text]}'"
   end
-  
+
   def quote2(opts)
     "``#{opts[:text]}\""
   end
-  
+
   def ellipsis(opts)
     "#{opts[:text]}\\ldots{}"
   end
-  
+
   def emdash(opts)
     "---"
   end
-  
+
   def endash(opts)
     "--"
   end
-  
+
   def arrow(opts)
     "\\rightarrow{}"
   end
-  
+
   def trademark(opts)
     "\\texttrademark{}"
   end
-  
+
   def registered(opts)
     "\\textregistered{}"
   end
-  
+
   def copyright(opts)
     "\\copyright{}"
   end
-  
+
   # TODO: what do we do with (unknown) unicode entities ? 
   #
   def entity(opts)
     text = opts[:text][0..0] == '#' ? opts[:text][1..-1] : opts[:text] 
     ENTITIES[text]
   end
-  
+
   def dim(opts)
     opts[:text].gsub!('x', '\times')
     opts[:text].gsub!('"', "''")
@@ -246,8 +286,13 @@ module RedCloth::Formatters::LATEX
     "$#{opts[:text]}$#{period}"
   end
   
-  private
+  # TODO: what do we do with HTML?
+  def inline_html(opts)
+    opts[:text] || ""
+  end
   
+  private
+
   def escape(text)
     latex_esc(text)
   end
@@ -255,14 +300,14 @@ module RedCloth::Formatters::LATEX
   def escape_pre(text)
     text
   end
-  
+
   # Use this for block level commands that use \begin
   def begin_chunk(type)
     chunk_counter[type] += 1
     return "\\begin{#{type}}" if 1 == chunk_counter[type]
     ''
   end
-  
+
   # Use this for block level commands that use \end
   def end_chunk(type)
     chunk_counter[type] -= 1
@@ -270,7 +315,7 @@ module RedCloth::Formatters::LATEX
     return "\\end{#{type}}" if 0 == chunk_counter[type]
     ''
   end
-  
+
   def chunk_counter
     @chunk_counter ||= Hash.new 0
   end

data/lib/redcloth/formatters/latex_entities.yml

@@ -2354,7 +2354,7 @@ tilde: \~{}
 #HORIZONTAL TABULATION
 "9": \>,\=
 #LINE FEED
-"10": \\
+"10": "\n"
 #SINGLE LEFT-POINTING ANGLE QUOTATION MARK
 #requires fontenc:T1
 lsaquo: \guilsinglleft{}
@@ -2411,4 +2411,4 @@ euro: \texteuro{}
 "865": \t{}
 #REFERENCE MARK
 #requires textcomp
-"8251": \textreferencemark{}
+"8251": \textreferencemark{}

data/lib/redcloth/version.rb

@@ -1,8 +1,8 @@
 module RedCloth
   module VERSION
     MAJOR = 4
-    MINOR = 1
-    TINY  = 9
+    MINOR = 2
+    TINY  = 0
     RELEASE_CANDIDATE = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')
@@ -23,6 +23,11 @@ module RedCloth
   NAME = "RedCloth"
   GEM_NAME = NAME
   URL  = "http://redcloth.org/"
+  description = "Textile parser for Ruby."
 
-  DESCRIPTION = "#{NAME}-#{VERSION::FULL_VERSION} - Textile parser for Ruby.\n#{URL}"
-end
+  if RedCloth.const_defined?(:EXTENSION_LANGUAGE)
+    DESCRIPTION = "#{NAME}-#{VERSION::FULL_VERSION}-#{EXTENSION_LANGUAGE} - #{description}\n#{URL}"
+  else
+    DESCRIPTION = "#{NAME}-#{VERSION::FULL_VERSION} - #{description}\n#{URL}"
+  end
+end

data/lib/tasks/pureruby.rake

@@ -0,0 +1,12 @@
+Gem::Specification::PLATFORM_CROSS_TARGETS << "pureruby"
+
+task 'pureruby' do
+  reset_target 'pureruby'
+end
+
+if target = ARGV.detect do |arg| 
+  # Hack to get the platform set before the Rakefile evaluates
+    Gem::Specification::PLATFORM_CROSS_TARGETS.include? arg
+  end
+  reset_target target
+end

data/spec/custom_tags_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module FigureTag
+  def fig( opts )
+    label, img = opts[:text].split('|').map! {|str| str.strip}
+
+    html  = %Q{<div class="img" id="figure-#{label.tr('.', '-')}">\n}
+    html << %Q{  <a class="fig" href="/images/#{img}">\n}
+    html << %Q{    <img src="/images/thumbs/#{img}" alt="Figure #{label}" />\n}
+    html << %Q{  </a>\n}
+    html << %Q{  <p>Figure #{label}</p>\n}
+    html << %Q{<div>\n}
+  end
+end
+
+describe "custom tags" do
+  it "should recognize the custom tag" do
+    input  = %Q{The first line of text.\n\n}
+    input << %Q{fig. 1.1 | img.jpg\n\n}
+    input << %Q{The last line of text.\n}
+    r = RedCloth.new input
+    r.extend FigureTag
+
+    html  = %Q{<p>The first line of text.</p>\n}
+    html << %Q{<div class="img" id="figure-1-1">\n}
+    html << %Q{  <a class="fig" href="/images/img.jpg">\n}
+    html << %Q{    <img src="/images/thumbs/img.jpg" alt="Figure 1.1" />\n}
+    html << %Q{  </a>\n}
+    html << %Q{  <p>Figure 1.1</p>\n}
+    html << %Q{<div>\n}
+    html << %Q{<p>The last line of text.</p>}
+    
+    r.to_html.should == html
+  end
+
+  it "should fall back if custom tag isn't defined" do
+    r = RedCloth.new %Q/fig()>[no]{color:red}. 1.1 | img.jpg/
+    
+    r.to_html.should == "<p>fig()>[no]{color:red}. 1.1 | img.jpg</p>"
+  end
+  
+  it "should not call just regular string methods" do
+    r = RedCloth.new "next. "
+    r.extend FigureTag
+
+    html  = "<p>next. </p>"
+
+    r.to_html.should == html
+  end
+end