dbi-dbrc 1.1.0 → 1.1.1

data/CHANGES

@@ -1,3 +1,12 @@
+== 1.1.1 - 2-Aug-2007
+* DBRCError is now DBRC::Error.
+* Added a Rakefile with tasks for installation and testing.
+* Added the win32-dir library as a prerequisite for MS Windows.
+* Removed the install.rb file. That's now handled by the Rakefile.
+* Some refactoring in the constructor, including the elimination of
+  warnings that appeared when run with -w.
+* Some doc and test updates.
+
 == 1.1.0 - 19-Oct-2005
 * Bug fix for MS Windows (there's no Win32 namespace for win32/file).
 * Changed platform detection mechanism.

data/MANIFEST

@@ -0,0 +1,16 @@
+* MANIFEST
+* CHANGES
+* README
+* Rakefile
+* dbi-dbrc.gemspec
+* lib/dbi/dbrc.rb
+* examples/plain/.dbrc
+* examples/plain/test.rb
+* examples/xml_examples/.dbrc
+* examples/xml_examples/test_xml.rb
+* examples/yml_examples/.dbrc
+* examples/yml_examples/test_yml.rb
+* test/ts_all.rb
+* test/tc_dbrc.rb
+* test/tc_dbrc_xml.rb
+* test/tc_dbrc_yml.rb

data/README

@@ -2,15 +2,21 @@
    This is a supplement to the dbi module, allowing you to avoid hard-coding
    passwords in your programs that make database connections.
 
+== Requirements
+   * Ruby 1.8.2 or later
+   * sys-admin
+   * win32-file (MS Windows only)
+   * win32-dir (MS Windows only)
+
 == Synopsis
    require 'dbi/dbrc'
    include DBI
 
-   dbrc = DBRC.new("mydb")
+   dbrc = DBRC.new('mydb')
 
    or
 
-   dbrc = DBRC.new("mydb","someUser")
+   dbrc = DBRC.new('mydb', 'someUser')
 
    puts dbrc.db
    puts dbrc.user
@@ -22,18 +28,9 @@
 
    dbh = DBI.connect(dbrc.dsn, dbrc.user, dbrc.password)
 
-== Requirements
-   * Ruby 1.8.0 or later
-   * sys-admin
-   * win32-file (Win32 only)
-
 == Installation
-=== Manual Installation
-   * ruby test/ts_all.rb (optional)
-   * ruby install.rb
-=== Gem Installation
-   * ruby dbi-dbrc.gemspec
-   * gem install dbi-dbrc-<version>.gem
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gem)
    
 == Notes on the .dbrc file
    This module relies on a file in your home directory called ".dbrc", and it
@@ -42,9 +39,9 @@
    module or it will fail:
 
    * Permissions must be set to 600 (Unix only).
-   * Must be hidden (Win32 only).
+   * Must be hidden (MS Windows only).
    * Must be owned by the current user.
-   * Must have database, user and password.  Other fields are optional.
+   * Must have database, user and password. Other fields are optional.
    * Must be in the following space-separated format (in the 'plain' version):
 
    database user password driver timeout maximum_reconnects interval
@@ -52,11 +49,12 @@
    e.g. mydb     dan    mypass     oracle   10        2         30
 
    You may include comments in the .dbrc file by starting the line with a
-   "#" symbol
+   "#" symbol.
 
-   A failure in any of the rules mentioned above will result in a DBRCError
-   being raised. In addition, the file may also be encrypted on Win32 systems,
-   in which case the file will automatically be (temporarily) decrypted.
+   A failure in any of the rules mentioned above will result in a DBRC::Error
+   being raised. In addition, the file may also be encrypted on MS Windows
+   systems, in which case the file will automatically be (temporarily)
+   decrypted.
 
    The format for XML (using the example above) is as follows:
 
@@ -87,25 +85,25 @@ VERSION
     
 == Class Methods
 DBRC.new(db, user=nil, dir=nil)
-   The constructor takes one to three arguments.  The first argument is the
-   database name.  This *must* be provided.  If only the database name is
+   The constructor takes one to three arguments. The first argument is the
+   database name. This *must* be provided. If only the database name is
    passed, the module will look for the first database entry in the .dbrc
    file that matches.
 
-   The second argument, a user name, is optional.  If it is passed, the
+   The second argument, a user name, is optional. If it is passed, the
    module will look for the first entry in the .dbrc file where both the
    database *and* user name match.
 
    The third argument, also optional, specifies the directory where DBRC will
