spreadsheet-excel 0.3.4

data/CHANGES

@@ -0,0 +1,124 @@
+== 0.3.4 - 17-Feb-2006
+* Added a workaround for a bug in Ruby 1.8.3 and Ruby 1.8.4 where subclasses
+  of IO are not guaranteed to call IO#close in block form.
+* Added support for hidden and outlined cells in the Worksheet#format_row
+  method.  Thanks go to Jade Meskill for the patch.
+
+== 0.3.3 - 5-Dec-2005
+* Made an change in the Workbook class, by splitting out the OLEWriter
+  handling into its own method.  This is an internal change only that was
+  made as an attempt to eliminate an Errno::EBADF bug reported by
+  Stephen Bannasch.  It's also cleaner code in general.
+
+== 0.3.2 - 12-Oct-2005
+* Fixed bug/quirk for MS Windows where the file mode wasn't being passed
+  properly.
+* Fix for the install.rb code.
+* Renamed "example_formula.rb" to "example_format.rb" (oops).
+* Minor update for the example programs.
+* Corrected the release dates for 0.3.0 and 0.3.1.
+
+== 0.3.1 - 11-Oct-2005
+* Directory layout change for the sake of gems.
+* Fixes, and rename, for the gemspec.
+
+== 0.3.0 - 10-Oct-2005
+* The OLEWriter class is now a subclass of IO instead of File, and takes a
+  string, fileno or IO object for an argument.  This means you are not bound
+  to write the contents to a file (RFE #1183036).
+* Bug fixed in the Format class that was causing black cells (Bug #1044052).
+* Removed the INSTALL file.  Installation instructions can now be found in
+  the README file.
+* Removed the InvalidTypeError class. Now just uses TypeError where
+  appropriate.
+* Added the Worksheet#format_rectangle method (RFE #1043418).
+* Removed the .rd and .html documents.  The .txt files, and most other
+  files, are now rdoc friendly.
+* Moved sample scripts to the 'examples' directory.
+* Test suite additions and changes.
+
+== 0.2.9 - 11-Jun-2004
+* Added 'brown','cyan' and 'magenta' to the list of valid color strings
+  for Format objects.
+* Fixed bugs and slightly modified handling with regards to color,
+  bg_color and fg_color attributes for Format objects.  Thanks go to
+  David Brady for the spot.
+* Minor optimization for the append and prepend methods in the BiffWriter
+  class
+* Minor $LOAD_PATH correction for test.rb
+* Added some more unit tests for Format ojbects.
+* Added warranty information
+
+== 0.2.8 - 2-Dec-2003
+* Eliminated warnings for 1.8.x
+* Added a README file (which you should, of course, read)
+* Tidied up test suite a bit, and made it MS Windows-friendly.
+* Separated rd docs from source.  They are now in the 'doc' directory.  In
+  the future, I plan to use RDoc for this package.
+* Eliminated warnings caused by worksheet.rb when $DEBUG mode was used
+  (method redefinitions).
+* Renamed test cases to "tc_" for (foolish?) consistency with my other
+  packages.
+* Removed the VERSION() class method - use the constant instead.
+
+== 0.2.7 - 18-May-2003
+* Modified worksheet.rb to truncate strings over 255 characters instead of
+  raising a MaxSizeError.  This is what it should have been doing.  Thanks
+  go to an anonymous sourceforge user.
+* Minor modifications to test.rb and the MANIFEST
+
+== 0.2.6 - 7-Apr-2003
+* Fixed minor bug in the write_blank() method which was accidentally
+  reintroduced.
+* The write_row() and write_column() methods now handle nil properly
+* Fixed a bug in the write_url() method.
+* Yet more unit tests added.
+* Minor doc tweaks/corrections.
+* Removed annoying MS Windows line formatting.
+
+== 0.2.5 - 8-Mar-2003
+* Added the format_row() and format_column() methods to worksheet.rb.
+  These are analogous to the set_row() and set_column() methods.
+* Updated the test suite for testunit 0.1.8
+* Fixed some bugs in the test suite
+* Updated and fixed some documentation
+
+== 0.2.4 - 30-Jan-2003
+* Fixed a bug in the write_blank method.  Thanks to moumar for the spot
+  and the patch.
+
+== 0.2.3 - 15-Jan-2003
+* Added the write_row and write_column methods
+* Some optimization
+
+== 0.2.2 - 20-Dec-2002
+* Fixed variable name typo's in worksheet.rb and format.rb. Thanks
+  go to Mark Slagell for the spot.
+* Modified the tarball directory layout a bit - nothing special
+* Added a copyright notice
+* Added a VERSION method to the Excel class (class method)
+* Some documentation corrections
+
+== 0.2.1 - 11-Dec-2002
+* Fixed a bug with num_format property in Format class
+* Added lots of documentation for Format class, mostly lifted
+  from John McNamara's documentation
+* Added block-style constructors for Format class
+* Added ability to pass Format instances to the add_format Workbook
+  method
+
+== 0.2.0 - 3-Dec-2002
+* Added formats!
+* Minor fix in worksheet.rb
+* Added verbose output for install.rb
+* A few more tests
+
+== 0.1.1 - 29-Nov-2002
+* Tarball fix
+* install.rb fix
+
+== 0.1.0 - 27-Nov-2002
+* Initial Release
+* Based on version .21 of Spreadsheet::WriteExcel (by John McNamara)
+* Well, technically, I did release version .11 of Spreadsheet::WriteExcel
+  on the web, but this is the first *official* release

data/CVS/Entries

@@ -0,0 +1,10 @@
+/.project/1.2/Tue Oct 11 14:08:38 2005//
+/CHANGES/1.14/Fri Feb 17 17:12:54 2006/-kb/
+/MANIFEST/1.10/Mon Dec  5 02:05:39 2005/-kb/
+/README/1.5/Tue Oct 11 17:06:12 2005/-kb/
+/install.rb/1.8/Mon Dec  5 02:13:14 2005/-ko/
+/spreadsheet-excel.gemspec/1.7/Fri Feb 17 03:44:27 2006/-kb/
+D/doc////
+D/examples////
+D/lib////
+D/test////

data/CVS/Repository

@@ -0,0 +1 @@
+RubySpreadsheet

data/CVS/Root

@@ -0,0 +1 @@
+:ext:hwyss@rubyspreadsheet.cvs.sourceforge.net:/cvsroot/rubyspreadsheet

data/README

@@ -0,0 +1,69 @@
+== Description
+   This is a port of John McNamara's Perl module "Spreadsheet::WriteExcel". It
+   allows you to generate Microsoft Excel compatible spreadsheets (in 
+   Excel 95 format) on *any* platform. These spreadsheets are viewable
+   with most other popular spreadsheet programs, including Gnumeric.
+
+== Installation
+=== Standard Installation
+   ruby test/ts_all.rb (optional)
+   ruby install.rb
+
+=== Gem Installation
+   ruby test/ts_all.rb (optional)
+   ruby spreadsheet-excel.gemspec
+   gem install spreadsheet-excel-x.y.z.gem # where 'x.y.z' is the version
+   
+== Synopsis
+   require "spreadsheet/excel"
+   include Spreadsheet
+   
+   workbook = Excel.new("test.xls")
+   
+   format = Format.new
+   format.color = "green"
+   format.bold  = true
+   
+   worksheet = workbook.add_worksheet
+   worksheet.write(0, 0, "Hello", format)
+   worksheet.write(1, 1, ["Matz","Larry","Guido"])
+   
+   workbook.close
+
+== What it doesn't do
+   There is no support for formulas (yet).
+   There is no support for worksheets greater than 7 MB.
+   You cannot read/parse an existing spreadsheet with this package.
+
+== Regarding formula support
+   Simple formulas are easy enough, but to handle complex formulas in a
+   reasonable fashion requires a parser.  John used "Parse::RecDescent" in his
+   own code to parse formulas and I will need something similar to do so as
+   well. Since I'm not too good at parsing, and I don't personally have the
+   need for formula support, I'm more or less waiting for a patch.
+
+== Regarding the 7MB limit
+   Getting past the 7 MB limit requires an interface to the MS structured
+   storage format.  This doesn't exist (yet) in Ruby.  For more on structured
+   storage documents, download this: http://www.i3a.org/pdf/wg1n1017.pdf
+   (there's a structured storage section).  That, and there is information
+   about structured storage on the MSDN website at http://microsoft.msdn.com
+
+== More information
+   See the documentation in the 'doc' directory for more details.
+
+== Known Bugs
+   None that I'm aware of.  If you find any, please log them on the project
+   page at http://rubyspreadsheet.sf.net.
+
+== License
+   Ruby's
+
+== Copyright
+   (C) 2005, Daniel J. Berger
+   All Rights Reserved
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   IRC nickname: imperator/mok/rubyhacker1 (freenode)

data/doc/CVS/Entries

@@ -0,0 +1,3 @@
+/format.txt/1.4/Mon Oct 10 22:39:01 2005//
+/spreadsheet.txt/1.10/Fri Feb 17 03:43:30 2006/-ko/
+D

data/doc/CVS/Repository

@@ -0,0 +1 @@
+RubySpreadsheet/doc

data/doc/CVS/Root

@@ -0,0 +1 @@
+:ext:hwyss@rubyspreadsheet.cvs.sourceforge.net:/cvsroot/rubyspreadsheet

data/doc/format.txt

@@ -0,0 +1,330 @@
+== Description
+   Format objects contain format information which is applied to a cell, or
+   group of of cells, in an Excel object.
+   
+== Instance Methods
+Format#align
+   Returns the align property.
+
+Format#align=(value = "off")
+   Sets the horizontal and vertical alignment within a cell.  Vertical and
+   horizontal alignments can be combined.  Valid arguments are:
+
+   Horizontal: left, right, fill, justify, merge
+   Vertical: top, vcenter, bottom, vjustify
+
+   Text can be aligned across two or more adjacent cells using the merge
+   property.
+
+   The vjustify (vertical justify) option can be used to provide automatic
+   text wrapping in a cell. The height of the cell will be adjusted to
+   accommodate the wrapped text. To specify where the text wraps use the
+   Format#text_wrap= method.
+
+Formate#bg_color
+   Returns the value of the background color.
+    
+Format#bg_color=(value)
+   Sets the background color of a pattern.  Patterns are defined via the
+   Format#pattern= method. If a pattern hasn't been defined
+   then a solid fill pattern is used as the default.
+    
+Format#bold
+   Returns the bold value of the format.
+
+Format#bold=(weight)
+   Sets the bold property of the font.  Values in the range 100..1000 are
+   also valid. 400 is normal, 700 is bold and 1000 is very bold.  Some might
+   even say, daring.
+
+   You can also specify true or false, which sets the value to 1 and 0,
+   respectively.
+
+Format#border
+   Returns the border format.  The default is 0 (no border).
+    
+Format#border=(int)
+   Sets the border for a given cell.  A cell border is comprised of a border
+   on the bottom, top, left and right.
+
+   Valid arguments are as follows:
+   0 - No border
+   1 - Thin single border
+   2 - Medium single border
+   3 - Dashed border
+   4 - Dotted border
+   5 - Thick single border
+   6 - Double line border
+   7 - Hair border
+
+   Also see the Format#top=, Format#bottom=, Format#left=, and Format#right=
+   methods.
+
+Format#border_color
+   Returns the format border color. The default is black.
+
+Format#border_color=(value)
+   Sets the color of the cell borders. Valid values are the same as for the
+   Format#color= method.
+
+   Also see the Format#bottom_color=, Format#top_color=, Format#left_color=,
+   and Format#right_color= methods.
+    
+Format#bottom
+   Returns the bottom border value. The default is 0 (no border).
+
+Format#bottom=(integer)
+   Sets the bottom border of the cell. Valid arguments are the same as for the
+   Format#border= method.
+    
+Format#bottom_color
+   Returns the bottom border cell color value. The default is black.
+
+Format#bottom_color=(value)
+   Sets the bottom cell border color.  Valid values are the same as for the
+   Format#color= method.
+    
+Format#color
+   Returns the font color. The default is black.
+
+Format#color=(value)
+   Sets the font color of text within a cell (not the cell itself).  Any
+   integer from 8..63 is valid.  The following strings are also recognized:
+
+   black, blue, brown, cyan, gray/grey, green, lime, magenta, navy, orange,
+   purple, red, silver, white, yellow
+    
+Format#fg_color=(value = "off")
+   Sets the foreground color of a pattern or uses a solid fill pattern if
+   a pattern has not been defined.
+    
+Format#font
+   Returns the font name used for text. The default is "Arial".
+
+Format#font=(font_name)
+   Sets the font used. Excel can only display fonts that are installed on
+   the system that it is running on. Therefore it is best to use the fonts
+   that come as standard such as 'Arial', 'Times New Roman' or 'Courier New'.
+    
+Format#font_shadow
+   Returns the font shadow value.
+
+   Mac only.
+
+Format#font_shadow=(value)
+   Sets the font shadow property.  0/1 or false/true may be used.
+
+   Mac only.
+    
+Format#italic
+   Returns the italic property for the font. The default is 0 (false).
+
+Format#italic=(value)
+   Sets the italic property of the font.  
+
+   You can also specify true or false, which sets the value to 1 and 0,
+   respectively.
+    
+Format#left
+   Returns the left border value for the format.
+
+Format#left=(integer)
+   Sets the left border of the cell.  Valid arguments are the same as for the
+   Format#border= method.
+    
+Format#left_color
+   Returns the left cell border color. The default is black.
+
+Format#left_color=(value)
+   Sets the left cell border color. Valid values are the same as for the
+   Format#color= method.
+
+Format#num_format
+   Returns the numerical format for numbers.  The default is 1.
+    
+Format#num_format=(value)
+   This method is used to define the numerical format of a number in Excel.
+   It controls whether a number is displayed as an integer, a floating point
+   number, a date, a currency value or some other user defined format. 
+
+   The numerical format of a cell can be specified by using a format string
+   or an index to one of Excel's built-in formats, e.g.
+
+      format1 = Format.new(:num_format => "d mmm yyyy")
+      format2 = Format.new(:num_format => 0x0f)
+      workbook.addformat(format1)
+      workbook.addformat(format2)
+
+      worksheet.write(0,0,36892.521,format1) -> 1 Jan 2001
+      worksheet.write(0,0,36892.521,format2) -> 1-Jan-01
+
+   Using format strings you can define very sophisticated formatting of numbers.
+   Assume each of these is separate and has been added to a workbook:
+
+      format.num_format = '0.000'
+      worksheet.write(0,0,3.1415926,format) -> 3.142
+
+      format.num_format = '#,##0'
+      worksheet.write(1,0,1234.56,format)   -> 1,235
+
+      format.num_format = '#,##0.00'
+      worksheet.write(2,0,1234.56,format)   -> 1,234.56
+
+      format.num_format = '0.00'
+      worksheet.write(3,0,49.99,format)     -> 49.99
+
+      format.num_format = '�0.00'
+      worksheet.write(4,0,49.99,format)     -> �49.99
+
+      format.num_format = '�0.00'
+      worksheet.write(5,0,49.99,format)     -> �49.99
+
+      format.num_format = 'mm/dd/yy'
+      worksheet.write(6,0,36892.521,format) -> 01/01/01
+
+      format.num_format = 'mmm d yyyy'
+      worksheet.write(7,0,36892.521,format) -> Jan 1 2001
+
+      format.num_format = 'd mmmm yyyy'
+      worksheet.write(8,0,36892.521,format) -> 1 January 2001
+
+      format.num_format = 'dd/mm/yyyy hh:mm AM/PM'
+      worksheet.write(9,0,36892.521,format) -> 01/01/2001 12:30 AM
+
+      format.num_format = '0 "dollar and" .00 "cents"'
+      worksheet.write(10,0,1.87,format)     -> 1 dollar and .87 cents
+
+      # Conditional formatting
+      format.num_format = '[Green]General;[Red]-General;General'
+      worksheet.write(11,0,123,format) -> > 0 Green
+      worksheet.write(12,0,-45,format) -> < 0 Red
+      worksheet.write(13,0, 0, format) -> = 0 Default colour
+
+      # Zip code
+      format.num_format = '00000'
+      worksheet.write(14,0,'01209',format)
+     
+Format#outline
+   Returns the outline property. The default is 0.
+
+   Mac only.
+
+Format#outline=(value)
+    Sets outline property.  Accepts 1/0 or true/false, respectively.
+
+   Mac only.
+    
+Format#pattern
+   Returns the background pattern value. The default is 0 (solid pattern).
+
+Format#pattern=(int)
+   Sets the background pattern. Valid arguments are 0..18.
+
+Format#right
+   Returns the right border value. The default is 0.
+    
+Format#right=(int)
+   Sets the right border of the cell. Valid arguments are the same as for the
+   Format#border= method.
+
+Format#right_color
+   Returns the right cell border color. The default is black.
+    
+Format#right_color=(value)
+   Sets the right cell border color. Valid values are the same as for the
+   Format#color= method.
+    
+Format#rotation
+   Returns the rotation value. The default is 0 (no rotation).
+
+Format#rotation=(int)
+   Sets the rotation of the text in the cell.
+
+   Valid arguments:
+      0 - No rotation
+      1 - Top to bottom
+      2 - 90 degrees counter-clockwise
+      3 - 90 degrees clockwise
+
+   Note that fractional rotation is not possible in the Excel 95 format.
+    
+Format#script
+   Returns the subscript/superscript property. The default is 0 (normal). 
+
+Format#script=(integer = 0)
+   Sets the subscript/superscript property of the font.
+
+   Valid arguments:
+      0 = Normal
+      1 = Superscript
+      2 = Subscript
+       
+Format#shadow
+   Returns the shadow property value. The default is 0 (none).
+
+   Mac only.
+
+Format#shadow=(value)
+   Sets the shadow property of the font. Accepts 1/0 or true/false, respectively.
+
+   Mac only.
+    
+Format#size
+   Returns the font size. The default font size is 10.
+
+Format#size=(size)
+   Set the font size. Note that MS Excel adjusts the height of a row to
+   accommodate the largest font size in the row.
+    
+Format#text_justlast
+   Returns the justlast value. The default is 0.
+
+   Only applicable to Far Eastern versions of MS Excel.
+
+Format#text_justlast=(value)
+   Sets the justlast value.  0/1 or false/true may be used here.
+
+   Only applicable to Far Eastern versions of MS Excel.
+    
+Format#text_wrap
+   Returns the text wrap value. The default is 0 (off).
+
+Format#text_wrap=(value)
+   Turn text wrap on.  Excel will adjust the height of the row to accommodate
+   the wrapped text. A similar effect can be obtained without newlines using
+   the Format#align= method.
+
+   Accepts 1/0 or true/false as valid values.
+    
+Format#top
+   Returns the top border value. The default is 0.
+
+Format#top=(integer)
+   Sets the top border of the cell. Valid arguments are the same as for the
+   Format#border= method.
+    
+Format#top_color
+   Returns the top cell border color. The default value is black.
+
+Format#top_color=(value)
+   Sets the top cell border color. Valid values are the same as for the
+   Format#color= method.
+
+Format#underline
+   Returns the value of the underline property. The default value is 0 (none).
+    
+Format#underline=(value = 0)
+   Sets the underline property of the font.
+
+   Valid arguments:
+      0/false - No underline
+      1/true  - Single underline
+      2       - Double underline
+      33      - Single accounting underline
+      34      - Double accounting underline
+     
+Format#strikeout
+   Returns the strikeout value. The default is 0 (none).
+
+Format#strikeout=(value)
+    Sets the strikeout property.