augustl-redclothcoderay 0.2.0

data/README

@@ -0,0 +1,64 @@
+== Redcloth with CodeRay
+
+Adds CodeRay syntax highlighting support to RedCloth, with a 'source' tag. See the examples below.
+
+A short summary of what you can do:
+
+* <source>foo</source> - Use this tag to produce CodeRay highlighted HTML for the contents within that tag. The language defaults to Ruby.
+* <source:css>foo</source> - Highlight as usual, but highlight as CSS. Supports everything CodeRay supports. Refer to the CodeRay documentation for a list of supported languages.
+
+== Installing
+
+Installation as usual:
+
+ sudo gem install redclothcoderay
+ 
+ 
+== Using
+
+You have to specify that you want to use refs_syntax_highlighter when calling RedCloth#to_html.
+
+ require 'rubygems'
+ require 'redcloth'
+ require 'coderay'
+ require 'redclothcoderay'
+ 
+ RedCloth.new('I am *bold* and <source>@hi_tech</source>').to_html(:textile, :refs_syntax_highlighter)
+ 
+You can also use the always_on method to always use the refs_syntax_highlighter parser when calling to_html
+
+  RedclothCoderay.always_on
+  
+You can specify the CodeRay options, too (defaults to RedclothCoderay::CODERAY_OPTIONS).
+
+  RedclothCoderay.coderay_options :line_numbers => :table
+ 
+== In Ruby on Rails
+
+In an initializer (config/initializers/[anything].rb) or at the bottom of environment.rb, add this line:
+
+  Redclothcoderay.always_on
+
+== Example
+
+This input:
+
+ Hello, this is *textilized*. It also has <source>@inline_code_examples</source>!
+ 
+ What about a multi-line code sample?
+ 
+ <source:html>
+ <h1>Hello, world!</h1>
+ </source>
+    
+produces this output (indented for clarity):
+
+ <p>Hello, this is <strong>textilized</strong>. It also has <code class="inline_code">
+   <span class="iv">@inline_code_examples</span>
+ </code>!</p>
+ 
+ <p>What about a multi-line code sample?</p>
+ 
+ <pre><code class=\"multiline_code\">
+   <span class=\"ta\">&amp;lt;h1&amp;gt;</span>Hello, world!<span class=\"ta\">&amp;lt;/h1&amp;gt;</span>
+ </code></pre>

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+task :test do
+  $LOAD_PATH << File.join(File.dirname(__FILE__), 'test')
+  load "test/redclothcoderay_test.rb"
+end

data/lib/redclothcoderay.rb

@@ -0,0 +1,44 @@
+module RedclothCoderay
+  SINGLE_LINE = '<code class="inline_code">%s</code>'
+  MULTI_LINE = '<pre><code class="multiline_code">%s</code></pre>'
+  SOURCE_TAG_REGEXP = /(([\t\n])?<source(?:\:([a-z]+))?>(.+?)<\/source>[\t\n]?)/m
+  CODERAY_OPTIONS = {:wrap => nil, :css => :class}
+  
+  # The RedCloth extension that performs the syntax highlighting.
+  def refs_syntax_highlighter(text)
+    text.gsub!(SOURCE_TAG_REGEXP) do |m|
+      all_of_it = $~[1]
+      whitespace_before = $~[2]
+      lang = ($~[3] || :ruby).to_sym
+      code = $~[4].strip
+      
+      wrap_in = all_of_it =~ /\n/ ? MULTI_LINE : SINGLE_LINE
+      highlighted = wrap_in % CodeRay.scan(code, lang).div(CODERAY_OPTIONS)
+      
+      "#{whitespace_before}<notextile>#{highlighted}</notextile>"
+    end
+  end
+  
+  # Adds the syntax highlighter to all RedCloth#to_htmls, so that you don't have to
+  # do that to_html(:textile, :refs_syntax_highlighter) thin.
+  def self.always_on
+    if RedCloth::VERSION.to_s < "4"
+      RedCloth::DEFAULT_RULES << :refs_syntax_highlighter
+    else
+      RedCloth::TextileDoc.class_eval {
+        alias :_to_html :to_html
+        
+        def to_html(*rules)
+          rules << :refs_syntax_highlighter
+          _to_html(*rules)
+        end
+      }
+    end
+  end
+  
+  def self.coderay_options(options)
+    CODERAY_OPTIONS.replace(options)
+  end
+end
+
+RedCloth.class_eval { include RedclothCoderay }

