trinidad_generic_dbpool_extension 0.4.0 → 0.4.2

data/History.txt

@@ -1,3 +1,17 @@
+== 0.4.2 (2012-12-22)
+
+ * updated tomcat-dbcp.jar to 7.0.32
+ * support multiple jar files (and globbing) with driver path
+ * trinidad_mssql_dbpool_extension jTDS jar updated to 1.3.0
+
+== 0.4.1 (2012-11-29)
+
+* updated driver jars for following :
+  - trinidad_mysql_dbpool_extension
+  - trinidad_postgresql_dbpool_extension
+  - trinidad_mssql_dbpool_extension
+* added trinidad_sqlite_dbpool_extension
+
 == 0.4.0 (2012-05-31)
 
 * revised trinidad_generic_dbpool_extension :

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 David Calavera
+Copyright (c) 2012 Team Trinidad and contributors http://github.com/trinidad
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,8 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== JDBC Driver
+
+Included JDBC drivers are most likely distributed under different terms than 
+those above, please make sure you understand your driver's license terms.

data/README.md

@@ -0,0 +1,114 @@
+# Trinidad Database Pool
+
+A bunch of Trinidad extensions to support database connection pooling on top of 
+the underlying Apache Tomcat container (using Tomcat's JDBC Connection Pool).
+
+Please note, that such pools are usually configured as "global" and thus 
+shareable by multiple applications deployed on to of the Trinidad server.
+
+Also most Java issues caused by JDBC drivers packaged with the application (e.g.
+`java.lang.UnsatisfiedLinkError` with SQLite3's JDBC driver) that JRuby inherits
+should go away when database connections are managed externally.
+
+http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
+
+## Available Pools
+
+* MySQL (trinidad_mysql_dbpool_extension)
+* PostgreSQL (trinidad_postgresql_dbpool_extension)
+* SQLite (trinidad_sqlite_dbpool_extension)
+* MS-SQL (trinidad_mssql_dbpool_extension) using (unofficial) jTDS driver
+* Oracle (trinidad_oracle_dbpool_extension)
+* Generic (trinidad_generic_dbpool_extension) in case your DB ain't supported
+
+## Usage
+
+* Install the gem e.g. `jruby -S gem install trinidad_mysql_dbpool_extension`
+* Configure the pool with Trinidad's configuration file e.g. :
+
+```yml
+  web_apps:
+    default:
+      extensions:
+        mysql_dbpool:                    # EXTENSION NAME AS KEY
+          jndi: 'jdbc/TestDB'            # name (linked with database.yml)
+          url: 'localhost:3306/javatest' # database URL (or full jdbc: URL)
+          username: 'root'               # database username
+          password: 'root'               # database password
+          maxActive: 100                 # max nodes actives
+          maxIdle: 30                    # max nodes idles
+          maxWait: 10000                 # max nodes waiting
+```
+
+**jndi**, **url** are mandatory (as well **username** and **password** if your
+database server + driver requires authentication), while other supported 
+configuration options might be found here in Tomcat's "datasource" how-to:
+
+http://tomcat.apache.org/tomcat-7.0-doc/jndi-datasource-examples-howto.html
+
+http://commons.apache.org/dbcp/configuration.html
+
+If you happen to be using *SQLite* on production you'll need an absolute path :
+
+```yml
+  extensions:
+    sqlite_dbpool:
+      jndi: jdbc/FileDB
+      url: <%= File.expand_path('db/production.db') %>
+```
+
+* Configure the (Rails) application to use JNDI with *config/database.yml*
+
+```yml
+production:
+  adapter: jdbc # it will detect the adapter spec e.g. `ArJdbc::MySQL`
+  jndi: java:/comp/env/jdbc/TestDB
+  # (Java) JDBC driver class name is detected for built-in adapters that
+  # activerecord-jdbc-adapter supports, specify for a "generic" adapter
+  #driver: com.mysql.jdbc.Driver
+```
+
+do not forget to delete **pool** setup part since there's no need for it ...
+
+## Generic Pool
+
+If there's no "official" pool for your database, or would like to use a 
+different version of a JDBC driver for a supported Trinidad pool, this allows
+you to completely customize a pool.
+
+NOTE: You will need a JDBC driver for your database, check the driver DB if 
+unsure about how to get one http://developers.sun.com/product/jdbc/drivers
+
+Sample configuration for a DB2 database :
+
+```yml
+---
+  extensions:
+    generic_dbpool:                          # EXTENSION NAME AS KEY
+      jndi: 'jdbc/MyDB'                      # JNDI name
+      url: 'jdbc:db2://127.0.0.1:50000/MYDB' # specify full jdbc: URL
+      username: 'mydb'                       # database username
+      password: 'pass'                       # database password
+      driverPath: '/opt/IBM/DB2/db2jcc4.jar' # leave out if on class-path
+      driverName: com.ibm.db2.jcc.DB2Driver  # resolved from driverPath jar
+```
+
+Beyond standard configuration options there's 2 specific options here :
+
+* **driverPath** should be a path to your JDBC driver archive, might leave that
+  out but make sure it's on the (shared) class-path for each and every deployed 
+  application that requires it. You might specify multiple jars using the 
+  `Dir.glob` syntax or by separating paths using the `:` separator.
+
+  Also in case *driverPath* is omitted you'll need to specify a *driverName* !
+
+* **driverName** the class name implementing the JDBC driver interface, if 
+  you're not sure check the .jar for a META-INF/services/java.sql.Driver file.
+  If present that file contains the class-name and you might leave *driverName*
+  blank if you specified the jar path using *driverPath* but you're going still
+  going to need the driver name in your *database.yml*
+
+## Copyright
+
+Copyright (c) 2012 [Team Trinidad](https://github.com/trinidad). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/lib/trinidad_generic_dbpool_extension/generic_webapp_extension.rb

@@ -1,24 +1,42 @@
-require 'pathname'
-
 module Trinidad
   module Extensions
     class GenericDbpoolWebAppExtension < DbpoolWebAppExtension
-      def driver_name
-        if driver_path = @driver_path
-          unless File.exist?(driver_path)
-            driver_path = "#{driver_path}.jar" if driver_path[-4..-1] != '.jar'
+      
+      def driver_path(first = nil)
+        path = @driver_path || []
+        first ? path.first : path
+      end
+      
+      def driver_path=(path)
+        path = ( path || '' ).split(':') # : PATH separator
+        path.map! do |jar|
+          jars = Dir.glob(jar)
+          if jars.empty? # normalize .jar ext
+            jar = "#{jar}.jar" if jar[-4..-1] != '.jar'
+            jar
+          else
+            jars
           end
-          driver_path = Pathname.new(driver_path).realpath.to_s
-          if File.exist?(driver_path)
-            url = java.net.URL.new "jar:file://#{driver_path}!/META-INF/services/java.sql.Driver"
+        end
+        path.flatten!
+        @driver_path = path
+      end
+      
+      def driver_name
+        return @driver_name if defined? @driver_name
+        driver_path.find do |path|
+          path = java.io.File.new(path).absolute_path
+          if File.exist?(path)
+            url = java.net.URL.new "jar:file://#{path}!/META-INF/services/java.sql.Driver"
             begin
               reader = java.io.InputStreamReader.new( url.openStream )
-              return java.io.BufferedReader.new( reader ).readLine
+              return @driver_name = java.io.BufferedReader.new( reader ).readLine
             rescue java.io.FileNotFoundException
+              false
             end
           end
         end
-        nil
+        @driver_name = nil
       end
 
       def protocol
@@ -26,11 +44,22 @@ module Trinidad
       end
       
       protected
+      
       def create_resource tomcat, app_context, options
-        @driver_path = options.delete(:driverPath)
-        require @driver_path if @driver_path
+        path = options.delete(:driverPath) || options.delete(:driver_path)
+        self.driver_path = path if path
+        if path && driver_path.empty?
+          warn "no driver matched with specified :driverPath = #{path.inspect}"
+        else
+          load_driver
+        end
         super
       end
+      
+      def load_driver
+        driver_path.each { |jar| load jar }
+      end
+      
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: trinidad_generic_dbpool_extension
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
   - Patrick Cheng
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-31 00:00:00 Z
+date: 2012-12-22 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad_dbpool
@@ -55,15 +55,15 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+  - README.md
+  - History.txt
   - LICENSE
-  - README.rdoc
 files: 
   - lib/trinidad_generic_dbpool_extension.rb
   - lib/trinidad_generic_dbpool_extension/generic_webapp_extension.rb
+  - README.md
   - History.txt
   - LICENSE
-  - README.rdoc
-  - Rakefile
 homepage: http://github.com/trinidad/trinidad_dbpool_extension
 licenses: []
 
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Addon to support generic database pools in Trinidad

data/README.rdoc

@@ -1,93 +0,0 @@
-= trinidad-dbpool
-
-Trinidad extensions to support database connection pooling on top of the 
-underlying Apache Tomcat container.
-
-Please note, that such pools are usually configured as "global" and thus 
-shareable by multiple applications deployed on to of Trinidad server.
-
-== Available Pools
-
-* MySQL (trinidad_mysql_dbpool_extension)
-* PostgreSQL (trinidad_postgresql_dbpool_extension)
-* MS-SQL (trinidad_mssql_dbpool_extension) using (unofficial) jTDS driver
-* Oracle (trinidad_oracle_dbpool_extension)
-* Generic (trinidad_generic_dbpool_extension) in case your DB ain't supported
-
-== Usage
-
-* Install the gem e.g. `jruby -S gem install trinidad_mysql_dbpool_extension`
-* Configure the pool with Trinidad's configuration file e.g. :
-
-    web_apps:
-      default:
-        extensions:
-          mysql_dbpool:                        # EXTENSION NAME AS KEY
-            jndi: 'jdbc/TestDB'                # JNDI name
-            username: 'root'                   # database username
-            password: 'root'                   # database password
-            url: 'localhost:3306/javatest'     # database URL (or full jdbc: URL)
-            maxActive: 100                     # max nodes actives
-            maxIdle: 30                        # max nodes idles
-            maxWait: 10000                     # max nodes waiting
-
-_jndi_, _username_, _password_ and _url_ are mandatory, 
-while other supported configuration options might be found here:
-
-http://tomcat.apache.org/tomcat-6.0-doc/jndi-datasource-examples-howto.html
-
-http://commons.apache.org/dbcp/configuration.html
-
-* Configure your rails application to use JNDI into the config/database.yml
-
-    production:
-      adapter: jdbc
-      jndi: java:/comp/env/jdbc/TestDB
-      driver: com.mysql.jdbc.Driver # JDBC driver is mandatory here
-
-== Generic Pool
-
-If there's no "official" pool for your database, or would like to use a 
-different version of a JDBC driver for a supported Trinidad pool, this allows
-you to completely customize a pool.
-
-NOTE: You will need a JDBC driver for your database, check the driver DB if 
-unsure about how to get one http://developers.sun.com/product/jdbc/drivers
-
-Sample configuration for a DB2 database :
-
-    ---
-      extensions:
-        generic_dbpool:                          # EXTENSION NAME AS KEY
-          jndi: 'jdbc/MyDB'                      # JNDI name
-          url: 'jdbc:db2://127.0.0.1:50000/MYDB' # specify full jdbc: URL
-          username: 'mydb'                       # database username
-          password: 'pass'                       # database password
-          driverPath: '/opt/IBM/DB2/db2jcc4.jar' # leave out if it's on class-path
-          driverName: com.ibm.db2.jcc.DB2Driver  # might resolve from driverPath
-
-Beyond standard configuration options there's 2 specific options here :
-
-* _driverPath_ should be a path to your JDBC driver archive, if you're using a
-  --libs jar folder with trinidad, might leave that out but make sure it's on 
-  the class-path for each and every deployed application that requires it.
-
-  Also in case driverPath: is ommited you'll need to specify a driverName: !
-
-* _driverName_ the class name implementing the JDBC driver interface, if you're
-  not sure check the .jar for a META-INF/services/java.sql.Driver file. If 
-  present that file contains the class-name and you might leave driverName: 
-  blank if you specified the jar path using driverPath: but you're going still
-  going to need the driver name in your database.yml
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010-2012 David Calavera. See LICENSE for details.

data/Rakefile

@@ -1,75 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-def build(gem)
-  mkdir_p 'pkg'
-  sh "gem build #{gem}.gemspec"
-  mv Dir["#{gem}*.gem"].last, 'pkg'
-end
-
-def release(gem, version = nil)
-  unless `git branch` =~ /^\* master$/
-    raise "must be on master to release !"
-  end
-  
-  if version
-    unless gem_file = Dir.glob("pkg/#{gem}-#{version}.gem").first
-      raise "#{gem}-#{version}.gem not build !"
-    end
-  else
-    unless gem_file = Dir.glob("pkg/#{gem}*").sort.last
-      raise "#{gem}*.gem not build !"
-    end
-    unless match = gem_file.match(/.*?\-(\d\.\d\.\d)\.gem/)
-      raise "version number not matched from: #{gem_file}"
-    end
-    version = match[1]
-  end
-  
-  sh "git tag #{gem}-#{version}"
-  sh "git push origin master --tags"
-  sh "gem push #{gem_file}"
-end
-
-all_gems = %W{ 
-  dbpool 
-  generic_dbpool_extension 
-  mysql_dbpool_extension 
-  postgresql_dbpool_extension 
-  mssql_dbpool_extension 
-  oracle_dbpool_extension 
-}
-all_gems.map! { |gem| "trinidad_#{gem}" }
-all_gems.each do |gem_name|
-  namespace gem_name do
-    desc "Build the #{gem_name} gem"
-    task :build do
-      build(gem_name)
-    end
-    desc "Release the #{gem_name} gem"
-    task :release => :build do
-      release(gem_name)
-    end
-  end
-end
-
-{
-  :build => 'Build all connection pool gems', 
-  :release => 'Release all connection pool gems'
-}.each do |t, d|
-  desc d
-  task t => all_gems.map { |name| "#{name}:#{t}" } # e.g. mysql_dbpool:build
-end
-
-desc "Clear out all built .gem files"
-task :clear do
-  FileUtils.rm Dir["*.gem"]
-  FileUtils.rm_r Dir["pkg/*"] if File.exist?("pkg")
-end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ['--color', "--format documentation"]
-end
-
-task :default => :spec