webficient-rack-coderay 0.1.2

data/README.rdoc

@@ -0,0 +1,81 @@
+= CodeRay Syntax Highlighter for Rack
+
+Rack::Coderay parses text/html markup and replaces code with output
+from the CodeRay gem (http://coderay.rubychan.de/), producing syntax highlighting. 
+By default, this component looks for <pre lang="xxxx">...</pre>
+blocks, where 'xxxx' is any of the languages supported by CodeRay (e.g. 'ruby'). 
+See http://coderay.rubychan.de/doc/classes/CodeRay/Scanners.html
+
+For more information about the Rack specification, check out http://rack.rubyforge.org
+
+== Installation
+
+Prerequisites:
+
+  -Rack gem (sudo gem install rack)
+  -CodeRay gem (sudo gem install coderay)
+
+From Gem:
+
+  $ sudo gem install webficient-rack-coderay
+
+With a local working copy:
+
+  $ git clone git://github.com/webficient/rack-coderay.git
+  $ rake build && sudo rake install
+
+== Usage
+
+Basic Usage
+-----------
+
+Rack::Coderay is implemented as a piece of Rack middleware and can be used with
+any Rack-based application. If your application includes a rackup (`.ru`) file
+or uses Rack::Builder to construct the application pipeline, simply require
+and use as follows:
+
+  require 'rack/coderay'
+
+  use Rack::Coderay
+  run app
+
+Using with Rails
+----------------
+
+Add this to your `config/environment.rb`:
+
+  # above Rails::Initializer block
+  require 'rack/coderay'
+
+  # inside Rails::Initializer block
+  config.middleware.use Rack::Coderay
+
+You should now see `Rack::Coderay` listed in the middleware pipeline:
+
+  rake middleware
+    
+Configuration Options
+---------------------
+
+To override the default markup trigger (<pre lang="xxxx">), you
+can pass in a css or xpath selector as the second argument:
+
+  # Rails example
+  config.middleware.use Rack::Coderay, "//div[@lang]"
+          
+To set additional CodeRay gem options, pass a hash as the third argument:
+
+  # Rails example
+  config.middleware.use Rack::Coderay, 
+    "//pre[@lang]", 
+    :line_numbers => :table
+
+Stylesheet
+----------
+You can grab the latest CSS from the CodeRay site at http://coderay.rubychan.de/stylesheets/coderay.css.
+
+A copy has been embedded in the Rack::Coderay gem under the /resources directory for your convenience.
+
+== Copyright
+
+Copyright (c) 2009 Phil Misiowiec, Webficient LLC. See MIT-LICENSE for details.

data/lib/rack/coderay/parser.rb

@@ -0,0 +1,61 @@
+require 'coderay'
+require 'hpricot'
+
+module Rack::Coderay
+  # This class is the interface between Rack and the CodeRay gem
+  class Parser
+    
+    # Defaults for the Coderay gem config
+    DEFAULT_CODERAY_OPTS = {
+      :css => :class
+    }
+    
+    # Coderay gem options for HTML encoder, 
+    # see http://coderay.rubychan.de/doc/classes/CodeRay/Encoders/HTML.html
+    attr_accessor :coderay_options
+    
+    def initialize(app, markup_trigger, options = {})
+      @app = app
+      @markup_trigger = markup_trigger
+      self.coderay_options = DEFAULT_CODERAY_OPTS.merge(options)
+      raise "Markup trigger must include a 'lang' attribute" if !markup_trigger.include?('lang')
+    end
+    
+    # method required by Rack interface
+    def call(env)
+      call! env
+    end
+
+    # thread safe version using shallow copy of env
+    def call!(env)
+      @env = env.dup
+      status, headers, response = @app.call(@env)
+      if headers["Content-Type"] && headers["Content-Type"].include?("text/html")
+        headers.delete('Content-Length')
+        response = Rack::Response.new(
+          response = parse_and_replace(response.respond_to?(:body) ? response.body : response),
+          status,
+          headers
+        )
+        response.finish
+        response.to_a
+      else
+        [status, headers, response]
+      end
+    end
+    
+    private
+        
+      def parse_and_replace(content) #:nodoc:
+        doc = Hpricot(content.is_a?(Array) ? content[0] : content)
+        doc.search(@markup_trigger).each do |node|
+          node.swap(coderay_render(node.inner_html, node['lang']))
+        end
+        doc.to_original_html
+      end
+      
+      def coderay_render(text, language) #:nodoc:
+        ::CodeRay.scan(text, language.to_sym).div(self.coderay_options)
+      end
+  end
+end

data/lib/rack/coderay.rb

@@ -0,0 +1,46 @@
+require 'rack'
+
+# = CodeRay Syntax Highlighter Rack Appliance
+#
+# Rack::Coderay parses text/html markup and replaces code with output
+# from the CodeRay gem (http://coderay.rubychan.de/), producing syntax highlighting. 
+# By default, this component looks for <pre lang="xxxx">...</pre>
+# blocks, where 'xxxx' is any of the languages supported by CodeRay (e.g. 'ruby'). 
+# See http://coderay.rubychan.de/doc/classes/CodeRay/Scanners.html
+#
+# You can re-configure Rack::Coderay to look for a different trigger 
+# but it needs to have a 'lang' attribute.
+#
+# === Usage
+#
+# Within a rackup file (or with Rack::Builder):
+#   require 'rack/coderay'
+#   use Rack::Coderay
+#   run app
+#
+# Rails example:
+#   # above Rails::Initializer block
+#   require 'rack/coderay'
+#
+#   # inside Rails::Initializer block 
+#   config.middleware.use Rack::Coderay
+#
+# To override the default markup trigger (<pre lang="xxxx">), you
+# can pass in a css or xpath selector as the second argument:
+#
+#   config.middleware.use Rack::Coderay, "//div[@lang]"
+#
+# To set additional CodeRay gem options, pass a hash as the third argument:
+#
+#   config.middleware.use Rack::Coderay, 
+#     "//pre[@lang]", 
+#     :line_numbers => :table
+module Rack::Coderay
+  autoload :Parser, 'rack/coderay/parser'
+    
+  # Create a new Rack::Coderay middleware component that automatically
+  # highlights syntax using the CodeRay gem.
+  def self.new(backend, markup_trigger = "//pre[@lang]", options = {})
+    Parser.new(backend, markup_trigger, options)
+  end
+end

data/resources/coderay.css

@@ -0,0 +1,130 @@
+.CodeRay {
+  background-color: #f8f8f8;
+  border: 1px solid silver;
+  font-family: 'Courier New', 'Terminal', monospace;
+  color: #000;
+}
+.CodeRay pre { margin: 0px }
+
+div.CodeRay { }
+
+span.CodeRay { white-space: pre; border: 0px; padding: 2px }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px }
+table.CodeRay td { padding: 2px 4px; vertical-align: top }
+
+.CodeRay .line_numbers, .CodeRay .no {
+  background-color: #def;
+  color: gray;
+  text-align: right;
+}
+.CodeRay .line_numbers tt { font-weight: bold }
+.CodeRay .line_numbers .highlighted { color: red }
+.CodeRay .no { padding: 0px 4px }
+.CodeRay .code { width: 100% }
+
+ol.CodeRay { font-size: 10pt }
+ol.CodeRay li { white-space: pre }
+
+.CodeRay .code pre { overflow: auto }
+
+.CodeRay .debug { color:white ! important; background:blue ! important; }
+
+.CodeRay .af { color:#00C }
+.CodeRay .an { color:#007 }
+.CodeRay .at { color:#f08 }
+.CodeRay .av { color:#700 }
+.CodeRay .aw { color:#C00 }
+.CodeRay .bi { color:#509; font-weight:bold }
+.CodeRay .c  { color:#888; }
+
+.CodeRay .ch { color:#04D }
+.CodeRay .ch .k { color:#04D }
+.CodeRay .ch .dl { color:#039 }
+
+.CodeRay .cl { color:#B06; font-weight:bold }
+.CodeRay .cm { color:#A08; font-weight:bold }
+.CodeRay .co { color:#036; font-weight:bold }
+.CodeRay .cr { color:#0A0 }
+.CodeRay .cv { color:#369 }
+.CodeRay .de { color:#B0B; }
+.CodeRay .df { color:#099; font-weight:bold }
+.CodeRay .di { color:#088; font-weight:bold }
+.CodeRay .dl { color:black }
+.CodeRay .do { color:#970 }
+.CodeRay .dt { color:#34b }
+.CodeRay .ds { color:#D42; font-weight:bold }
+.CodeRay .e  { color:#666; font-weight:bold }
+.CodeRay .en { color:#800; font-weight:bold }
+.CodeRay .er { color:#F00; background-color:#FAA }
+.CodeRay .ex { color:#F00; font-weight:bold }
+.CodeRay .fl { color:#60E; font-weight:bold }
+.CodeRay .fu { color:#06B; font-weight:bold }
+.CodeRay .gv { color:#d70; font-weight:bold }
+.CodeRay .hx { color:#058; font-weight:bold }
+.CodeRay .i  { color:#00D; font-weight:bold }
+.CodeRay .ic { color:#B44; font-weight:bold }
+
+.CodeRay .il { background: #ddd; color: black }
+.CodeRay .il .il { background: #ccc }
+.CodeRay .il .il .il { background: #bbb }
+.CodeRay .il .idl { background: #ddd; font-weight: bold; color: #666 }
+.CodeRay .idl { background-color: #bbb; font-weight: bold; color: #666; }
+
+.CodeRay .im { color:#f00; }
+.CodeRay .in { color:#B2B; font-weight:bold }
+.CodeRay .iv { color:#33B }
+.CodeRay .la { color:#970; font-weight:bold }
+.CodeRay .lv { color:#963 }
+.CodeRay .oc { color:#40E; font-weight:bold }
+.CodeRay .of { color:#000; font-weight:bold }
+.CodeRay .op { }
+.CodeRay .pc { color:#038; font-weight:bold }
+.CodeRay .pd { color:#369; font-weight:bold }
+.CodeRay .pp { color:#579; }
+.CodeRay .ps { color:#00C; font-weight: bold; }
+.CodeRay .pt { color:#349; font-weight:bold }
+.CodeRay .r, .kw  { color:#080; font-weight:bold }
+
+.CodeRay .ke { color: #808; }
+.CodeRay .ke .dl { color: #606; }
+.CodeRay .ke .ch { color: #80f; }
+.CodeRay .vl { color: #088; }
+
+.CodeRay .rx { background-color:#fff0ff }
+.CodeRay .rx .k { color:#808 }
+.CodeRay .rx .dl { color:#404 }
+.CodeRay .rx .mod { color:#C2C }
+.CodeRay .rx .fu  { color:#404; font-weight: bold }
+
+.CodeRay .s { background-color:#fff0f0; color: #D20; }
+.CodeRay .s .s { background-color:#ffe0e0 }
+.CodeRay .s .s  .s { background-color:#ffd0d0 }
+.CodeRay .s .k { }
+.CodeRay .s .ch { color: #b0b; }
+.CodeRay .s .dl { color: #710; }
+
+.CodeRay .sh { background-color:#f0fff0; color:#2B2 }
+.CodeRay .sh .k { }
+.CodeRay .sh .dl { color:#161 }
+
+.CodeRay .sy { color:#A60 }
+.CodeRay .sy .k { color:#A60 }
+.CodeRay .sy .dl { color:#630 }
+
+.CodeRay .ta { color:#070 }
+.CodeRay .tf { color:#070; font-weight:bold }
+.CodeRay .ts { color:#D70; font-weight:bold }
+.CodeRay .ty { color:#339; font-weight:bold }
+.CodeRay .v  { color:#036 }
+.CodeRay .xt { color:#444 }
+
+.CodeRay .ins { background: #afa; }
+.CodeRay .del { background: #faa; }
+.CodeRay .chg { color: #aaf; background: #007; }
+.CodeRay .head { color: #f8f; background: #505 }
+
+.CodeRay .ins .ins { color: #080; font-weight:bold }
+.CodeRay .del .del { color: #800; font-weight:bold }
+.CodeRay .chg .chg { color: #66f; }
+.CodeRay .head .head { color: #f4f; }

data/test/rack_coderay_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+
+class RackCoderayTest < Test::Unit::TestCase
+
+  def get_response(path, body, markup_trigger = "//pre[@lang]", options = {})
+    app = Rack::Builder.new do
+      use Rack::Coderay, markup_trigger, options
+      run lambda { |env| [200, {'Content-Type' => 'text/html'}, [body] ] }
+    end
+    Rack::MockRequest.new(app).get(path)
+  end
+
+  context "Rack::Coderay" do
+    context "with default options" do
+      setup do
+        @response = get_response('/', %Q{
+          <pre lang="ruby">
+            class Foo
+              def bar
+              end
+            end
+          </pre>})
+      end
+      should "replace markup with CodeRay formatting" do
+        assert @response.body.include?(%Q{<div class="CodeRay">})
+      end
+    end
+    
+    context "with markup trigger set to a non-matching tag" do
+      setup do
+        @response = get_response('/', %Q{
+          <pre lang="ruby">
+            class Foo
+              def bar
+              end
+            end
+          </pre>}, '//div[@lang]')
+      end
+      should "not replace markup with CodeRay formatting" do
+        assert @response.body.include?(%Q{<pre lang="ruby">})
+      end
+    end
+        
+    context "with markup trigger set to //div[@lang]" do
+      setup do
+        @response = get_response('/', %Q{
+          <div lang="ruby">
+            class Foo
+              def bar
+              end
+            end
+          </div>}, '//div[@lang]')        
+      end
+      should "replace markup with CodeRay formatting" do
+        assert @response.body.include?(%Q{<div class="CodeRay">})
+      end
+    end
+    
+    context "with :css property set to :style" do
+      setup do
+        @response = get_response('/', %Q{
+          <pre lang="ruby">
+            class Foo
+              def bar
+              end
+            end
+          </pre>}, "//pre[@lang]", :css => :style)
+      end
+      should "replace markup with CodeRay formatting and use embedded styles" do
+        assert @response.body.include?(%Q{<span style="color:#080;font-weight:bold">})
+      end
+    end
+
+    context "with different order of attributes in markup trigger" do
+      setup do
+        @response = get_response('/', %Q{
+          <pre class="blah" lang="json">
+            { "just": "an", "example": 42 }
+          </pre>})
+      end
+      should "replace markup with CodeRay formatting" do
+        assert @response.body.include?(%Q{<div class="CodeRay">})
+      end
+    end
+      
+    context "with lang set to json" do
+      setup do
+        @response = get_response('/', %Q{
+          <pre lang="json">
+            { "just": "an", "example": 42 }
+          </pre>})
+      end
+      should "replace markup with CodeRay formatting" do
+        assert @response.body.include?(%Q{<div class="CodeRay">})
+      end
+    end
+    
+    context "when markup trigger is missing 'lang' attribute" do
+      should "raise a RuntimeError exception " do
+        assert_raise(RuntimeError) {  
+          @response = get_response('/', 'blah', '//pre')
+        }
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rack/coderay'
+require 'rack/mock'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: webficient-rack-coderay
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Phil Misiowiec
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This Rack middleware component uses the CodeRay gem to automatically format code syntax by detecting a specific container in the final rendered markup.
+email: phil@webficient.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/rack/coderay.rb
+- lib/rack/coderay/parser.rb
+- resources/coderay.css
+- README.rdoc
+has_rdoc: false
+homepage: http://github.com/webficient/rack-coderay
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that automatically formats code syntax using CodeRay gem
+test_files: 
+- test/rack_coderay_test.rb
+- test/test_helper.rb