pod4 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 222b047955f5c90f80f9766f7d14b51322761dd9dce60d289c104b0f8becce35
-  data.tar.gz: 34d692c2d9d1831e4d3b6f5525ab2bda44bb7351dd6f8041b1ebe66d41db6463
+  metadata.gz: 7f7db5348478c3d4dba39f248760d0f148f14f21866246e95ec3ea8c69505979
+  data.tar.gz: 7cbace08f7fb4151bfb7b9713bed4d5262d4d4bc7b4a0a87e79723e6c990fabf
 SHA512:
-  metadata.gz: 92f70348d8ac572a9ca5a3a4dfb3fe7b1abf6f1fa0e6846a7bab3aa94f18cc35413706e663db56517fcf5b525a7e481ca464b66c990f892f0531c0b5aa39375f
-  data.tar.gz: 6850576058884778e31e38c63bb02eec915baa63423168d523b7d0593d5fb9dfd97151ad32584c1fc3f6bcacd34119871033bf3f45b89cc555266cf75688de4c
+  metadata.gz: 9b0d0707ae21d1060cbc5df5fa0bee569c85a5dc6f9af3db288c4ba4025c047a1cbb3f3390535df81589b1143053bc29337a407b3f345a4bbcfa594ae7051e83
+  data.tar.gz: 983c421cdfca75e40b211d19f9a80ed63bbd14068a539b3861be446803231b361d323e34f91de1675ad1bbc528cd62e9f6dd9601d0b7e252d3985287e8ccbcc8

data/.hgtags

@@ -33,3 +33,4 @@ e98232cdc6cbe61e2bf0513fcf578001a2931018 0.10.4
 daae29a48272b5c3029b6509354bd3c3e6bf339a 0.10.5
 48d204fe041672e6df5845ad552497df8db3029a 0.10.6
 82ec1031be4084a673f2f979f9bbf9950e21d71a 1.0.0
+a6b22bc7314b21fb0959f77ec324911b631d786b 1.0.2

data/Gemfile

@@ -11,6 +11,8 @@ group :development, :test do
   gem "rspec",   "~> 3.10"
   gem 'pry'
   gem "pry-doc"
+  gem "base64"
+  gem "logger"
 
   # For testing
   gem "sequel",         "~> 5.4" 

data/README.md

@@ -466,18 +466,26 @@ where I was going.
 In practice this means you need to get your DB connection details from somewhere, maybe create your
 Sequel DB object; and only then can you require your models.
 
-Leading on from this, wrinkle two: except when using Sequel (which behaves differently) each
-interface has its own connection to the database. This means that your application has (simplifying
-a bit here) one database connection for each model class.  So if you have a Customer model and a
-Orders model, your application will hold two connections to the database.  All customer enquiries
-share a single connection, and all order enquiries share a single connection.
+As it stood, this meant that, except when using Sequel (which behaves differently) each
+interface had its own connection to the database. This means that your application had (simplifying
+a bit here) one database connection for each model class.
+
+This scaled surprisingly well, but (again, excepting Sequel) was not thread safe; multiple threads,
+if you had them, would share the same connection. Note that we are talking in the past tense for
+this second wrinkle, because of:
 
-I'm finding that, generally, this scales about right. But if you have a lot of different models and a
-database that runs out of connections easily, it might be problematic.
 
 ### The Connection Object ###
 
-The solution to both of these wrinkles, if you need one, is to use a Pod4::Connection object:
+The solution to both of these wrinkles is the Pod4::Connection object. 
+
+By default any interface other than SequelInterface will create a pool of connections and connect
+to the database with one your thread is currently using.  (Sequel uses it's own connection pool, so
+will create one internally. It uses its own thread pool, of course, and we only use the one Sequel
+DB object for the whole of Pod4, so it doesn't need any of that. That's why it uses
+Pod4::Connection, instead.)
+
+You can set this up manually, if you wish:
 
     #
     # init.rb -- bootup for my project
@@ -519,14 +527,6 @@ With TdsInterface and PgInterface you can pass the same connection to multiple m
 share it.  These interfaces take a Pod4::ConnectionPool instead, but otherwise the code looks
 exactly the same as the above example. 
 
-(Technical note: the ConnectionPool object will actually provide multiple connections, one per
-thread that uses it.  This satisfies the requirement of the underlying libraries that connections
-are not shared between threads, and therefore ensures that Pod4 is more or less thread safe.  You
-get this functionality automatically -- if you don't define a ConnectionPool, then the interface
-will create one internally. Sequel uses its own thread pool, of course, and we only use the one
-Sequel DB object for the whole of Pod4, so it doesn't need any of that. That's why it uses
-Pod4::Connection, instead.)
-
 
 BasicModel
 ----------

