coderay 1.0.0.598.pre → 1.0.0.738.pre

data/bin/coderay

@@ -73,7 +73,7 @@ Examples:
   end
   
   if tokens == :scan
-    output = CodeRay::Duo[lang => format].highlight input
+    output = CodeRay.encoder(format).encode(input, lang)
   else
     output = tokens.encode format
   end

data/lib/coderay.rb

@@ -1,16 +1,21 @@
+# encoding: utf-8
+# Encoding.default_internal = 'UTF-8'
+
 # = CodeRay Library
 #
 # CodeRay is a Ruby library for syntax highlighting.
 #
-# I try to make CodeRay easy to use and intuitive, but at the same time fully featured, complete,
-# fast and efficient.
+# I try to make CodeRay easy to use and intuitive, but at the same time fully
+# featured, complete, fast and efficient.
 # 
 # See README.
 # 
 # It consists mainly of
-# * the main engine: CodeRay (Scanners::Scanner, Tokens, Encoders::Encoder), PluginHost
+# * the main engine: CodeRay (Scanners::Scanner, Tokens, Encoders::Encoder)
+# * the plugin system: PluginHost, Plugin
 # * the scanners in CodeRay::Scanners
 # * the encoders in CodeRay::Encoders
+# * the styles in CodeRay::Styles
 # 
 # Here's a fancy graphic to light up this gray docu:
 # 
@@ -22,8 +27,8 @@
 #
 # == Usage
 #
-# Remember you need RubyGems to use CodeRay, unless you have it in your load path. Run Ruby with
-# -rubygems option if required.
+# Remember you need RubyGems to use CodeRay, unless you have it in your load
+# path. Run Ruby with -rubygems option if required.
 #
 # === Highlight Ruby code in a string as html
 # 
@@ -128,16 +133,25 @@ module CodeRay
   # Teeny: development state, 0 for pre-release
   # Revision: Subversion Revision number (generated on rake gem:make)
   VERSION = '1.0.0'
-
-  require 'coderay/tokens'
-  require 'coderay/token_kinds'
-  require 'coderay/scanner'
-  require 'coderay/encoder'
-  require 'coderay/duo'
-  require 'coderay/style'
-
+  
+  # Tokens
+  autoload :Tokens, 'coderay/tokens'
+  autoload :TokenKinds, 'coderay/token_kinds'
+  
+  # Plugin system
+  autoload :PluginHost, 'coderay/helpers/plugin'
+  autoload :Plugin, 'coderay/helpers/plugin'
+  
+  # Plugins
+  autoload :Scanners, 'coderay/scanner'
+  autoload :Encoders, 'coderay/encoder'
+  autoload :Styles, 'coderay/style'
+  
+  # Convenience access and reusable Encoder/Scanner pair
+  autoload :Duo, 'coderay/duo'
+  
   class << self
-
+    
     # Scans the given +code+ (a String) with the Scanner for +lang+.
     #
     # This is a simple way to use CodeRay. Example:
@@ -181,16 +195,6 @@ module CodeRay
       encoder(format, options).encode code, lang, options
     end
 
-    # Highlight a string into a HTML <div>.
-    #
-    # CSS styles use classes, so you have to include a stylesheet
-    # in your output.
-    #
-    # See encode.
-    def highlight code, lang, options = { :css => :class }, format = :div
-      encode code, lang, format, options
-    end
-
     # Encode pre-scanned Tokens.
     # Use this together with CodeRay.scan:
     #
@@ -217,6 +221,16 @@ module CodeRay
       encode_tokens tokens, format, options
     end
 
+    # Highlight a string into a HTML <div>.
+    #
+    # CSS styles use classes, so you have to include a stylesheet
+    # in your output.
+    #
+    # See encode.
+    def highlight code, lang, options = { :css => :class }, format = :div
+      encode code, lang, format, options
+    end
+
     # Highlight a file into a HTML <div>.
     #
     # CSS styles use classes, so you have to include a stylesheet
@@ -266,11 +280,3 @@ module CodeRay
   end
 
 end
-
-# Run a test script.
-if $0 == __FILE__
-  $stderr.print 'Press key to print demo.'; gets
-  # Just use this file as an example of Ruby code.
-  code = File.read(__FILE__)[/module CodeRay.*/m]
-  print CodeRay.scan(code, :ruby).html
-end

