rhodes 3.3.3.beta.4 → 3.3.3

data/lib/extensions/pdf-writer/color/rgb/metallic.rb

@@ -0,0 +1,43 @@
+#--
+# Color
+# Colour management with Ruby
+# http://rubyforge.org/projects/color
+#   Version 1.4.1
+#
+# Licensed under a MIT-style licence. See Licence.txt in the main
+# distribution for full licensing information.
+#
+# Copyright (c) 2005 - 2010 Austin Ziegler and Matt Lyon
+#++
+
+# This namespace contains some RGB metallic colours suggested by Jim Freeze.
+module Color::RGB::Metallic
+  Aluminum    = Color::RGB.new(0x99, 0x99, 0x99)
+  CoolCopper  = Color::RGB.new(0xd9, 0x87, 0x19)
+  Copper      = Color::RGB.new(0xb8, 0x73, 0x33)
+  Iron        = Color::RGB.new(0x4c, 0x4c, 0x4c)
+  Lead        = Color::RGB.new(0x19, 0x19, 0x19)
+  Magnesium   = Color::RGB.new(0xb3, 0xb3, 0xb3)
+  Mercury     = Color::RGB.new(0xe6, 0xe6, 0xe6)
+  Nickel      = Color::RGB.new(0x80, 0x80, 0x80)
+  PolySilicon = Color::RGB.new(0x60, 0x00, 0x00)
+  Poly        = PolySilicon
+  Silver      = Color::RGB.new(0xcc, 0xcc, 0xcc)
+  Steel       = Color::RGB.new(0x66, 0x66, 0x66)
+  Tin         = Color::RGB.new(0x7f, 0x7f, 0x7f)
+  Tungsten    = Color::RGB.new(0x33, 0x33, 0x33)
+
+  Aluminum.freeze
+  CoolCopper.freeze
+  Copper.freeze
+  Iron.freeze
+  Lead.freeze
+  Magnesium.freeze
+  Mercury.freeze
+  Nickel.freeze
+  PolySilicon.freeze
+  Silver.freeze
+  Steel.freeze
+  Tin.freeze
+  Tungsten.freeze
+end

data/lib/extensions/pdf-writer/color/yiq.rb

@@ -0,0 +1,84 @@
+#--
+# Color
+# Colour management with Ruby
+# http://rubyforge.org/projects/color
+#   Version 1.4.1
+#
+# Licensed under a MIT-style licence. See Licence.txt in the main
+# distribution for full licensing information.
+#
+# Copyright (c) 2005 - 2010 Austin Ziegler and Matt Lyon
+#++
+
+# A colour object representing YIQ (NTSC) colour encoding.
+class Color::YIQ
+  # Creates a YIQ colour object from fractional values 0 .. 1.
+  #
+  #   Color::YIQ.new(0.3, 0.2, 0.1)
+  def self.from_fraction(y = 0, i = 0, q = 0)
+    color = Color::YIQ.new
+    color.y = y
+    color.i = i
+    color.q = q
+    color
+  end
+
+  # Creates a YIQ colour object from percentages 0 .. 100.
+  #
+  #   Color::YIQ.new(10, 20, 30)
+  def initialize(y = 0, i = 0, q = 0)
+    @y = y / 100.0
+    @i = i / 100.0
+    @q = q / 100.0
+  end
+
+  # Compares the other colour to this one. The other colour will be
+  # converted to YIQ before comparison, so the comparison between a YIQ
+  # colour and a non-YIQ colour will be approximate and based on the other
+  # colour's #to_yiq conversion. If there is no #to_yiq conversion, this
+  # will raise an exception. This will report that two YIQ values are
+  # equivalent if all component colours are within COLOR_TOLERANCE of each
+  # other.
+  def ==(other)
+    other = other.to_yiq
+    other.kind_of?(Color::YIQ) and
+    ((@y - other.y).abs <= Color::COLOR_TOLERANCE) and
+    ((@i - other.i).abs <= Color::COLOR_TOLERANCE) and
+    ((@q - other.q).abs <= Color::COLOR_TOLERANCE) 
+  end
+
+  def to_yiq
+    self
+  end
+
+  def brightness
+    @y
+  end
+  def to_grayscale
+    Color::GrayScale.new(@y)
+  end
+  alias to_greyscale to_grayscale
+
+  def y
+    @y
+  end
+  def y=(yy)
+    @y = Color.normalize(yy)
+  end
+  def i
+    @i
+  end
+  def i=(ii)
+    @i = Color.normalize(ii)
+  end
+  def q
+    @q
+  end
+  def q=(qq)
+    @q = Color.normalize(qq)
+  end
+
+  def inspect
+    "YIQ [%.2f%%, %.2f%%, %.2f%%]" % [ @y * 100, @i * 100, @q * 100 ]
+  end
+end