data/lib/pod4/connection_pool.rb

@@ -11,7 +11,7 @@ module Pod4
 
   class ConnectionPool < Connection
 
-    PoolItem = Struct.new(:client, :thread_id)
+    PoolItem = Struct.new(:client, :thread_id, :stamp)
 
     class Pool
       def initialize
@@ -21,12 +21,16 @@ module Pod4
 
       def <<(cl)
         @mutex.synchronize do
-          @items << PoolItem.new(cl, Thread.current.object_id)
+          @items << PoolItem.new(cl, Thread.current.object_id, Time.now)
         end
       end
 
+      def get(id)
+        @items.find{|x| x.thread_id == id }
+      end
+
       def get_current 
-        @items.find{|x| x.thread_id == Thread.current.object_id }
+        get(Thread.current.object_id)
       end
 
       def get_free
@@ -37,13 +41,19 @@ module Pod4
         end
       end
 
-      def release
-        pi = get_current
+      def release(id=nil)
+        pi = id.nil? ? get_current : get(id)
+        pi.thread_id = nil if pi
+      end
+
+      def release_oldest
+        pi = @items.sort{|a,b| a.stamp <=> b.stamp}.first
         pi.thread_id = nil if pi
       end
 
-      def drop
-        @items.delete_if{|x| x.thread_id == Thread.current.object_id }
+      def drop(id=nil)
+        id ||= Thread.current.object_id
+        @items.delete_if{|x| x.thread_id == id }
       end
 
       def size 
@@ -84,6 +94,8 @@ module Pod4
     # Return the client we gave this thread before. 
     # Failing that, assign a free one from the pool.
     # Failing that, ask the interface to give us a new client.
+    # Failing that, if we've set a timeout, wait for a client to be freed; if we have not, release
+    #   the oldest client and use that.
     #
     # Note: The interface passes itself in case we want to call it back to get a new client; but
     # clients are assigned to a _thread_. Every interface in a given thread gets the same pool
@@ -106,9 +118,16 @@ module Pod4
         end
 
         if @max_clients && @pool.size >= @max_clients 
-          raise Pod4::PoolTimeout if @max_wait && (Time.now - time > @max_wait)
-          sleep 1
-          next
+          if @max_wait
+            raise Pod4::PoolTimeout if @max_wait && (Time.now - time > @max_wait)
+            Pod4.logger.warn(__FILE__){ "waiting for a free client..." }
+            sleep 1
+            next
+          else
+            Pod4.logger.debug(__FILE__){ "releasing oldest client" }
+            @pool.release_oldest
+            next
+          end
         end
 
         cl = interface.new_connection(@data_layer_options)

data/lib/pod4/typecasting.rb

@@ -222,7 +222,7 @@ module Pod4
         return thing if thing.nil?
 
         # For all current cases, attempting to typecast a blank string should return nil
-        return nil if thing =~ /\A\s*\Z/ 
+        return nil if thing.is_a?(String) && thing =~ /\A\s*\Z/ 
 
         # The order we try these in matters
         return tc_bigdecimal(thing) if type == BigDecimal 

data/lib/pod4/version.rb

@@ -1,3 +1,3 @@
 module Pod4 
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

data/pod4.gemspec

@@ -3,12 +3,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pod4/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pod4"
-  spec.version       = Pod4::VERSION
-  spec.authors       = ["Andy Jones"]
-  spec.email         = ["andy.jones@twosticksconsulting.co.uk"]
-  spec.summary       = %q|Totally not an ORM|
-  spec.description   = <<-DESC.gsub(/^\s+/, "")
+  spec.name                  = "pod4"
+  spec.version               = Pod4::VERSION
+  spec.required_ruby_version = ">= 2.7.4"
+  spec.authors               = ["Andy Jones"]
+  spec.email                 = ["andy.jones@twosticksconsulting.co.uk"]
+  spec.summary               = %q|Totally not an ORM|
+  spec.description           = <<-DESC.gsub(/^\s+/, "")
     Provides a simple, common framework to talk to a bunch of data sources,
     using model classes which consist of a bare minimum of DSL plus vanilla Ruby
     inheritance.

data/spec/common/connection_pool_spec.rb

@@ -127,9 +127,9 @@ describe Pod4::ConnectionPool do
         end
       end
 
-      context "when we reach the maximum" do
+      context "when we reach the maximum and there is a max_wait" do
         before(:each) do