data/lib/coderay/duo.rb

@@ -1,4 +1,3 @@
-($:.unshift '..'; require 'coderay') unless defined? CodeRay
 module CodeRay
   
   # = Duo
@@ -36,7 +35,7 @@ module CodeRay
     # The options are forwarded to scanner and encoder
     # (see CodeRay.get_scanner_options).
     def initialize lang = nil, format = nil, options = {}
-      if format == nil and lang.is_a? Hash and lang.size == 1
+      if format.nil? && lang.is_a?(Hash) && lang.size == 1
         @lang = lang.keys.first
         @format = lang[@lang]
       else
@@ -80,55 +79,3 @@ module CodeRay
   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 DuoTest < Test::Unit::TestCase
-  
-  def test_two_arguments
-    duo = CodeRay::Duo[:ruby, :html]
-    assert_kind_of CodeRay::Scanners[:ruby], duo.scanner
-    assert_kind_of CodeRay::Encoders[:html], duo.encoder
-  end
-  
-  def test_two_hash
-    duo = CodeRay::Duo[:ruby => :html]
-    assert_kind_of CodeRay::Scanners[:ruby], duo.scanner
-    assert_kind_of CodeRay::Encoders[:html], duo.encoder
-  end
-  
-  def test_call
-    duo = CodeRay::Duo[:python => :yaml]
-    assert_equal <<-'YAML', duo.call('def test: "pass"')
---- 
-- - def
-  - :keyword
-- - " "
-  - :space
-- - test
-  - :method
-- - ":"
-  - :operator
-- - " "
-  - :space
-- - :begin_group
-  - :string
-- - "\""
-  - :delimiter
-- - pass
-  - :content
-- - "\""
-  - :delimiter
-- - :end_group
-  - :string
-    YAML
-  end
-  
-end

data/lib/coderay/encoder.rb

@@ -1,5 +1,5 @@
 module CodeRay
-
+  
   # This module holds the Encoder class and its subclasses.
   # For example, the HTML encoder is named CodeRay::Encoders::HTML
   # can be found in coderay/encoders/html.
@@ -8,9 +8,10 @@ module CodeRay
   # mechanism and the [] method that returns the Encoder class
   # belonging to the given format.
   module Encoders
+    
     extend PluginHost
     plugin_path File.dirname(__FILE__), 'encoders'
-
+    
     # = Encoder
     #
     # The Encoder base class. Together with Scanner and
@@ -26,27 +27,27 @@ module CodeRay
     class Encoder
       extend Plugin
       plugin_host Encoders
-
+      
       class << self
-
+        
         # If FILE_EXTENSION isn't defined, this method returns the
         # downcase class name instead.
         def const_missing sym
           if sym == :FILE_EXTENSION
-            plugin_id
+            plugin_id.to_s
           else
             super
           end
         end
-
+        
       end
-
+      
       # Subclasses are to store their default options in this constant.
       DEFAULT_OPTIONS = { }
-
+      
       # The options you gave the Encoder at creating.
       attr_accessor :options
-
+      
       # Creates a new Encoder.
       # +options+ is saved and used for all encode operations, as long
       # as you don't overwrite it there by passing additional options.
@@ -59,11 +60,9 @@ module CodeRay
       # added to the options you passed at creation.
       def initialize options = {}
         @options = self.class::DEFAULT_OPTIONS.merge options
-        raise "I am only the basic Encoder class. I can't encode "\
-          "anything. :( Use my subclasses." if self.class == Encoder
-        $ALREADY_WARNED_OLD_INTERFACE = false
+        @@CODERAY_TOKEN_INTERFACE_DEPRECATION_WARNING_GIVEN = false
       end
-
+      
       # Encode a Tokens object.
       def encode_tokens tokens, options = {}
         options = @options.merge options
@@ -71,7 +70,7 @@ module CodeRay
         compile tokens, options
         finish options
       end
-
+      
       # Encode the given +code+ using the Scanner for +lang+.
       def encode code, lang, options = {}
         options = @options.merge options
@@ -81,33 +80,23 @@ module CodeRay
         CodeRay.scan code, lang, scanner_options
         finish options
       end
-
+      
       # You can use highlight instead of encode, if that seems
       # more clear to you.
       alias highlight encode
