htmlfilter 1.0.0 → 1.1

data/HISTORY

@@ -0,0 +1,25 @@
+= RELEASE HISTORY
+
+== 1.1 / 2009-11-24
+
+This is release adjusts the names of the classes to
+be capitialized according to the actual use of the
+terms. Some alternate options presets have been added
+as well, and this releaseo sheds the Multiton, which
+was basically a YAGNI.
+
+Changes:
+
+* Renamed HtmlFilter to HTMLFilter.
+* Renamed CssFilter to CSSFilter
+* HTMLFilter is no longer a Multiton.
+* Old names are still available temporarily.
+* Added built-in option constants.
+* CssTree is now CSSFilter::Tree.
+
+== 1.0.0 / 2009-06-25
+
+Changes:
+
+* Birthday! (Spun-off from Ruby Facets)
+

data/{Manifest.txt → MANIFEST}

@@ -1,19 +1,17 @@
 #!mast bin lib meta test [A-Z]*
-lib
 lib/cssfilter.rb
-lib/htmlfilter
-lib/htmlfilter/multiton.rb
 lib/htmlfilter.rb
-meta
-meta/package
-meta/project
+meta/collection
+meta/contact
+meta/description
+meta/homepage
+meta/name
+meta/repository
 meta/title
 meta/version
-test
 test/test_cssfilter.rb
 test/test_htmlfilter.rb
 Rakefile
-Manifest.txt
 TODO
 README.rdoc
-History.rdoc
+HISTORY

data/README.rdoc

@@ -1,6 +1,7 @@
 = HtmlFilter
 
 * http://rubyworks.github.com/htmlfilter
+* http://github.com/rubyworks/htmlfilter
 
 == DESCRIPTION:
 
@@ -14,8 +15,11 @@ whitespace and most importantly remove urls.
 
 == FEATURES:
 
-* Santize HTML
-* Compress CSS
+* Based on well-worn PHP library.
+* Regular expression based filtering.
+* Very efficient for small snippets, like blog comments.
+* Pure-Ruby and no dependencies.
+* Also has library to clean and compact cascading stylesheets.
 
 == SYNOPSIS:
 
@@ -27,14 +31,10 @@ Via the class.
 
 Or using the String extension.
 
-  html.html_filter  #=> "<b>hello</b>"
+  html.html_filter(options)  #=> "<b>hello</b>"
 
 See RDocs for more information.
 
-== REQUIREMENTS:
-
-* Uses a copy of multiton.rb (included)
-
 == INSTALL:
 
 * sudo gem install htmlfilter

data/TODO

@@ -2,6 +2,4 @@
 
 * Maybe write executable(s) to use library via commandline.
 * Elaborate on Features list in README.txt.
-* Rename class to HTMLFilter (instead of HtmlFilter)
-
 

data/lib/cssfilter.rb

@@ -1,6 +1,6 @@
 # = CSS Filter
 #
-# The CssFilter class will clean up a cascading style sheet.
+# The CSSFilter class will clean up a cascading stylesheet.
 # It can be used to remove whitespace and most importantly
 # remove urls.
 #
@@ -8,25 +8,27 @@
 #
 # * Trans
 #
-# == Todo
+# == Copying
 #
-# * Allow urls to be specified per attribute type.
+# Copyright (c) 2007 Thomas Sawyer
 #
-# == Copying
+# Creative Commons Attribution-ShareAlike 3.0 License
 #
-#   Copyright (c) 2007 7rans
+# Ref. http://creativecommons.org/licenses/by-sa/3.0/
+
+
+# TODO: Allow urls to be specified per attribute type.
 
 #require 'htmlfilter/uri'
 require 'uri'
 
 # = CSS Filter
 #
-# The CssFilter class will clean up a cascading style sheet.
+# The CSSFilter class will clean up a cascading style sheet.
 # It can be used to remove whitespace and most importantly
 # remove urls.
-#
-class CssFilter
-  VERSION="1.0.0"
+
+class CSSFilter
 
   # should we remove comments? (true, false)
   attr_accessor :strip_comments
@@ -158,7 +160,7 @@ class CssFilter
   # TODO: Not complete, does not work with "@xxx foo;" for example.
 
   def parse(css)
-    tree = CssTree.new
+    tree = Tree.new
     entries = css.scan(/^(.*?)\{(.*?)\}/m)
     entries.each do |ref, props|
       tree[ref.strip] ||= {}
@@ -196,31 +198,33 @@ class CssFilter
     return val
   end
 
-end
-
-
-# CSS parse tree. This is for a "deep filtering".
+  # CSS parse tree. This is for a "deep filtering".
 
-class CssTree < Hash
+  class Tree < Hash
 
-  def initialize(options=nil)
-    @options = options || {}
-    super()
-  end
+    def initialize(options=nil)
+      @options = options || {}
+      super()
+    end
 
-  # Re-output the CSS, all tidy ;)
+    # Re-output the CSS, all tidy ;)
 
-  def to_css
-    css = ""
-    each do |selector, entries|
-      css << "#{selector}{"
-      entries.each do |key, value|
-        css << "#{key}:#{value};"
+    def to_css
+      css = ""
+      each do |selector, entries|
+        css << "#{selector}{"
+        entries.each do |key, value|
+          css << "#{key}:#{value};"
+        end
+        css << "}\n"
       end
-      css << "}\n"
+      return css
     end
-    return css
+
   end
 
 end
 
+# For backward compatability. Eventually this will be deprecated.
+CssFilter = CSSFilter
+

data/lib/htmlfilter.rb

@@ -5,9 +5,8 @@
 # for instance.
 #
 # HtmlFilter is a port of lib_filter.php, v1.15 by Cal Henderson <cal@iamcal.com>
-#
-# This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License
-# http://creativecommons.org/licenses/by-sa/2.5/
+# licensed under a Creative Commons Attribution-ShareAlike 2.5 License
+# http://creativecommons.org/licenses/by-sa/2.5/.
 #
 # Thanks to Jang Kim for adding support for single quoted attributes.
 #
@@ -26,32 +25,35 @@
 #
 # == Copying
 #
-# Copyright (c) 2007 Trans
+# Copyright (c) 2007 Thomas Sawyer
+#
+# Creative Commons Attribution-ShareAlike 3.0 License
+#
+# Ref. http://creativecommons.org/licenses/by-sa/3.0/
 
-require 'htmlfilter/multiton.rb'
 
-# = HtmlFilter
+# = HTMLFilter
 #
 # HTML Filter library can be used to sanitize and sterilize
 # HTML. A good idea if you let users submit HTML in comments,
 # for instance.
 #
-# lib_filter.php, v1.15 by Cal Henderson <cal@iamcal.com>
+# == Usage
 #
-# This code is licensed under a Creative Commons Attribution-ShareAlike 2.5 License
-# http://creativecommons.org/licenses/by-sa/2.5/
-#
-# Thanks to Jang Kim for adding support for single quoted attributes.
+#   hf = HTMLFilter.new
+#   hf.filter("<b>Bold Action")  #=> "<b>Bold Action</b>"
 #
 # == Reference
 #
 # * http://iamcal.com/publish/articles/php/processing_html/
 # * http://iamcal.com/publish/articles/php/processing_html_part_2/
-
-class HtmlFilter
-  VERSION = "1.0.0"
-
-  include Multiton
+#
+# == Issues
+#
+# * The built in option constants could use a fair bit of refinement.
+# * Eventually the old HtmlFilter name needs to be deprecated.
+#
+class HTMLFilter
 
   # tags and attributes that are allowed
   #
@@ -85,7 +87,7 @@ class HtmlFilter
   # should we remove comments? (true, false)
   attr_accessor :strip_comments
 
-  # should we try and make a b tag out of "b>" (true, false)
+  # should we try and make a <b> tag out of "b>" (true, false)
   attr_accessor :always_make_tags
 
   # entity control option (true, false)
@@ -94,14 +96,18 @@ class HtmlFilter
   # entity control option (amp, gt, lt, quot, etc.)
   attr_accessor :allowed_entities
 
