trinidad_dbpool 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f93eef63246340486ea0ecca09eb0d944cc9ca7
-  data.tar.gz: 3ec1c314d6ea8046125d506cfa364629248fffa6
+  metadata.gz: ec58e3883b1b9311357eb67855850c9c533e84de
+  data.tar.gz: 86a73ec4c26494de2034379f39161a8a2f518c05
 SHA512:
-  metadata.gz: 846038f43082dbcb7e5f190921227284869a078062ecbe4185ca81dc3d1b20d9074404d42f9e9d180fa6193b1bfe7486f8171c0521b3b8a40bc5b457b40b6573
-  data.tar.gz: d334c5d8ecd37cf8b9b8ae7ef910b7eb86525e63d55051ca8b855988a1516cd78d19f3661cd24e1c03a9822fe160bcb79c814e23feb5b96e6c941b044acb1e7a
+  metadata.gz: fe405ecd57e9dfdd2b6091822e9744f829ef2e6ed4889a19b03acfcb1331e4df3c836b6072bcb612ffc228430ce5ac9b377a688886d0d330dc80a7dcd706d2de
+  data.tar.gz: 80ae0a6d5be2b5776de2892da161bc582b3612b934c3238df68275508f2a2a01daeb82735cf1ecb85111be0408f33a870b17fd2774ffeac1e52abcc3fd4d4c5a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Team Trinidad and contributors http://github.com/trinidad
+Copyright (c) 2014 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

data/README.md

@@ -30,8 +30,8 @@ http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
     default:
       extensions:
         mysql_dbpool:                   # EXTENSION NAME AS KEY
-          jndi: 'jdbc/MySampleDB'       # name (linked with database.yml)
-          url: 'localhost:3306/sample'  # database URL (or full jdbc: URL)
+          name: jdbc/MySampleDB         # name (linked with database.yml)
+          url: localhost:3306/sample    # database URL (or full jdbc: URL)
           username: root
           password: root
           maxActive:  100  # maximum number of connections managed by the pool
@@ -39,9 +39,9 @@ http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
           maxWait:  10000  # ms the pool waits for a connection to be returned
 ```
 
-**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 JDBC pool documentation :
+**name** (aliased as **jndi**), **url** are mandatory (as well **username** and
+**password** if your database server + driver requires authentication), while
+the other supported options might be found in Tomcat's JDBC pool documentation :
 
 http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html#Common_Attributes
 
@@ -113,5 +113,5 @@ Beyond standard configuration options there's 2 specific options here :
 
 ## Copyright
 
-Copyright (c) 2013 [Team Trinidad](https://github.com/trinidad).
+Copyright (c) 2016 [Team Trinidad](https://github.com/trinidad).
 See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -50,57 +50,69 @@ all_gems.each do |gem_name|
 
 end
 
+unless Bundler::GemHelper.method_defined?(:release_gem)
+  Bundler::GemHelper.send :define_method, :release_gem do
+    guard_clean
+    tag_version unless already_tagged?
+    built_gem_path = build_gem
+    rubygem_push(built_gem_path) if gem_push?
+  end
+  Bundler::GemHelper.send :define_method, :install_gem do
+    built_gem_path = build_gem
+    install_gem(built_gem_path)
+  end
+end
+
 namespace :all do
   desc "Build all gems into the pkg directory"
   task 'build' => all_gems.map { |gem_name| "#{gem_name}:build" }
 
   desc "Build and install all gems into system gems"
   task 'install' => all_gems.map { |gem_name| "#{gem_name}:install" }
-end
 
-namespace :'tomcat-dbcp' do
+  task 'release' => all_gems.map { |gem_name| "#{gem_name}:release" }
+end
 
-  TOMCAT_MAVEN_REPO = 'http://repo2.maven.org/maven2/org/apache/tomcat'
+['tomcat-jdbc', 'tomcat-dbcp'].each do |tomcat_pool|
 
-  TRINIDAD_LIBS = File.expand_path('./trinidad-libs', File.dirname(__FILE__))
+  namespace tomcat_pool do
 
-  dbcp_jar = "tomcat-dbcp.jar"
+    tomcat_maven_repo = 'http://repo2.maven.org/maven2/org/apache/tomcat'
+    trinidad_libs = File.expand_path('trinidad-libs', File.dirname(__FILE__))
 
-  task :download, :version do |_, args| # rake tomcat-dbcp:download[7.0.41]
-    version = args[:version]
+    tomcat_pool_jar = "#{tomcat_pool}.jar"
 
-    dbcp_uri = "#{TOMCAT_MAVEN_REPO}/tomcat-dbcp/#{version}/tomcat-dbcp-#{version}.jar"
+    task :download, :version do |_, args| # rake tomcat-jdbc:download[7.0.54]
+      version = args[:version]
 
-    require 'open-uri'; require 'tmpdir'
+      uri = "#{tomcat_maven_repo}/#{tomcat_pool}/#{version}/#{tomcat_pool}-#{version}.jar"
 
-    temp_dir = File.join(Dir.tmpdir, (Time.now.to_f * 1000).to_i.to_s)
-    FileUtils.mkdir temp_dir
+      require 'open-uri'; require 'tmpdir'
 
-    downloads = Hash.new
-    downloads[dbcp_jar] = dbcp_uri
+      temp_dir = File.join(Dir.tmpdir, (Time.now.to_f * 1000).to_i.to_s)
+      FileUtils.mkdir temp_dir
 
-    Dir.chdir(temp_dir) do
-      FileUtils.mkdir TRINIDAD_LIBS unless File.exist?(TRINIDAD_LIBS)
-      downloads.each do |jar, uri|
+      Dir.chdir(temp_dir) do
         puts "downloading #{uri}"
         file = open(uri)
-        FileUtils.cp file.path, File.join(TRINIDAD_LIBS, jar)
+        FileUtils.cp file.path, File.join(trinidad_libs, tomcat_pool_jar)
       end
+
+      FileUtils.rm_r temp_dir
     end
 
-    FileUtils.rm_r temp_dir
-  end
+    task :check do
+      jar_path = File.join(trinidad_libs, tomcat_pool_jar)
+      unless File.exist?(jar_path)
+        Rake::Task["#{tomcat_pool}:download"].invoke
+      end
+    end
 
-  task :check do
-    jar_path = File.join(TRINIDAD_LIBS, dbcp_jar)
-    unless File.exist?(jar_path)
-      Rake::Task['tomcat-jndi:download'].invoke
+    task :clear do
+      jar_path = File.join(trinidad_libs, tomcat_pool_jar)
+      rm jar_path if File.exist?(jar_path)
     end
-  end
 
-  task :clear do
-    jar_path = File.join(TRINIDAD_LIBS, dbcp_jar)
-    rm jar_path if File.exist?(jar_path)
   end
 
 end

data/lib/trinidad_dbpool.rb

@@ -1,7 +1,121 @@
 require 'java'
-
-require 'trinidad'
 require 'trinidad/jars'
 load File.expand_path('../../trinidad-libs/tomcat-jdbc.jar', __FILE__)
 
-require 'trinidad_dbpool/webapp_extension'
+module Trinidad
+  module DBPool
+    class << self
+
+      def create_resource(context, options, protocol = nil)
+        name = options.delete(:name) || options.delete(:jndi); url = options.delete(:url)
+        if ! url.start_with?('jdbc:') && protocol
+          url = "#{protocol}#{url}" unless url.start_with?(protocol)
+        end
+
+        resource_factory = options.key?(:factory) ? options.delete(:factory) :
+          'org.apache.tomcat.jdbc.pool.DataSourceFactory'
+        if ( pool = options.delete(:pool) ) && pool.to_s != 'jdbc' # pool: 'dbcp'
+          begin
+            load File.expand_path("../../trinidad-libs/tomcat-#{pool}.jar", __FILE__)
+            resource_factory = nil
+          rescue LoadError
+            context.logger.warn "The `pool: #{pool}` option is not supported, please remove it"
+          else
+            context.logger.info "Using deprecated `pool: #{pool}` configuration option, consider removing it"
+          end
+        end
+
+        driver = options.delete(:driver) || options.delete(:driverName) || options.delete(:driver_name)
+
+        context.logger.debug "Using JDBC URL: #{url.inspect} for #{name}"
+
+        # <Resource name="jdbc/MyDB"
+        #           auth="Container"
+        #           type="javax.sql.DataSource"
+        #           url="jdbc:mysql://localhost:3306/mydb"
+        #           driverClassName="com.mysql.jdbc.Driver"
+        #           maxActive="100" maxIdle="30" maxWait="10000"
+        #           username="root" password="secret" />
+        resource = Trinidad::Tomcat::ContextResource.new
+        resource.set_auth(options.delete(:auth)) if options.key?(:auth)
+        resource.set_description(options.delete(:description)) if options.key?(:description)
+        resource.set_name(name)
+        resource.set_type(options.delete(:type) || 'javax.sql.DataSource')
+        resource.set_property('factory', resource_factory) if resource_factory
+        resource.set_property('driverClassName', driver)
+        resource.set_property('url', url)
+        camelizer = supported_properties_camelizer
+        options.each do |key, value|
+          resource.set_property(camelizer[key.to_s], value.to_s)
+        end
+
+        yield(resource) if block_given?
+
+        context.naming_resources.add_resource(resource)
+        context.naming_resources = resource.naming_resources
+
+        resource
+      end
+
+      private
+
+      def supported_properties_camelizer
+        hash = Hash.new { |hash, key| simple_camelize(key) }
+
+        # Common Attributes :
+
+        hash['username'] = 'username'
+        hash['password'] = 'password'
+        hash['driver_class_name'] = 'driverClassName'
+
+        hash['default_auto_commit'] = 'defaultAutoCommit'
+        hash['default_read_only'] = 'defaultReadOnly'
+        hash['default_transaction_isolation'] = 'defaultTransactionIsolation'
+        hash['default_catalog'] = 'defaultCatalog'
+
+        hash['max_active'] = 'maxActive'
+        hash['max_idle'] = 'maxIdle'
+        hash['min_idle'] = 'minIdle'
+        hash['initial_size'] = 'initialSize'
+        hash['max_wait'] = 'maxWait'
+
+        hash['test_on_borrow'] = 'testOnBorrow'
+        hash['test_on_return'] = 'testOnReturn'
+        hash['test_while_idle'] = 'testWhileIdle'
+
+        hash['validation_query'] = 'validationQuery'
+        hash['validation_query_timeout'] = 'validationQueryTimeout'
+
+        #
+
+        hash['log_abandoned'] = 'logAbandoned'
+        hash['remove_abandoned'] = 'removeAbandoned'
+        hash['remove_abandoned_timeout'] = 'removeAbandonedTimeout'
+
+        hash['connection_properties'] = 'connectionProperties'
+
+        # Tomcat JDBC pool only :
+
+        hash['init_sql'] = 'initSQL'
+        hash['validation_interval'] = 'validationInterval'
+        hash['jmx_enabled'] = 'jmxEnabled'
+        hash['fair_queue'] = 'fairQueue'
+        hash['abandon_when_percentage_full'] = 'abandonWhenPercentageFull'
+
+        hash['max_age'] = 'maxAge'
+        hash['suspect_timeout'] = 'suspectTimeout'
+        hash['rollback_on_return'] = 'rollbackOnReturn'
+        hash['commit_on_return'] = 'commitOnReturn'
+        hash['alternate_username_allowed'] = 'alternateUsernameAllowed'
+
+        hash
+      end
+
+      def simple_camelize(string)
+        return string unless string.index('_')
+        string.gsub(/_([a-z\d]*)/i) { $1.capitalize }
+      end
+
+    end
+  end
+end

data/lib/trinidad_dbpool/webapp_extension.rb

@@ -1,3 +1,5 @@
+require 'trinidad'
+
 module Trinidad
   module Extensions
     class DbpoolWebAppExtension < WebAppExtension
@@ -5,7 +7,7 @@ module Trinidad
       def configure(tomcat, context)
         case @options
         when Hash
-          [create_resource(tomcat, context, @options)]
+          [ create_resource(tomcat, context, @options) ]
         when Array
           @options.map { |opts| create_resource tomcat, context, opts }
         end
@@ -14,52 +16,27 @@ module Trinidad
       protected
 
       def create_resource tomcat, context, options
-        jndi, url = options.delete(:jndi), options.delete(:url)
-        url = protocol + url unless %r{^#{protocol}} =~ url
-        options[:url] = url
-
-        resource_factory = options.key?(:factory) ? options.delete(:factory) :
-          'org.apache.tomcat.jdbc.pool.DataSourceFactory'
-        if pool = options.delete(:pool) # pool: dbcp (backwards compatibility)
-          begin
-            load File.expand_path("../../../trinidad-libs/tomcat-#{pool}.jar", __FILE__)
-            resource_factory = nil
-          rescue LoadError
-            context.logger.warn "The `pool: #{pool}` option is not supported, please remove it"
-          else
-            context.logger.info "Using deprecated `pool: #{pool}` configuration option, consider removing it"
-          end
-        end
-
         load_driver
 
-        driver_name = options.delete(:driver) || options.delete(:driverName) ||
-                      self.driver_name
+        options[:driver] ||= options.delete(:driverName) ||
+          options.delete(:driver_name) || self.driver_name
 
-        # <Resource name="jdbc/MyDB"
-        #           auth="Container"
-        #           type="javax.sql.DataSource"
-        #           url="jdbc:mysql://localhost:3306/mydb"
-        #           driverClassName="com.mysql.jdbc.Driver"
-        #           maxActive="100" maxIdle="30" maxWait="10000"
-        #           username="root" password="secret" />
-        resource = Trinidad::Tomcat::ContextResource.new
-        resource.set_auth(options.delete(:auth)) if options.key?(:auth)
-        resource.set_description(options.delete(:description)) if options.key?(:description)
-        resource.set_name(jndi)
-        resource.set_type(options.delete(:type) || 'javax.sql.DataSource')
-        resource.set_property('factory', resource_factory) if resource_factory
-        resource.set_property('driverClassName', driver_name)
-        options.each { |key, value| resource.set_property(key.to_s, value.to_s) }
-
-        context.naming_resources.add_resource(resource)
-        context.naming_resources = resource.naming_resources
+        if properties = options.delete(:properties) || connection_properties
+          if properties.is_a?(String)
+            options['connectionProperties'] ||= properties
+          else # format: prop1=value1;prop2=value2
+            url_params = properties.map { |key, value| "#{key}=#{value}" }
+            options['connectionProperties'] ||= url_params.join(';')
+          end
+        end
 
-        resource
+        Trinidad::DBPool.create_resource(context, options, protocol)
       end
 
       def load_driver; end
 
+      def connection_properties; end
+
     end
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: trinidad_dbpool
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - David Calavera
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trinidad_jars
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.4
+  name: trinidad_jars
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.10'
+  name: rspec
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: mocha
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.10'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
+  name: mocha
   prerelease: false
   type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: Addon to support database pools in Trinidad
 email: calavera@apache.org
 executables: []
@@ -62,14 +62,14 @@ extra_rdoc_files:
 - LICENSE
 - Rakefile
 files:
+- History.txt
+- LICENSE
+- README.md
+- Rakefile
 - lib/trinidad_dbpool.rb
 - lib/trinidad_dbpool/webapp_extension.rb
 - trinidad-libs/tomcat-dbcp.jar
 - trinidad-libs/tomcat-jdbc.jar
-- README.md
-- History.txt
-- LICENSE
-- Rakefile
 homepage: http://github.com/trinidad/trinidad_dbpool_extension
 licenses: []
 metadata: {}
@@ -79,17 +79,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Addon to support database pools in Trinidad