coderay 0.8.357 → 0.9.1

data/lib/README

@@ -18,7 +18,7 @@ And with line numbers.
 * is what everybody should have on their website
 * solves all your problems and makes the girls run after you
 
-Version: 0.8.4
+Version: 0.9.1
 Author:: murphy (Kornelius Kalnbach)
 Contact:: murphy rubychan de
 Website:: coderay.rubychan.de[http://coderay.rubychan.de]
@@ -88,10 +88,11 @@ Please report errors in this documentation to <murphy rubychan de>.
 * Jeremy Hinegardner for finding the shebang-on-empty-file bug in FileType.
 * Charles Oliver Nutter and Yehuda Katz for helping me benchmark CodeRay on JRuby.
 * Andreas Neuhaus for pointing out a markup bug in coderay/for_redcloth.
+* 0xf30fc7 for the FileType patch concerning Delphi file extensions.
 * The folks at redmine.org - thank you for using and fixing CodeRay!
 * matz and all Ruby gods and gurus
 * The inventors of: the computer, the internet, the true color display, HTML &
-  CSS, VIM, RUBY, pizza, microwaves, guitars, scouting, programming, anime, 
+  CSS, VIM, Ruby, pizza, microwaves, guitars, scouting, programming, anime, 
   manga, coke and green ice tea.
 
 Where would we be without all those people?
@@ -107,7 +108,7 @@ Where would we be without all those people?
 * Subversion[http://subversion.tigris.org/]
 * Redmine[http://redmine.org/]
 * Firefox[http://www.mozilla.org/products/firefox/],
-  Firebug[http://getfirebug.com/], and
+  Firebug[http://getfirebug.com/], Safari[http://www.apple.com/safari/], and
   Thunderbird[http://www.mozilla.org/products/thunderbird/]
 * RubyGems[http://docs.rubygems.org/] and Rake[http://rake.rubyforge.org/]
 * TortoiseSVN[http://tortoisesvn.tigris.org/] using Apache via

data/lib/coderay.rb

@@ -132,9 +132,10 @@ module CodeRay
   # Minor: feature milestone
   # Teeny: development state, 0 for pre-release
   # Revision: Subversion Revision number (generated on rake gem:make)
-  VERSION = '0.8'
+  VERSION = '0.9.1'
 
   require 'coderay/tokens'
+  require 'coderay/token_classes'
   require 'coderay/scanner'
   require 'coderay/encoder'
   require 'coderay/duo'

data/lib/coderay/encoder.rb

@@ -1,5 +1,3 @@
-require "stringio"
-
 module CodeRay
 
   # This module holds the Encoder class and its subclasses.
@@ -126,26 +124,36 @@ module CodeRay
         @out = ''
       end
 
-      # Called with +text+ and +kind+ of the currently scanned token.
+      # Called with +content+ and +kind+ of the currently scanned token.
       # For simple scanners, it's enougth to implement this method.
       #
       # By default, it calls text_token or block_token, depending on
-      # whether +text+ is a String.
-      def token text, kind
-        out =
-          if text.is_a? ::String
-            text_token text, kind
-          elsif text.is_a? ::Symbol
-            block_token text, kind
+      # whether +content+ is a String.
+      def token content, kind
+        encoded_token =
+          if content.is_a? ::String
+            text_token content, kind
+          elsif content.is_a? ::Symbol
+            block_token content, kind
           else
-            raise 'Unknown token text type: %p' % text
+            raise 'Unknown token content type: %p' % [content]
           end
-        @out << out if defined?(@out) && @out
+        append_encoded_token_to_output encoded_token
       end
-
+      
+      def append_encoded_token_to_output encoded_token
+        @out << encoded_token if encoded_token && defined?(@out) && @out
+      end
+      
+      # Called for each text token ([text, kind]), where text is a String.
       def text_token text, kind
       end
-
+      
+      # Called for each block (non-text) token ([action, kind]),
+      # where +action+ is a Symbol.
+      # 
+      # Calls open_token, close_token, begin_line, and end_line according to
+      # the value of +action+.
       def block_token action, kind
         case action
         when :open
@@ -160,6 +168,22 @@ module CodeRay
           raise 'unknown block action: %p' % action
         end
       end
+      
+      # Called for each block token at the start of the block ([:open, kind]).
+      def open_token kind
+      end
+      
+      # Called for each block token end of the block ([:close, kind]).
+      def close_token kind
+      end
+      
+      # Called for each line token block at the start of the line ([:begin_line, kind]).
+      def begin_line kind
+      end
+      
+      # Called for each line token block at the end of the line ([:end_line, kind]).
+      def end_line kind
+      end
 
       # Called with merged options after encoding starts.
       # The return value is the result of encoding, typically @out.
@@ -173,7 +197,9 @@ module CodeRay
       # TokenStream or a Tokens object.
       if RUBY_VERSION >= '1.9'
         def compile tokens, options
-          tokens.each { |text, kind| token text, kind }  # FIXME for Ruby 1.9?
+          for text, kind in tokens
+            token text, kind
+          end
         end
       else
         def compile tokens, options

data/lib/coderay/encoders/_map.rb

@@ -1,8 +1,10 @@
 module CodeRay
 module Encoders
 
-  map :stats => :statistic,
+  map \
+    :loc => :lines_of_code,
     :plain => :text,
+    :stats => :statistic,
     :tex => :latex
 
 end

data/lib/coderay/encoders/comment_filter.rb

@@ -0,0 +1,43 @@
+($:.unshift '../..'; require 'coderay') unless defined? CodeRay
+module CodeRay
+module Encoders
+  
+  load :token_class_filter
+  
+  class CommentFilter < TokenClassFilter
+    
+    register_for :comment_filter
+    
+    DEFAULT_OPTIONS = superclass::DEFAULT_OPTIONS.merge \
+      :exclude => [:comment]
+    
+  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'
+
+class CommentFilterTest < Test::Unit::TestCase
+  
+  def test_filtering_comments
+    tokens = CodeRay.scan <<-RUBY, :ruby
+#!/usr/bin/env ruby
+# a minimal Ruby program
+puts "Hello world!"
+    RUBY
+    assert_equal <<-RUBY_FILTERED, tokens.comment_filter.text
+#!/usr/bin/env ruby
+
+puts "Hello world!"
+    RUBY_FILTERED
+  end
+  
+end

data/lib/coderay/encoders/div.rb

@@ -9,10 +9,9 @@ module Encoders
 
     register_for :div
 
-    DEFAULT_OPTIONS = HTML::DEFAULT_OPTIONS.merge({
+    DEFAULT_OPTIONS = HTML::DEFAULT_OPTIONS.merge \
       :css => :style,
-      :wrap => :div,
-    })
+      :wrap => :div
 
   end
 

data/lib/coderay/encoders/filter.rb

@@ -0,0 +1,75 @@
+($:.unshift '../..'; require 'coderay') unless defined? CodeRay
+module CodeRay
+module Encoders
+  
+  class Filter < Encoder
+    
+    register_for :filter
+    
+  protected
+    def setup options
+      @out = Tokens.new
+    end
+    
+    def text_token text, kind
+      [text, kind] if include_text_token? text, kind
+    end
+    
+    def include_text_token? text, kind
+      true
+    end
+    
+    def block_token action, kind
+      [action, kind] if include_block_token? action, kind
+    end
+    
+    def include_block_token? action, kind
+      true
+    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'
+
+class FilterTest < Test::Unit::TestCase
+  
+  def test_creation
+    assert CodeRay::Encoders::Filter < CodeRay::Encoders::Encoder
+    filter = nil
+    assert_nothing_raised do
+      filter = CodeRay.encoder :filter
+    end
+    assert_kind_of CodeRay::Encoders::Encoder, filter
+  end
+  
+  def test_filtering_text_tokens
+    tokens = CodeRay::Tokens.new
+    10.times do |i|
+      tokens << [i.to_s, :index]
+    end
+    assert_equal tokens, CodeRay::Encoders::Filter.new.encode_tokens(tokens)
+    assert_equal tokens, tokens.filter
+  end
+  
+  def test_filtering_block_tokens
+    tokens = CodeRay::Tokens.new
+    10.times do |i|
+      tokens << [:open, :index]
+      tokens << [i.to_s, :content]
+      tokens << [:close, :index]
+    end
+    assert_equal tokens, CodeRay::Encoders::Filter.new.encode_tokens(tokens)
+    assert_equal tokens, tokens.filter
+  end
+  
+end

data/lib/coderay/encoders/html.rb

@@ -1,4 +1,4 @@
-require "set"
+require 'set'
 
 module CodeRay
 module Encoders
@@ -41,6 +41,12 @@ module Encoders
   #
   # Default: nil
   #
+  # === :title
+  # 
+  # The title of the HTML page (works only when :wrap is set to :page.)
+  #
+  # Default: 'CodeRay output'
+  #
   # === :line_numbers
   # Include line numbers in :table, :inline, :list or nil (no line numbers)
   #
@@ -56,6 +62,16 @@ module Encoders
   #
   # Default: 10
   #
+  # === :highlight_lines
+  # 
+  # Highlights certain line numbers.
+  # Can be any Enumerable, typically just an Array or Range, of numbers.
+  # 
+  # Bolding is deactivated when :highlight_lines is set. It only makes sense
+  # in combination with :line_numbers.
+  #
+  # Default: nil
+  #
   # === :hint
   # Include some information into the output using the title attribute.
   # Can be :info (show token type on mouse-over), :info_long (with full path)
@@ -72,16 +88,16 @@ module Encoders
     DEFAULT_OPTIONS = {
       :tab_width => 8,
 
-      :level => :xhtml,
       :css => :class,
 
       :style => :cycnus,
-
       :wrap => nil,
+      :title => 'CodeRay output',
 
       :line_numbers => nil,
       :line_number_start => 1,
       :bold_every => 10,
+      :highlight_lines => nil,
 
       :hint => false,
     }
@@ -216,6 +232,7 @@ module Encoders
       @out.css = @css
       @out.numerize! options[:line_numbers], options
       @out.wrap! options[:wrap]
+      @out.apply_title! options[:title]
 
       super
     end

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

@@ -27,7 +27,7 @@ module Encoders
         1.upto(styles.size) do |offset|
           break if style = cl[styles[offset .. -1]]
         end
-        raise 'Style not found: %p' % [styles] if $DEBUG and style.empty?
+        $stderr.puts 'Style not found: %p' % [styles] if $DEBUG and style.empty?
         return style
       end
 

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

@@ -32,9 +32,19 @@ module Encoders
         #end
 
         bold_every = options[:bold_every]
+        highlight_lines = options[:highlight_lines]
         bolding =
-          if bold_every == false
+          if bold_every == false && highlight_lines == nil
             proc { |line| line.to_s }
+          elsif highlight_lines.is_a? Enumerable
+            highlight_lines = highlight_lines.to_set
+            proc do |line|
+              if highlight_lines.include? line
+                "<strong class=\"highlighted\">#{line}</strong>"  # highlighted line numbers in bold
+              else
+                line.to_s
+              end
+            end
           elsif bold_every.is_a? Integer
             raise ArgumentError, ":bolding can't be 0." if bold_every == 0
             proc do |line|
@@ -65,7 +75,6 @@ module Encoders
           # Because even monospace fonts seem to have different heights when bold,
           # I make the newline bold, both in the code and the line numbers.
           # FIXME Still not working perfect for Mr. Internet Exploder
-          # FIXME Firefox struggles with very long codes (> 200 lines)
           line_numbers = (start ... start + line_count).to_a.map(&bolding).join("\n")
           line_numbers << "\n"  # also for Mr. MS Internet Exploder :-/
           line_numbers.gsub!(/\n/) { "<tt>\n</tt>" }

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

@@ -86,6 +86,11 @@ module Encoders
         Template.wrap! self, template, 'CONTENT'
         self
       end
+      
+      def apply_title! title
+        self.sub!(/(<title>)(<\/title>)/) { $1 + title + $2 }
+        self
+      end
 
       def wrap! element, *args
         return self if not element or element == wrapped_in
@@ -100,6 +105,10 @@ module Encoders
           wrap! :div if wrapped_in? nil
           raise "Can't wrap %p in %p" % [wrapped_in, element] unless wrapped_in? :div
           wrap_in! Output.page_template_for_css(@css)
+          if args.first.is_a?(Hash) && title = args.first[:title]
+            apply_title! title
+          end
+          self
         when nil
           return self
         else
@@ -177,7 +186,7 @@ module Encoders
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="de">
 <head>
   <meta http-equiv="content-type" content="text/html; charset=utf-8" />
-  <title>CodeRay Output</title>
+  <title></title>
   <style type="text/css">
 <%CSS%>
   </style>

data/lib/coderay/encoders/json.rb

@@ -0,0 +1,69 @@
+($:.unshift '../..'; require 'coderay') unless defined? CodeRay
+module CodeRay
+module Encoders
+  
+  # = JSON Encoder
+  class JSON < Encoder
+    
+    register_for :json
+    FILE_EXTENSION = 'json'
+    
+  protected
+    def setup options
+      begin
+        require 'json'
+      rescue LoadError
+        require 'rubygems'
+        require 'json'
+      end
+      @out = []
+    end
+    
+    def text_token text, kind
+      { :type => 'text', :text => text, :kind => kind }
+    end
+    
+    def block_token action, kind
+      { :type => 'block', :action => action, :kind => kind }
+    end
+    
+    def finish options
+      @out.to_json
+    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