coderay 0.9.8 → 1.0.0

data/lib/coderay/encoders/html/css.rb

@@ -2,7 +2,7 @@ module CodeRay
 module Encoders
 
   class HTML
-    class CSS
+    class CSS  # :nodoc:
 
       attr :stylesheet
 
@@ -20,11 +20,11 @@ module Encoders
         parse style::TOKEN_COLORS
       end
 
-      def [] *styles
+      def get_style styles
         cl = @classes[styles.first]
         return '' unless cl
         style = ''
-        1.upto(styles.size) do |offset|
+        1.upto styles.size do |offset|
           break if style = cl[styles[offset .. -1]]
         end
         # warn 'Style not found: %p' % [styles] if style.empty?
@@ -44,7 +44,7 @@ module Encoders
         ( [^\}]+ )?          # $2 = style
         \s* \} \s*
       |
-        ( . )                # $3 = error
+        ( [^\n]+ )           # $3 = error
       /mx
       def parse stylesheet
         stylesheet.scan CSS_CLASS_PATTERN do |selectors, style, error|
@@ -63,8 +63,3 @@ module Encoders
 
 end
 end
-
-if $0 == __FILE__
-  require 'pp'
-  pp CodeRay::Encoders::HTML::CSS.new
-end

data/lib/coderay/encoders/html/numbering.rb

@@ -0,0 +1,115 @@
+module CodeRay
+module Encoders
+
+  class HTML
+
+    module Numbering  # :nodoc:
+
+      def self.number! output, mode = :table, options = {}
+        return self unless mode
+
+        options = DEFAULT_OPTIONS.merge options
+
+        start = options[:line_number_start]
+        unless start.is_a? Integer
+          raise ArgumentError, "Invalid value %p for :line_number_start; Integer expected." % start
+        end
+        
+        anchor_prefix = options[:line_number_anchors]
+        anchor_prefix = 'line' if anchor_prefix == true
+        anchor_prefix = anchor_prefix.to_s[/\w+/] if anchor_prefix
+        anchoring =
+          if anchor_prefix
+            proc do |line|
+              line = line.to_s
+              anchor = anchor_prefix + line
+              "<a href=\"##{anchor}\" name=\"#{anchor}\">#{line}</a>"
+            end
+          else
+            proc { |line| line.to_s }  # :to_s.to_proc in Ruby 1.8.7+
+          end
+        
+        bold_every = options[:bold_every]
+        highlight_lines = options[:highlight_lines]
+        bolding =
+          if bold_every == false && highlight_lines == nil
+            anchoring
+          elsif highlight_lines.is_a? Enumerable
+            highlight_lines = highlight_lines.to_set
+            proc do |line|
+              if highlight_lines.include? line
+                "<strong class=\"highlighted\">#{anchoring[line]}</strong>"  # highlighted line numbers in bold
+              else
+                anchoring[line]
+              end
+            end
+          elsif bold_every.is_a? Integer
+            raise ArgumentError, ":bolding can't be 0." if bold_every == 0
+            proc do |line|
+              if line % bold_every == 0
+                "<strong>#{anchoring[line]}</strong>"  # every bold_every-th number in bold
+              else
+                anchoring[line]
+              end
+            end
+          else
+            raise ArgumentError, 'Invalid value %p for :bolding; false or Integer expected.' % bold_every
+          end
+        
+        line_count = output.count("\n")
+        position_of_last_newline = output.rindex(RUBY_VERSION >= '1.9' ? /\n/ : ?\n)
+        if position_of_last_newline
+          after_last_newline = output[position_of_last_newline + 1 .. -1]
+          ends_with_newline = after_last_newline[/\A(?:<\/span>)*\z/]
+          line_count += 1 if not ends_with_newline
+        end
+        
+        case mode
+        when :inline
+          max_width = (start + line_count).to_s.size
+          line_number = start
+          nesting = []
+          output.gsub!(/^.*$\n?/) do |line|
+            line.chomp!
+            open = nesting.join
+            line.scan(%r!<(/)?span[^>]*>?!) do |close,|
+              if close
+                nesting.pop
+              else
+                nesting << $&
+              end
+            end
+            close = '</span>' * nesting.size
+            
+            line_number_text = bolding.call line_number
+            indent = ' ' * (max_width - line_number.to_s.size)  # TODO: Optimize (10^x)
+            line_number += 1
+            "<span class=\"line-numbers\">#{indent}#{line_number_text}</span>#{open}#{line}#{close}\n"
+          end
+
+        when :table
+          line_numbers = (start ... start + line_count).map(&bolding).join("\n")
+          line_numbers << "\n"
+          line_numbers_table_template = Output::TABLE.apply('LINE_NUMBERS', line_numbers)
+
+          output.gsub!(/<\/div>\n/, '</div>')
+          output.wrap_in! line_numbers_table_template
+          output.wrapped_in = :div
+
+        when :list
+          raise NotImplementedError, 'The :list option is no longer available. Use :table.'
+
+        else
+          raise ArgumentError, 'Unknown value %p for mode: expected one of %p' %
+            [mode, [:table, :inline]]
+        end
+
+        output
+      end
+
+    end
+
+  end
+
+end
+end

data/lib/coderay/encoders/html/output.rb

@@ -3,44 +3,29 @@ module Encoders
 
   class HTML
 
-    # This module is included in the output String from thew HTML Encoder.
+    # This module is included in the output String of the HTML Encoder.
     #
     # It provides methods like wrap, div, page etc.
     #
     # Remember to use #clone instead of #dup to keep the modules the object was
     # extended with.
     #
-    # TODO: more doc.
+    # TODO: Rewrite this without monkey patching.
     module Output
 
-      require 'coderay/encoders/html/numerization.rb'
-
       attr_accessor :css
 
       class << self
 
-        # This makes Output look like a class.
-        #
-        # Example:
-        #
-        #  a = Output.new '<span class="co">Code</span>'
-        #  a.wrap! :page
-        def new string, css = CSS.new, element = nil
-          output = string.clone.extend self
-          output.wrapped_in = element
-          output.css = css
-          output
-        end
-
         # Raises an exception if an object that doesn't respond to to_str is extended by Output,
         # to prevent users from misuse. Use Module#remove_method to disable.
-        def extended o
+        def extended o  # :nodoc:
           warn "The Output module is intended to extend instances of String, not #{o.class}." unless o.respond_to? :to_str
         end
 
-        def make_stylesheet css, in_tag = false
+        def make_stylesheet css, in_tag = false  # :nodoc:
           sheet = css.stylesheet
-          sheet = <<-CSS if in_tag
+          sheet = <<-'CSS' if in_tag
 <style type="text/css">
 #{sheet}
 </style>
@@ -48,27 +33,13 @@ module Encoders
           sheet
         end
 
-        def page_template_for_css css
+        def page_template_for_css css  # :nodoc:
           sheet = make_stylesheet css
           PAGE.apply 'CSS', sheet
         end
 
-        # Define a new wrapper. This is meta programming.
-        def wrapper *wrappers
-          wrappers.each do |wrapper|
-            define_method wrapper do |*args|
-              wrap wrapper, *args
-            end
-            define_method "#{wrapper}!".to_sym do |*args|
-              wrap! wrapper, *args
-            end
-          end
-        end
-
       end
 
-      wrapper :div, :span, :page
-
       def wrapped_in? element
         wrapped_in == element
       end
@@ -78,10 +49,6 @@ module Encoders
       end
       attr_writer :wrapped_in
 
-      def wrap_in template
-        clone.wrap_in! template
-      end
-
       def wrap_in! template
         Template.wrap! self, template, 'CONTENT'
         self
@@ -118,15 +85,13 @@ module Encoders
         self
       end
 
-      def wrap *args
-        clone.wrap!(*args)
-      end
-
       def stylesheet in_tag = false
         Output.make_stylesheet @css, in_tag
       end
 
-      class Template < String
+#-- don't include the templates in docu
+
+      class Template < String  # :nodoc:
 
         def self.wrap! str, template, target
           target = Regexp.new(Regexp.escape("<%#{target}%>"))
@@ -147,47 +112,34 @@ module Encoders
           end
         end
 
-        module Simple
-          def ` str  #` <-- for stupid editors
-            Template.new str
-          end
-        end
       end
 
-      extend Template::Simple
+      SPAN = Template.new '<span class="CodeRay"><%CONTENT%></span>'
 
-#-- don't include the templates in docu
-
-      SPAN = `<span class="CodeRay"><%CONTENT%></span>`
-
-      DIV = <<-`DIV`
+      DIV = Template.new <<-DIV
 <div class="CodeRay">
   <div class="code"><pre><%CONTENT%></pre></div>
 </div>
       DIV
 
-      TABLE = <<-`TABLE`
+      TABLE = Template.new <<-TABLE
 <table class="CodeRay"><tr>
-  <td class="line_numbers" title="click to toggle" onclick="with (this.firstChild.style) { display = (display == '') ? 'none' : '' }"><pre><%LINE_NUMBERS%></pre></td>
-  <td class="code"><pre ondblclick="with (this.style) { overflow = (overflow == 'auto' || overflow == '') ? 'visible' : 'auto' }"><%CONTENT%></pre></td>
+  <td class="line-numbers" title="double click to toggle" ondblclick="with (this.firstChild.style) { display = (display == '') ? 'none' : '' }"><pre><%LINE_NUMBERS%></pre></td>
+  <td class="code"><pre><%CONTENT%></pre></td>
 </tr></table>
       TABLE
-      # title="double click to expand"
-
-      LIST = <<-`LIST`
-<ol class="CodeRay">
-<%CONTENT%>
-</ol>
-      LIST
 
-      PAGE = <<-`PAGE`
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="de">
+      PAGE = Template.new <<-PAGE
+<!DOCTYPE html>
+<html>
 <head>
-  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title></title>
   <style type="text/css">
+.CodeRay .line-numbers a {
+  text-decoration: inherit;
+  color: inherit;
+}
 <%CSS%>
   </style>
 </head>

data/lib/coderay/encoders/json.rb

@@ -1,69 +1,83 @@
-($:.unshift '../..'; require 'coderay') unless defined? CodeRay
 module CodeRay
 module Encoders
   
-  # = JSON Encoder
+  # A simple JSON Encoder.
+  # 
+  # Example:
+  #  CodeRay.scan('puts "Hello world!"', :ruby).json
+  # yields
+  #  [
+  #    {"type"=>"text", "text"=>"puts", "kind"=>"ident"},
+  #    {"type"=>"text", "text"=>" ", "kind"=>"space"},
+  #    {"type"=>"block", "action"=>"open", "kind"=>"string"},
+  #    {"type"=>"text", "text"=>"\"", "kind"=>"delimiter"},
+  #    {"type"=>"text", "text"=>"Hello world!", "kind"=>"content"},
+  #    {"type"=>"text", "text"=>"\"", "kind"=>"delimiter"},
+  #    {"type"=>"block", "action"=>"close", "kind"=>"string"},
+  #  ]
   class JSON < Encoder
     
+    begin
+      require 'json'
+    rescue LoadError
+      begin
+        require 'rubygems' unless defined? Gem
+        gem 'json'
+        require 'json'
+      rescue LoadError
+        $stderr.puts "The JSON encoder needs the JSON library.\n" \
+          "Please gem install json."
+        raise
+      end
+    end
+    
     register_for :json
     FILE_EXTENSION = 'json'
     
   protected
     def setup options
-      begin
-        require 'json'
-      rescue LoadError
-        require 'rubygems'
-        require 'json'
+      super
+      
+      @first = true
+      @out << '['
+    end
+    
+    def finish options
+      @out << ']'
+    end
+    
+    def append data
+      if @first
+        @first = false
+      else
+        @out << ','
       end
-      @out = []
+      
+      @out << data.to_json
     end
     
+  public
     def text_token text, kind
-      { :type => 'text', :text => text, :kind => kind }
+      append :type => 'text', :text => text, :kind => kind
     end
     
-    def block_token action, kind
-      { :type => 'block', :action => action, :kind => kind }
+    def begin_group kind
+      append :type => 'block', :action => 'open', :kind => kind
     end
     
-    def finish options
-      @out.to_json
+    def end_group kind
+      append :type => 'block', :action => 'close', :kind => kind
+    end
+    
+    def begin_line kind
+      append :type => 'block', :action => 'begin_line', :kind => kind
+    end
+    
+    def end_line kind
+      append :type => 'block', :action => 'end_line', :kind => kind
     end
     
   end
   
 end
 end
-
-if $0 == __FILE__
-  $VERBOSE = true
-  $: << File.join(File.dirname(__FILE__), '..')
-  eval DATA.read, nil, $0, __LINE__ + 4
-end
-
-__END__
-require 'test/unit'
-$:.delete '.'
-require 'rubygems' if RUBY_VERSION < '1.9'
-
-class JSONEncoderTest < Test::Unit::TestCase
-  
-  def test_json_output
-    tokens = CodeRay.scan <<-RUBY, :ruby
-puts "Hello world!"
-    RUBY
-    require 'json'
-    assert_equal [
-      {"type"=>"text", "text"=>"puts", "kind"=>"ident"},
-      {"type"=>"text", "text"=>" ", "kind"=>"space"},
-      {"type"=>"block", "action"=>"open", "kind"=>"string"},
-      {"type"=>"text", "text"=>"\"", "kind"=>"delimiter"},
-      {"type"=>"text", "text"=>"Hello world!", "kind"=>"content"},
-      {"type"=>"text", "text"=>"\"", "kind"=>"delimiter"},
-      {"type"=>"block", "action"=>"close", "kind"=>"string"},
-      {"type"=>"text", "text"=>"\n", "kind"=>"space"}
-    ], JSON.load(tokens.json)
-  end
-  
-end