rackdb 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85abbc78d214e92fed878a662481b862331309e2
-  data.tar.gz: 530b4248476a132fb36980655cb5efc3678df949
+  metadata.gz: d9d5129e23dfb34e48b8086a9d23977a6c870e01
+  data.tar.gz: b8c864d5f8809b12bdea79f720a8c3f632262f92
 SHA512:
-  metadata.gz: 983755cfed0c92723baae4380791571f2bc1e74aa994aa9349556a69b02d9db9d9fa17ec470acbb2b3d51c2bcdee261882f04d9052e53c4059584636b93ac504
-  data.tar.gz: 28db8f413cb0b7b6ad8a7d52a80dac0c1e641493578c88aa274e391c3e6206e49d8f8c7bfb1f2992bbb331f0092d38ad6520290c86c18b487e3bcd424b67adc5
+  metadata.gz: b7b8781b4027d75998f22e415d78448f84627606f5f137b2ca8a871a6c39ff8d6b2954721e5e0382a72a84ee50b2a212328548c55738ac0d89522a621b416bc0
+  data.tar.gz: 2b56363071f3bfd1bc2f8bd0158bf8699a4f44130acae91bae28a297a3dac0212022e066d4a336f7fa2600fbf1535f88b34fb0df1ec304012ff1ea16154a7fa8

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.0 (2016-05-04)
+
+* Adds override of `config.yml` via `DATABASE_URL` environment variable; see `README.md` for details.
+* RCov added to test suite to verify test coverage of lines of code, albeit not all branch conditions. The coverage report makes it easy to see which things are covered and which things aren't (e.g. because they're imported from another code base with assumed coverage there).
+* Now considered feature-complete to original design goals and stable, so bumping to version 1.0.0.
+
 ## 0.0.4 (2016-05-03)
 
 * Fix very silly error where local machine via `bundle exec` resolved renamed file `init.rb` successfully but, of course, the clean deployment didn't; it was renamed to `console.rb`. Fixed and added a couple of simple additional tests to cover the executed binary and make sure it wakes up OK.

data/README.md

@@ -6,7 +6,15 @@
 
 **rackdb** is a database console for Ruby applications that run on Rack, which follow the Rails-like convention of a `config/database.yml` file describing the database connection parameters. This includes [Rails applications](http://rubyonrails.org) and [Hoodoo services](http://hoodoo.cloud/).
 
-It is based upon [`racksh`](https://github.com/sickill/racksh) and the Ruby on Rails `dbconsole` [code](https://github.com/rails/rails/blob/master/railties/lib/rails/commands/dbconsole.rb). For more information, see the Rails documentation for `dbconsole`.
+If environment variable `DATABASE_URL` is defined, it will be assumed to contain a fully qualified URI for connecting to the database of choice and will take precedence over `config.yml`. This is often the case for Hoodoo services in cloud-based deployment configurations with remote database services like RDS, rather than under development or in production with a locally hosted database.
+
+* The URI is parsed and `config.yml`-style parameters are filled in using its components.
+* PostgreSQL, MySQL and SQL Server URIs are very similar and should all work in theory, conveying the host, port, username, password and database name options where present in the URI. Only PostgreSQL is actually tested against a real database at the time of writing - the others were coded by observation.
+* SQLite URIs of `sqlite://` are assumed to be for a SQLite v3 database and the pathname of the URI is taken as the path to the database file on the local filesystem.
+* Oracle URIs are extremely unusual and are not supported.
+* A `jdbc:` scheme prefix is ignored if present; for example, `jdbc:mysql://...` and `mysql://` would both be treated the same way.
+
+The code is based upon [`racksh`](https://github.com/sickill/racksh), the Ruby on Rails `dbconsole` [code](https://github.com/rails/rails/blob/master/railties/lib/rails/commands/dbconsole.rb) and the Hoodoo [service shell](https://github.com/LoyaltyNZ/service_shell). For more information, see the Rails documentation for `dbconsole`.
 
 ## Installation
 

data/lib/rackdb/console.rb

@@ -105,10 +105,54 @@ module RackDB
 
     def config
       @config ||= begin
-        if configurations()[ environment ].blank?
-          raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations().inspect}"
+        if ENV[ 'DATABASE_URL' ]
+
+          # Assumptions: "jdbc:foo://..." style prefixes break the URI parser
+          # and we don't care about JDBC for parsing; strip it. SQLServer URIs
+          # start with "mssql"; 'sqlite' is taken to mean 'sqlite3'; else they
+          # start with something that works as the datapter verbatim.
+          #
+          # All presently known and supported connection URIs have the target
+          # database name as their path - either just one path element in most
+          # cases, or a full path to a file for SQLite.
+          #
+          # Unsupported: Oracle; URI is deeply bizarre. Custom sockets, pools,
+          # timeouts, query parameters etc. are ignored.
+
+          uri_str = ENV[ 'DATABASE_URL' ].gsub( /^jdbc\:/, '' )
+          uri     = URI.parse( uri_str )
+          scheme  = uri.scheme.downcase
+          adapter = case scheme
+            when 'mssql'
+              'sqlserver'
+            when 'sqlite'
+              'sqlite3'
+            else
+              scheme
+          end
+
+          path = case adapter
+            when 'sqlite3'
+              uri.path
+            else
+              ( uri.path || '' ).gsub( /^\/+/, '' ) # Remove any leading '/'s
+          end
+
+          {
+            'adapter'  => adapter,
+            'database' => path,
+            'user'     => uri.user,
+            'password' => uri.password,
+            'host'     => uri.host,
+            'port'     => uri.port
+          }
+
+        elsif configurations()[ environment ].blank?
+          raise ActiveRecord::AdapterNotSpecified, "Neither 'DATABASE_URL' nor 'config.yml' entry '#{environment}' are configured. Available configurations: #{configurations().inspect}"
+
         else
           configurations()[ environment ]
+
         end
       end
     end

data/lib/rackdb/version.rb

@@ -1,3 +1,3 @@
 module RackDB
-  VERSION = '0.0.4'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rackdb
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Hodgkinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Database console for Ruby applications running on Rack with ActiveRecord
   and following the Rails "config/database.yml" database configuration pattern
 email: ahodgkin@rowing.org.uk