coderay 0.5.0.121 → 0.7.1.147

data/lib/coderay/encoders/yaml.rb

@@ -1,19 +1,22 @@
 module CodeRay
-	module Encoders
+module Encoders
 
-		class YAML < Encoder
+	# = YAML Encoder
+	#
+	# Slow.
+	class YAML < Encoder
 
-			register_for :yaml
+		register_for :yaml
 
-			FILE_EXTENSION = 'yaml'
-
-			protected
-			def compile tokens, options
-				require 'yaml'
-				@out = tokens.to_a.to_yaml
-			end
+		FILE_EXTENSION = 'yaml'
 
+	protected
+		def compile tokens, options
+			require 'yaml'
+			@out = tokens.to_a.to_yaml
 		end
 
 	end
+
+end
 end

data/lib/coderay/helpers/filetype.rb

@@ -6,16 +6,29 @@
 #
 # Version: 0.1 (2005.september.1)
 #
-# ==Documentation
-#
-# TODO
+# == Documentation
 #
+#  # determine the type of the given
+#	 lang = FileType[ARGV.first]
+#  
+#	 # return :plaintext if the file type is unknown
+#	 lang = FileType.fetch ARGV.first, :plaintext
+#  
+#	 # try the shebang line, too
+#	 lang = FileType.fetch ARGV.first, :plaintext, true
+#	 
 module FileType
 	
 	UnknownFileType = Class.new Exception
 
 	class << self
 
+		# Try to determine the file type of the file.
+		#
+		# +filename+ is a relative or absolute path to a file.
+		#
+		# The file itself is only accessed when +read_shebang+ is set to true.
+		# That means you can get filetypes from files that don't exist.
 		def [] filename, read_shebang = false
 			name = File.basename filename
 			ext = File.extname name
@@ -43,6 +56,9 @@ module FileType
 		end
 		
 		# This works like Hash#fetch.
+		#
+		# If the filetype cannot be found, the +default+ value
+		# is returned.
 		def fetch filename, default = nil, read_shebang = false
 			if default and block_given?
 				warn 'block supersedes default value argument'
@@ -61,12 +77,17 @@ module FileType
 	TypeFromExt = {
 		'rb' => :ruby,
 		'rbw' => :ruby,
-		'cpp' => :cpp,
+		'rake' => :ruby,
+		'cpp' => :c,
 		'c' => :c,
 		'h' => :c,
 		'xml' => :xml,
 		'htm' => :html,
 		'html' => :html,
+		'xhtml' => :xhtml,
+		'rhtml' => :rhtml,
+		'yaml' => :yaml,
+		'yml' => :yaml,
 	}
 
 	TypeFromShebang = /\b(?:ruby|perl|python|sh)\b/
@@ -80,7 +101,7 @@ end
 
 if $0 == __FILE__
 	$VERBOSE = true
-  eval DATA.read, nil, $0, __LINE__+4
+	eval DATA.read, nil, $0, __LINE__+4
 end
 
 __END__
@@ -118,6 +139,7 @@ class TC_FileType < Test::Unit::TestCase
 		assert_equal :ruby, FileType['C:\\Program Files\\x\\y\\c\\test.rbw']
 		assert_equal :ruby, FileType['/usr/bin/something/Rakefile']
 		assert_equal :ruby, FileType['~/myapp/gem/Rantfile']
+		assert_equal :ruby, FileType['./lib/tasks\repository.rake']
 		assert_not_equal :ruby, FileType['test_rb']
 		assert_not_equal :ruby, FileType['Makefile']
 		assert_not_equal :ruby, FileType['set.rb/set']
@@ -133,6 +155,20 @@ class TC_FileType < Test::Unit::TestCase
 		assert_not_equal :c, FileType['~/projects/blabla/c']
 	end
 
+	def test_html
+		assert_equal :html, FileType['test.htm']
+		assert_equal :xhtml, FileType['test.xhtml']
+		assert_equal :xhtml, FileType['test.html.xhtml']
+		assert_equal :rhtml, FileType['_form.rhtml']
+	end
+
+	def test_yaml
+		assert_equal :yaml, FileType['test.yml']
+		assert_equal :yaml, FileType['test.yaml']
+		assert_equal :yaml, FileType['my.html.yaml']
+		assert_not_equal :yaml, FileType['YAML']
+	end
+
 	def test_shebang
 		dir = './test'
 		if File.directory? dir

data/lib/coderay/helpers/gzip_simple.rb

@@ -89,7 +89,7 @@ class String
 end
 
 if $0 == __FILE__
-  eval DATA.read, nil, $0, __LINE__+4
+	eval DATA.read, nil, $0, __LINE__+4
 end
 
 __END__

data/lib/coderay/helpers/plugin.rb

@@ -1,6 +1,6 @@
 # = PluginHost
 #
