fireruby 0.4.0-mswin32 → 0.4.1-mswin32

data/doc/CVS/Entries

@@ -1,4 +1,3 @@
+/README/1.8/Fri Nov 11 21:07:43 2005//
 /license.txt/1.1/Tue Mar 15 13:40:26 2005//
-D/classes////
-D/files////
-/README/1.7/Sat Oct 29 17:30:46 2005//
+D

data/doc/CVS/Entries.Log

@@ -0,0 +1,2 @@
+A D/classes////
+A D/files////

data/doc/README

@@ -1,67 +1,44 @@
-== FireRuby Version 0.4.0
-Its been a while but I'm glad to release version 0.4.0 of the FireRuby library.
+= FireRuby Version 0.4.1
 FireRuby is an extension for the Ruby programming language that provides access
-to the Firebird open source RDBMS. There aren't a great deal of changes for this
-release but some of the alterations may have an impact on existing code, so
-please read the enhancements and alterations section to see what has been done.
+to the Firebird open source RDBMS. The FireRuby library is release under the
+Mozilla Public Licence version 1.1 and is free for commercial use.
 
-== Enhancements & Alterations
+---
 
-This release contains some changes that are part of a suite of suggestion put
-forward by Ken Kunz to enhancement support for the Firebird ActiveRecord 
-adapter he developed. The first of these changes involved switching the keying
-of Row objects away from using the column name to using the column alias. This
-is a logical change as the alias is more likely to be unique. I realise that
-change has the potential to break existing code so I've included a work around
-that can be used to have the library behave as it used to. To use keying on
-columns insert the following line into your code after you've loaded the
-FireRuby library and before you've done any database work...
-
-   $FireRubySettings[:ALIAS_KEYS] = false
-   
-This will cause the library to use column names as keys on rows. A second change
-I've made that could impact existing code is for the retrieval of data from
-columns of SQL type DATE. These were being returned as a Time object but are now
-being returned as a Date object, again a fairly logical change. If this causes
-problems for your code then you can add the following line to get the library to
-return Times by adding the following line...
-
-   $FireRubySettings[:DATE_AS_DATE] = false
-   
-The final change I've made for this release from Ken's wish list is that I have
-incorporated Enumerable into the Row and ResultSet classes. Your code may
-already do this and, unfortunately, I'm not providing any sort of work around
-other than you remove this from your own code.
+== Enhancements & Alterations
 