-          @connection = ConnectionPool.new(interface: ifce_class, max_clients: 1)
+          @connection = ConnectionPool.new(interface: ifce_class, max_clients: 1, max_wait: 10)
           @connection.data_layer_options = "meh"
           @interface = ifce_class.new
           @interface.set_conn "boz"
@@ -194,6 +194,42 @@ describe Pod4::ConnectionPool do
         end
       end # of when we reach the maximum, max_wait is set and the time is up
 
+      context "when we reach the maximum and no max_wait is set" do
+        before(:each) do
+          @connection = ConnectionPool.new(interface: ifce_class, max_clients: 2)
+          @connection.data_layer_options = "meh"
+          @interface = ifce_class.new
+          @interface.set_conn "foo"
+
+          # assign our 2 clients in the pool to a different thread
+          @threads = []
+          2.times do
+            @threads << Thread.new { @connection.client(@interface); Thread.stop }
+          end
+          sleep 0.1 until @threads.all?{|t| t.stop? }
+
+          expect( @connection._pool.size ).to eq 2
+          @threads.each do |t|
+            expect( t ).not_to be_nil
+            expect( t ).not_to eq Thread.current.object_id
+          end
+        end
+
+        after(:each) { @threads.each{|t| t.kill} }
+
+        it "releases the oldest connection" do
+          oldest = @connection._pool.sort_by{|x| x.stamp}.first
+          expect( oldest.thread_id ).not_to eq Thread.current.object_id
+
+          @connection.client(@interface)
+          expect( @connection._pool.size ).to eq 2
+
+          conn = @connection._pool.find{|x| x.stamp == oldest.stamp }
+          expect( conn.thread_id ).to eq Thread.current.object_id
+        end
+
+      end # of when we reach the maximum and no max_wait is set
+
     end # of when max_clients != nil, there is no client for this thread and none free
     
   end # of #client

data/spec/common/sequel_interface_pg_spec.rb

@@ -92,10 +92,18 @@ describe "SequelInterface (Pg)" do
     d
   end
 
-  let(:db_url) { "postgres://pod4test:pod4test@centos7andy/pod4_test?search_path=public" }
+  #let(:db_url) { "postgres://pod4_test:#why#ring#@postgresql01/pod4_test?search_path=public" }
+
+  let(:db_hash) do
+    { host:     'postgresql01',
+      user:     'pod4_test',
+      password: '#why#ring#',
+      adapter:  :postgres,
+      database: 'pod4_test' }
+  end
 
   let(:db) do
-    db = Sequel.connect(db_url)
+    db = Sequel.connect(db_hash)
     db_setup(db)
     db
   end
@@ -119,7 +127,7 @@ describe "SequelInterface (Pg)" do
   describe "#new" do
      
     context "when passed a Sequel DB object" do
-      let(:ifce) { sequel_interface_class.new(Sequel.connect db_url) }
+      let(:ifce) { sequel_interface_class.new(Sequel.connect db_hash) }
 
       it "uses it to create a connection" do
         expect( ifce._connection ).to be_a Connection
@@ -133,7 +141,7 @@ describe "SequelInterface (Pg)" do
     end
 
     context "when passed a String" do
-      let(:ifce) { sequel_interface_class.new(db_url) }
+      let(:ifce) { sequel_interface_class.new(db_hash) }
 
       it "uses it to create a connection" do
         expect( ifce._connection ).to be_a Connection
@@ -160,7 +168,7 @@ describe "SequelInterface (Pg)" do
       # Normally we'd expect on _every_ use, but Sequel is different
       it "calls Connection#client on first use" do
         # When we pass a connection object we are expected to set the data layer option
-        conn.data_layer_options = Sequel.connect(db_url)
+        conn.data_layer_options = Sequel.connect(db_hash)
 
         expect( ifce._connection ).to receive(:client).with(ifce).and_call_original
 

data/spec/fixtures/database.rb

@@ -6,13 +6,13 @@ DB[:tds] =
     password:   'pod4test' }
 
 DB[:pg] = 
-  { host:     'centos7andy',
+  { host:     'postgresql01.jhallpr.com',
     dbname:   'pod4_test',
-    user:     'pod4test',
-    password: 'pod4test' }
+    user:     'pod4_test',
+    password: '#why#ring#' }
 
 DB[:sequel] = 
-  { host:     'centos7andy',
-    user:     'pod4test',
-    password: 'pod4test' }
+  { host:     'postgresql01',
+    user:     'pod4_test',
+    password: '#why#ring#' }
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pod4
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Andy Jones
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devnull
@@ -117,7 +116,6 @@ homepage: https://bitbucket.org/andy-twosticks/pod4
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -125,15 +123,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Totally not an ORM
 test_files: