pod4 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e0f3ba3e1a6e876874296334e8df4a789c6757403a6f72697e7f2a5506ac05f
-  data.tar.gz: db35eb4f442ebe83b30de9ce394354143586142144af531171f35afffa8e504c
+  metadata.gz: 7f9748ac25c58c39c322e50a32b47d0fa805defb67fcbcea795752b46f00dff5
+  data.tar.gz: ef8a3e1abcb0409663a3fd16178a2017bc4319aadac065adc8581c0676ab2259
 SHA512:
-  metadata.gz: 4d033f6947e0e2fcf421f764746f647c68e1158b65568a215c57db2508773aecc700815bc4ad318bb844f5252e89c64fe16eca6a1b20c60fb15730835d411b90
-  data.tar.gz: 68908e5107c5f1160b42b4948514554c57e53dcc337e413fd5b6282e6edc22ecf4dd51680a4a11f59103c6fb2ee1f8cb1d138f01b0f9007c5be41f4e2b984b1f
+  metadata.gz: 5b86b655f9773b47a482a87a8d79a5c61e4d6284164b554cbd20f1827f6fabe5812bda22cd92f4e9676a8e23e479d79b7cff6757a46e11865f2f1a8a6f4cf749
+  data.tar.gz: bdc18c5e1616a9a6ea538eb6466473683bc7a97e7a22d06758498f8020fb506049065d25c6f1fb61c619a7cae91b2db7dd987ca87b94458deb22af079d6b8fd2

data/.bugs/bugs

@@ -1,3 +1,4 @@
 Fixnum is Deprecated                                         | owner:Andy Jones <andy.jones@jameshall.co.uk>, open:True, id:274eb8828bd4e7d879e4f7a99317c75eb2a2e2b0, time:1533817328.12
 BigDecimal.new is deprecated                                 | owner:Andy Jones <andy.jones@jameshall.co.uk>, open:False, id:3979ce1679bc4f8c4aef8436e344e10e3773480d, time:1533817342.0
+Remove id field from record in update if its autoincrement   | owner:Andy Jones <andy.jones@jameshall.co.uk>, open:True, id:a383d9f88db5b73e9391a824310133ed2e348eda, time:1570013165.41
 Connection Pool Parallelism tests crash rspec when run as part of the suite | owner:Andy Jones <andy.jones@jameshall.co.uk>, open:False, id:b5368c7ef19065fc597b5692314da71772660963, time:1554280671.5

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

@@ -6,14 +6,16 @@ gemspec
 group :development, :test do
 
   # for bundler, management, etc etc
-  gem "bundler", "~> 2"
-  gem "rake",    "~> 12" 
-  gem "rspec",   "~> 3.8"
+  gem "bundler", "~> 2.2"
+  gem "rake",    "~> 13.0" 
+  gem "rspec",   "~> 3.10"
   gem 'pry'
   gem "pry-doc"
+  gem "base64"
+  gem "logger"
 
   # For testing
-  gem "sequel",         "~> 5.20" 
+  gem "sequel",         "~> 5.4" 
   gem "nebulous_stomp", "~> 3"
 
   platforms :ruby do
@@ -26,7 +28,13 @@ group :development, :test do
     gem "jruby-lint"
     gem "jeremyevans-postgres-pr"
     gem 'jdbc-mssqlserver'
-    gem 'jdbc-postgres', '9.4.1200'
+
+    # Note that this gem is part of a larger project, for Activerecord, and their version history
+    # makes no sense at all.  See the RubyGems site to make sense of that.  Note: there are
+    # alternative gems. But this is by the jRuby team; so that's a powerful reason to tolerate BS.
+    # If you want to go back to the previous version we used you'll have to pin it here; Bundler
+    # can't figure out their version history, either.
+    gem 'jdbc-postgres', '42.2.14'
   end
 
 

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/sequel_interface.rb

@@ -234,7 +234,8 @@ module Pod4
     #
     # Use ? as a placeholder in the SQL
     # mode is either :insert :update or :delete
-    # Please quote values for yourself, we don't.
+    # Sequel appears to quote these if you don't but bear in mind that, apparently,  symbols get
+    # "quoted" as if they were columns while strings get 'quoted' as if they are, well, strings.
     #
     # "update and delete should return the number of rows affected, and insert should return the
     # autogenerated primary integer key for the row inserted (if any)"

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.0'
+  VERSION = '1.0.2'
 end

data/pod4.gemspec

@@ -5,6 +5,7 @@ require 'pod4/version'
 Gem::Specification.new do |spec|
   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|

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.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Andy Jones
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devnull
@@ -117,24 +116,21 @@ homepage: https://bitbucket.org/andy-twosticks/pod4
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 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: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Totally not an ORM
 test_files: