coderay 0.7.1.147 → 0.7.2.165

data/bin/coderay

@@ -1,18 +1,18 @@
 #!/usr/bin/env ruby
 # CodeRay Executable
-# 
+#
 # Version: 0.1
 # Author: murphy
 
 def err msg
-	$stderr.puts msg
+  $stderr.puts msg
 end
 
 begin
-	require 'coderay'
+  require 'coderay'
 
-	if ARGV.empty?
-		puts <<-USAGE
+  if ARGV.empty?
+    puts <<-USAGE
 CodeRay #{CodeRay::Version} (http://rd.cYcnus.de/coderay)
 Usage:
   coderay -<lang> [-<format>] < file > output
@@ -20,60 +20,58 @@ Usage:
 Example:
   coderay -ruby -statistic < foo.rb
   coderay codegen.c  # generates codegen.c.html
-		USAGE
-	end
-	
-	first, second = ARGV
+    USAGE
+  end
 
-	if first
-		if first[/-(\w+)/] == first
-			lang = $1.to_sym
-			input = $stdin.read
-			tokens = CodeRay.scan input, lang
-		elsif first == '-'
-			lang = $1.to_sym
-			input = $stdin.read
-			tokens = CodeRay.scan input, lang
-		else
-			file = first
-			tokens = CodeRay.scan_file file
-			output_filename, output_ext = file, /#{Regexp.escape(File.extname(file))}$/
-		end
-	else
-		puts 'No lang/file given.'
-		exit 1
-	end
+  first, second = ARGV
 
-	if second
-		if second[/-(\w+)/] == second
-			format = $1.to_sym
-		else
-			raise 'Invalid format (must be -xxx).'
-		end
-	else
-		$stderr.puts 'No format given; setting to default (HTML Page)'
-		format = :page
-	end
+  if first
+    if first[/-(\w+)/] == first
+      lang = $1.to_sym
+      input = $stdin.read
+      tokens = CodeRay.scan input, lang
+    elsif first == '-'
+      lang = $1.to_sym
+      input = $stdin.read
+      tokens = CodeRay.scan input, lang
+    else
+      file = first
+      tokens = CodeRay.scan_file file
+      output_filename, output_ext = file, /#{Regexp.escape(File.extname(file))}$/
+    end
+  else
+    puts 'No lang/file given.'
+    exit 1
+  end
 
-	output = tokens.encode format
-	out = $stdout
-	if output_filename
-		output_filename += '.' + CodeRay::Encoders[format]::FILE_EXTENSION
-		if File.exist? output_filename
-			err 'File %s already exists.' % output_filename
-			exit
-		else
-			out = File.open output_filename, 'w'
-		end
-	else
-		
-	end
-	out.print output
+  if second
+    if second[/-(\w+)/] == second
+      format = $1.to_sym
+    else
+      raise 'Invalid format (must be -xxx).'
+    end
+  else
+    $stderr.puts 'No format given; setting to default (HTML Page)'
+    format = :page
+  end
+
+  output = tokens.encode format
+  out = $stdout
+  if output_filename
+    output_filename += '.' + CodeRay::Encoders[format]::FILE_EXTENSION
+    if File.exist? output_filename
+      err 'File %s already exists.' % output_filename
+      exit
+    else
+      out = File.open output_filename, 'w'
+    end
+  end
+  out.print output
 
 rescue => boom
-	err "Error: #{boom.message}\n"
-	err boom.backtrace
-	err '-' * 50
-	err ARGV.options
-	exit 1
+  err "Error: #{boom.message}\n"
+  err boom.backtrace
+  err '-' * 50
+  err ARGV.options
+  exit 1
 end

data/demo/suite.rb

@@ -7,46 +7,46 @@ require 'test/unit'
 include Test::Unit
 
 class CodeRaySuite < TestCase
-	
-	def self.dir &block
-		@dir ||= File.dirname(__FILE__)
-		if block
-			Dir.chdir @dir, &block
-		end
-		@dir
-	end
-
-	def dir &block
-		self.class.dir(&block)
-	end
-	
-	def test_ALL
-		dir do
-			for input in Dir["demo_*.rb"] - %w(demo_server.rb demo_stream.rb)
-				puts "[ testing #{input}... ]"
-				name = File.basename(input, ".rb")
-				output = name + '.out'
-				code = File.open(input, 'rb') { |f| break f.read }
-
-				result = `ruby -wI../lib #{input}`
-
-				if File.exist? output
-					expected = File.read output
-					ok = expected == result
-					computed = output.sub('.out', '.computed')
-					unless ok
-						File.open(computed, 'w') { |f| f.write result }
-						print `gvimdiff #{output} #{computed}` if $DEBUG
-					end
-					assert(ok, "Output error: #{computed} != #{output}") unless $DEBUG
-				else
-					File.open(output, 'w') do |f| f.write result end
-					puts "New test: #{output}"
-				end
-
-			end
-		end
-	end
+
+  def self.dir &block
+    @dir ||= File.dirname(__FILE__)
+    if block
+      Dir.chdir @dir, &block
+    end
+    @dir
+  end
+
+  def dir &block
+    self.class.dir(&block)
+  end
+
+  def test_ALL
+    dir do
+      for input in Dir["demo_*.rb"] - %w(demo_server.rb demo_stream.rb)
+        puts "[ testing #{input}... ]"
+        name = File.basename(input, ".rb")
+        output = name + '.out'
+        code = File.open(input, 'rb') { |f| break f.read }
+
+        result = `ruby -wI../lib #{input}`
+
+        if File.exist? output
+          expected = File.read output
+          ok = expected == result
+          computed = output.sub('.out', '.computed')
+          unless ok
+            File.open(computed, 'w') { |f| f.write result }
+            print `gvimdiff #{output} #{computed}` if $DEBUG
+          end
+          assert(ok, "Output error: #{computed} != #{output}") unless $DEBUG
+        else
+          File.open(output, 'w') do |f| f.write result end
+          puts "New test: #{output}"
+        end
+
+      end
+    end
+  end
 
 end
 
@@ -55,28 +55,28 @@ $suite = TestSuite.new 'CodeRay Demos Test'
 $suite << CodeRaySuite.suite
 
 def load_suite name
-	begin
-		require name + '/suite.rb'
-	rescue LoadError
-		$stderr.puts <<-ERR
+  begin
+    require name + '/suite.rb'
+  rescue LoadError
+    $stderr.puts <<-ERR
 
 !! Folder #{File.split(__FILE__).first + '/' + name} not found
-		
-		ERR
-		false
-	end
+
+    ERR
+    false
+  end
 end
 
 if subsuite = ARGV.find { |a| break $1 if a[/^([^-].*)/] }
-	load_suite(subsuite) or exit
+  load_suite(subsuite) or exit
 else
-	Dir[mydir + '/*/'].each { |suite| load_suite suite }
+  Dir[mydir + '/*/'].each { |suite| load_suite suite }
 end
 
 if ARGV.include? '-f'
-	require 'test/unit/ui/fox/testrunner'
-	UI::Fox::TestRunner.run $suite
+  require 'test/unit/ui/fox/testrunner'
+  UI::Fox::TestRunner.run $suite
 else
-	require 'test/unit/ui/console/testrunner'
-	UI::Console::TestRunner.run $suite
+  require 'test/unit/ui/console/testrunner'
+  UI::Console::TestRunner.run $suite
 end

data/lib/coderay.rb

@@ -1,6 +1,6 @@
 # = CodeRay Library
 #
-# $Id: coderay.rb 141 2006-05-11 23:32:49Z murphy $
+# $Id: coderay.rb 162 2006-07-11 06:03:43Z murphy $
 #
 # CodeRay is a Ruby library for syntax highlighting.
 #
@@ -67,24 +67,24 @@
 # * All methods take an optional hash as last parameter, +options+, that is send to
 #   the Encoder / Scanner.
 # * Input and language are always sorted in this order: +code+, +lang+.
-# 	(This is in alphabetical order, if you need a mnemonic ;)
+#   (This is in alphabetical order, if you need a mnemonic ;)
 # 
 # You should be able to highlight everything you want just using these methods;
 # so there is no need to dive into CodeRay's deep class hierarchy.
 #
 # The examples in the demo directory demonstrate common cases using this interface.
-#	
+#  
 # = Basic Access Ways
 #
 # Read this to get a general view what CodeRay provides.
 # 
 # == Scanning
-#	
-#	Scanning means analysing an input string, splitting it up into Tokens.
-#	Each Token knows about what type it is: string, comment, class name, etc.
+#  
+#  Scanning means analysing an input string, splitting it up into Tokens.
+#  Each Token knows about what type it is: string, comment, class name, etc.
 #
-#	Each +lang+ (language) has its own Scanner; for example, <tt>:ruby</tt> code is
-#	handled by CodeRay::Scanners::Ruby.
+#  Each +lang+ (language) has its own Scanner; for example, <tt>:ruby</tt> code is
+#  handled by CodeRay::Scanners::Ruby.
 # 
 # CodeRay.scan:: Scan a string in a given language into Tokens.
 #                This is the most common method to use.
@@ -108,212 +108,212 @@
 #
 # Streaming saves RAM by running Scanner and Encoder in some sort of
 # pipe mode; see TokenStream.
-# 
+#
 # CodeRay.scan_stream:: Scan in stream mode.
-# 
-#	== All-in-One Encoding
+#
+#  == All-in-One Encoding
 #
 # CodeRay.encode:: Highlight a string with a given input and output format.
 #
 # == Instanciating
-#	
-#	You can use an Encoder instance to highlight multiple inputs. This way, the setup
-#	for this Encoder must only be done once.
-#	
+#
+# You can use an Encoder instance to highlight multiple inputs. This way, the setup
+# for this Encoder must only be done once.
+#
 # CodeRay.encoder:: Create an Encoder instance with format and options.
 #
 # There is no CodeRay.scanner method because Scanners are bound to an input string
 # on creation; you can't re-use them with another string.
 #
-#	The scanning methods provide more flexibility; we recommend to use these.
+#  The scanning methods provide more flexibility; we recommend to use these.
 module CodeRay
-	
-	# Version: Major.Minor.Teeny[.Revision]
-	# Major: 0 for pre-release
-	# Minor: odd for beta, even for stable
-	# Teeny: development state
-	# Revision: Subversion Revision number (generated on rake)
-	Version = '0.7.1'
-	
-	require 'coderay/tokens'
-	require 'coderay/scanner'
-	require 'coderay/encoder'
-	require 'coderay/duo'
-	require 'coderay/style'
 
+  # Version: Major.Minor.Teeny[.Revision]
+  # Major: 0 for pre-release
+  # Minor: odd for beta, even for stable
+  # Teeny: development state
+  # Revision: Subversion Revision number (generated on rake)
+  Version = '0.7.2'
+
+  require 'coderay/tokens'
+  require 'coderay/scanner'
+  require 'coderay/encoder'
+  require 'coderay/duo'
+  require 'coderay/style'
+
+
+  class << self
+
+    # Scans the given +code+ (a String) with the Scanner for +lang+.
+    #
+    # This is a simple way to use CodeRay. Example:
+    #  require 'coderay'
+    #  page = CodeRay.scan("puts 'Hello, world!'", :ruby).html
+    #
+    # See also demo/demo_simple.
+    def scan code, lang, options = {}, &block
+      scanner = Scanners[lang].new code, options, &block
+      scanner.tokenize
+    end
+
+    # Scans +filename+ (a path to a code file) with the Scanner for +lang+.
+    #
+    # If +lang+ is :auto or omitted, the CodeRay::FileType module is used to
+    # determine it. If it cannot find out what type it is, it uses
+    # CodeRay::Scanners::Plaintext.
+    #
+    # Calls CodeRay.scan.
+    #
+    # Example:
+    #  require 'coderay'
+    #  page = CodeRay.scan_file('some_c_code.c').html
+    def scan_file filename, lang = :auto, options = {}, &block
+      file = IO.read filename
+      if lang == :auto
+        require 'coderay/helpers/filetype'
+        lang = FileType.fetch filename, :plaintext, true
+      end
+      scan file, lang, options = {}, &block
+    end
+
+    # Scan the +code+ (a string) with the scanner for +lang+.
+    #
+    # Calls scan.
+    #
+    # See CodeRay.scan.
+    def scan_stream code, lang, options = {}, &block
+      options[:stream] = true
+      scan code, lang, options, &block
+    end
+
+    # Encode a string in Streaming mode.
+    #
+    # This starts scanning +code+ with the the Scanner for +lang+
+    # while encodes the output with the Encoder for +format+.
+    # +options+ will be passed to the Encoder.
+    #
+    # See CodeRay::Encoder.encode_stream
+    def encode_stream code, lang, format, options = {}
+      encoder(format, options).encode_stream code, lang, options
+    end
 
-	class << self
+    # Encode a string.
+    #
+    # This scans +code+ with the the Scanner for +lang+ and then
+    # encodes it with the Encoder for +format+.
+    # +options+ will be passed to the Encoder.
+    #
+    # See CodeRay::Encoder.encode
+    def encode code, lang, format, options = {}
+      encoder(format, options).encode code, lang, options
+    end
 
-		# Scans the given +code+ (a String) with the Scanner for +lang+.
-		# 
-		# This is a simple way to use CodeRay. Example:
-		#  require 'coderay'
-		#  page = CodeRay.scan("puts 'Hello, world!'", :ruby).html
-		#
-		# See also demo/demo_simple.
-		def scan code, lang, options = {}, &block
-			scanner = Scanners[lang].new code, options, &block
-			scanner.tokenize
-		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
 
-		# Scans +filename+ (a path to a code file) with the Scanner for +lang+.
-		# 
-		# If +lang+ is :auto or omitted, the CodeRay::FileType module is used to
-		# determine it. If it cannot find out what type it is, it uses
-		# CodeRay::Scanners::Plaintext.
-		#
-		# Calls CodeRay.scan.
-		# 
-		# Example:
-		#  require 'coderay'
-		#  page = CodeRay.scan_file('some_c_code.c').html
-		def scan_file filename, lang = :auto, options = {}, &block
-			file = IO.read filename
-			if lang == :auto
-				require 'coderay/helpers/filetype'
-				lang = FileType.fetch filename, :plaintext, true
-			end
-			scan file, lang, options = {}, &block
-		end
+    # Encode pre-scanned Tokens.
+    # Use this together with CodeRay.scan:
+    #
+    #  require 'coderay'
+    #  
+    #  # Highlight a short Ruby code example in a HTML span
+    #  tokens = CodeRay.scan '1 + 2', :ruby
+    #  puts CodeRay.encode_tokens(tokens, :span)
+    #
+    def encode_tokens tokens, format, options = {}
+      encoder(format, options).encode_tokens tokens, options
+    end
 
-		# Scan the +code+ (a string) with the scanner for +lang+.
-		# 
-		# Calls scan.
-		# 
-		# See CodeRay.scan.
-		def scan_stream code, lang, options = {}, &block
-			options[:stream] = true
-			scan code, lang, options, &block
-		end
+    # Encodes +filename+ (a path to a code file) with the Scanner for +lang+.
+    #
+    # See CodeRay.scan_file.
+    # Notice that the second argument is the output +format+, not the input language.
+    #
+    # Example:
+    #  require 'coderay'
+    #  page = CodeRay.encode_file 'some_c_code.c', :html
+    def encode_file filename, format, options = {}
+      tokens = scan_file filename, :auto, get_scanner_options(options)
+      encode_tokens tokens, format, options
+    end
 
-		# Encode a string in Streaming mode.
-		# 
-		# This starts scanning +code+ with the the Scanner for +lang+ 
-		# while encodes the output with the Encoder for +format+.
-		# +options+ will be passed to the Encoder.
-		#
-		# See CodeRay::Encoder.encode_stream
-		def encode_stream code, lang, format, options = {}
-			encoder(format, options).encode_stream code, lang, options
-		end
+    # Highlight a file into a HTML <div>.
+    #
+    # CSS styles use classes, so you have to include a stylesheet
+    # in your output.
+    #
+    # See encode.
+    def highlight_file filename, options = { :css => :class }, format = :div
+      encode_file filename, format, options
+    end
 
-		# Encode a string.
-		# 
-		# This scans +code+ with the the Scanner for +lang+ and then
-		# encodes it with the Encoder for +format+.
-		# +options+ will be passed to the Encoder.
-		#
-		# See CodeRay::Encoder.encode
-		def encode code, lang, format, options = {}
-			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:
-		# 
-		#  require 'coderay'
-		#  
-		#  # Highlight a short Ruby code example in a HTML span
-		#  tokens = CodeRay.scan '1 + 2', :ruby
-		#  puts CodeRay.encode_tokens(tokens, :span)
-		#
-		def encode_tokens tokens, format, options = {}
-			encoder(format, options).encode_tokens tokens, options
-		end
+    # Finds the Encoder class for +format+ and creates an instance, passing
+    # +options+ to it.
+    #
+    # Example:
+    #  require 'coderay'
+    #  
+    #  stats = CodeRay.encoder(:statistic)
+    #  stats.encode("puts 17 + 4\n", :ruby)
+    #  
+    #  puts '%d out of %d tokens have the kind :integer.' % [
+    #    stats.type_stats[:integer].count,
+    #    stats.real_token_count
+    #  ]
+    #  #-> 2 out of 4 tokens have the kind :integer.
+    def encoder format, options = {}
+      Encoders[format].new options
+    end
 
-		# Encodes +filename+ (a path to a code file) with the Scanner for +lang+.
-		# 
-		# See CodeRay.scan_file.
-		# Notice that the second argument is the output +format+, not the input language.
-		# 
-		# Example:
-		#  require 'coderay'
-		#  page = CodeRay.encode_file 'some_c_code.c', :html
-		def encode_file filename, format, options = {}
-			tokens = scan_file filename, :auto, get_scanner_options(options)
-			encode_tokens tokens, format, options
-		end
+    # Finds the Scanner class for +lang+ and creates an instance, passing
+    # +options+ to it.
+    #
+    # See Scanner.new.
+    def scanner lang, options = {}
+      Scanners[lang].new '', options
+    end
 
-		# Highlight a file into a HTML <div>.
-		#
-		# CSS styles use classes, so you have to include a stylesheet
-		# in your output.
-		# 
-		# See encode.
-		def highlight_file filename, options = { :css => :class }, format = :div
-			encode_file filename, format, options
-		end
-		
-		# Finds the Encoder class for +format+ and creates an instance, passing
-		# +options+ to it.
-		# 
-		# Example:
-		#  require 'coderay'
-		#  
-		#  stats = CodeRay.encoder(:statistic)
-		#  stats.encode("puts 17 + 4\n", :ruby)
-		#  
-		#  puts '%d out of %d tokens have the kind :integer.' % [
-		#  	stats.type_stats[:integer].count,
-		#  	stats.real_token_count
-		#  ]
-		#  #-> 2 out of 4 tokens have the kind :integer.
-		def encoder format, options = {}
-			Encoders[format].new options
-		end
+    # Extract the options for the scanner from the +options+ hash.
+    #
+    # Returns an empty Hash if <tt>:scanner_options</tt> is not set.
+    #
+    # This is used if a method like CodeRay.encode has to provide options
+    # for Encoder _and_ scanner.
+    def get_scanner_options options
+      options.fetch :scanner_options, {}
+    end
 
-		# Finds the Scanner class for +lang+ and creates an instance, passing
-		# +options+ to it.
-		#
-		# See Scanner.new.
-		def scanner lang, options = {}
-			Scanners[lang].new '', options
-		end
+  end
 
-		# Extract the options for the scanner from the +options+ hash.
-		#
-		#	Returns an empty Hash if <tt>:scanner_options</tt> is not set.
-		#	
-		# This is used if a method like CodeRay.encode has to provide options
-		# for Encoder _and_ scanner.
-		def get_scanner_options options
-			options.fetch :scanner_options, {}
-		end
+  # This Exception is raised when you try to stream with something that is not
+  # capable of streaming.
+  class NotStreamableError < Exception
+    def initialize obj
+      @obj = obj
+    end
 
-	end
+    def to_s
+      '%s is not Streamable!' % @obj.class
+    end
+  end
 
-	# This Exception is raised when you try to stream with something that is not
-	# capable of streaming.
-	class NotStreamableError < Exception
-		def initialize obj
-			@obj = obj
-		end
+  # A dummy module that is included by subclasses of CodeRay::Scanner an CodeRay::Encoder
+  # to show that they are able to handle streams.
+  module Streamable
+  end
 
-		def to_s
-			'%s is not Streamable!' % @obj.class
-		end
-	end
-	
-	# A dummy module that is included by subclasses of CodeRay::Scanner an CodeRay::Encoder
-	# to show that they are able to handle streams.
-	module Streamable
-	end
-	
 end
 
 # Run a test script.
 if $0 == __FILE__
-	$stderr.print 'Press key to print demo.'; gets
-	code = File.read($0)[/module CodeRay.*/m]
-	print CodeRay.scan(code, :ruby).html
+  $stderr.print 'Press key to print demo.'; gets
+  code = File.read($0)[/module CodeRay.*/m]
+  print CodeRay.scan(code, :ruby).html
 end