coderay 0.4.3.48

data/lib/coderay/helpers/gzip_simple.rb

@@ -0,0 +1,123 @@
+# =GZip Simple
+#
+# A simplified interface to the gzip library +zlib+ (from the Ruby Standard Library.)
+#
+# Author: murphy (mail to murphy cYcnus de)
+#
+# Version: 0.2 (2005.may.28)
+#
+# ==Documentation
+#
+# See +GZip+ module and the +String+ extensions.
+#
+module GZip
+	
+	require 'zlib'
+
+	# The default zipping level. 7 zips good and fast.
+	DEFAULT_GZIP_LEVEL = 7
+	
+	# Unzips the given string +s+.
+	#
+	# Example:
+	#   require 'gzip_simple'
+	#   print GZip.gunzip(File.read('adresses.gz'))
+	# 
+	def GZip.gunzip s
+		Zlib::Inflate.inflate s
+	end
+	
+	# Zips the given string +s+.
+	#
+	# Example:
+	#   require 'gzip_simple'
+	#   File.open('adresses.gz', 'w') do |file
+	#     file.write GZip.gzip('Mum: 0123 456 789', 9)
+	#   end
+	# 
+	# If you provide a +level+, you can control how strong
+	# the string is compressed:
+	# - 0: no compression, only convert to gzip format
+	# - 1: compress fast
+	# - 7: compress more, but still fast (default)
+	# - 8: compress more, slower
+	# - 9: compress best, very slow
+	def GZip.gzip s, level = DEFAULT_GZIP_LEVEL
+		Zlib::Deflate.new(level).deflate s, Zlib::FINISH
+	end
+end
+
+# String extensions to use the GZip module.
+#
+# The methods gzip and gunzip provide an even more simple
+# interface to the ZLib:
+#
+#   # create a big string
+#   x = 'a' * 1000
+#   
+#   # zip it
+#   x_gz = x.gzip
+#   
+#   # test the result
+#   puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size]
+#   #-> Zipped 1000 bytes to 19 bytes.
+#   
+#   # unzipping works
+#   p x_gz.gunzip == x  #-> true
+class String
+	# Returns the string, unzipped.
+	# See GZip.gunzip
+	def gunzip
+		GZip.gunzip self
+	end
+	# Replaces the string with its unzipped value.
+	# See GZip.gunzip
+	def gunzip!
+		replace gunzip
+	end
+	
+	# Returns the string, zipped.
+	# +level+ is the gzip compression level, see GZip.gzip.
+	def gzip level = GZip::DEFAULT_GZIP_LEVEL
+		GZip.gzip self, level
+	end
+	# Replaces the string with its zipped value.
+	# See GZip.gzip.
+	def gzip!(*args)
+		replace gzip(*args)
+	end
+end
+
+if $0 == __FILE__
+  eval DATA.read, nil, $0, __LINE__+4
+end
+
+__END__
+#CODE
+
+# Testing / Benchmark
+x = 'a' * 1000
+x_gz = x.gzip
+puts 'Zipped %d bytes to %d bytes.' % [x.size, x_gz.size]  #-> Zipped 1000 bytes to 19 bytes.
+p x_gz.gunzip == x  #-> true
+
+require 'benchmark'
+
+INFO = 'packed to %0.3f%%'  # :nodoc:
+
+x = Array.new(100000) { rand(255).chr + 'aaaaaaaaa' + rand(255).chr }.join
+Benchmark.bm(10) do |bm|
+	for level in 0..9
+		bm.report "zip #{level}" do
+			$x = x.gzip level
+		end
+		puts INFO % [100.0 * $x.size / x.size]
+	end
+	bm.report 'zip' do
+		$x = x.gzip
+	end
+	puts INFO % [100.0 * $x.size / x.size]
+	bm.report 'unzip' do
+		$x.gunzip
+	end
+end

data/lib/coderay/helpers/plugin.rb

@@ -0,0 +1,286 @@
+# = PluginHost
+#
+# $Id: plugin.rb 47 2005-10-01 06:04:52Z murphy $
+#
+# A simple subclass plugin system.
+# 
+#	Example:		
+#		class Generators < PluginHost
+#			plugin_path 'app/generators'
+#		end
+#		
+#	  class Generator
+#	  	extend Plugin
+#	  	PLUGIN_HOST = Generators
+#	  end
+#   
+#	  class FancyGenerator < Generator
+#	  	register_for :fancy
+#	  end
+#
+#	  Generators[:fancy]  #-> FancyGenerator
+#	  # or
+#	  require_plugin 'Generators/fancy'
+module PluginHost
+
+	# Raised if Encoders::[] fails because:
+	# * a file could not be found
+	# * the requested Encoder is not registered
+	PluginNotFound = Class.new Exception
+	HostNotFound = Class.new Exception
+
+	PLUGIN_HOSTS = []
+	PLUGIN_HOSTS_BY_ID = {}  # dummy hash
+
+	class << self
+
+		def extended mod
+			PLUGIN_HOSTS << mod
+		end
+
+		def included mod
+			warn "#{name} should not be included. Use extend."
+		end
+
+		# Find the PluginHost for host_id.
+		def host_by_id host_id
+			unless PLUGIN_HOSTS_BY_ID.default_proc
+				ph = Hash.new do |h, a_host_id|
+					for host in PLUGIN_HOSTS
+						h[host.host_id] = host
+					end
+					h.fetch a_host_id, nil
+				end				
+				PLUGIN_HOSTS_BY_ID.replace ph
+			end
+			PLUGIN_HOSTS_BY_ID[host_id]
+		end
+
+	end
+	
+	def plugin_host_id host_id
+		if host_id.is_a? String
+			raise ArgumentError,
+				"String or Symbol expected, but #{lang.class} given."
+		end
+	end
+
+	# The path where the plugins can be found.
+	def plugin_path *args
+		unless args.empty?
+			@plugin_path = File.join(*args)
+		end
+		@plugin_path
+	end
+
+	# The host's ID.
+	#
+	# If PLUGIN_HOST_ID is not set, it is simply the class name.
+	def host_id
+		if self.const_defined? :PLUGIN_HOST_ID
+			self::PLUGIN_HOST_ID
+		else
+			name
+		end
+	end
+
+	def create_plugin_hash
+		@plugin_hash =
+			Hash.new do |h, plugin_id|
+				id = validate_id(plugin_id)
+				path = path_to id
+				begin
+					$stderr.puts 'Loading plugin: ' + path if $DEBUG
+					require path
+				rescue LoadError
+					raise PluginNotFound, "Plugin #{id.inspect} not found."
+				else
+					# Plugin should have registered by now
+					unless h.has_key? id
+						raise PluginNotFound,
+							"No #{self.name} plugin for #{id.inspect} found in #{path}."
+					end
+				end
+				h[id]
+			end
+	end
+
+	def plugin_hash
+		@plugin_hash ||= create_plugin_hash
+	end
+
+
+	# Every plugin must register itself for one or more
+	# +ids+ by calling register_for, which calls this method.
+	#
+	# See Plugin#register_for.
+	def register plugin, *ids
+		for id in ids
+			unless id.is_a? Symbol
+				raise ArgumentError,
+					"id must be a Symbol, but it was a #{id.class}" 
+			end
+			plugin_hash[validate_id(id)] = plugin
+		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('*')].map do |file|
+			File.basename file, '.rb'
+		end
+	end
+
+	# Loads all plugins using all_plugin_names and load.
+	def load_all
+		for plugin in all_plugin_names
+			load_plugin plugin
+		end
+	end
+
+
+	# Returns the Plugin for +id+.
+	# 
+	# Example:
+	#  yaml_plugin = MyPluginHost[:yaml]
+	def [] id, *args, &blk
+		plugin_hash.[] validate_id(id), *args, &blk
+	end
+
+	# Alias for +[]+.
+	alias load_plugin []
+
+	# Returns the Plugin for +id+.
+	# Use it like Hash#fetch.
+	# 
+	# Example:
+	#  yaml_plugin = MyPluginHost[:yaml, :default]
+	def fetch id, *args, &blk
+		plugin_hash.fetch validate_id(id), *args, &blk
+	end
+
+	# Returns the path to the encoder for format.
+	def path_to plugin_id
+		File.join plugin_path, "#{plugin_id}.rb"
+	end
+
+	# Converts +id+ to a downcase Symbol if it is a String,
+	# or returns +id+ if it already is a Symbol.
+	#
+	# 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
+			id
+		elsif id.is_a? String
+			if id[/\w+/] == id
+				id.downcase.to_sym
+			else
+				raise ArgumentError, "Invalid id: '#{id}' given."
+			end
+		else
+			raise ArgumentError,
+				"String or Symbol expected, but #{id.class} given."
+		end
+	end
+
+end
+
+
+# = Plugin
+# 
+#	Plugins have to include this module.
+#
+#	IMPORTANT: use extend for this module.
+#
+#	Example: see PluginHost.
+module Plugin
+
+	def included mod
+		warn "#{name} should not be included. Use extend."
+	end
+
+	# Register this class for the given langs.
+	# Example:
+	#   class MyPlugin < PluginHost::BaseClass
+	#     register_for :my_id
+	#     ...
+	#   end
+	#
+	# See PluginHost.register.
+	def register_for *ids
+		plugin_host.register self, *ids
+	end
+
+	# The host for this Plugin class.
+	def plugin_host host = nil
+		if host and not host.is_a? PluginHost
+			raise ArgumentError,
+				"PluginHost expected, but #{host.class} given."
+		end
+		self.const_set :PLUGIN_HOST, host if host
+		self::PLUGIN_HOST
+	end
+
+end
+
+
+# Convenience method for plugin loading.
+# The syntax used is:
+#
+#  require_plugin '<Host ID>/<Plugin ID>'
+# 
+# Returns the loaded plugin.
+def require_plugin path
+	host_id, plugin_id = path.split '/', 2
+	host = PluginHost.host_by_id(host_id)
+	raise PluginHost::HostNotFound,
+		"No host for #{host_id.inspect} found." unless host
+	host.load_plugin plugin_id
+end
+
+
+if $0 == __FILE__
+	$VERBOSE = $DEBUG = true
+	eval DATA.read, nil, $0, __LINE__+4
+end
+
+__END__
+
+require 'test/unit'
+
+class TC_PLUGINS < Test::Unit::TestCase
+
+	class Generators
+		extend PluginHost
+		plugin_path '.'
+	end
+
+	class Generator
+		extend Plugin
+		plugin_host Generators
+	end
+
+	class FancyGenerator < Generator
+		register_for :plugin_host
+	end
+
+	def test_plugin
+		assert_nothing_raised do
+			Generators[:plugin_host]
+		end	
+		assert_equal FancyGenerator, Generators[:plugin_host]
+	end
+	
+	def test_require
+		assert_nothing_raised do
+			require_plugin('TC_PLUGINS::Generators/plugin_host')
+		end
+		assert_equal FancyGenerator,
+			require_plugin('TC_PLUGINS::Generators/plugin_host')
+	end
+
+end