-  # default settings
+  ## max number of text characters at which to truncate (leave as +nil+ for no truncation)
+  #attr_accessor :truncate
 
+  # Default settings
   DEFAULT = {
     'allowed' => {
       'a'   => ['href', 'target'],
+      'img' => ['src', 'width', 'height', 'alt'],
       'b'   => [],
       'i'   => [],
-      'img' => ['src', 'width', 'height', 'alt']
+      'em'  => [],
+      'tt'  => [],
     },
     'no_close' => ['img', 'br', 'hr'],
     'always_close' => ['a', 'b'],
@@ -114,9 +120,75 @@ class HtmlFilter
     'allowed_entities' => ['amp', 'gt', 'lt', 'quot']
   }
 
-  # New html filter.
+  # Basic settings are simlialr to DEFAULT but do not allow any type
+  # of links, neither <tt>a href</tt> or <tt>img</tt>.
+  BASIC = {
+    'allowed' => {
+      'b'   => [],
+      'i'   => [],
+      'em'  => [],
+      'tt'  => [],
+    },
+    'no_close' => ['img', 'br', 'hr'],
+    'always_close' => ['a', 'b'],
+    'protocol_attributes' => ['src', 'href'],
+    'allowed_protocols' => ['http', 'ftp', 'mailto'],
+    'remove_blanks' => ['a', 'b'],
+    'strip_comments' => true,
+    'always_make_tags' => true,
+    'allow_numbered_entities' => true,
+    'allowed_entities' => ['amp', 'gt', 'lt', 'quot']
+  }
+
+  # Strict settings do not allow any tags.
+  STRICT = {
+    'allowed' => {},
+    'no_close' => ['img', 'br', 'hr'],
+    'always_close' => ['a', 'b'],
+    'protocol_attributes' => ['src', 'href'],
+    'allowed_protocols' => ['http', 'ftp', 'mailto'],
+    'remove_blanks' => ['a', 'b'],
+    'strip_comments' => true,
+    'always_make_tags' => true,
+    'allow_numbered_entities' => true,
+    'allowed_entities' => ['amp', 'gt', 'lt', 'quot']
+  }
 
-  def initialize( options=nil )
+  # Relaxed settings allows a great deal of HTML spec.
+  #
+  # TODO: Need to expand upon RELAXED options.
+  #
+  RELAXED = {
+    'allowed' => {
+      'a'    => ['class', 'href', 'target'],
+      'b'    => ['class'],
+      'i'    => ['class'],
+      'img'  => ['class', 'src', 'width', 'height', 'alt'],
+      'div'  => ['class'],
+      'pre'  => ['class'],
+      'code' => ['class'],
+      'ul'   => ['class'], 'ol' => ['class'], 'li' => ['class']
+    },
+    'no_close' => ['img', 'br', 'hr'],
+    'always_close' => ['a', 'b'],
+    'protocol_attributes' => ['src', 'href'],
+    'allowed_protocols' => ['http', 'ftp', 'mailto'],
+    'remove_blanks' => ['a', 'b'],
+    'strip_comments' => true,
+    'always_make_tags' => true,
+    'allow_numbered_entities' => true,
+    'allowed_entities' => ['amp', 'gt', 'lt', 'quot']
+  }
+
+  # New html filter.
+  #
+  # Provide custom +options+, or use one of the built-in options
+  # constants.
+  #
+  #   hf = HTMLFilter.new(HTMLFilter::RELAXED)
+  #   hf.filter(htmlstr)
+  #
+  def initialize(options=nil)
     if options
       h = DEFAULT.dup
       options.each do |k,v|
@@ -126,22 +198,20 @@ class HtmlFilter
     else
       options = DEFAULT.dup
     end
-
     options.each{ |k,v| send("#{k}=",v) }
   end
 
   # Filter html string.
 
-  def filter(data)
+  def filter(html)
     @tag_counts = {}
-
-    data = escape_comments(data)
-    data = balance_html(data)
-    data = check_tags(data)
-    data = process_remove_blanks(data)
-    data = validate_entities(data)
-
-    return data
+    html = escape_comments(html)
+    html = balance_html(html)
+    html = check_tags(html)
+    html = process_remove_blanks(html)
+    html = validate_entities(html)
+    #html = truncate_html(html)
+    html
   end
 
   private
@@ -504,13 +574,47 @@ class HtmlFilter
     return data
   end
 
+  ## HTML comment regular expression
+  #REM_RE = %r{<\!--(.*?)-->}
+  #
+  ## HTML tag regular expression
+  #TAG_RE = %r{</?\w+((\s+\w+(\s*=\s*(?:"(.|\n)*?"|'(.|\n)*?'|[^'">\s]+))?)+\s*|\s*)/?>}    #'
+  #
+  ##
+  #def truncate_html(html)
+  #  return html unless truncate
+  #  # default settings
+  #  limit = truncate
+  #
+  #  mask = html.gsub(REM_RE){ |m| "\0" * m.size }
+  #  mask = mask.gsub(TAG_RE){ |m| "\0" * m.size }
+  #
+  #  i, x = 0, 0
+  #
+  #  while i < mask.size && x < limit
+  #    x += 1 if mask[i] != "\0"
+  #    i += 1
+  #  end
+  #
+  #  while x > 0 && mask[x,1] == "\0"
+  #    x -= 1
+  #  end
+  #
+  #  return html[0..x]
+  #end
+
 end
 
 # Overload the standard String class for extra convienience.
 
 class String
   def html_filter(*opts)
-    HtmlFilter.new(*opts).filter(self)
+    HTMLFilter.new(*opts).filter(self)
   end
 end
 
+# For backward compatability. Eventually this will be deprecated.
+HtmlFilter = HTMLFilter
+
+
+

data/meta/contact

@@ -0,0 +1 @@
+rubyworks-mailinglist@googlegroups.com

data/meta/description

@@ -0,0 +1 @@
+Sanitize and sterilize HTML, also includes a CSS filter.

data/meta/homepage

@@ -0,0 +1 @@
+http://rubyworks.github.com/htmlfilter

data/meta/repository

@@ -0,0 +1 @@
+git://github.com/rubyworks/htmlfilter.git

data/meta/version

@@ -1 +1 @@
-1.0.0
+1.1

data/test/test_cssfilter.rb

@@ -2,7 +2,7 @@ require "test/unit"
 require "cssfilter"
 #require 'yaml'
 
-class TestCssFilter < Test::Unit::TestCase
+class TestCSSFilter < Test::Unit::TestCase
 
   def setup
     @css = <<-END
@@ -26,7 +26,7 @@ class TestCssFilter < Test::Unit::TestCase
   end
 
   def test_filter
-    cssfilter = CssFilter.new(:allowed_hosts=>["here.org"], :strip_whitespace => true)
+    cssfilter = CSSFilter.new(:allowed_hosts=>["here.org"], :strip_whitespace => true)
     csstree   = cssfilter.filter(@css)
     assert_equal(@result, csstree.to_s)
   end

data/test/test_htmlfilter.rb

@@ -1,28 +1,12 @@
 require "test/unit"
 require "htmlfilter"
 
-class TestHtmlFilter < Test::Unit::TestCase
+class TestHTMLFilter < Test::Unit::TestCase
 
   # core tests
 
-  def test_multiton_without_options
-    h1 = HtmlFilter.new
-    h2 = HtmlFilter.new
-    h3 = HtmlFilter.new( :strip_comments => false )
-    assert_equal( h1.object_id, h2.object_id )
-    assert_not_equal( h1.object_id, h3.object_id )
-  end
-
-  def test_multiton_with_options
-    h1 = HtmlFilter.new( :strip_comments => false )
-    h2 = HtmlFilter.new( :strip_comments => false )
-    h3 = HtmlFilter.new
-    assert_equal( h1.object_id, h2.object_id )
-    assert_not_equal( h1.object_id, h3.object_id )
-  end
-
   def test_strip_single
-    hf = HtmlFilter.new
+    hf = HTMLFilter.new
     assert_equal( '"', hf.send(:strip_single,'\"') )
     assert_equal( "\000", hf.send(:strip_single,'\0') )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: htmlfilter
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: "1.1"
 platform: ruby
 authors: []
 
