dbi-dbrc 1.4.1 → 1.5.0

data/Rakefile

@@ -1,8 +1,8 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
   desc "Create the dbi-dbrc gem"
@@ -20,23 +20,7 @@ namespace :gem do
   end
 end
 
-namespace :test do
-  Rake::TestTask.new(:all) do |t|
-    t.warning = true
-    t.verbose = true
-  end
-
-  Rake::TestTask.new(:xml) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_dbi_dbrc_xml.rb']
-  end
-
-  Rake::TestTask.new(:yml) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_dbi_dbrc_yml.rb']
-  end
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => 'test:all'
+task :default => :spec

data/dbi-dbrc.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'dbi-dbrc'
-  spec.version    = '1.4.1'
+  spec.version    = '1.5.0'
   spec.author     = 'Daniel Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -12,17 +12,14 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['test/test*.rb']
   spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST']
-
-  spec.required_ruby_version = ">= 1.9.3"
-
-  spec.add_development_dependency('test-unit')
   spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('fakefs', '~> 1.3')
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/dbi-dbrc',
     'bug_tracker_uri'   => 'https://github.com/djberg96/dbi-dbrc/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/dbi-dbrc/blob/master/CHANGES',
+    'changelog_uri'     => 'https://github.com/djberg96/dbi-dbrc/blob/main/CHANGES',
     'documentation_uri' => 'https://github.com/djberg96/dbi-dbrc/wiki',
     'source_code_uri'   => 'https://github.com/djberg96/dbi-dbrc',
     'wiki_uri'          => 'https://github.com/djberg96/dbi-dbrc/wiki'

data/lib/dbi/dbrc.rb

@@ -18,7 +18,7 @@ module DBI
     class Error < StandardError; end
 
     # The version of the dbi-dbrc library
-    VERSION = '1.4.1'.freeze
+    VERSION = '1.5.0'.freeze
 
     WINDOWS = File::ALT_SEPARATOR # :no-doc:
 
@@ -118,6 +118,7 @@ module DBI
         end
 
         @dbrc_file = File.join(home, '.dbrc')
+        dbrc_dir = home
       else
         raise Error, 'bad directory' unless File.directory?(dbrc_dir)
         @dbrc_file = File.join(dbrc_dir, '.dbrc')
@@ -220,7 +221,7 @@ module DBI
     # Parse the text out of the .dbrc file.  This is the only method you
     # need to redefine if writing your own config handler.
     def parse_dbrc_config_file(file=@dbrc_file)
-      IO.foreach(file){ |line|
+      File.foreach(file){ |line|
         next if line =~ /^#/    # Ignore comments
         db, user, pwd, driver, timeout, max, interval = line.split
 
@@ -253,7 +254,7 @@ module DBI
 
   # A subclass of DBRC designed to handle .dbrc files in XML format.  The
   # public methods of this class are identical to DBRC.
-  class XML < DBRC
+  class DBRC::XML < DBRC
     require 'rexml/document' # Good enough for small files
     include REXML
 
@@ -282,7 +283,7 @@ module DBI
 
   # A subclass of DBRC designed to handle .dbrc files in YAML format. The
   # public methods of this class are identical to DBRC.
-  class YML < DBRC
+  class DBRC::YML < DBRC
     require 'yaml'
 
     private

data/spec/dbi_dbrc_spec.rb

@@ -0,0 +1,236 @@
+#########################################################################
+# dbi_dbrc_spec.rb
+#
+# Specs for the base class of DBI::DBRC. This test case should be
+# run via the 'rake spec' task.
+#########################################################################
+require 'dbi/dbrc'
+require 'fileutils'
+require 'spec_helper'
+require 'pp' # Requiring this ahead of fakefs to address a superclass issue.
+require 'fakefs/spec_helpers'
+
+RSpec.describe DBI::DBRC do
+  include FakeFS::SpecHelpers
+
+  let(:windows) { File::ALT_SEPARATOR }
+  let(:home) { File.join(Dir.pwd, 'home', 'someone') }
+  let(:dbrc) { File.join(home, '.dbrc') }
+
+  let(:plain) {
+    %q{
+      foo      user1    pwd1     Oracle   40       3     60
+      foo      user2    pwd2     OCI8     60       4     60
+      bar      user1    pwd3     Oracle   30       2     30
+      baz      user3    pwd4
+    }.lstrip
+  }
+
+  let(:db_foo){ 'foo' }
+  let(:db_bar){ 'bar' }
+  let(:db_baz){ 'baz' }
+  let(:user1) { 'user1' }
+  let(:user2) { 'user2' }
+
+  before do
+    allow(Dir).to receive(:home).and_return(home)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(plain) }
+    File.chmod(0600, dbrc)
+
+    # FakeFS doesn't implement this yet
+    allow_any_instance_of(FakeFS::File::Stat).to receive(:owned?).and_return(true)
+  end
+
+  example "version" do
+    expect(described_class::VERSION).to eq('1.5.0')
+    expect(described_class::VERSION).to be_frozen
+  end
+
+  context "windows", :windows => true do
+    example "constructor raises an error unless the .dbrc file is hidden" do
+      File.unset_attr(plain, File::HIDDEN)
+      expect{ described_class.new(db_foo, user1) }.to raise_error(described_class::Error)
+    end
+  end
+
+  context "constructor" do
+    example "constructor raises an error if the permissions are invalid" do
+      File.chmod(0555, dbrc)
+      expect{ described_class.new(db_foo, user1) }.to raise_error(described_class::Error)
+    end
+
+    example "constructor raises an error if no database is provided" do
+      expect{ described_class.new }.to raise_error(ArgumentError)
+    end
+
+    example "constructor works as expected with or without user" do
+      expect{ described_class.new(db_foo, user1) }.not_to raise_error
+      expect{ described_class.new(db_foo, nil) }.not_to raise_error
+    end
+
+    example "constructor fails if the database entry doesn't exist" do
+      expect{ described_class.new('bogus', user1) }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor fails if the user entry doesn't exist" do
+      expect{ described_class.new(db_foo, 'nobody') }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor fails if the .dbrc file isn't found in the specified directory" do
+      expect{ described_class.new(db_foo, user1, '/bogusXX') }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor returns expected values for the same database with different users" do
+      dbrc1 = described_class.new(db_foo, user1)
+      dbrc2 = described_class.new(db_foo, user2)
+      expect(dbrc1.database).to eq(dbrc2.database)
+      expect(dbrc1.user).to eq('user1')
+      expect(dbrc2.user).to eq('user2')
+    end
+
+    example "constructor returns expected values for the same user with different database" do
+      dbrc1 = described_class.new(db_foo, user1)
+      dbrc2 = described_class.new(db_bar, user1)
+      expect(dbrc1.user).to eq(dbrc2.user)
+      expect(dbrc1.database).to eq('foo')
+      expect(dbrc2.database).to eq('bar')
+    end
+
+    example "constructor works as expected if some optional fields are not defined" do
+      dbrc = described_class.new(db_baz)
+      expect(dbrc.user).to eq("user3")
+      expect(dbrc.passwd).to eq("pwd4")
+      expect(dbrc.driver).to be_nil
+      expect(dbrc.interval).to be_nil
+      expect(dbrc.timeout).to be_nil
+      expect(dbrc.max_reconn).to be_nil
+      expect(dbrc.dsn).to be_nil
+    end
+  end
+
+  context "instance methods" do
+    before do
+      @dbrc = DBI::DBRC.new(db_foo)
+    end
+
+    example "basic database getter method and aliases" do
+      expect(@dbrc).to respond_to(:database)
+      expect(@dbrc.method(:database)).to eq(@dbrc.method(:db))
+      expect(@dbrc.method(:database)).to eq(@dbrc.method(:host))
+    end
+
+    example "basic database setter method and alias" do
+      expect(@dbrc).to respond_to(:database=)
+      expect(@dbrc.method(:database=)).to eq(@dbrc.method(:db=))
+    end
+
+    example "database method returns expected value" do
+      expect(@dbrc.database).to eq('foo')
+    end
+
+    example "basic dbrc_dir check" do
+      expect(@dbrc).to respond_to(:dbrc_dir)
+    end
+
+    example "dbrc_dir returns the expected value" do
+      expect(@dbrc.dbrc_dir).to eq(home)
+    end
+
+    example "basic dbrc_file check" do
+      expect(@dbrc).to respond_to(:dbrc_file)
+    end
+
+    example "dbrc_file returns the expected value" do
+      expect(File.basename(@dbrc.dbrc_file)).to eq('.dbrc')
+    end
+
+    example "basic dsn getter check" do
+      expect(@dbrc).to respond_to(:dsn)
+    end
+
+    example "dsn method returns the expected value" do
+      expect(@dbrc.dsn).to eq('dbi:Oracle:foo')
+    end
+
+    example "basic dsn setter check" do
+      expect(@dbrc).to respond_to(:dsn=)
+    end
+
+    example "user getter basic check" do
+      expect(@dbrc).to respond_to(:user)
+    end
+
+    example "user method returns expected value" do
+      expect(@dbrc.user).to eq('user1')
+    end
+
+    example "user setter basic check" do
+      expect(@dbrc).to respond_to(:user=)
+    end
+
+    example "password getter basic check and alias" do
+      expect(@dbrc).to respond_to(:password)
+      expect(@dbrc.method(:password)).to eq(@dbrc.method(:passwd))
+    end
+
+    example "password method returns expected value" do
+      expect(@dbrc.password).to eq("pwd1")
+    end
+
+    example "password setter basic check and alias" do
+      expect(@dbrc).to respond_to(:password=)
+      expect(@dbrc.method(:password=)).to eq(@dbrc.method(:passwd=))
+    end
+
+    example "driver getter basic check" do
+      expect(@dbrc).to respond_to(:driver)
+    end
+
+    example "driver method returns expected value" do
+      expect(@dbrc.driver).to eq("Oracle")
+    end
+
+    example "driver setter basic check" do
+      expect(@dbrc).to respond_to(:driver=)
+    end
+
+    example "interval getter basic check" do
+      expect(@dbrc).to respond_to(:interval)
+    end
+
+    example "interval method returns expected value" do
+      expect(@dbrc.interval).to eq(60)
+    end
+
+    example "interval setter basic check" do
+      expect(@dbrc).to respond_to(:interval=)
+    end
+
+    example "timeout getter basic check" do
+      expect(@dbrc).to respond_to(:timeout)
+      expect(@dbrc.method(:timeout)).to eq(@dbrc.method(:time_out))
+    end
+
+    example "timeout method returns expected value" do
+      expect(@dbrc.timeout).to eq(40)
+    end
+
+    example "timeout setter basic check" do
+      expect(@dbrc).to respond_to(:timeout=)
+    end
+
+    example "max_reconn getter basic check" do
+      expect(@dbrc).to respond_to(:max_reconn)
+      expect(@dbrc.method(:max_reconn)).to eq(@dbrc.method(:maximum_reconnects))
+    end
+
+    example "max_reconn method returns expected value" do
+      expect(@dbrc.max_reconn).to eq(3)
+    end
+
+    example "max_reconn setter basic check" do
+      expect(@dbrc).to respond_to(:max_reconn=)
+    end
+  end
+end

data/spec/dbi_dbrc_xml_spec.rb

@@ -0,0 +1,95 @@
+########################################################################
+# dbi_dbrc_xml_spec.rb
+#
+# 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 'rspec'
+require 'pp' # Need this to avoid fakefs error
+require 'fakefs/spec_helpers'
+
+RSpec.describe DBI::DBRC::XML, :xml => true do
+  include FakeFS::SpecHelpers
+
+  let(:home) { File.join(Dir.pwd, 'home', 'someone') }
+  let(:dbrc) { File.join(home, '.dbrc') }
+
+  let(:db_foo){ 'foo' }
+  let(:user1) { 'user1' }
+
+  let(:xml){
+    %q{
+      <dbrc>
+         <database name="foo">
+            <user>user1</user>
+            <password>pwd1</password>
+            <driver>Oracle</driver>
+            <interval>60</interval>
+            <timeout>40</timeout>
+            <maximum_reconnects>3</maximum_reconnects>
+         </database>
+         <database name="foo">
+            <user>user2</user>
+            <password>pwd2</password>
+            <driver>OCI8</driver>
+            <interval>60</interval>
+            <timeout>60</timeout>
+            <maximum_reconnects>4</maximum_reconnects>
+         </database>
+         <database name="bar">
+            <user>user1</user>
+            <password>pwd3</password>
+            <driver>Oracle</driver>
+            <interval>30</interval>
+            <timeout>30</timeout>
+            <maximum_reconnects>2</maximum_reconnects>
+         </database>
+         <database name="baz">
+            <user>user3</user>
+            <password>pwd4</password>
+         </database>
+      </dbrc>
+    }.lstrip
+  }
+
+  before do
+    allow(Dir).to receive(:home).and_return(home)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(xml) }
+    File.chmod(0600, dbrc)
+
+    # FakeFS doesn't implement this yet
+    allow_any_instance_of(FakeFS::File::Stat).to receive(:owned?).and_return(true)
+  end
+
+  context "instance methods" do
+    before do
+      @dbrc = described_class.new(db_foo, user1)
+    end
+
+    example "database method returns expected value" do
+      expect(@dbrc.database).to eq('foo')
+    end
+
+    example "password method returns expected value" do
+      expect(@dbrc.password).to eq('pwd1')
+    end
+
+    example "driver method returns expected value" do
+      expect(@dbrc.driver).to eq('Oracle')
+    end
+
+    example "interval method returns expected value" do
+      expect(@dbrc.interval).to eq(60)
+    end
+
+    example "timeout method returns expected value" do
+      expect(@dbrc.timeout).to eq(40)
+    end
+
+    example "maximum_reconnects method returns expected value" do
+      expect(@dbrc.maximum_reconnects).to eq(3)
+    end
+  end
+end