-# $Id: plugin.rb 105 2006-02-20 01:41:40Z murphy $
+# $Id: plugin.rb 143 2006-06-28 23:05:18Z murphy $
 #
 # A simple subclass plugin system.
 # 
@@ -56,7 +56,6 @@ module PluginHost
 
 	def require_helper plugin_id, helper_name
 		path = path_to File.join(plugin_id, helper_name)
-		#$stderr.puts 'Loading helper: ' + path
 		require path
 	end		
 
@@ -125,6 +124,20 @@ module PluginHost
 		end
 	end
 	
+	# Define the default plugin to use when no plugin is found
+	# for a given id.
+	#
+	# See also map.
+	# 
+	#  class MyColorHost < PluginHost
+	#    map :navy => :dark_blue
+	#    default :gray
+	#  end
+	def default id
+		id = validate_id id
+		plugin_hash[nil] = id
+	end
+	
 	# Every plugin must register itself for one or more
 	# +ids+ by calling register_for, which calls this method.
 	#
@@ -144,6 +157,17 @@ module PluginHost
 		@plugin_hash ||= create_plugin_hash
 	end
 
+	# Returns an array of all .rb files in the plugin path.
+	# 
+	# The extension .rb is not included.
+	def all_plugin_names
+		Dir[path_to('*')].select do |file|
+			File.basename(file)[/^(?!_)\w+\.rb$/]
+		end.map do |file|
+			File.basename file, '.rb'
+		end
+	end
+
 protected
 	# Created a new plugin list and stores it to @plugin_hash.
 	def create_plugin_hash
@@ -152,10 +176,13 @@ protected
 				id = validate_id(plugin_id)
 				path = path_to id
 				begin
-					#$stderr.puts 'Loading plugin: ' + path if $DEBUG
 					require path
 				rescue LoadError => boom
-					raise PluginNotFound, 'Could not load plugin %p: %s' % [id, boom]
+					if h.has_key? nil  # default plugin
+						h[id] = h[nil]
+					else
+						raise PluginNotFound, 'Could not load plugin %p: %s' % [id, boom]
+					end
 				else
 					# Plugin should have registered by now
 					unless h.has_key? id
@@ -188,17 +215,6 @@ protected
 		end
 	end
 
-	# Returns an array of all .rb files in the plugin path.
-	# 
-	# The extension .rb is not included.
-	def all_plugin_names
-		Dir[path_to('*')].select do |file|
-			File.basename(file)[/^(?!_)\w+\.rb$/]
-		end.map do |file|
-			File.basename file, '.rb'
-		end
-	end
-
 	# Returns the Plugin for +id+.
 	# Use it like Hash#fetch.
 	# 
@@ -208,7 +224,7 @@ protected
 		plugin_hash.fetch validate_id(id), *args, &blk
 	end
 
-	# Returns the path to the encoder for format.
+	# Returns the expected path to the plugin file for the given id.
 	def path_to plugin_id
 		File.join plugin_path, "#{plugin_id}.rb"
 	end
@@ -219,7 +235,7 @@ protected
 	# Raises +ArgumentError+ for all other objects, or if the
 	# given String includes non-alphanumeric characters (\W).
 	def validate_id id
-		if id.is_a? Symbol
+		if id.is_a? Symbol or id.nil?
 			id
 		elsif id.is_a? String
 			if id[/\w+/] == id

data/lib/coderay/scanner.rb

@@ -4,7 +4,7 @@ module CodeRay
 
 	# = Scanners
 	# 
-	# $Id: scanner.rb 90 2005-11-05 14:37:40Z murphy $
+	# $Id: scanner.rb 143 2006-06-28 23:05:18Z murphy $
 	# 
 	# This module holds the Scanner class and its subclasses.
 	# For example, the Ruby scanner is named CodeRay::Scanners::Ruby
@@ -65,6 +65,10 @@ module CodeRay
 					is_a? Streamable
 				end
 
+        def normify code
+          code = code.to_s.to_unix
+        end
+
 			end
 
 =begin
@@ -91,44 +95,59 @@ module CodeRay
 			# TokenStream with the +block+ as callback to handle the tokens.
 			#
 			# Else, a Tokens object is used.
-			def initialize code, options = {}, &block
+			def initialize code='', options = {}, &block
 				@options = self.class::DEFAULT_OPTIONS.merge options
 				raise "I am only the basic Scanner class. I can't scan "\
 					"anything. :( Use my subclasses." if self.class == Scanner
 
-				# I love this hack. It seems to silence
-				# all dos/unix/mac newline problems.
-				super code.gsub(/\r\n?/, "\n")
+				super Scanner.normify(code)
 
+				@tokens = options[:tokens]
 				if @options[:stream]
 					warn "warning in CodeRay::Scanner.new: :stream is set, "\
 						"but no block was given" unless block_given?
 					raise NotStreamableError, self unless kind_of? Streamable