data/lib/coderay/helpers/scanner_helper.rb

@@ -0,0 +1,63 @@
+module CodeRay
+module Scanners
+
+  class Scanner
+
+    # A WordList is a Hash with some additional features.
+    # It is intended to be used for keyword recognition.
+    class WordList < Hash
+
+      def initialize default = false, case_mode = :case_match
+        @case_ignore =
+          case case_mode
+          when :case_match then false
+          when :case_ignore then true
+          else
+            raise ArgumentError,
+              "#{self.class.name}.new: second argument must be :case_ignore or :case_match, but #{case_mode} was given."
+          end
+
+        if @case_ignore
+          super() do |h, k|
+            h[k] = h.fetch k.downcase, default
+          end
+        else
+          super default
+        end
+      end
+
+      def include? word
+        self[word] if @case_ignore
+        has_key? word
+      end
+
+      def add words, kind = true
+        words.each do |word|
+          self[mind_case(word)] = kind
+        end
+        self
+      end
+
+      alias words keys
+
+      def case_ignore?
+        @case_mode
+      end
+
+    private
+      def mind_case word
+        if @case_ignore
+          word.downcase
+        else
+          word.dup
+        end
+      end
+
+    end		
+
+  end
+
+end
+end
+
+# vim:sw=2:ts=2:et:tw=78