data/spec/dbi_dbrc_yml_spec.rb

@@ -0,0 +1,89 @@
+########################################################################
+# dbi_dbrc_yml_spec.rb
+#
+# Test suite for the YAML specific version of DBI::DBRC. This test case
+# should be run via the 'rake test' task.
+########################################################################
+require 'dbi/dbrc'
+require 'rspec'
+require 'pp' # Need this to avoid fakefs error
+require 'fakefs/spec_helpers'
+
+RSpec.describe DBI::DBRC::YML, :yml => true do
+  include FakeFS::SpecHelpers
+
+  let(:home) { File.join(Dir.pwd, 'home', 'someone') }
+  let(:dbrc) { File.join(home, '.dbrc') }
+
+  let(:db_foo){ 'foo' }
+  let(:user1) { 'user1' }
+
+  let(:yml){
+    %q{
+- foo:
+   user: user1
+   password: pwd1
+   driver: Oracle
+   interval: 60
+   timeout: 40
+   maximum_reconnects: 3
+- foo:
+   user: user2
+   password: pwd2
+   driver: OCI8
+   interval: 60
+   timeout: 60
+   maximum_reconnects: 4
+- bar:
+   user: user1
+   password: pwd3
+   driver: Oracle
+   interval: 30
+   timeout: 30
+   maximum_reconnects: 2
+- baz:
+   user: user3
+   password: pwd4
+    }
+  }
+
+  before do
+    allow(Dir).to receive(:home).and_return(home)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(yml) }
+    File.chmod(0600, dbrc)
+
+    # FakeFS doesn't implement this yet
+    allow_any_instance_of(FakeFS::File::Stat).to receive(:owned?).and_return(true)
+  end
+
+  context "instance methods" do
+    before do
+      @dbrc = described_class.new(db_foo, user1)
+    end
+
+    example "database method returns expected value" do
+      expect(@dbrc.database).to eq('foo')
+    end
+
+    example "password method returns expected value" do
+      expect(@dbrc.password).to eq('pwd1')
+    end
+
+    example "driver method returns expected value" do
+      expect(@dbrc.driver).to eq('Oracle')
+    end
+
+    example "interval method returns expected value" do
+      expect(@dbrc.interval).to eq(60)
+    end
+
+    example "timeout method returns expected value" do
+      expect(@dbrc.timeout).to eq(40)
+    end
+
+    example "maximum_reconnects method returns expected value" do
+      expect(@dbrc.maximum_reconnects).to eq(3)
+    end
+  end
+end