@@ -9,46 +9,48 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-22 00:00:00 -04:00
+date: 2009-11-24 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: HTML Filter library can be used to sanitize and sterilize HTML. A good idea if you let users submit HTML in comments, for instance.   This library also include CssFilter. The CssFilter class will clean-up a cascading style sheet. It can be used to remove whitespace and most importantly remove urls.
-email: 
+description: Sanitize and sterilize HTML, also includes a CSS filter.
+email: rubyworks-mailinglist@googlegroups.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - Rakefile
-- Manifest.txt
+- MANIFEST
 - TODO
 - README.rdoc
-- History.rdoc
+- HISTORY
 files: 
 - lib/cssfilter.rb
-- lib/htmlfilter/multiton.rb
 - lib/htmlfilter.rb
-- meta/package
-- meta/project
+- meta/collection
+- meta/contact
+- meta/description
+- meta/homepage
+- meta/name
+- meta/repository
 - meta/title
 - meta/version
 - test/test_cssfilter.rb
 - test/test_htmlfilter.rb
 - Rakefile
-- Manifest.txt
 - TODO
 - README.rdoc
-- History.rdoc
+- HISTORY
+- MANIFEST
 has_rdoc: true
-homepage: 
+homepage: http://rubyworks.github.com/htmlfilter
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --title
-- htmlfilter api
+- HTMLFilter API
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -69,7 +71,7 @@ rubyforge_project: htmlfilter
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: HTML Filter library can be used to sanitize and sterilize HTML.
+summary: Sanitize and sterilize HTML, also includes a CSS filter.
 test_files: 
 - test/test_cssfilter.rb
 - test/test_htmlfilter.rb

data/History.rdoc

@@ -1,6 +0,0 @@
-=== 1.0.0 / 2009-06-25
-
-* 1 major enhancement
-
-  * Birthday!
-

data/lib/htmlfilter/multiton.rb