data/lib/extensions/pdf-writer/ext/LICENSES/color/Licence.txt

@@ -0,0 +1,27 @@
+Color
+Colour management in Ruby
+http://rubyforge.org/projects/color/
+
+Copyright (c) 2005 - 2010 Austin Ziegler, Matt Lyon, and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+* The names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/extensions/pdf-writer/ext/LICENSES/color/README.txt

@@ -0,0 +1,32 @@
+= Color
+Color is a Ruby library to provide basic RGB, CMYK, HSL, and other colourspace
+manipulation support to applications that require it. It also provides 152
+named RGB colours (184 with spelling variations) that are commonly supported
+in HTML, SVG, and X11 applications. A technique for generating monochromatic
+contrasting palettes is also included.
+
+The capabilities of the Color library are limited to pure mathematical
+manipulation of the colours based on colour theory without reference to colour
+profiles (such as sRGB or Adobe RGB). For most purposes, when working with the
+RGB and HSL colours, this won't matter. However, some colour models (like CIE
+L*a*b*) are not supported because Color does not yet support colour profiles,
+giving no meaningful way to convert colours in absolute colour spaces (like
+L*a*b*, XYZ) to non-absolute colour spaces (like RGB).
+
+Color version 1.4 is the result of a project merge between color.rb 0.1.0 by
+Matt Lyon and color-tools 1.3 by Austin Ziegler. Please see History.txt for
+details on the changes this merge brings. Color version 1.4.1 changes
+development to GitHub and fixes some small problems.
+
+Copyright:: Copyright (c) 2005 - 2010 by Austin Ziegler and Matt Lyon
+Version::   1.4.1
+Homepage::  http://rubyforge.org/projects/color/
+Licence::   MIT-Style; see Licence.txt
+
+Color::Palette was developed based on techniques described by Andy "Malarkey"
+Clarke[1], implemented in JavaScript by Steve G. Chipman at SlayerOffice[2] and
+by Patrick Fitzgerald of BarelyFitz[3] in PHP.
+
+[1] http://www.stuffandnonsense.co.uk/archives/creating_colour_palettes.html 
+[2] http://slayeroffice.com/tools/color_palette/
+[3] http://www.barelyfitz.com/projects/csscolor/

data/lib/extensions/pdf-writer/ext/LICENSES/pdf-writer/LICENCE

