redclothcoderay 0.1.0 → 0.1.1

data/CHANGELOG

@@ -0,0 +1,9 @@
+*0.1.1 (November 18th 2008)
+
+* Removed any references to Rails
+
+* Updated documentation.
+
+*0.1.0 (November 18th 2008)
+
+* Converted the plugin into a gem.

data/Manifest

@@ -1,8 +1,8 @@
-lib/redcloth_with_coderay/customized_textile_helper.rb
-lib/redcloth_with_coderay/redcloth_extension.rb
+CHANGELOG
 lib/redcloth_with_coderay.rb
 Manifest
 MIT-LICENSE
 Rakefile
 README
+redclothcoderay.gemspec
 test/redclothcoderay_test.rb

data/README

@@ -1,25 +1,50 @@
-Rails plugin that extends Redcloth to parse the <source> tag and syntax highlight it. Sample input:
+== Redcloth with CodeRay
 
-    Hello, this is *textilized*. It also has <source>@inline_code_examples</source>!
+Adds CodeRay syntax highlighting support to RedCloth, with a 'source' tag. See the examples below.
 
-    What about a multi-line code sample?
+A short summary of what you can do:
 
-    <source:html>
-    <h1>Hello, world!</h1>
-    </source>
-    
-Which will return (indented for clarity):
+* <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:
 
-    <p>Hello, this is <strong>textilized</strong>. It also has <code class="inline_code">
-        <span class="iv">@inline_code_examples</span>
-    </code>!</p>
+ sudo gem install redcloth
+ 
+ 
+== Using
 
-    <p>What about a multi-line code sample?</p>
+You have to specify that you want to use refs_syntax_highlighter when calling RedCloth#to_html.
 
-    <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>
+ require 'rubygems'
+ require 'redcloth'
+ require 'coderay'
+ require 'redclothcoderay'
+ 
+ RedCloth.new('I am *bold* and <source>@hi_tech</source>').to_html(:textile, :refs_syntax_highlighter)
 
-This plugin overrides the built-in "textilize helper", just call it as usual, in a helper or a view:
+== Example
 
-    <%= textilize(@post.body) %>
+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

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('redclothcoderay', '0.1.0') do |p|
+Echoe.new('redclothcoderay', '0.1.1') do |p|
   p.description    = "Integrates CodeRay with RedCloth by adding a <source> tag."
   p.url            = "http://redclothcoderay.rubyforge.org/"
   p.author         = "August Lilleaas"

data/lib/redcloth_with_coderay.rb

@@ -1,7 +1,28 @@
-$: << File.join(File.dirname(__FILE__), 'redcloth_with_coderay')
+class String
+  # Utility method to check if a string contains newlines.
+  def contains_newlines?
+    self =~ /\n/
+  end
+end
 
-require 'redcloth_extension'
-require 'customized_textile_helper'
+module RedclothWithCoderay
+  SINGLE_LINE = '<code class="inline_code">%s</code>'
+  MULTI_LINE = '<pre><code class="multiline_code">%s</code></pre>'
+  WRAPPER = '<notextile>%s</notextile>'
+  SOURCE_TAG_REGEXP = /([\t\n]?<source(?:\:([a-z]+))?>(.+?)<\/source>[\t\n]?)/m
+  
+  # The RedCloth extension that performs the syntax highlighting.
+  def refs_syntax_highlighter(text)
+    text.gsub!(SOURCE_TAG_REGEXP) do |m|
+      all_of_it = $~[1]
+      lang = ($~[2] || :ruby).to_sym
+      code = $~[3].strip
+      
+      wrap_in = all_of_it.contains_newlines? ? MULTI_LINE : SINGLE_LINE
+      highlighted = wrap_in % CodeRay.scan(code, lang).div(:wrap => nil, :css => :class)
+      WRAPPER % highlighted
+    end
+  end
+end
 
-RedCloth.class_eval { include RedclothWithCoderay }
-ActionView::Helpers.class_eval { include CustomizedTextileHelper }
+RedCloth.class_eval { include RedclothWithCoderay }

data/redclothcoderay.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redclothcoderay}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["August Lilleaas"]
   s.date = %q{2008-11-18}
   s.description = %q{Integrates CodeRay with RedCloth by adding a <source> tag.}
   s.email = %q{augustlilleaas@gmail.com}
-  s.extra_rdoc_files = ["lib/redcloth_with_coderay/customized_textile_helper.rb", "lib/redcloth_with_coderay/redcloth_extension.rb", "lib/redcloth_with_coderay.rb", "README"]
-  s.files = ["lib/redcloth_with_coderay/customized_textile_helper.rb", "lib/redcloth_with_coderay/redcloth_extension.rb", "lib/redcloth_with_coderay.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "test/redclothcoderay_test.rb", "redclothcoderay.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/redcloth_with_coderay.rb", "README"]
+  s.files = ["CHANGELOG", "lib/redcloth_with_coderay.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "redclothcoderay.gemspec", "test/redclothcoderay_test.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://redclothcoderay.rubyforge.org/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Redclothcoderay", "--main", "README"]

data/test/redclothcoderay_test.rb

@@ -3,9 +3,6 @@ require 'redcloth'
 require 'coderay'
 require 'test/unit'
 
-require 'action_controller'
-require 'action_controller/test_process'
-
 current_directory = File.dirname(__FILE__)
 $:.unshift File.join(current_directory, '..', 'lib')
 require 'redcloth_with_coderay'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redclothcoderay
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - August Lilleaas
@@ -49,20 +49,18 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- lib/redcloth_with_coderay/customized_textile_helper.rb
-- lib/redcloth_with_coderay/redcloth_extension.rb
+- CHANGELOG
 - lib/redcloth_with_coderay.rb
 - README
 files: 
-- lib/redcloth_with_coderay/customized_textile_helper.rb
-- lib/redcloth_with_coderay/redcloth_extension.rb
+- CHANGELOG
 - lib/redcloth_with_coderay.rb
 - Manifest
 - MIT-LICENSE
 - Rakefile
 - README
-- test/redclothcoderay_test.rb
 - redclothcoderay.gemspec
+- test/redclothcoderay_test.rb
 has_rdoc: true
 homepage: http://redclothcoderay.rubyforge.org/
 post_install_message: 

data/lib/redcloth_with_coderay/customized_textile_helper.rb

@@ -1,5 +0,0 @@
-module CustomizedTextileHelper
-  def textilize(text)
-    RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
-  end
-end

data/lib/redcloth_with_coderay/redcloth_extension.rb

@@ -1,24 +0,0 @@
-class String
-  def contains_newlines?
-    self =~ /\n/
-  end
-end
-
-module RedclothWithCoderay
-  SINGLE_LINE = '<code class="inline_code">%s</code>'
-  MULTI_LINE = '<pre><code class="multiline_code">%s</code></pre>'
-  WRAPPER = '<notextile>%s</notextile>'
-  SOURCE_TAG_REGEXP = /([\t\n]?<source(?:\:([a-z]+))?>(.+?)<\/source>[\t\n]?)/m
-  
-  def refs_syntax_highlighter(text)
-    text.gsub!(SOURCE_TAG_REGEXP) do |m|
-      all_of_it = $~[1]
-      lang = ($~[2] || :ruby).to_sym
-      code = $~[3].strip
-      
-      wrap_in = all_of_it.contains_newlines? ? MULTI_LINE : SINGLE_LINE
-      highlighted = wrap_in % CodeRay.scan(code, lang).div(:wrap => nil, :css => :class)
-      WRAPPER % highlighted
-    end
-  end
-end