-					@tokens = TokenStream.new(&block)
+					@tokens ||= TokenStream.new(&block)
 				else
 					warn "warning in CodeRay::Scanner.new: Block given, "\
 						"but :stream is #{@options[:stream]}" if block_given?
-					@tokens = Tokens.new
+					@tokens ||= Tokens.new
 				end
+
+				setup
 			end
 
 			# More mnemonic accessor name for the input string.
 			alias code string
 
+			def reset
+				super
+				reset_instance
+			end
+
+			def string= code
+				code = Scanner.normify(code)
+				super code
+				reset_instance
+			end
+
 			# Scans the code and returns all tokens in a Tokens object.
-			def tokenize options = {}
-				options = @options.merge({}) #options
-				if @options[:stream]  # :stream must have been set already
-					reset ## what is this for?
-					scan_tokens @tokens, options
-					@tokens
-				else
-					@cached_tokens ||= scan_tokens @tokens, options
-				end
+			def tokenize new_string=nil, options = {}
+				options = @options.merge(options)
+				self.string = new_string if new_string
+				@cached_tokens = 
+					if @options[:stream]  # :stream must have been set already
+						reset unless new_string
+						scan_tokens @tokens, options
+						@tokens
+					else
+						scan_tokens @tokens, options
+					end
 			end
 
-			# You can also see tokenize as a read-only attribute
-			alias tokens tokenize
+			def tokens
+				@cached_tokens ||= tokenize
+			end
 
 			# Traverses the tokens.
 			def each &block
@@ -148,6 +167,14 @@ module CodeRay
 
 		protected
 
+			# Can be implemented by subclasses to do some initialization
+			# that has to be done once per instance.
+			# 
+			# Use reset for initialization that has to be done once per
+			# scan.
+			def setup
+			end
+
 			# This is the central method, and commonly the only one a
 			# subclass implements.
 			# 
@@ -158,6 +185,11 @@ module CodeRay
 					"#{self.class}#scan_tokens not implemented."
 			end
 
+			def reset_instance
+				@tokens.clear unless @options[:keep_tokens]
+				@cached_tokens = nil
+			end
+
 			# Scanner error with additional status information
 			def raise_inspect msg, tokens, ambit = 30
 				raise ScanError, <<-EOE % [
@@ -194,4 +226,13 @@ surrounding code:
 	end
 end
 
-# vim:sw=2:ts=2:noet:tw=78
+class String
+	# I love this hack. It seems to silence all dos/unix/mac newline problems.
+	def to_unix
+		if index ?\r
+			gsub(/\r\n?/, "\n")
+		else
+			self
+		end
+	end
+end

data/lib/coderay/scanners/_map.rb

@@ -1,10 +1,14 @@
 module CodeRay
-	module Scanners
-		
-		map :cpp => :c,
-			:plain => :plaintext,
-			:pascal => :delphi,
-			:irb => :ruby
-		
-	end
+module Scanners
+	
+	map :cpp => :c,
+		:plain => :plaintext,
+		:pascal => :delphi,
+		:irb => :ruby,
+		:xml => :html,
+		:xhtml => :nitro_html
+
+	default :plain
+	
+end
 end

data/lib/coderay/scanners/c.rb

@@ -1,4 +1,5 @@
-module CodeRay module Scanners
+module CodeRay
+module Scanners
 	
 	class C < Scanner
 
@@ -42,7 +43,9 @@ module CodeRay module Scanners
 				kind = :error
 				match = nil
 
-				if state == :initial
+				case state
+
+				when :initial
 					
 					if scan(/ \s+ | \\\n /x)
 						kind = :space
@@ -96,7 +99,7 @@ module CodeRay module Scanners
 						getch
 					end
 					
-				elsif state == :string
+				when :string
 					if scan(/[^\\"]+/)
 						kind = :content
 					elsif scan(/"/)
@@ -110,10 +113,10 @@ module CodeRay module Scanners
 						kind = :error
 						state = :initial
 					else
-						raise "else case \" reached; %p not handled." % peek(1), tokens
+						raise_inspect "else case \" reached; %p not handled." % peek(1), tokens
 					end
 					
-				elsif state == :include_expected
+				when :include_expected
 					if scan(/<[^>\n]+>?|"[^"\n\\]*(?:\\.[^"\n\\]*)*"?/)
 						kind = :include
 						state = :initial
@@ -128,12 +131,16 @@ module CodeRay module Scanners
 					end
 					
 				else
-					raise 'else-case reached', tokens
+					raise_inspect 'Unknown state', tokens
 					
 				end
 				
 				match ||= matched
-				raise [match, kind], tokens if kind == :error
+				if $DEBUG and (not kind or kind == :error)
+					raise_inspect 'Error token %p in line %d' %
+						[[match, kind], line], tokens
+				end
+				raise_inspect 'Empty token', tokens unless match
 
 				tokens << [match, kind]
 				
@@ -144,4 +151,5 @@ module CodeRay module Scanners
 
 	end
 
-end end
+end
+end