-   look for the .dbrc file.  By default, it looks in the pwuid (present
-   working user id) home directory.  The rules for a .dbrc file still apply.
+   look for the .dbrc file. By default, it looks in the pwuid (present
+   working user id) home directory. The rules for a .dbrc file still apply.
     
-   Win32 users should read the "Notes" section for how your home directory
+   MS Windows users should read the "Notes" section for how your home directory
    is determined.
     
 == Instance Methods
 DBRC#database
-   The name of the database.  Note that the same entry can appear more than
+   The name of the database. Note that the same entry can appear more than
    once, presumably because you have multiple user id's for the same
    database.
     
@@ -183,17 +181,17 @@ DBRC#dsn=(dsn)
    not automatically reset the driver or database.
     
 == Canonical Example
-   This is a basic template for how I do things:
+   # This is a basic template for how I do things:
 
-   require "dbi/dbrc"
-   require "timeout"
+   require 'dbi/dbrc'
+   require 'timeout'
 
    db = DBI::DBRC.new("somedb")
    n = db.max_reconn
 
    begin
       timeout(db.time_out){
-         DBI.connect(db.dsn,db.user,db.passwd)
+         DBI.connect(db.dsn, db.user, db.passwd)
       }
    rescue DBI::Error
       n -= 1
@@ -203,25 +201,24 @@ DBRC#dsn=(dsn)
    rescue TimeoutError
       # handle timeout error
    end
-   
-== Notes for Win32 Users
+
+== Notes for MS Windows Users
    The 'home' directory for Win32 users is determined by ENV['USERPROFILE'].
-   If that is not set, ENV['HOME'] is used.  If that is not set, then
-   'C:\Documents and Settings\' + Admin.get_user(Admin.get_login).home_dir is
-   used.
+   If that is not set, ENV['HOME'] is used. If that is not set, then
+   'C:\Documents and Settings\user_name' is used.
 
    To make your file hidden, right click on the .dbrc file in your Explorer
    window, select "Properties" and check the "Hidden" checkbox.
 
-   I was going to require that the .dbrc file be encrypted on Win32 systems,
+   I was going to require that the .dbrc file be encrypted on MS Windows,
    but that may require an official "certificate", assigned to you by a third
-   party, which is a bit much to expect.  However, if the file is encrypted,
+   party, which is a bit much to expect. However, if the file is encrypted,
    DBRC will attempt to decrypt it, parse it, and encrypt it again when done
    parsing.
 
 == Notes on running the test suite
    I cannot guarantee that the .dbrc files under the +examples+
-   subdirectories maintain the appropriate properties.  This can cause
+   subdirectories maintain the appropriate properties. This can cause
    failures for the test suite (which uses these files).
    
    The only solution is to perform a 'chmod 600 .dbrc' (on Unix) or set
@@ -229,16 +226,16 @@ DBRC#dsn=(dsn)
    question.
    
 == Summary
-   These "methods" don't really do anything.  They're simply meant as a
+   These "methods" don't really do anything. They're simply meant as a
    convenience mechanism for you dbi connections, plus a little bit of
    obfuscation (for passwords).
 
 == Adding your own configuration
    If you want to add your own type of configuration file, you can still use
-   the dbi-dbrc package.  All you need to do is:
+   the dbi-dbrc package. All you need to do is:
 
    * subclass DBRC
-   * redefine the +parse_dbrc_config_file+ method
+   * redefine the +parse_dbrc_config_file+ method (a private method).
 
    Take a look at the XML and YML subclasses in dbrc.rb for two examples that
    you can work from.
@@ -249,5 +246,5 @@ DBRC#dsn=(dsn)
    
 == Author
    Daniel J. Berger
-   djberg96 at gmail dot com
+   djberg96 at nospam at gmail dot com
    imperator on IRC (irc.freenode.net)

data/lib/dbi/dbrc.rb

@@ -1,19 +1,22 @@
-if PLATFORM.match("mswin")
-   require "win32/file"
+if RUBY_PLATFORM.match('mswin')
+   require 'win32/file'
+   require 'win32/dir'
 end
 
-require "sys/admin"
+require 'sys/admin'
 include Sys
 
+# The DBI module serves as a namespace only.
 module DBI
 