@@ -0,0 +1,131 @@
+= PDF::Writer for Ruby
+Homepage::  http://rubyforge.org/projects/ruby-pdf/
+Copyright:: Copyright � 2003�2005 Austin Ziegler. 
+Summary::   MIT-style                             
+
+This project had a change of maintainers in November, 2007.
+New developments are now copyrighted by Gregory Brown and Michael Milner,
+unless otherwise noted.
+
+---
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+* The names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+== Works Included Under Other Licences
+=== pdf/writer/graphics/imageinfo.rb
+PDF::Writer includes a derivative of Keisuke Minami's ImageSize library,
+which can be found at rubycgi[http://www.rubycgi.org/tools/index.en.htm].
+This work�and only this or other named works�may be treated as under the Ruby
+licensing scheme (GPL 2 or later, Ruby's licence) as well as the overall
+PDF::Writer licence.
+
+=== Ruby Quick Reference Sheets
+PDF::Writer has demo programs that will create Quick Reference cards for
+Ruby. The content and output of these programs is copyright 2003�2005 Ryan
+Davis and is licensed under the Creative Commons
+Attribution-NonCommercial-ShareAlike[http://creativecommons.org/licenses/by-nc-sa/2.0/]
+licence.
+
+=== Images from "Why's (Poignant) Guide to Ruby"
+One of the demo programs uses images originally from "Why's (Poignant) Guide
+to Ruby"[http://poignantguide.net/ruby], with permission. These immages are
+released under the Creative Commons
+Attributions ShareAlike[http://creativecommons.org/licenses/by-sa/2.0/]
+licence.
+
+=== Adobe PostScript AFM Files
+pdf/writer/fonts/MustRead.html and the 14 PostScript(R) AFM files it
+accompanies may be used, copied, and distributed for any purpose and without
+charge, with or without modification, provided that all copyright notices are
+retained; that the AFM files are not distributed without this file; that all
+modifications to this file or any of the AFM files are prominently noted in
+the modified file(s); and that this paragraph is not modified. Adobe Systems
+has no responsibility or obligation to support the use of the AFM files.
+
+== Other Credits
+=== PDF::Writer
+PDF::Writer is based originally on the R & OS PDF class for
+PHP[http://www.ros.co.nz/pdf/], which is released as public domain.
+
+=== Standard Deviation Chart
+The standard deviation chart (pdf/charts/stddev.rb) class is based on
+work by Cris Ewing[mailto:cewing@u.washington.edu] of the University of
+Washington School of Medicine, originally created for the R & OS PDF class
+for PHP. He has graciously donated the code for PDF::Writer for Ruby.
+
+=== bluesmoke.jpg
+The logo image for PDF::Writer, bluesmoke.jpg, is modified from a picture
+taken by Matthew "TheSaint" Bowden[mailto:matthewbowden@gmail.com] and is
+available on the stock.xchng(R) at
+<http://www.sxc.hu/browse.phtml?f=view&id=275430>. Many thanks to Matthew for
+the use of this image.
+
+== Patents Covering the Adobe PDF Format
+=== ADOBE PATENTS
+This software is based on Adobe's PDF Reference, Third Edition, version 1.6.
+There may be limitations on the use of this library based on patent
+restrictions from Adobe. See bewlow for more information.
+
+=== UNISYS LZW PATENT
+This software does not fully conform to the Adobe PDF specification because
+no support for LZW is included in this software. At the time of original
+development of this software (2003), the Unisys LZW patent was still in
+effect outside of the United States. This will be modified in a future
+version of this software.
+
+== Patent Clarification Notice: Reading and Writing PDF Files
+Adobe has a number of patents covering technology that is disclosed in the
+Portable Document Format (PDF) Specification, version 1.6 and later, as
+documented in PDF Reference and associated Technical Notes (the
+"Specification". Adobe desires to promote the use of PDF for information
+interchange among diverse products and applications.
+
+Accordingly, the following patents are licensed on a royalty-free, non-
+exclusive basis for the term of each patent and for the sole purpose of
+developing software that produces, consumes, and interprets PDF files that
+are compliant with the Specification:
+
+U.S. Patent Numbers: 5,634,064; 5,737,599; 5,781,785; 5,819,301; 6,028,583;
+6,289,364; 6,421,460
+
+In addition, the following patent is licensed on a royalty-free, non-
+exclusive basis for its term and for the sole purpose of developing software
+that produces PDF files that are compliant with the Specification
+(specifically excluding, however, software that consumes and/or interprets
+PDF files):
+
+U.S. Patent Numbers: 5,860,074
+
+The above licenses are limited to only those rights required to implement the
+Specification and no others. That is to say, Adobe grants only those rights
+in the above patent(s) necessarily practiced to implement the Specification,
+and does not grant any rights not required to implement the Specification.
+The licenses do not grant the right to practice any patent covering other
+technologies, such as implementation techniques that are not explicitly
+disclosed in the Specification, nor does it allow the use of any patented
+feature for any purpose other than as set forth in the applicable license
+grant. Adobe has other patents in various fields, none of which are hereby
+licensed.
+
+$Id: LICENCE 182 2007-12-10 03:17:15Z sandal $
+# vim: sts=2 sw=2 ts=4 et ai tw=77

data/lib/extensions/pdf-writer/ext/LICENSES/pdf-writer/README

@@ -0,0 +1,33 @@
+= PDF::Writer for Ruby
+This library provides the ability to create PDF documents using only native
+Ruby libraries. There are several demo programs available in the demo/
+directory. The canonical documentation for PDF::Writer is "manual.pdf", which
+can be generated using bin/techbook (just "techbook" for RubyGem users) and
+the manual file "manual.pwd".
+
+Homepage::  http://rubyforge.org/projects/ruby-pdf/
+Copyright:: 2003�2005, Austin Ziegler
+
+This software is based on Adobe's PDF Reference, Fifth Edition, version 1.6.
+This and earlier editions are available from Adobe's PDF developer
+website[http://partners.adobe.com/public/developer/pdf/index_reference.html].
+
+== LICENCE NOTES
+Please read the file LICENCE for licensing restrictions on this library, as
+well as important patent considerations.
+
+== Requirements
+PDF::Writer requires Ruby 1.8.2 or better, Color 1.4.0 or better, and
+Transaction::Simple 1.3.0 or better.
+
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: README 196 2008-01-04 23:15:50Z sandal $
+#++
+# vim: sts=2 sw=2 ts=4 et ai tw=77

data/lib/extensions/pdf-writer/ext/LICENSES/transaction-simple/Licence.txt

@@ -0,0 +1,25 @@
+Transaction::Simple
+Simple object transaction support for Ruby
+http://rubyforge.org/projects/trans-simple/
+
+Copyright (c) 2003 - 2007 Austin Ziegler
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+$Id: simple.rb,v 1.7 2005/06/12 19:48:17 austin Exp $

data/lib/extensions/pdf-writer/ext/LICENSES/transaction-simple/Readme.txt

@@ -0,0 +1,204 @@
+= Transaction::Simple for Ruby
+
+Transaction::Simple provides a generic way to add active transaction
+support to objects. The transaction methods added by this module will work
+with most objects, excluding those that cannot be Marshal-ed (bindings,
+procedure objects, IO instances, or singleton objects).
+
+The transactions supported by Transaction::Simple are not associated with
+any sort of data store. They are "live" transactions occurring in memory
+on the object itself. This is to allow "test" changes to be made to an
+object before making the changes permanent.
+
+Transaction::Simple can handle an "infinite" number of transaction levels
+(limited only by memory). If I open two transactions, commit the second,
+but abort the first, the object will revert to the original version.
+
+Transaction::Simple supports "named" transactions, so that multiple levels
+of transactions can be committed, aborted, or rewound by referring to the
+appropriate name of the transaction. Names may be any object except nil.
+
+Transaction groups are also supported. A transaction group is an object
+wrapper that manages a group of objects as if they were a single object
+for the purpose of transaction management. All transactions for this group
+of objects should be performed against the transaction group object, not
+against individual objects in the group.
+
+Version 1.4.0 of Transaction::Simple adds a new post-rewind hook so that
+complex graph objects of the type in tests/tc_broken_graph.rb can correct
+themselves.
+
+Copyright:: Copyright (c) 2003 - 2007 by Austin Ziegler
+Version::   1.4.0
+Homepage::  http://rubyforge.org/projects/trans-simple/
+Licence::   MIT-Style; see Licence.txt
+
+Thanks to David Black, Mauricio Fernandez, Patrick Hurley, Pit Capitain, and
+Matz for their assistance with this library.
+
+== Usage
+  include 'transaction/simple'
+
+  v = "Hello, you."               # -> "Hello, you."
+  v.extend(Transaction::Simple)   # -> "Hello, you."
+
+  v.start_transaction             # -> ... (a Marshal string)
+  v.transaction_open?             # -> true
+  v.gsub!(/you/, "world")         # -> "Hello, world."
+
+  v.rewind_transaction            # -> "Hello, you."
+  v.transaction_open?             # -> true
+
+  v.gsub!(/you/, "HAL")           # -> "Hello, HAL."
+  v.abort_transaction             # -> "Hello, you."
+  v.transaction_open?             # -> false
+
+  v.start_transaction             # -> ... (a Marshal string)
+  v.start_transaction             # -> ... (a Marshal string)
+
+  v.transaction_open?             # -> true
+  v.gsub!(/you/, "HAL")           # -> "Hello, HAL."
+
+  v.commit_transaction            # -> "Hello, HAL."
+  v.transaction_open?             # -> true
+  v.abort_transaction             # -> "Hello, you."
+  v.transaction_open?             # -> false
+
+== Named Transaction Usage
+  v = "Hello, you."               # -> "Hello, you."
+  v.extend(Transaction::Simple)   # -> "Hello, you."
+
+  v.start_transaction(:first)     # -> ... (a Marshal string)
+  v.transaction_open?             # -> true
+  v.transaction_open?(:first)     # -> true
+  v.transaction_open?(:second)    # -> false
+  v.gsub!(/you/, "world")         # -> "Hello, world."
+
+  v.start_transaction(:second)    # -> ... (a Marshal string)
+  v.gsub!(/world/, "HAL")         # -> "Hello, HAL."
+  v.rewind_transaction(:first)    # -> "Hello, you."
+  v.transaction_open?             # -> true
+  v.transaction_open?(:first)     # -> true
+  v.transaction_open?(:second)    # -> false
+
+  v.gsub!(/you/, "world")         # -> "Hello, world."
+  v.start_transaction(:second)    # -> ... (a Marshal string)
+  v.gsub!(/world/, "HAL")         # -> "Hello, HAL."
+  v.transaction_name              # -> :second
+  v.abort_transaction(:first)     # -> "Hello, you."
+  v.transaction_open?             # -> false
+
+  v.start_transaction(:first)     # -> ... (a Marshal string)
+  v.gsub!(/you/, "world")         # -> "Hello, world."
+  v.start_transaction(:second)    # -> ... (a Marshal string)
+  v.gsub!(/world/, "HAL")         # -> "Hello, HAL."
+
+  v.commit_transaction(:first)    # -> "Hello, HAL."
+  v.transaction_open?             # -> false
+
+== Block Transaction Usage
+  v = "Hello, you."               # -> "Hello, you."
+  Transaction::Simple.start(v) do |tv|
+      # v has been extended with Transaction::Simple and an unnamed
+      # transaction has been started.
+    tv.transaction_open?          # -> true
+    tv.gsub!(/you/, "world")      # -> "Hello, world."
+
+    tv.rewind_transaction         # -> "Hello, you."
+    tv.transaction_open?          # -> true
+
+    tv.gsub!(/you/, "HAL")        # -> "Hello, HAL."
+      # The following breaks out of the transaction block after
+      # aborting the transaction.
+    tv.abort_transaction          # -> "Hello, you."
+  end
+    # v still has Transaction::Simple applied from here on out.
+  v.transaction_open?             # -> false
+
+  Transaction::Simple.start(v) do |tv|
+    tv.start_transaction          # -> ... (a Marshal string)
+
+    tv.transaction_open?          # -> true
+    tv.gsub!(/you/, "HAL")        # -> "Hello, HAL."
+
+      # If #commit_transaction were called without having started a
+      # second transaction, then it would break out of the transaction
+      # block after committing the transaction.
+    tv.commit_transaction         # -> "Hello, HAL."
+    tv.transaction_open?          # -> true
+    tv.abort_transaction          # -> "Hello, you."
+  end
+  v.transaction_open?             # -> false
+
+== Transaction Groups
+  require 'transaction/simple/group'
+
+  x = "Hello, you."
+  y = "And you, too."
+
+  g = Transaction::Simple::Group.new(x, y)
+  g.start_transaction(:first)     # -> [ x, y ]
+  g.transaction_open?(:first)     # -> true
+  x.transaction_open?(:first)     # -> true
+  y.transaction_open?(:first)     # -> true
+
+  x.gsub!(/you/, "world")         # -> "Hello, world."
+  y.gsub!(/you/, "me")            # -> "And me, too."
+
+  g.start_transaction(:second)    # -> [ x, y ]
+  x.gsub!(/world/, "HAL")         # -> "Hello, HAL."
+  y.gsub!(/me/, "Dave")           # -> "And Dave, too."
+
+  g.rewind_transaction(:second)   # -> [ x, y ]
+  x                               # -> "Hello, world."
+  y                               # -> "And me, too."
+
+  x.gsub!(/world/, "HAL")         # -> "Hello, HAL."
+  y.gsub!(/me/, "Dave")           # -> "And Dave, too."
+
+  g.commit_transaction(:second)   # -> [ x, y ]
+  x                               # -> "Hello, HAL."
+  y                               # -> "And Dave, too."
+
+  g.abort_transaction(:first)     # -> [ x, y ]
+  x                               = -> "Hello, you."
+  y                               = -> "And you, too."
+
+== Thread Safety
+Threadsafe versions of Transaction::Simple and Transaction::Simple::Group
+exist; these are loaded from 'transaction/simple/threadsafe' and
+'transaction/simple/threadsafe/group', respectively, and are represented in
+Ruby code as Transaction::Simple::ThreadSafe and
+Transaction::Simple::ThreadSafe::Group, respectively.
+
+== Contraindications
+While Transaction::Simple is very useful, it has limitations that must be
+understood prior to using it. Transaction::Simple:
+
+* uses Marshal. Thus, any object which cannot be Marshal-ed cannot use
+  Transaction::Simple. In my experience, this affects singleton objects
+  more often than any other object.
+* does not manage external resources. Resources external to the object and
+  its instance variables are not managed at all. However, all instance
+  variables and objects "belonging" to those instance variables are
+  managed. If there are object reference counts to be handled,
+  Transaction::Simple will probably cause problems.
+* is not thread-safe. In the ACID ("atomic, consistent, isolated,
+  durable") test, Transaction::Simple provides consistency and durability, but
+  cannot itself provide isolation. Transactions should be considered "critical
+  sections" in multi-threaded applications. Thread safety of the transaction
+  acquisition and release process itself can be ensured with the thread-safe
+  version, Transaction::Simple::ThreadSafe. With transaction groups, some
+  level of atomicity is assured.
+* does not maintain Object#__id__ values on rewind or abort. This only affects
+  complex self-referential graphs. tests/tc_broken_graph.rb demonstrates this
+  and its mitigation with the new post-rewind hook. #_post_transaction_rewind.
+  Matz has implemented an experimental feature in Ruby 1.9 that may find its
+  way into the released Ruby 1.9.1 and ultimately Ruby 2.0 that would obviate
+  the need for #_post_transaction_rewind. Pit Capitain has also suggested a
+  workaround that does not require changes to core Ruby, but does not work in
+  all cases. A final resolution is still pending further discussion.
+* Can be a memory hog if you use many levels of transactions on many
+  objects.
+
+$Id: Readme.txt 50 2007-02-03 20:26:19Z austin $