redclothcoderay 0.1.2 → 0.2.0

data/README

@@ -21,19 +21,23 @@ You have to specify that you want to use refs_syntax_highlighter when calling Re
  require 'rubygems'
  require 'redcloth'
  require 'coderay'
- require 'redcloth_with_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
 
-Ruby on Rails provides you with a textilize helper. You probably want to override it. Something like this is probably sensible:
+In an initializer (config/initializers/[anything].rb) or at the bottom of environment.rb, add this line:
 
- module ApplicationHelper
-   def textilize(text)
-     RedCloth.new(text).to_html(:textile, :refs_syntax_highlighter)
-   end
- end
+  Redclothcoderay.always_on
 
 == Example
 

data/Rakefile

@@ -1,11 +1,9 @@
-require 'rubygems'
 require 'rake'
-require 'echoe'
+require 'rake/testtask'
 
-Echoe.new('redclothcoderay', '0.1.2') do |p|
-  p.description    = "Integrates CodeRay with RedCloth by adding a <source> tag."
-  p.url            = "http://redclothcoderay.rubyforge.org/"
-  p.author         = "August Lilleaas"
-  p.email          = "augustlilleaas@gmail.com"
-  p.runtime_dependencies = ['RedCloth', 'coderay']
+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

@@ -1,41 +1,24 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
-  s.name = %q{redclothcoderay}
-  s.version = "0.1.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.name = "redclothcoderay"
+  s.version = "0.2.0"
+  s.date = "2009-04-23"
   s.authors = ["August Lilleaas"]
-  s.date = %q{2008-11-25}
-  s.description = %q{Integrates CodeRay with RedCloth by adding a <source> tag.}
-  s.email = %q{augustlilleaas@gmail.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/redcloth_with_coderay.rb", "README"]
-  s.files = ["CHANGELOG", "lib/redcloth_with_coderay.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "test/redclothcoderay_test.rb", "redclothcoderay.gemspec"]
+  s.email = "augustlilleaas@gmail.com"
+  s.rubyforge_project = "redclothcoderay"
   s.has_rdoc = true
-  s.homepage = %q{http://redclothcoderay.rubyforge.org/}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Redclothcoderay", "--main", "README"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{redclothcoderay}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Integrates CodeRay with RedCloth by adding a <source> tag.}
-  s.test_files = ["test/redclothcoderay_test.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
-      s.add_runtime_dependency(%q<coderay>, [">= 0"])
-      s.add_development_dependency(%q<echoe>, [">= 0"])
-    else
-      s.add_dependency(%q<RedCloth>, [">= 0"])
-      s.add_dependency(%q<coderay>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<RedCloth>, [">= 0"])
-    s.add_dependency(%q<coderay>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-  end
-end
+  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

@@ -1,12 +1,6 @@
-require 'rubygems'
+require 'test_helper'
 require 'redcloth'
-require 'coderay'
-require 'test/unit'
-
-current_directory = File.dirname(__FILE__)
-$:.unshift File.join(current_directory, '..', 'lib')
-require 'redcloth_with_coderay'
-
+require 'redclothcoderay'
 
 class PluginTest < Test::Unit::TestCase
   def test_parsing_inline_code

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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redclothcoderay
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - August Lilleaas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-25 00:00:00 +01:00
+date: 2009-04-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,45 +32,29 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Integrates CodeRay with RedCloth by adding a <source> tag.
+description: 
 email: augustlilleaas@gmail.com
 executables: []
 
-extensions: []
+extensions: 
+- Rakefile
+extra_rdoc_files: []
 
-extra_rdoc_files: 
-- CHANGELOG
-- lib/redcloth_with_coderay.rb
-- README
 files: 
-- CHANGELOG
-- lib/redcloth_with_coderay.rb
-- Manifest
-- MIT-LICENSE
-- Rakefile
+- redclothcoderay.gemspec
 - README
+- Rakefile
+- lib/redclothcoderay.rb
 - test/redclothcoderay_test.rb
-- redclothcoderay.gemspec
+- 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/
+homepage: http://redclothcoderay.rubyforge.org
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Redclothcoderay
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -83,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
@@ -92,5 +76,5 @@ rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Integrates CodeRay with RedCloth by adding a <source> tag.
-test_files: 
-- test/redclothcoderay_test.rb
+test_files: []
+

data/CHANGELOG

@@ -1,15 +0,0 @@
-*0.1.2 (November 25th 2008)
-
-* Fixed some issues with whitespaces before <source> tags
-
-* Removed String#has_newlines?, doing it "by hand" instead.
-
-*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/MIT-LICENSE

@@ -1,20 +0,0 @@
-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/Manifest

@@ -1,7 +0,0 @@
-CHANGELOG
-lib/redcloth_with_coderay.rb
-Manifest
-MIT-LICENSE
-Rakefile
-README
-test/redclothcoderay_test.rb

data/lib/redcloth_with_coderay.rb

@@ -1,22 +0,0 @@
-module RedclothWithCoderay
-  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
-  
-  # 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(:wrap => nil, :css => :class)
-      
-      "#{whitespace_before}<notextile>#{highlighted}</notextile>"
-    end
-  end
-end
-
-RedCloth.class_eval { include RedclothWithCoderay }