k33l0r-redclothcoderay 0.3.4 → 0.3.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 August Lilleaas
+
+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 OR COPYRIGHT HOLDERS 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/README.rdoc

@@ -0,0 +1,58 @@
+== 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.
+* You can also use the <code> tag.
+
+== Installing
+
+Installation as usual:
+
+ sudo gem install redclothcoderay
+ 
+You can also install the gem via github, to get the latest HEAD.
+
+ sudo gem install augustl-redclothcoderay --source=http://gems.github.com/
+ 
+== Using
+
+A short example.
+
+ require 'rubygems'
+ require 'redcloth'
+ require 'coderay'
+ require 'redclothcoderay'
+ 
+ RedCloth.new('I am *bold* and <source>@hi_tech</source>').to_html
+  
+You can specify the CodeRay options, too (defaults to RedclothCoderay::CODERAY_OPTIONS).
+
+  RedclothCoderay.coderay_options :line_numbers => :table
+
+== 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,23 @@
+require 'rake'
+require 'rake/testtask'
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'test')
+
+task :default => "test:v4"
+
+namespace :test do
+  desc "Test RedCloth 3"
+  task :v3 do
+    gem 'RedCloth', "< 4.0.0"
+    require 'RedCloth'
+    
+    load "test/redclothcoderay_test.rb"
+  end
+  
+  desc "Test RedCloth 4"
+  task :v4 do
+    gem 'RedCloth', ">= 4.0.0"
+    require 'RedCloth'
+    
+    load "test/redclothcoderay_test.rb"
+  end
+end

data/lib/redclothcoderay.rb

@@ -0,0 +1,38 @@
+module RedclothCoderay
+  SINGLE_LINE = '<code class="inline_code">%s</code>'
+  MULTI_LINE = '<div class="multiline_code">%s</div>'
+  SOURCE_TAG_REGEXP = /(([\t\n])?<source(?:\:([a-z]+))?>(.+?)<\/source>([\t\n])?)/m
+  CODERAY_OPTIONS = {:wrap => nil, :css => :class}
+  
+  def preprocess_with_syntax_highlighting(text)
+    text.gsub(SOURCE_TAG_REGEXP) do |m|
+      all_of_it = $~[1]
+      whitespace_before = $~[2]
+      lang = ($~[3] || :ruby).to_sym
+      code = $~[4].strip
+      whitespace_after = $~[5]
+      
+      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>#{whitespace_after}"
+    end
+  end
+  
+  def self.coderay_options(options)
+    CODERAY_OPTIONS.replace(options)
+  end
+end
+
+redcloth_thingie = RedCloth::VERSION.to_s < "4" ? RedCloth : RedCloth::TextileDoc
+
+redcloth_thingie.class_eval {
+  alias_method :_initialize, :initialize
+  
+  def initialize(text, *args)
+    text = preprocess_with_syntax_highlighting(text)
+    _initialize(text, *args)
+  end
+}
+
+redcloth_thingie.send(:include, RedclothCoderay)

data/redclothcoderay.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "redclothcoderay"
+  s.version = "0.3.5"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.date = Time.now
+  s.authors = ['August Lilleaas', 'Matias Korhonen']
+  s.email = "augustlilleaas@gmail.com"
+  s.files = ["lib", "lib/redclothcoderay.rb", "MIT-LICENSE", "Rakefile", "README.rdoc", "redclothcoderay.gemspec", "test", "test/coderay_options_test.rb", "test/redclothcoderay_test.rb", "test/test_helper.rb"]
+  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.description = %q{Adds CodeRay syntax highlighting support to RedCloth, with a ‘source’ tag.}
+end

data/test/coderay_options_test.rb

@@ -0,0 +1,18 @@
+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
+
+  def test_it_with_code_tag
+    RedclothCoderay.coderay_options :line_numbers => :table
+    assert_equal :table, RedclothCoderay::CODERAY_OPTIONS[:line_numbers]
+    assert RedCloth.new("<code>ugly_inline :stuff</code>").to_html(:refs_syntax_highlighter).include?(%{<table class="CodeRay"})
+  end
+
+end

data/test/redclothcoderay_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+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
+    
+    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
+    
+    assert result.include?(%Q{<strong>textilized</strong>})
+    assert result.include?(%Q{<div 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
+    
+    assert result.include?(%Q{<strong>textilized</strong>})
+    assert result.include?(%Q{<div class=\"multiline_code\">hello_to_you</div>})
+  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
+
+    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
+    assert result.include?(%Q{<h2>Hello, world.</h2>})
+  end
+  
+  # This case is a real case that caused borks, which lead to 0.3.0.
+  def test_odd_indents
+    text = %Q{Let's try, now.
+
+<source>
+class Person < ActiveRecord::Base
+  composed_of :address, :class_name => "Address", 
+    :mapping => [
+      [:address_street, :street],
+      [:address_postal_code, :postal_code]]
+end
+</source>}
+
+    result = RedCloth.new(text).to_html
+    
+    assert result.include?(%{[<span class="sy">:address_street</span>, <span class="sy">:street</span>],})
+    assert result.include?(%{composed_of <span class="sy">:address</span>, <span class="sy">:class_name</span> =&gt; <span class="s"><span class="dl">&quot;</span><span class="k">Address</span><span class="dl">&quot;</span></span>,})
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: k33l0r-redclothcoderay
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - August Lilleaas
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-08 00:00:00 -07:00
+date: 2009-09-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "Adds CodeRay syntax highlighting support to RedCloth, with a \xE2\x80\x98source\xE2\x80\x99 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."
+description: "Adds CodeRay syntax highlighting support to RedCloth, with a \xE2\x80\x98source\xE2\x80\x99 tag."
 email: augustlilleaas@gmail.com
 executables: []
 
@@ -41,8 +41,17 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib
+- lib/redclothcoderay.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- redclothcoderay.gemspec
+- test
+- test/coderay_options_test.rb
+- test/redclothcoderay_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://redclothcoderay.rubyforge.org
 post_install_message: