caruby-core 2.1.2 → 2.1.3

data/History.md

@@ -1,6 +1,10 @@
 This history lists major release themes. See the GitHub Commits (https://github.com/caruby/core)
 for change details.
 
+2.1.3 / 2012-06-18
+------------------
+* Split up access properties.
+
 2.1.2 / 2012-06-12
 ------------------
 * Support caSmall.

data/LEGAL

@@ -1,5 +1,4 @@
 LEGAL NOTICE INFORMATION
 ------------------------
-
 All the files in this distribution are covered under either the MIT
 license (see the file LICENSE).

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Oregon Health & Science University
+Copyright (c) 2012 Oregon Health & Science University
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,20 +1,17 @@
 caRuby: Simplifying caBIG(TM)
 =============================
-
 **Home**:         [http://caruby.rubyforge.org](http://caruby.rubyforge.org)    
 **Git**:          [http://github.com/caruby/core](http://github.com/caruby/core)       
 **Author**:       OHSU Knight Cancer Institute    
-**Copyright**:    2010, 2011    
+**Copyright**:    2012    
 **License**:      MIT License    
 
 Synopsis
 --------
-
 caRuby presents a JRuby facade that simplifies interaction with caBIG applications.
 
 Feature List
 ------------
-
 1. caCORE API wrapper.
 
 2. Resolves persistence dependencies.
@@ -32,12 +29,10 @@ is installed.
 
 Usage
 -----
-
 See the project [Home](http://caruby.rubyforge.org) Page for usage examples. 
 
 Copyright
 ---------
-
-caRuby © 2010, 2011 by [Oregon Health & Science University](http://www.ohsu.edu/xd/health/services/cancer/index.cfm).
+caRuby © 2012 by [Oregon Health & Science University](http://www.ohsu.edu/xd/health/services/cancer/index.cfm).
 caRuby is licensed under the MIT license. Please see the LICENSE and LEGAL
 files for more information.

data/lib/caruby/database/sql_executor.rb

@@ -6,6 +6,19 @@ module CaRuby
   # Use of this class requires the dbi gem.
   # SQLExecutor is an auxiliary utility class and is not used by the rest of the CaRuby API.
   class SQLExecutor
+    # The database connection access options.
+    ACCESS_OPTS = [
+      [:database_host, '--database_host HOST', 'the database host name'],
+      [:database_port, '--database_port PORT', Integer, 'the database port number'],
+      [:database, '--database NAME', 'the database name'],
+      [:database_url, '--database_url URL', 'the database connection URL'],
+      [:database_type, '--database_type TYPE', 'the database type (mysql or oracle)'],
+      [:database_driver, '--database_driver DRIVER', 'the database driver string'],
+      [:database_driver_class, '--database_driver_class CLASS', 'the JDBC database driver class name'],
+      [:database_user, '--database_user USER', 'the database login user'],
+      [:database_password, '--database_password PSWD', 'the database login password']
+    ]
+    
     # Creates a new SQLExecutor with the given options.
     #
     # The default database host is the application :host property value, which in turn
@@ -18,19 +31,19 @@ module CaRuby
     # The default database driver class is +com.mysql.jdbc.Driver+ for MySQL,
     # +oracle.jdbc.OracleDriver+ for Oracle.
     #
-    # The default database URI is +dbi:+_db_driver_+://+_db_host_+:+_db_port_+/+_db_name_.
+    # The default database url is +_db_driver_+://+_db_host_+:+_db_port_+/+_db_name_.
     #
     # @param [Hash] opts the connect options
-    # @option opts [String] :database the mandatory database name
-    # @option opts [String] :database_user the mandatory database username (not the application login name)
-    # @option opts [String] :database_password the optional database password (not the application login password)
-    # @option opts [String] :database_type the optional database type (default +mysql+)
-    # @option opts [String] :database_host the optional database host
-    # @option opts [Integer] :database_port the optional database port number
-    # @option opts [String] :database_driver the optional DBI connect driver string, e.g. +jdbc:mysql+
-    # @option opts [String] :database_url the optional database connection URL
-    # @option opts [String] :database_driver_class the optional DBI connect driver class name
-    # @raise [CaRuby::ConfigurationError] if an option is invalid
+    # @option opts [String] :database the database name
+    # @option opts [String] :database_user the database username (not the application login name)
+    # @option opts [String] :database_password the database password (not the application login password)
+    # @option opts [String] :database_type the database type (default +mysql+)
+    # @option opts [String] :database_host the database host
+    # @option opts [Integer] :database_port the database port number
+    # @option opts [String] :database_driver the JDBC driver string, e.g. +jdbc:mysql+
+    # @option opts [String] :database_url the database connection URL
+    # @option opts [String] :database_driver_class the connect driver class name
+    # @raise [CaRuby::ConfigurationError] if neither the database url nor its constituent options are specified
     def initialize(opts)
       if opts.empty? then
         raise CaRuby::ConfigurationError.new("The caRuby database connection properties were not found.") 
@@ -50,9 +63,8 @@ module CaRuby
           raise_missing_option_error(:database)
         end
       end 
-      @dbi_url = 'dbi:' + @db_url
       @username = Options.get(:database_user, opts) { raise_missing_option_error(:database_user) }
-      @password = Options.get(:database_password, opts)
+      @password = Options.get(:database_password, opts) { raise_missing_option_error(:database_password) }
       @driver_class = Options.get(:database_driver_class, opts, default_driver_class(db_type))
       # The effective connection options.
       eff_opts = {

data/lib/caruby/database.rb

@@ -10,6 +10,7 @@ require 'caruby/database/operation'
 require 'caruby/database/reader'
 require 'caruby/database/writer'
 require 'caruby/database/persistifier'
+require 'caruby/database/sql_executor'
 
 module CaRuby
   # Database operation error.
@@ -41,22 +42,13 @@ module CaRuby
   class Database
     include Reader, Writer, Persistifier
 
-    # The application and database connection access command line options.
+    # The application and database connection options.
     ACCESS_OPTS = [
       [:user, '-u USER', '--user USER', 'the application login user'],
       [:password, '-p PSWD', '--password PSWD', 'the application login password'],
       [:host, '--host HOST', 'the application host name'],
       [:port, '--port PORT', 'the application port number'],
-      [:classpath, '--classpath PATH', 'the application client classpath'],
-      [:database_host, '--database_host HOST', 'the database host name'],
-      [:database_port, '--database_port PORT', Integer, 'the database port number'],
-      [:database, '--database NAME', 'the database name'],
-      [:database_url, '--database_url URL', 'the database connection URL'],
-      [:database_type, '--database_type TYPE', 'the database type (mysql or oracle)'],
-      [:database_driver, '--database_driver DRIVER', 'the database driver string'],
-      [:database_driver_class, '--database_driver_class CLASS', 'the database driver class name'],
-      [:database_user, '--database_user USER', 'the database login user'],
-      [:database_password, '--database_password PSWD', 'the database login password']
+      [:classpath, '--classpath PATH', 'the application client classpath']
     ]
     
     attr_reader :operations

data/lib/caruby/version.rb

@@ -1,3 +1,3 @@
 module CaRuby
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

metadata

@@ -2,7 +2,7 @@
 name: caruby-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors: 
   - OHSU
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-12 00:00:00 Z
+date: 2012-07-17 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: bundler