-
+      
       # Return the default file extension for outputs of this encoder.
       def file_extension
         self.class::FILE_EXTENSION
       end
       
       def << token
-        warn 'Using old Tokens#<< interface.' unless $ALREADY_WARNED_OLD_INTERFACE
-        $ALREADY_WARNED_OLD_INTERFACE = true
+        unless @@CODERAY_TOKEN_INTERFACE_DEPRECATION_WARNING_GIVEN
+          warn 'Using old Tokens#<< interface.'
+          @@CODERAY_TOKEN_INTERFACE_DEPRECATION_WARNING_GIVEN = true
+        end
         self.token(*token)
       end
-
-    protected
-
-      # Called with merged options before encoding starts.
-      # Sets @out to an empty string.
-      #
-      # See the HTML Encoder for an example of option caching.
-      def setup options
-        @out = ''
-      end
-      
-    public
       
       # Called with +content+ and +kind+ of the currently scanned token.
       # For simple scanners, it's enougth to implement this method.
@@ -127,12 +116,13 @@ module CodeRay
         when :end_line
           end_line kind
         else
-          raise 'Unknown token content type: %p, kind = %p' % [content, kind]
+          raise ArgumentError, 'Unknown token content type: %p, kind = %p' % [content, kind]
         end
       end
       
       # Called for each text token ([text, kind]), where text is a String.
       def text_token text, kind
+        @out << text
       end
       
       # Starts a token group with the given +kind+.
@@ -153,6 +143,14 @@ module CodeRay
       
     protected
       
+      # Called with merged options before encoding starts.
+      # Sets @out to an empty string.
+      #
+      # See the HTML Encoder for an example of option caching.
+      def setup options
+        @out = ''
+      end
+      
       # Called with merged options after encoding starts.
       # The return value is the result of encoding, typically @out.
       def finish options
@@ -178,11 +176,11 @@ module CodeRay
         end
         raise 'odd number list for Tokens' if content
       end
-    
+      
       alias tokens compile
       public :tokens
       
     end
-
+    
   end
 end

data/lib/coderay/encoders/_map.rb

@@ -1,6 +1,6 @@
 module CodeRay
 module Encoders
-
+  
   map \
     :loc => :lines_of_code,
     :term => :terminal,
@@ -8,6 +8,8 @@ module Encoders
     :remove_comments => :comment_filter,
     :stats => :statistic,
     :tex => :latex
-
+  
+  # No default because Tokens#nonsense would not raise NoMethodError.
+  
 end
 end

data/lib/coderay/encoders/comment_filter.rb

@@ -1,4 +1,3 @@
-($:.unshift '../..'; require 'coderay') unless defined? CodeRay
 module CodeRay
 module Encoders
   
@@ -24,63 +23,3 @@ module Encoders
   
 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
-  
-  def test_filtering_docstrings
-    tokens = CodeRay.scan <<-PYTHON, :python
-'''
-Assuming this is file mymodule.py then this string, being the
-first statement in the file will become the mymodule modules
-docstring when the file is imported
-'''
-
-class Myclass():
-    """
-    The class's docstring
-    """
-
-    def mymethod(self):
-        '''The method's docstring'''
-
-def myfunction():
-    """The function's docstring"""
-    PYTHON
-    assert_equal <<-PYTHON_FILTERED.chomp, tokens.comment_filter.text
-
-
-class Myclass():
-    
-
-    def mymethod(self):
-        
-
-def myfunction():
-    
-
-PYTHON_FILTERED
-  end
-  
-end

data/lib/coderay/encoders/count.rb

@@ -1,4 +1,3 @@
-($:.unshift '../..'; require 'coderay') unless defined? CodeRay
 module CodeRay
 module Encoders
   
@@ -15,6 +14,8 @@ module Encoders
       @out = 0
     end
     
+  public
+    
     def text_token text, kind
       @out += 1
     end
@@ -30,25 +31,3 @@ module Encoders
   
 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 CountTest < Test::Unit::TestCase
-  
-  def test_count
-    tokens = CodeRay.scan <<-RUBY.strip, :ruby
-#!/usr/bin/env ruby
-# a minimal Ruby program
-puts "Hello world!"
-    RUBY
-    assert_equal 9, tokens.encode_with(:count)
-  end
-  
-end