-I've also added functionality to the library to aid in determining type
-information in relation to database tables and query results. As far as I can
-determine the Firebird data structures used to return data from the database
-provide no means of determining exact type specifics (please correct me if I'm
-wrong). This means that for queries all I can return are details of the
-underlying type but not the specifics (so I can tell you that a result column is
-NUMERIC but I can't give you the precision and scale for example).
+This release has been brought about as a direct result of efforts to get the
+library working on a 64 bit platform. This process exposed some code of
+questionable quality. All of the issues raised in getting a 64 bit build have
+been addressed and it's only fair that the improvements obtained be passed on
+to all platforms. Functionally nothing has changed since the last release and
+the new version should replace the old with no problems.
 
-I have provided a new class called SQLType. This defines constants for the basic
-types supported by FireRuby. It also allows for querying of table types. In this
-case, as I'm referring to the actual database, I can provide more specific
-details (so I can tell you that a column is NUMERIC, has a precision of 5 and a
-scale or 2 for example). See the API documentation for this class for more
-information.
+=== Bug Fixes
 
-Finally I have added some new unit tests and updated existing ones to cover the
-changes I have made.
+A number of bug fixes were implemented as part of the effort to get the library
+working on a 64 bit platform. None of these had been raised as bugs against the
+library so I have nothing specific to tick off.
 
-== Bug Fixes
+=== Backward Compatibility
 
-I've made a few cosmetic and minor bug fixes that were unlikely to have had an
-impact on anyone (but its nice that they're fixed anyway).
+Version 0.4.0 of the library made fundamental changes to functionality that was
+available in earlier versions of the library. To help accommodate this change
+elements were added to support backward compatibility. The relevant details are
+listed here...
 
-I received some feedback with regards to FireRuby not working with Firebird
-database aliases but, as this has been successfully tested via the use of the
-Rails adapter based on FireRuby, I have to assume that this was a user set up
-problem.
+- Row objects were switched from keying on column names to keying on column
+  aliases. To revert to the older functionality assign a value of true to the
+  $FireRubySettings[:ALIAS_KEYS] global setting.
+  
+- DATE columns were switched from being returned as Time objects to be returned
+  as Date objects. To revert to the older functionality assign a value of true
+  to the $FireRubySettings[:DATE_AS_DATE] global setting.
+  
+One other point to note is that, as of version 0.4.0, Enumerable is included in
+the Row and ResultSet classes.
 
-== Issues
+=== Issues
 
 Nothing is perfect so this section outlines those issues that are known to
 exist as of this release.
@@ -89,6 +66,29 @@ exist as of this release.
   note that you may need to alter permissions on the test directory to run the
   actual unit tests on Linux/Unix.
   
+---
+
+== Credit Where Credit Is Due
+
+Over its lifetime the FireRuby library has benefitted from input provided by a
+number of individuals. This section acknowledges these inputs...
+
+<b>Ken Kunz</b>: Ken has been a strong supporter of the library from early on and
+has contributed through feedback, testing and suggestions. For some time he
+produced and tested the Linux builds of the library.
+
+<b>David Walthour</b>: David basically executed all of the work to generate the
+64 bit version of the library, along the way exposing some flaws in the code
+(amazing what a bit of peer review can find!). David produced the 64 bit version
+of the library gem.
+
+<b>John Wood</b>: John currently builds and tests the Mac OS X version of the
+library.
+
+<b>Art Federov</b>: Art provided input on handling and testing character sets.
+
+---
+  
 == Installation & Usage
 
 The library is provided as a gem and built for use with Ruby 1.8+. Testing
@@ -97,13 +97,13 @@ the Ruby Gems package to be installed. Assuming that these installation criteria
 have been met the library can be installed on Windows by executing a command
 such as the following...
 
-   gem install fireruby-0.4.0-mswin32.gem
+   gem install fireruby-0.4.1-mswin32.gem
    
 On the Mac OS X platform you may require super user privilege if your Ruby is
 installed to the default location (i.e. /usr/local/lib). In this case you can
 use the sudo command to make the installation like this...
 
-   sudo gem install fireruby-0.4.0-powerpc-darwin.gem
+   sudo gem install fireruby-0.4.1-powerpc-darwin.gem
    
 Once the gem installation is complete the FireRuby functionality can be accessed
 in code with the usual gem style requires...
@@ -111,20 +111,63 @@ in code with the usual gem style requires...
    require 'rubygems'
    require 'fireruby'
   
-== Build Details
+=== Build Details
+
+The FireRuby library is a Ruby extension written in C. The avoid build issues
+binary versions are provided for a number of platforms, including...
+
+- Windows: Built against a version of Ruby installed using the one-click
+  installer and using the freely available Microsoft development tools. This
+  version was compiled against version 1.5.2 of Firebird.
+  
+- Linux: Built on Ubuntu Linux (Breezy Badger) using a version of Ruby 1.8.2
+  installed via the Synaptic package manager. This package manager was also
+  used to make an installation of Firebird.
+  
+- Mac OS X: Build on version 10.4.3 of OS X against the 1.8.2 version of Ruby
+  that comes with the operating system. A framework installation of Firebird
+  version 1.5.1 was used to make the build.
+
+Its possible to try and build the library on other platforms so I'll provide a
+few details as to how to go about doing this. The first step is to download the
+CVS tar ball from the Ruby Forge site and expand it into a local directory. This
+will create a directory called fireruby. Change into this directory and then
+into the fireruby/src subdirectory.
+
+This directory contains a file called extconf.rb that is used to create the
+make file used to build the library. The make file is created by executing this
+file but before you do there are a number of parameters that you should be
+aware of. The main one of these is --with-firebird-dir. This parameter is used
+to indicate the whereabouts of the Firebird headers and libraries. The following
+is an example of how this might be used...
+
+   ruby extconf.rb --with-firebird-dir=/usr/local/firebird
+   
+You may need to customise the path for your own Firebird installation. The path
+specified should be a directory that contains subdirectories called 'lib' and
+'include'. The lib subdirectory should contain the fbclient shared library and
+include should contain the ibase.h header file.
+
+A note for Windows users. The library requires the free Microsoft C++ compiler,
+the Windows SDK, the .NET SDK and nmake to build. If you have all of these
+and Firebird installed to default locations then you can create a make file
+using the mkmf.bat batch file in the src directory.
+
+Once you have the make file you can attempt a library build using either make
+(on Unix/Linux) or nmake (on Windows). If it builds successfully you can move
+on to creating a gem file for installation. To do this, change into the ../gem
+directory. In this directory you can do the following (on Windows)...
+
+   make_gem
+   
+...or the following (on Unix/Linux)...
 
-The FireRuby library is an extension of the Ruby language written in C. The Mac
-OS X version was built by my brother John (thanks!) using Mac OS X  10.4.3
-against Firebird installed as a framework, version 1.5.1, and with Ruby version
-1.8.2. For the Windows platform the library is built on Windows XP and against
-a Ruby installation created using the one-click installer, version 1.8.2. The
-Windows build was created using the freely available Microsoft compilers and
-SDKs and built against a standard installation of Firebird, version 1.5.2. On
-Linux the library is built using an Ubuntu system (Breezy Badger release) using
-Firebird installed through the Synaptic package manager and version 1.8.2 of
-Ruby installed using the same tool.
+   ruby make_gem.rb
+   
+This will create the gem file in the main fireruby directory. Install this and
+execute the unit tests to check whether you're version is working.
 
-== So How Do I Use It?
+=== So How Do I Use It?
 
 This section will provide some examples of usage for the the FireRuby classes.
 Throughout the code the following set of assumptions are made.
@@ -374,7 +417,7 @@ database administrator you might do the following...
    
 Assuming that this succeeds you are now ready to execute tasks through your
 ServiceManager object. Within the FireRuby library individual task are broken
-out into separate classes. For this release (0.4.0) there are four task classes
+out into separate classes. For this release (0.4.1) there are four task classes
 provided in the library - Backup, Restore, AddUser and RemoveUser. I think the
 class names are relatively self explanatory but if you want more information
 consult the API documentation for a class.

data/doc/classes/CVS/Entries

@@ -1 +1 @@
-D/FireRuby////
+D

data/doc/classes/CVS/Entries.Log

@@ -0,0 +1 @@
+A D/FireRuby////

data/doc/classes/FireRuby/CVS/Entries

@@ -1,7 +1 @@
-D/Connection.src////
-D/Database.src////
-D/FireRubyError.src////
-D/Generator.src////
-D/ResultSet.src////
-D/Statement.src////
-D/Transaction.src////
+D

data/doc/classes/FireRuby/CVS/Entries.Log

@@ -0,0 +1,7 @@
+A D/Connection.src////
+A D/Database.src////
+A D/FireRubyError.src////
+A D/Generator.src////
+A D/ResultSet.src////
+A D/Statement.src////
+A D/Transaction.src////

data/lib/CVS/Entries

@@ -1,6 +1,6 @@
+/SQLType.rb/1.1/Sat Oct 29 17:37:42 2005//
 /fireruby.bundle/1.3/Fri Jun 10 12:20:22 2005//
+/fireruby.rb/1.1/Sat Oct 29 17:37:42 2005//
 /mkdoc/1.2/Mon Mar 21 08:53:22 2005//
-/src.rb/1.6/Sat Oct 29 17:06:07 2005//
-/SQLType.rb/1.1/Thu Oct 27 19:16:36 2005//
-/fireruby.rb/1.1/Tue Oct 25 19:45:08 2005//
+/src.rb/1.6/Sat Oct 29 17:31:38 2005//
 D

data/test/CVS/Entries

@@ -1,20 +1,20 @@
-/AddRemoveUserTest.rb/1.2/Sat Oct 22 09:32:00 2005//
-/BackupRestoreTest.rb/1.2/Sat Oct 22 08:23:48 2005//
-/CharacterSetTest.rb/1.2/Sat Oct 22 08:07:40 2005//
-/ConnectionTest.rb/1.6/Sat Oct 22 08:09:00 2005//
-/DDLTest.rb/1.6/Sat Oct 22 08:09:42 2005//
-/DatabaseTest.rb/1.4/Sat Oct 22 08:21:18 2005//
-/GeneratorTest.rb/1.4/Sat Oct 22 08:21:10 2005//
-/ResultSetTest.rb/1.4/Sat Oct 29 17:00:15 2005//
-/RowCountTest.rb/1.3/Sat Oct 22 08:20:44 2005//
-/RowTest.rb/1.3/Sat Oct 29 14:49:15 2005//
-/SQLTest.rb/1.5/Sat Oct 22 08:27:06 2005//
-/ServiceManagerTest.rb/1.2/Sat Oct 22 08:23:22 2005//
-/StatementTest.rb/1.5/Sat Oct 22 08:22:58 2005//
-/TestSetup.rb/1.2/Sat Oct 22 08:16:26 2005//
-/TransactionTest.rb/1.6/Sat Oct 22 08:22:38 2005//
-/UnitTest.rb/1.7/Sat Oct 29 15:03:24 2005//
-/KeyTest.rb/1.1/Sat Oct 22 09:26:20 2005//
-/SQLTypeTest.rb/1.1/Thu Oct 27 19:22:34 2005//
-/TypeTest.rb/1.1/Sat Oct 29 16:58:35 2005//
+/AddRemoveUserTest.rb/1.2/Sat Oct 29 17:31:38 2005//
+/BackupRestoreTest.rb/1.2/Sat Oct 29 17:31:39 2005//
+/CharacterSetTest.rb/1.2/Sat Oct 29 17:31:39 2005//
+/ConnectionTest.rb/1.6/Sat Oct 29 17:31:39 2005//
+/DDLTest.rb/1.6/Sat Oct 29 17:31:39 2005//
+/DatabaseTest.rb/1.4/Sat Oct 29 17:31:39 2005//
+/GeneratorTest.rb/1.4/Sat Oct 29 17:31:39 2005//
+/KeyTest.rb/1.1/Sat Oct 29 17:37:43 2005//
+/ResultSetTest.rb/1.4/Sat Oct 29 17:31:39 2005//
+/RowCountTest.rb/1.3/Sat Oct 29 17:31:39 2005//
+/RowTest.rb/1.3/Sat Oct 29 17:31:39 2005//
+/SQLTest.rb/1.5/Sat Oct 29 17:31:39 2005//
+/SQLTypeTest.rb/1.1/Sat Oct 29 17:37:43 2005//
+/ServiceManagerTest.rb/1.2/Sat Oct 29 17:31:39 2005//
+/StatementTest.rb/1.5/Sat Oct 29 17:31:39 2005//
+/TestSetup.rb/1.2/Sat Oct 29 17:31:39 2005//
+/TransactionTest.rb/1.6/Sat Oct 29 17:31:39 2005//
+/TypeTest.rb/1.1/Sat Oct 29 17:37:43 2005//
+/UnitTest.rb/1.10/Fri Nov 11 21:34:10 2005//
 D

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: fireruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2005-11-11
+  version: 0.4.1
+date: 2005-11-27
 summary: Ruby interface library for the Firebird database.
 require_paths: 
   - lib
@@ -27,12 +27,12 @@ platform: mswin32
 authors: 
   - Peter Wood
 files: 
+  - lib/CVS
   - lib/fireruby.rb
   - lib/fr_lib.so
   - lib/mkdoc
   - lib/SQLType.rb
   - lib/src.rb
-  - lib/CVS
   - lib/CVS/Entries
   - lib/CVS/Repository
   - lib/CVS/Root
@@ -40,6 +40,7 @@ files:
   - test/BackupRestoreTest.rb
   - test/CharacterSetTest.rb
   - test/ConnectionTest.rb
+  - test/CVS
   - test/DatabaseTest.rb
   - test/DDLTest.rb
   - test/GeneratorTest.rb
@@ -55,68 +56,70 @@ files:
   - test/TransactionTest.rb
   - test/TypeTest.rb
   - test/UnitTest.rb
-  - test/CVS
   - test/CVS/Entries
   - test/CVS/Repository
   - test/CVS/Root
-  - doc/license.txt
-  - doc/files
-  - doc/CVS
   - doc/classes
+  - doc/CVS
+  - doc/files
+  - doc/license.txt
   - doc/README
-  - doc/files/CVS
-  - doc/files/CVS/Entries
-  - doc/files/CVS/Repository
-  - doc/files/CVS/Root
-  - doc/CVS/Entries
-  - doc/CVS/Repository
-  - doc/CVS/Root
-  - doc/classes/FireRuby
   - doc/classes/CVS
-  - doc/classes/FireRuby/Transaction.src
-  - doc/classes/FireRuby/Statement.src
-  - doc/classes/FireRuby/ResultSet.src
-  - doc/classes/FireRuby/Generator.src
-  - doc/classes/FireRuby/FireRubyError.src
-  - doc/classes/FireRuby/Database.src
-  - doc/classes/FireRuby/CVS
+  - doc/classes/FireRuby
+  - doc/classes/CVS/Entries
+  - doc/classes/CVS/Entries.Log
+  - doc/classes/CVS/Repository
+  - doc/classes/CVS/Root
   - doc/classes/FireRuby/Connection.src
-  - doc/classes/FireRuby/Transaction.src/CVS
-  - doc/classes/FireRuby/Transaction.src/CVS/Entries
-  - doc/classes/FireRuby/Transaction.src/CVS/Repository
-  - doc/classes/FireRuby/Transaction.src/CVS/Root
-  - doc/classes/FireRuby/Statement.src/CVS
-  - doc/classes/FireRuby/Statement.src/CVS/Entries
-  - doc/classes/FireRuby/Statement.src/CVS/Repository
-  - doc/classes/FireRuby/Statement.src/CVS/Root
-  - doc/classes/FireRuby/ResultSet.src/CVS
-  - doc/classes/FireRuby/ResultSet.src/CVS/Entries
-  - doc/classes/FireRuby/ResultSet.src/CVS/Repository
-  - doc/classes/FireRuby/ResultSet.src/CVS/Root
-  - doc/classes/FireRuby/Generator.src/CVS
-  - doc/classes/FireRuby/Generator.src/CVS/Entries
-  - doc/classes/FireRuby/Generator.src/CVS/Repository
-  - doc/classes/FireRuby/Generator.src/CVS/Root
-  - doc/classes/FireRuby/FireRubyError.src/CVS
-  - doc/classes/FireRuby/FireRubyError.src/CVS/Entries
-  - doc/classes/FireRuby/FireRubyError.src/CVS/Repository
-  - doc/classes/FireRuby/FireRubyError.src/CVS/Root
-  - doc/classes/FireRuby/Database.src/CVS
-  - doc/classes/FireRuby/Database.src/CVS/Entries
-  - doc/classes/FireRuby/Database.src/CVS/Repository
-  - doc/classes/FireRuby/Database.src/CVS/Root
-  - doc/classes/FireRuby/CVS/Entries
-  - doc/classes/FireRuby/CVS/Repository
-  - doc/classes/FireRuby/CVS/Root
+  - doc/classes/FireRuby/CVS
+  - doc/classes/FireRuby/Database.src
+  - doc/classes/FireRuby/FireRubyError.src
+  - doc/classes/FireRuby/Generator.src
+  - doc/classes/FireRuby/ResultSet.src
+  - doc/classes/FireRuby/Statement.src
+  - doc/classes/FireRuby/Transaction.src
   - doc/classes/FireRuby/Connection.src/CVS
   - doc/classes/FireRuby/Connection.src/CVS/Entries
   - doc/classes/FireRuby/Connection.src/CVS/Repository
   - doc/classes/FireRuby/Connection.src/CVS/Root
-  - doc/classes/CVS/Entries
-  - doc/classes/CVS/Repository
-  - doc/classes/CVS/Root
-  - examples/example01.rb
+  - doc/classes/FireRuby/CVS/Entries
+  - doc/classes/FireRuby/CVS/Entries.Log
+  - doc/classes/FireRuby/CVS/Repository
+  - doc/classes/FireRuby/CVS/Root
+  - doc/classes/FireRuby/Database.src/CVS
+  - doc/classes/FireRuby/Database.src/CVS/Entries
+  - doc/classes/FireRuby/Database.src/CVS/Repository
+  - doc/classes/FireRuby/Database.src/CVS/Root
+  - doc/classes/FireRuby/FireRubyError.src/CVS
+  - doc/classes/FireRuby/FireRubyError.src/CVS/Entries
+  - doc/classes/FireRuby/FireRubyError.src/CVS/Repository
+  - doc/classes/FireRuby/FireRubyError.src/CVS/Root
+  - doc/classes/FireRuby/Generator.src/CVS
+  - doc/classes/FireRuby/Generator.src/CVS/Entries
+  - doc/classes/FireRuby/Generator.src/CVS/Repository
+  - doc/classes/FireRuby/Generator.src/CVS/Root
+  - doc/classes/FireRuby/ResultSet.src/CVS
+  - doc/classes/FireRuby/ResultSet.src/CVS/Entries
+  - doc/classes/FireRuby/ResultSet.src/CVS/Repository
+  - doc/classes/FireRuby/ResultSet.src/CVS/Root
+  - doc/classes/FireRuby/Statement.src/CVS
+  - doc/classes/FireRuby/Statement.src/CVS/Entries
+  - doc/classes/FireRuby/Statement.src/CVS/Repository
+  - doc/classes/FireRuby/Statement.src/CVS/Root
+  - doc/classes/FireRuby/Transaction.src/CVS
+  - doc/classes/FireRuby/Transaction.src/CVS/Entries
+  - doc/classes/FireRuby/Transaction.src/CVS/Repository
+  - doc/classes/FireRuby/Transaction.src/CVS/Root
+  - doc/CVS/Entries
+  - doc/CVS/Entries.Log
+  - doc/CVS/Repository
+  - doc/CVS/Root
+  - doc/files/CVS
+  - doc/files/CVS/Entries
+  - doc/files/CVS/Repository
+  - doc/files/CVS/Root
   - examples/CVS
+  - examples/example01.rb
   - examples/CVS/Entries
   - examples/CVS/Repository
   - examples/CVS/Root