@@ -1,386 +0,0 @@
-# = Multiton
-#
-# == Synopsis
-#
-# Multiton design pattern ensures only one object is allocated for a given state.
-#
-# The 'multiton' pattern is similar to a singleton, but instead of only one
-# instance, there are several similar instances.  It is useful when you want to
-# avoid constructing objects many times because of some huge expense (connecting
-# to a database for example), require a set of similar but not identical
-# objects, and cannot easily control how many times a contructor may be called.
-#
-#   class SomeMultitonClass
-#     include Multiton
-#     attr :arg
-#     def initialize(arg)
-#       @arg = arg
-#     end
-#   end
-#
-#   a = SomeMultitonClass.new(4)
-#   b = SomeMultitonClass.new(4)   # a and b are same object
-#   c = SomeMultitonClass.new(2)   # c is a different object
-#
-# == Previous Behavior
-#
-# In previous versions of Multiton the #new method was made
-# private and #instance had to be used in its stay --just like Singleton.
-# But this is less desirable for Multiton since Multitions can
-# have multiple instances, not just one.
-#
-# So instead Multiton now defines #create as a private alias of
-# the original #new method (just in case it is needed) and then
-# defines #new to handle the multiton; #instance is provided
-# as an alias for it.
-#
-#--
-# So if you must have the old behavior, all you need do is re-alias
-# #new to #create and privatize it.
-#
-#   class SomeMultitonClass
-#     include Multiton
-#     alias_method :new, :create
-#     private :new
-#     ...
-#   end
-#
-# Then only #instance will be available for creating the Multiton.
-#++
-#
-# == How It Works
-#
-# A pool of objects is searched for a previously cached object,
-# if one is not found we construct one and cache it in the pool
-# based on class and the args given to the contructor.
-#
-# A limitation of this approach is that it is impossible to
-# detect if different blocks were given to a contructor (if it takes a
-# block).  So it is the constructor arguments _only_ which determine
-# the uniqueness of an object. To workaround this, define the _class_
-# method ::multiton_id.
-#
-#   def Klass.multiton_id(*args, &block)
-#     # ...
-#   end
-#
-# Which should return a hash key used to identify the object being
-# constructed as (not) unique.
-#
-# == Authors
-#
-# * Christoph Rippel
-# * Thomas Sawyer
-#
-# = Copying
-#
-# Copyright (c) 2007 Christoph Rippel, Thomas Sawyer
-#
-# Ruby License
-#
-# This module is free software. You may use, modify, and/or redistribute this
-# software under the same terms as Ruby.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.
-
-require 'thread'
-
-# = Multiton
-#
-# Multiton design pattern ensures only one object is allocated for a given state.
-#
-# The 'multiton' pattern is similar to a singleton, but instead of only one
-# instance, there are several similar instances.  It is useful when you want to
-# avoid constructing objects many times because of some huge expense (connecting
-# to a database for example), require a set of similar but not identical
-# objects, and cannot easily control how many times a contructor may be called.
-#
-#   class SomeMultitonClass
-#     include Multiton
-#     attr :arg
-#     def initialize(arg)
-#       @arg = arg
-#     end
-#   end
-#
-#   a = SomeMultitonClass.new(4)
-#   b = SomeMultitonClass.new(4)   # a and b are same object
-#   c = SomeMultitonClass.new(2)   # c is a different object
-#
-# == How It Works
-#
-# A pool of objects is searched for a previously cached object,
-# if one is not found we construct one and cache it in the pool
-# based on class and the args given to the contructor.
-#
-# A limitation of this approach is that it is impossible to
-# detect if different blocks were given to a contructor (if it takes a
-# block).  So it is the constructor arguments _only_ which determine
-# the uniqueness of an object. To workaround this, define the _class_
-# method ::multiton_id.
-#
-#   def Klass.multiton_id(*args, &block)
-#     # ...
-#   end
-#
-# Which should return a hash key used to identify the object being
-# constructed as (not) unique.
-
-module Multiton
-
-  #  disable build-in copying methods
-
-  def clone
-    raise TypeError, "can't clone Multiton #{self}"
-    #self
-  end
-
-  def dup
-    raise TypeError, "can't dup Multiton #{self}"
-    #self
-  end
-
-  # default marshalling strategy
-
-  protected
-
-  def _dump(depth=-1)
-    Marshal.dump(@multiton_initializer)
-  end
-
-  # Mutex to safely store multiton instances.
-
-  class InstanceMutex < Hash  #:nodoc:
-    def initialize
-      @global = Mutex.new
-    end
-
-    def initialized(arg)
-      store(arg, DummyMutex)
-    end
-
-    def (DummyMutex = Object.new).synchronize
-      yield
-    end
-
-    def default(arg)
-      @global.synchronize{ fetch(arg){ store(arg, Mutex.new) } }
-    end
-  end
-
-  # Multiton can be included in another module, in which case that module effectively becomes
-  # a multiton behavior distributor too. This is why we propogate #included to the base module.
-  # by putting it in another module.
-  #
-  #--
-  #    def append_features(mod)
-  #      #  help out people counting on transitive mixins
-  #      unless mod.instance_of?(Class)
-  #        raise TypeError, "Inclusion of Multiton in module #{mod}"
-  #      end
-  #      super
-  #    end
-  #++
-
-  module Inclusive
-    private
-    def included(base)
-      class << base
-        #alias_method(:new!, :new) unless method_defined?(:new!)
-        # gracefully handle multiple inclusions of Multiton
-        unless include?(Multiton::MetaMethods)
-          alias_method :new!, :new
-          private :allocate #, :new
-          include Multiton::MetaMethods
-
-          if method_defined?(:marshal_dump)
-            undef_method :marshal_dump
-            warn "warning: marshal_dump was undefined since it is incompatible with the Multiton pattern"
-          end
-        end
-      end
-    end
-  end
-
-  extend Inclusive
-
-  #
-
-  module MetaMethods
-
-    include Inclusive
-
-    def instance(*e, &b)
-      arg = multiton_id(*e, &b)
-      multiton_instance.fetch(arg) do
-        multiton_mutex[arg].synchronize do
-          multiton_instance.fetch(arg) do
-            val = multiton_instance[arg] = new!(*e, &b) #new(*e, &b)
-            val.instance_variable_set(:@multiton_initializer, e, &b)
-            multiton_mutex.initialized(arg)
-            val
-          end
-        end
-      end
-    end
-    alias_method :new, :instance
-
-    def initialized?(*e, &b)
-      multiton_instance.key?(multiton_id(*e, &b))
-    end
-
-    protected
-
-    def multiton_instance
-      @multiton_instance ||= Hash.new
-    end
-
-    def multiton_mutex
-      @multiton_mutex ||= InstanceMutex.new
-    end
-
-    def reinitialize
-      multiton_instance.clear
-      multiton_mutex.clear
-    end
-
-    def _load(str)
-      instance(*Marshal.load(str))
-    end
-
-    private
-
-    # Default method to to create a key to cache already constructed
-    # instances. In the use case MultitonClass.new(e), MultiClass.new(f)
-    # must be semantically equal if multiton_id(e).eql?(multiton_id(f))
-    # evaluates to true.
-    def multiton_id(*e, &b)
-      e
-    end
-
-    def singleton_method_added(sym)
-      super
-      if (sym == :marshal_dump) & singleton_methods.include?('marshal_dump')
-        raise TypeError, "Don't use marshal_dump - rely on _dump and _load instead"
-      end
-    end
-
-  end
-
-end
-
-
-
-
-=begin
-# TODO Convert this into a real test and/or benchmark.
-
-if $0 == __FILE__
-
-  ### Simple marshalling test #######
-  class A
-    def initialize(a,*e)
-      @e = a
-    end
-
-    include Multiton
-    begin
-      def self.marshal_dump(depth = -1)
-      end
-    rescue => mes
-      p mes
-      class << self; undef marshal_dump end
-    end
-  end
-
-  C = Class.new(A.clone)
-  s = C.instance('a','b')
-
-  raise unless Marshal.load(Marshal.dump(s)) == s
-
-
-  ### Interdependent initialization example and threading benchmark ###
-
-  class Regular_SymPlane
-    def self.multiton_id(*e)
-        a,b = e
-        (a+b - 1)*(a+b )/2  + (a > b ? a : b)
-    end
-
-    def initialize(a,b)
-      klass = self.class
-      if a < b
-        @l =  b > 0 ?  klass.instance(a,b-1) : nil
-        @r =  a > 0 ?  klass.instance(a-1,b) : nil
-      else
-        @l =  a > 0 ?  klass.instance(a-1,b) : nil
-        @r =  b > 0 ?  klass.instance(a,b-1) : nil
-      end
-    end
-
-    include Multiton
-  end
-
-
-
-  def nap
-  # Thread.pass
-  sleep(rand(0.01))
-  end
-
-  class SymPlane < Regular_SymPlane
-    @m = Mutex.new
-    @count = 0
-  end
-
-  class << SymPlane
-    attr_reader :count
-    def reinitialize
-      super
-      @m = Mutex.new
-      @count = 0
-    end
-    def inherited(sub_class)
-      super
-      sub_class.instance_eval { @m = Mutex.new; @count = 0 }
-    end
-
-    def multiton_id(*e)
-      nap()
-      super
-    end
-
-    def new!(*e)  # NOTICE!!!
-      super
-    ensure
-      nap()
-      @m.synchronize { p @count if (@count += 1) % 15 == 0 }
-    end
-
-    def run(k)
-      threads = 0
-      max = k * (k+1) / 2
-      puts ""
-      while count() < max
-        Thread.new { threads+= 1; instance(rand(30),rand(30)) }
-      end
-      puts "\nThe simulation created #{threads} threads"
-    end
-  end
-
-
-  require 'benchmark'
-  include Benchmark
-
-  bmbm do |x|
-    x.report('Initialize 465 SymPlane instances') { SymPlane.run(30) }
-    x.report('Reinitialize ') do
-      sleep 3
-      SymPlane.reinitialize
-    end
-  end
-
-end
-=end