-   # The base error class for dbi-dbrc.  If anything goes wrong, this is
-   # the error that is raised.  A subclass of StandardError.
-   class DBRCError < StandardError; end
-
-   # The main class.
+   # The DBRC class encapsulates a database resource config file.
    class DBRC
-      VERSION = "1.1.0"
+
+      # This error is raised if anything fails trying to read the config file.
+      # the error that is raised. 
+      class Error < StandardError; end
+
+      VERSION = '1.1.1'
       attr_accessor :database, :user, :password, :driver, :dsn
       attr_accessor :maximum_reconnects, :timeout, :interval, :dbrc_dir
 
@@ -28,38 +31,43 @@ module DBI
       # file.
       #
       # If an entry cannot be found for the database, or database plus user
-      # combination, then a DBRCError is raised.  If the .dbrc file cannot
+      # combination, then a Error is raised.  If the .dbrc file cannot
       # be found, or is setup improperly with regards to permissions or
-      # properties, a DBRCError is raised.
-      def initialize(database,user=nil,dbrc_dir=nil)
+      # properties, a Error is raised.
+      #
+      def initialize(database, user=nil, dbrc_dir=nil)
          if dbrc_dir.nil?
-            if PLATFORM.match("mswin")
-               home = ENV["USERPROFILE"] || ENV["HOME"]
+            if RUBY_PLATFORM.match('mswin')
+               home = ENV['USERPROFILE'] || ENV['HOME']
                file = nil
                
                if home
-                  file = home + "\\.dbrc"
+                  file = File.join(home, '.dbrc')
                else
-                  file = "C:\\Documents and Settings\\"
-                  file += Admin.get_user(Admin.get_login).home_dir + "\\.dbrc"
+                  file = File.join(File.basename(Dir::APPDATA), '.dbrc')
                end
                
                @dbrc_file = file
             else
-               @dbrc_file = Admin.get_user(Process.uid).dir + "/.dbrc"
+               @dbrc_file = File.join(Admin.get_user(Process.uid).dir, '.dbrc')
             end
          else
-            @dbrc_file = dbrc_dir + "/.dbrc"
+            @dbrc_file = File.join(dbrc_dir, '.dbrc')
          end
          
          @database  = database
          @user      = user
          encrypted  = false # Win32 only
 
+         @driver   = nil
+         @interval = nil
+         @timeout  = nil
+         @maximum_reconnects = nil
+
          check_file()
          
          # If on Win32 and the file is encrypted, decrypt it.
-         if PLATFORM.match("mswin") && File.encrypted?(@dbrc_file)
+         if RUBY_PLATFORM.match("mswin") && File.encrypted?(@dbrc_file)
             encrypted = true
             File.decrypt(@dbrc_file)
          end
@@ -70,7 +78,7 @@ module DBI
          create_dsn_string()
          
          # If on Win32 and the file was encrypted, re-encrypt it
-         if PLATFORM.match("mswin") && encrypted
+         if RUBY_PLATFORM.match("mswin") && encrypted
             File.encrypt(@dbrc_file)
          end
       end
@@ -80,11 +88,11 @@ module DBI
       # Ensure that the user/password has been set
       def validate_data
          unless @user
-            raise DBRCError, "no user found associated with #{@database}"
+            raise Error, "no user found associated with #{@database}"
          end
 
          unless @password
-            raise DBRCError, "password not defined for #{@user}@#{@database}"
+            raise Error, "password not defined for #{@user}@#{@database}"
          end
       end
    
@@ -106,19 +114,19 @@ module DBI
 
             # Permissions must be set to 600 or better on Unix systems.
             # Must be hidden on Win32 systems.
-            if PLATFORM.match("mswin")
+            if RUBY_PLATFORM.match("mswin")
                unless File.hidden?(file)
-                  raise DBRCError, "The .dbrc file must be hidden"
+                  raise Error, "The .dbrc file must be hidden"
                end
             else
                unless (f.stat.mode & 077) == 0
-                  raise DBRCError, "Bad .dbrc file permissions"
+                  raise Error, "Bad .dbrc file permissions"
                end
             end
 
             # Only the owner may use it
             unless f.stat.owned?
-               raise DBRCError, "Not owner of .dbrc file"
+               raise Error, "Not owner of .dbrc file"
             end
          }
       end
@@ -151,7 +159,8 @@ module DBI
          else
             err = "no record found for #{@database}"
          end
