bcdatabase 1.0.0 → 1.0.1

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+1.0.1
+=====
+- Update some old syntax for ruby 1.9 compatibility (David Yip)
+
 1.0.0
 =====
 - Split out from NUBIC internal `bcdatabase` project.

data/README.markdown

@@ -14,19 +14,19 @@ Ensure that [gemcutter](http://gemcutter.org) is in your gem sources list, then:
 A bog-standard rails application's `config/database.yml` file looks like this:
 
     development:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //localhost/XE
       username: cfg_animal
       password: not-important
 
     test:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //localhost/XE
       username: cfg_animal_test
       password: who-cares
 
     production:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //super/prod
       username: cfg_animal
       password: very-secret
@@ -39,13 +39,13 @@ Rails allows this file to contain [ERB][].  `bcdatabase` uses ERB to replace an
     %>
 
     development:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //localhost/XE
       username: cfg_animal
       password: not-important
 
     test:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //localhost/XE
       username: cfg_animal_test
       password: who-cares
@@ -83,7 +83,7 @@ Since each file can define a set of default properties which are shared by all t
 If you have an `/etc/nubic/db/stage.yml` file that looks like this:
 
     defaults:
-      adapter: oracle-enhanced
+      adapter: oracle_enhanced
       database: //mondo/stage
     cfg_animal:
       password: secret
@@ -93,14 +93,14 @@ If you have an `/etc/nubic/db/stage.yml` file that looks like this:
 
 You have defined two configuration entries.  `:stage, :cfg_animal`:
 
-    adapter:  oracle-enhanced
+    adapter:  oracle_enhanced
     username: cfg_animal
     password: secret
     database: //mondo/stage
 
 and `:bcstage, :personnel`:
 
-    adapter:  oracle-enhanced
+    adapter:  oracle_enhanced
     username: pers
     password: more-secret
     database: //mondo/stage

data/VERSION.yml

@@ -1,5 +1,5 @@
----
+--- 
 :major: 1
 :minor: 0
-:build:
-:patch: 0
+:build: 
+:patch: 1

data/lib/bcdatabase.rb

@@ -79,14 +79,14 @@ module Bcdatabase
       dbname = (args[1] or raise "Database entry name not specified for #{name}")
       n = name.to_s
       begin
-        unseparated_yaml({ n, self[groupname, dbname] })
+        unseparated_yaml(n => self[groupname, dbname])
       rescue Bcdatabase::Error => e
         if defined?(RAILS_ENV) and RAILS_ENV == n
           raise e
         else
           # Not using that configuration right now, so return a dummy instead
           # of throwing an exception
-          unseparated_yaml({ n, { 'error' => e.message } })
+          unseparated_yaml(n => { 'error' => e.message })
         end
       end
     end

data/spec/bcdatabase_spec.rb

@@ -1,38 +1,10 @@
 require File.expand_path("spec_helper", File.dirname(__FILE__))
 
-describe Bcdatabase, "cipherment" do
-  before(:all) do
-    keyfile = "/tmp/bcdb-spec-key"
-    open(keyfile, 'w') { |f| f.write "01234567890123456789012345678901" }
-    ENV["BCDATABASE_PASS"] = keyfile
-  end
-
-  after(:all) do
-    FileUtils.rm ENV["BCDATABASE_PASS"]
-    ENV["BCDATABASE_PASS"] = nil
-  end
-
-  it "should be reversible" do
-    e = Bcdatabase.encrypt("riboflavin")
-    Bcdatabase.decrypt(e).should == "riboflavin"
-  end
-
-  it "should permute the input" do
-    Bcdatabase.encrypt("zanzibar").should_not == "zanzibar"
-  end
-
-  it "should do more than just encode" do
-    Bcdatabase.encrypt("zanzibar").should_not == Base64.encode64("zanzibar")
-  end
-end
-
-describe Bcdatabase, "module " do
+describe Bcdatabase do
   it "should have a d.d.d version" do
     Bcdatabase::VERSION.should =~ /^\d+\.\d+\.\d+$/
   end
-end
 
-describe Bcdatabase, "loading" do
   before(:each) do
     ENV["BCDATABASE_PATH"] = "/tmp/bcdb_specs"
     FileUtils.mkdir_p ENV["BCDATABASE_PATH"]
@@ -43,158 +15,250 @@ describe Bcdatabase, "loading" do
     ENV["BCDATABASE_PATH"] = nil
   end
 
-  it "should read simple YAML" do
-    temporary_yaml "simple", {
-      "single" =>  {
-        "adapter" => "foo", "username" => "baz"
-      }
-    }
-    bcdb = Bcdatabase.load
-    bcdb[:simple, :single]['adapter'].should == "foo"
-    bcdb[:simple, :single]['username'].should == "baz"
-  end
+  describe "cipherment" do
+    before(:all) do
+      keyfile = "/tmp/bcdb-spec-key"
+      open(keyfile, 'w') { |f| f.write "01234567890123456789012345678901" }
+      ENV["BCDATABASE_PASS"] = keyfile
+    end
 
-  it "should read and expose multiple groups from multiple files" do
-    temporary_yaml "one", {
-      "first" => { "dc" => "etc" }
-    }
-    temporary_yaml "two", {
-      "fourth" => { "dc" => "etc" }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['one', 'first'].should_not be_nil
-    bcdb['two', 'fourth'].should_not be_nil
-  end
+    after(:all) do
+      FileUtils.rm ENV["BCDATABASE_PASS"]
+      ENV["BCDATABASE_PASS"] = nil
+    end
 
-  it "should merge defaults from 'defaults'" do
-    temporary_yaml "defaulted", {
-      "defaults" => {
-        "database" => "postgresql"
-      },
-      "real" => {
-        "password" => "frood"
-      }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['defaulted', 'real']['password'].should == 'frood'
-    bcdb['defaulted', 'real']['database'].should == 'postgresql'
-  end
+    it "should be reversible" do
+      e = Bcdatabase.encrypt("riboflavin")
+      Bcdatabase.decrypt(e).should == "riboflavin"
+    end
 
-  it "should merge defaults from 'default'" do
-    temporary_yaml "singular", {
-      "default" => {
-        "adapter" => "three-eighths"
-      },
-      "real" => {
-        "password" => "frood"
-      }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['singular', 'real']['adapter'].should == 'three-eighths'
+    it "should permute the input" do
+      Bcdatabase.encrypt("zanzibar").should_not == "zanzibar"
+    end
+
+    it "should do more than just encode" do
+      Bcdatabase.encrypt("zanzibar").should_not == Base64.encode64("zanzibar")
+    end
   end
 
-  it "should preserve values overridden from defaults" do
-    temporary_yaml "jam", {
-      "default" => {
-        "adapter" => "three-eighths"
-      },
-      "standard" => {
-        "password" => "frood"
-      },
-      "custom" => {
-        "adapter" => "five-sixteenths",
-        "password" => "lazlo"
+  describe "loading" do
+    it "should read simple YAML" do
+      temporary_yaml "simple", {
+        "single" =>  {
+          "adapter" => "foo", "username" => "baz"
+        }
       }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['jam', 'standard']['adapter'].should == 'three-eighths'
-    bcdb['jam', 'custom']['adapter'].should == 'five-sixteenths'
-  end
+      bcdb = Bcdatabase.load
+      bcdb[:simple, :single]['adapter'].should == "foo"
+      bcdb[:simple, :single]['username'].should == "baz"
+    end
 
-  it "should default the username to the entry name" do
-    temporary_yaml "scran", {
-      "jim" => { "password" => "leather" }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['scran', 'jim']['username'].should == 'jim'
-    bcdb['scran', 'jim']['password'].should == 'leather'
-  end
+    it "should read and expose multiple groups from multiple files" do
+      temporary_yaml "one", {
+        "first" => { "dc" => "etc" }
+      }
+      temporary_yaml "two", {
+        "fourth" => { "dc" => "etc" }
+      }
+      bcdb = Bcdatabase.load
+      bcdb['one', 'first'].should_not be_nil
+      bcdb['two', 'fourth'].should_not be_nil
+    end
 
-  it "should default the database name to the entry name" do
-    temporary_yaml "scran", {
-      "jim" => { "password" => "leather" }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['scran', 'jim']['database'].should == 'jim'
-    bcdb['scran', 'jim']['password'].should == 'leather'
-  end
+    it "should merge defaults from 'defaults'" do
+      temporary_yaml "defaulted", {
+        "defaults" => {
+          "database" => "postgresql"
+        },
+        "real" => {
+          "password" => "frood"
+        }
+      }
+      bcdb = Bcdatabase.load
+      bcdb['defaulted', 'real']['password'].should == 'frood'
+      bcdb['defaulted', 'real']['database'].should == 'postgresql'
+    end
 
-  it "should not default the database name if there's an explicit database name" do
-    temporary_yaml "scran", {
-      "jim" => {
-        "password" => "leather",
-        "database" => "james"
+    it "should merge defaults from 'default'" do
+      temporary_yaml "singular", {
+        "default" => {
+          "adapter" => "three-eighths"
+        },
+        "real" => {
+          "password" => "frood"
+        }
       }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['scran', 'jim']['database'].should == 'james'
-    bcdb['scran', 'jim']['password'].should == 'leather'
-  end
+      bcdb = Bcdatabase.load
+      bcdb['singular', 'real']['adapter'].should == 'three-eighths'
+    end
 
-  it "should not default the database name to the entry name if there's a default database name" do
-    temporary_yaml "scran", {
-      "default" => {
-        "database" => "//localhost:345/etc"
-      },
-      "jim" => {
-        "password" => "leather",
+    it "should preserve values overridden from defaults" do
+      temporary_yaml "jam", {
+        "default" => {
+          "adapter" => "three-eighths"
+        },
+        "standard" => {
+          "password" => "frood"
+        },
+        "custom" => {
+          "adapter" => "five-sixteenths",
+          "password" => "lazlo"
+        }
       }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['scran', 'jim']['database'].should == '//localhost:345/etc'
-    bcdb['scran', 'jim']['password'].should == 'leather'
-  end
+      bcdb = Bcdatabase.load
+      bcdb['jam', 'standard']['adapter'].should == 'three-eighths'
+      bcdb['jam', 'custom']['adapter'].should == 'five-sixteenths'
+    end
 
-  it "should use an explicit username instead of the entry name if provided" do
-    temporary_yaml "scran", {
-      "jim" => {
-        "username" => "james",
-        "password" => "earldom"
+    it "should default the username to the entry name" do
+      temporary_yaml "scran", {
+        "jim" => { "password" => "leather" }
       }
-    }
-    bcdb = Bcdatabase.load
-    bcdb['scran', 'jim']['username'].should == 'james'
-    bcdb['scran', 'jim']['password'].should == 'earldom'
-  end
+      bcdb = Bcdatabase.load
+      bcdb['scran', 'jim']['username'].should == 'jim'
+      bcdb['scran', 'jim']['password'].should == 'leather'
+    end
 
-  describe "with encrypted passwords" do
-    before do
-      enable_fake_cipherment
+    it "should default the database name to the entry name" do
+      temporary_yaml "scran", {
+        "jim" => { "password" => "leather" }
+      }
+      bcdb = Bcdatabase.load
+      bcdb['scran', 'jim']['database'].should == 'jim'
+      bcdb['scran', 'jim']['password'].should == 'leather'
     end
 
-    after do
-      disable_fake_cipherment
+    it "should not default the database name if there's an explicit database name" do
+      temporary_yaml "scran", {
+        "jim" => {
+          "password" => "leather",
+          "database" => "james"
+        }
+      }
+      bcdb = Bcdatabase.load
+      bcdb['scran', 'jim']['database'].should == 'james'
+      bcdb['scran', 'jim']['password'].should == 'leather'
     end
 
-    it "should decrypt and expose the password" do
-      temporary_yaml "secure", {
-        "safe" => {
-          "epassword" => "moof"
+    it "should not default the database name to the entry name if there's a default database name" do
+      temporary_yaml "scran", {
+        "default" => {
+          "database" => "//localhost:345/etc"
+        },
+        "jim" => {
+          "password" => "leather",
         }
       }
       bcdb = Bcdatabase.load
-      bcdb['secure', 'safe']['password'].should == "foom"
+      bcdb['scran', 'jim']['database'].should == '//localhost:345/etc'
+      bcdb['scran', 'jim']['password'].should == 'leather'
     end
 
-    it "should prefer the decrypted version of an epassword" do
-      temporary_yaml "secure", {
-        "safe" => {
-          "password" => "fake",
-          "epassword" => "moof"
+    it "should use an explicit username instead of the entry name if provided" do
+      temporary_yaml "scran", {
+        "jim" => {
+          "username" => "james",
+          "password" => "earldom"
         }
       }
       bcdb = Bcdatabase.load
-      bcdb['secure', 'safe']['password'].should == "foom" # not "fake"
+      bcdb['scran', 'jim']['username'].should == 'james'
+      bcdb['scran', 'jim']['password'].should == 'earldom'
+    end
+
+    describe "with encrypted passwords" do
+      before do
+        enable_fake_cipherment
+      end
+
+      after do
+        disable_fake_cipherment
+      end
+
+      it "should decrypt and expose the password" do
+        temporary_yaml "secure", {
+          "safe" => {
+            "epassword" => "moof"
+          }
+        }
+        bcdb = Bcdatabase.load
+        bcdb['secure', 'safe']['password'].should == "foom"
+      end
+
+      it "should prefer the decrypted version of an epassword" do
+        temporary_yaml "secure", {
+          "safe" => {
+            "password" => "fake",
+            "epassword" => "moof"
+          }
+        }
+        bcdb = Bcdatabase.load
+        bcdb['secure', 'safe']['password'].should == "foom" # not "fake"
+      end
+    end
+  end
+
+  describe "for database.yml" do
+    before do
+      temporary_yaml "scran", {
+        "jim" => {
+          "username" => "james",
+          "password" => "earldom"
+        },
+
+        "dwide" => {
+          "username" => "dwight",
+          "password" => "help"
+        }
+      }
+      @bcdb = Bcdatabase.load
+    end
+
+    describe "the yaml for a valid reference" do
+      before do
+        @yaml = @bcdb.development(:scran, :jim)
+        @actual = YAML.load(@yaml)
+      end
+
+      it "isn't a separated YAML doc" do
+        @yaml.should_not =~ /---/
+      end
+
+      it "has a single top-level key" do
+        @actual.keys.should have(1).key
+        @actual.should have_key("development")
+      end
+
+      it "reflects the selected configuration" do
+        @actual['development']['username'].should == 'james'
+        @actual['development']['password'].should == 'earldom'
+      end
+    end
+
+    describe "an invalid reference" do
+      before do
+        ::RAILS_ENV = "staging"
+      end
+
+      after do
+        Object.class_eval { remove_const "RAILS_ENV" }
+      end
+
+      describe "for the current RAILS_ENV" do
+        it "allows the exception through" do
+          lambda { @bcdb.staging(:scran, :phil) }.should raise_error
+        end
+      end
+
+      describe "for a different RAILS_ENV" do
+        it "does not throw an exception" do
+          lambda { @bcdb.production(:scran, :phil) }.should_not raise_error
+        end
+
+        it "includes the error in the resulting hash" do
+          @bcdb.production(:scran, :phil).should =~ / error: No database entry for \"phil\" in scran/
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bcdatabase
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 -06:00
+date: 2009-12-20 00:00:00 -06:00
 default_executable: bcdatabase
 dependencies: 
 - !ruby/object:Gem::Dependency