data/redclothcoderay.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = "redclothcoderay"
+  s.version = "0.2.0"
+  s.date = "2009-04-23"
+  s.authors = ["August Lilleaas"]
+  s.email = "augustlilleaas@gmail.com"
+  s.rubyforge_project = "redclothcoderay"
+  s.has_rdoc = true
+  s.add_dependency('RedCloth')
+  s.add_dependency('coderay')
+  s.summary = "Integrates CodeRay with RedCloth by adding a <source> tag."
+  s.homepage = "http://redclothcoderay.rubyforge.org"
+  s.extensions = ["Rakefile"]
+  s.files =
+    ["redclothcoderay.gemspec",
+    "README",
+    "Rakefile",
+    "lib/redclothcoderay.rb",
+    "test/redclothcoderay_test.rb",
+    "test/always_on_3_test.rb",
+    "test/always_on_4_test.rb",
+    "test/coderay_options_test.rb",
+    "test/test_helper.rb"]
+end

data/test/always_on_3_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+gem 'RedCloth', "< 4.0.0"
+require 'RedCloth'
+require 'redclothcoderay'
+
+# Is in isolation, because it meddles with states and shit. CBA to mock that.
+class AlwaysOn3Test < Test::Unit::TestCase
+  def test_always_on
+    RedclothCoderay.always_on
+    result = RedCloth.new(%{I thar. <source>inline_code</source> and *textile*!}).to_html
+    assert result.include?("<strong>textile</strong>")
+    assert result.include?('<code class="inline_code">')
+  end
+end

data/test/always_on_4_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+gem 'RedCloth', ">= 4.0.0"
+require 'RedCloth'
+require 'redclothcoderay'
+
+# Is in isolation, because it meddles with states and shit. CBA to mock that.
+class AlwaysOn3Test < Test::Unit::TestCase
+  def test_always_on
+    RedclothCoderay.always_on
+    result = RedCloth.new(%{I thar. <source>inline_code</source> and *textile*!}).to_html
+    assert result.include?("<strong>textile</strong>")
+    assert result.include?('<code class="inline_code">')
+  end
+end

data/test/coderay_options_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+require 'RedCloth'
+require 'redclothcoderay'
+
+class CoderayOptionsTest < Test::Unit::TestCase
+  def test_it
+    RedclothCoderay.coderay_options :line_numbers => :table
+    assert_equal :table, RedclothCoderay::CODERAY_OPTIONS[:line_numbers]
+    assert RedCloth.new("<source>ugly_inline :stuff</source>").to_html(:refs_syntax_highlighter).include?(%{<table class="CodeRay"})
+  end
+end

data/test/redclothcoderay_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+require 'redcloth'
+require 'redclothcoderay'
+
+class PluginTest < Test::Unit::TestCase
+  def test_parsing_inline_code
+    text = "Hello, this is *textilized*. It also has <source>@inline_code_examples</source>!"
+    result = RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
+    
+    assert_equal(%Q{<p>Hello, this is <strong>textilized</strong>. It also has <code class="inline_code"><span class="iv">@inline_code_examples</span></code>!</p>}, result)
+  end
+  
+  def test_parsing_multiline_code
+    text = %Q{Hello, this is *textilized*.
+    <source>
+    def hello_world
+      puts "Allright"
+    end
+    </source>}
+    result = RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
+    
+    assert result.include?(%Q{<strong>textilized</strong>})
+    assert result.include?(%Q{<pre><code class="multiline_code">})
+  end
+  
+  def test_one_liner_multiline_code
+    text = %Q{Hello, this is *textilized*.
+      
+    <source>
+    hello_to_you
+    </source>
+    }
+    result = RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
+    
+    assert result.include?(%Q{<strong>textilized</strong>})
+    assert result.include?(%Q{<pre><code class=\"multiline_code\">hello_to_you</code></pre>})
+  end
+  
+  def test_parsing_other_languages
+    text = %Q{Hello, this is *textilized* with some <source:html><p>HTML code</p></source>!}
+    result = RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
+
+    assert result.include?(%Q{<strong>textilized</strong>})
+    assert result.include?(%Q{<code class="inline_code"><span class="ta">&lt;p&gt;</span>HTML code<span class="ta">&lt;/p&gt;</span></code>})
+  end
+  
+  def test_after_a_header
+    text = %Q{h2. Hello, world.
+
+<source>
+hello_world
+</source>}
+    result = RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
+    assert result.include?(%Q{<h2>Hello, world.</h2>})
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'coderay'
+require 'test/unit'
+
+path = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << path unless $LOAD_PATH.include?(path)

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: augustl-redclothcoderay
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- August Lilleaas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: augustlilleaas@gmail.com
+executables: []
+
+extensions: 
+- Rakefile
+extra_rdoc_files: []
+
+files: 
+- redclothcoderay.gemspec
+- README
+- Rakefile
+- lib/redclothcoderay.rb
+- test/redclothcoderay_test.rb
+- test/always_on_3_test.rb
+- test/always_on_4_test.rb
+- test/coderay_options_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://redclothcoderay.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: redclothcoderay
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Integrates CodeRay with RedCloth by adding a <source> tag.
+test_files: []
+