-         raise DBRCError, err
+
+         raise Error, err
       end
 
       alias_method(:db,:database)
@@ -187,7 +196,7 @@ module DBI
             return
          }
          # If we reach here it means the database and/or user wasn't found
-         raise DBRCError, "No record found for #{@user}@#{@database}"
+         raise Error, "No record found for #{@user}@#{@database}"
       end
    end
 
@@ -214,7 +223,7 @@ module DBI
             }
          }
          # If we reach this point, it means the database wasn't found
-         raise DBRCError, "No entry found for #{@user}@#{@database}"
+         raise Error, "No entry found for #{@user}@#{@database}"
       end
    end
 end

data/test/tc_dbrc.rb

@@ -1,24 +1,19 @@
-######################################################
+#########################################################################
 # tc_dbrc.rb
 #
-# Test suite for the base class of DBI::DBRC.
-######################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /dbi-dbrc/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-   Dir.chdir("test") rescue nil
-end
-
-require "dbi/dbrc"
-require "test/unit"
+# Test suite for the base class of DBI::DBRC. This test case should be
+# run via the 'rake test' task.
+#########################################################################
+require 'dbi/dbrc'
+require 'test/unit'
 include DBI
 
 class TC_DBRC < Test::Unit::TestCase
    def setup
+      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
+
       @dir      = "../examples/plain"
-      @file     = @dir + "/.dbrc"
+      @file     = File.join(@dir, '.dbrc')
       @db1      = "foo"
       @db2      = "bar"
       @user1    = "user1"
@@ -27,7 +22,7 @@ class TC_DBRC < Test::Unit::TestCase
       @user_bad = "user8" # Doesn't exist
      
       if File::ALT_SEPARATOR
-         File.set_attr(@file,File::HIDDEN)
+         File.set_attr(@file, File::HIDDEN)
       else
          File.chmod(0600, @file)
       end
@@ -36,16 +31,16 @@ class TC_DBRC < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.1.0", DBRC::VERSION)
+      assert_equal("1.1.1", DBRC::VERSION)
    end
 
    def test_bad_dbrc_properties
       if File::ALT_SEPARATOR
          File.unset_attr(@file, File::HIDDEN)
-         assert_raises(DBRCError){ DBRC.new(@db1, @user1, @dir) }
+         assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
       else
          File.chmod(0555,@file)
-         assert_raises(DBRCError){ DBRC.new(@db1, @user1, @dir) }
+         assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
       end
    end
 
@@ -56,11 +51,11 @@ class TC_DBRC < Test::Unit::TestCase
    end
 
    def test_bad_database
-      assert_raises(DBRCError){ DBRC.new(@db_bad, nil, @dir) }
+      assert_raises(DBRC::Error){ DBRC.new(@db_bad, nil, @dir) }
    end
 
    def test_bad_user
-      assert_raises(DBRCError){ DBRC.new(@db1, @user_bad, @dir) }
+      assert_raises(DBRC::Error){ DBRC.new(@db1, @user_bad, @dir) }
    end
 
    def test_database

data/test/tc_dbrc_xml.rb

@@ -1,16 +1,9 @@
-#################################################################
+########################################################################
 # tc_dbrc_xml.rb
 #
-# Test suite for the XML specific version of DBI::DBRC.
-#################################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /dbi-dbrc/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-   Dir.chdir("test") rescue nil
-end
-
+# Test suite for the XML specific version of DBI::DBRC. This test case
+# should be run via the 'rake test' task.
+########################################################################
 require "dbi/dbrc"
 require "test/unit"
 require "rexml/document"
@@ -19,8 +12,9 @@ include DBI
 
 class TC_DBRC_XML < Test::Unit::TestCase
    def setup
+      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
       @dir      = "../examples/xml"
-      @file     = @dir + "/.dbrc"
+      @file     = File.join(@dir, ".dbrc")
       @db1      = "foo"
       @db2      = "bar"
       @user1    = "user1"
@@ -28,12 +22,13 @@ class TC_DBRC_XML < Test::Unit::TestCase
       @db_bad   = "blah"  # Doesn't exist
       @user_bad = "user8" # Doesn't exist
 
+      if File::ALT_SEPARATOR
+         File.set_attr(@file, File::HIDDEN)
+      else
+         File.chmod(0600, @file)
+      end
+      
       @dbrc = DBRC::XML.new(@db1, nil, @dir)
-      File.chmod(0600, @file)
-   end
-
-   def test_version
-      assert_equal("1.1.0", DBRC::XML::VERSION)
    end
 
    def test_constructor
@@ -43,11 +38,11 @@ class TC_DBRC_XML < Test::Unit::TestCase
    end
 
    def test_bad_database
-      assert_raises(DBRCError){ DBRC::XML.new(@db_bad, nil, @dir) }
+      assert_raises(DBRC::Error){ DBRC::XML.new(@db_bad, nil, @dir) }
    end
 
    def test_bad_user
-      assert_raises(DBRCError){ DBRC::XML.new(@db1, @user_bad, @dir) }
+      assert_raises(DBRC::Error){ DBRC::XML.new(@db1, @user_bad, @dir) }
    end
 
    def test_database

data/test/tc_dbrc_yml.rb

@@ -1,24 +1,19 @@
-#################################################################
+#########################################################################
 # tc_dbrc_yml.rb
 #
-# Test suite for the YAML specific version of DBI::DBRC.
-#################################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /dbi-dbrc/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-   Dir.chdir("test") rescue nil
-end
-
+# Test suite for the YAML specific version of DBI::DBRC. You should run
+# this test case via the 'rake test' task.
+#########################################################################
 require "dbi/dbrc"
 require "test/unit"
 include DBI
 
 class TC_DBRC_YML < Test::Unit::TestCase
    def setup
+      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
+      
       @dir      = "../examples/yml"
-      @file     = @dir + "/.dbrc"
+      @file     = File.join(@dir, '.dbrc')
       @db1      = "foo"
       @db2      = "bar"
       @user1    = "user1"
@@ -35,10 +30,6 @@ class TC_DBRC_YML < Test::Unit::TestCase
       @dbrc = DBRC::YML.new(@db1, nil, @dir)
    end
 
-   def test_version
-      assert_equal("1.1.0", DBRC::YML::VERSION)
-   end
-
    def test_constructor
       assert_raises(ArgumentError){ DBRC::YML.new }
       assert_nothing_raised{ DBRC::YML.new(@db1, @user1, @dir) }
@@ -46,11 +37,11 @@ class TC_DBRC_YML < Test::Unit::TestCase
    end
 
    def test_bad_database
-      assert_raises(DBRCError){ DBRC::YML.new(@db_bad, nil, @dir) }
+      assert_raises(DBRC::Error){ DBRC::YML.new(@db_bad, nil, @dir) }
    end
 
    def test_bad_user
-      assert_raises(DBRCError){ DBRC::YML.new(@db1, @user_bad, @dir) }
+      assert_raises(DBRC::Error){ DBRC::YML.new(@db1, @user_bad, @dir) }
    end
 
    def test_database

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.4
 specification_version: 1
 name: dbi-dbrc
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2005-10-19 00:00:00 -06:00
+  version: 1.1.1
+date: 2007-08-02 00:00:00 -06:00
 summary: A simple way to avoid hard-coding passwords with DBI
 require_paths: 
-  - lib
+- lib
 email: djberg96@gmail.com
 homepage: http://www.rubyforge.org/projects/shards
 rubyforge_project: 
@@ -18,38 +18,45 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
-  - Daniel Berger
+- Daniel Berger
 files: 
-  - examples/plain
-  - examples/xml
-  - examples/yml
-  - examples/plain/test.rb
-  - examples/xml/test_xml.rb
-  - examples/yml/test_yml.rb
-  - lib/dbi
-  - lib/dbi/dbrc.rb
-  - test/tc_dbrc.rb
-  - test/tc_dbrc_xml.rb
-  - test/tc_dbrc_yml.rb
-  - test/ts_all.rb
-  - README
-  - CHANGES
+- examples/plain
+- examples/plain/test.rb
+- examples/xml
+- examples/xml/test_xml.rb
+- examples/yml
+- examples/yml/test_yml.rb
+- lib/dbi
+- lib/dbi/dbrc.rb
+- test/tc_dbrc.rb
+- test/tc_dbrc_xml.rb
+- test/tc_dbrc_yml.rb
+- test/ts_all.rb
+- README
+- CHANGES
+- MANIFEST
 test_files: 
-  - test/ts_all.rb
+- test/ts_all.rb
 rdoc_options: []
+
 extra_rdoc_files: 
-  - README
-  - CHANGES
+- README
+- CHANGES
+- MANIFEST
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+