simple-sql 0.5.14 → 0.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2cf9ed788b6ea018998b2a6e97d0a6144fe223f86234812387a86eaf65d2485
-  data.tar.gz: d722f3cfb44f0029ec51ccd2d54dbbe609fd6036b57431dc2c2481d8496ecf50
+  metadata.gz: 47d594c256de7bf4157b70be496694616ade42814fb0a1559a67fc893b61cbd2
+  data.tar.gz: e8c200c5a73ea3b64787ab597ea7eb6b8c4a4e9be06416c968eb86654aaf27d9
 SHA512:
-  metadata.gz: 2c94eaa1fe5651b0355ff6c614bd26a51a6f33d3b5c6f6ca5d832883d570e8e2434f63dc73a5f7e138f3d6eb9eef1ab3b43b5e137af282a55a21c38b8f7a8f09
-  data.tar.gz: 6e25c1fbc93fd05964d6bf3aae02df55047bf67f90ff19e0fed2ccbf327cbafa0871913591c58d4bc9169069c2299f89005ebc1f3192767d694f7a3fc81d54cd
+  metadata.gz: b4ea4c955d1957d9e774e7aa27f8bc5508014a6ef75090acbe6ba46319e4f443899ae46bad712a11b45aa19a5240d2f68dba8639fa8f8f811e6fd6e3cc796be1
+  data.tar.gz: 7f220c8ec126a72dec5369bd9600f361ee1ecd3e552f437b9d136d36067f6564978402184f488a5289c68a8997ce834490b31019480c9fe1fbe816a5a55c2909

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'byebug'
+gem 'rubocop', '~> 0.57.2'
+
 # Specify your gem's dependencies in {gemname}.gemspec
 gemspec

data/Rakefile

@@ -20,6 +20,5 @@ end
 
 task default: "test:prepare_db" do
   sh "rspec"
-  sh "USE_ACTIVE_RECORD=1 rspec"
   sh "rubocop -D"
 end

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/config/console-init.rb

@@ -1,3 +1 @@
-# rubocop:disable Naming/FileName
-
 # This file is loaded when running bin/console.

data/lib/simple-sql.rb

@@ -1,3 +1 @@
-# rubocop:disable Naming/FileName
-
 require "simple/sql"

data/lib/simple/sql.rb

@@ -44,6 +44,14 @@ module Simple
       Connection.create(database_url)
     end
 
+    def with_connection(database_url = :auto)
+      connection = connect(database_url)
+
+      yield(connection) if connection
+    ensure
+      connection&.disconnect!
+    end
+
     # deprecated
     def configuration
       Config.parse_url(Config.determine_url)

data/lib/simple/sql/config.rb

@@ -1,7 +1,6 @@
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/CyclomaticComplexity
 # rubocop:disable Metrics/PerceivedComplexity
-# rubocop:disable Layout/AlignHash
 
 # module to determine database configuration
 module Simple::SQL::Config

data/lib/simple/sql/connection.rb

@@ -1,8 +1,7 @@
 class Simple::SQL::Connection
 end
 
-require_relative "connection/raw_connection"
-require_relative "connection/active_record_connection"
+require "active_record"
 
 require_relative "connection/base"
 require_relative "connection/lock"
@@ -12,29 +11,85 @@ require_relative "connection/insert"
 require_relative "connection/duplicate"
 require_relative "connection/type_info"
 
-# A Connection object.
+# A Connection object. This wraps an ActiveRecord::Base connection.
 #
-# A Connection object is built around a raw connection (as created from the pg
-# ruby gem).
+# It Method.includes the ConnectionAdapter, which implements ask, all, + friends
 #
-#
-# It includes
-# the ConnectionAdapter, which implements ask, all, + friends, and also
-# includes a quiet simplistic Transaction implementation
 class Simple::SQL::Connection
   def self.create(database_url = :auto)
     case database_url
+    when nil    then DefaultConnection.new
+    when String then ExplicitConnection.new(database_url)
     when :auto
-      if defined?(::ActiveRecord)
-        ActiveRecordConnection.new
+      if ::ActiveRecord::Base.connected?
+        DefaultConnection.new
       else
-        RawConnection.new Simple::SQL::Config.determine_url
+        ExplicitConnection.new(::Simple::SQL::Config.determine_url)
       end
     else
-      RawConnection.new database_url
+      expect! database_url => [nil, :auto, String]
     end
   end
 
+  def initialize(active_record_class)
+    @active_record_class = active_record_class
+  end
+
+  def raw_connection
+    @active_record_class.connection.raw_connection
+  end
+
+  def transaction(&block)
+    @active_record_class.connection.transaction(&block)
+  end
+
   extend Forwardable
   delegate [:wait_for_notify] => :raw_connection
+
+  # -- specific connection classes --------------------------------------------
+
+  class DefaultConnection < self
+    def initialize
+      @active_record_class = ::ActiveRecord::Base
+    end
+
+    def disconnect!; end
+  end
+
+  class ExplicitConnection < self
+    def initialize(url)
+      super create_active_record_class(url)
+    end
+
+    def disconnect!
+      return unless @active_record_class
+
+      @active_record_class.remove_connection
+    end
+
+    private
+
+    # ActiveRecord needs a class name in order to connect.
+    module WritableClassName
+      attr_accessor :name
+    end
+
+    # create_active_record_class builds a ActiveRecord::Base class, whose
+    # ConnectionPool we are going to use for this connection.
+    def create_active_record_class(url)
+      Class.new(ActiveRecord::Base).tap do |klass|
+        klass.extend WritableClassName
+        klass.name = "Simple::SQL::Connection::ExplicitConnection::Adapter"
+        klass.establish_connection url
+
+        connection_pool = klass.connection_pool
+        connection_pool_stats = {
+          size: connection_pool.size,
+          automatic_reconnect: connection_pool.automatic_reconnect,
+          checkout_timeout: connection_pool.checkout_timeout
+        }
+        ::Simple::SQL.logger.info "#{url}: connected to connection pool w/#{connection_pool_stats.inspect}"
+      end
+    end
+  end
 end

data/lib/simple/sql/connection/insert.rb

@@ -1,6 +1,5 @@
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/LineLength
-# rubocop:disable Layout/AlignHash
 
 class Simple::SQL::Connection
   #

data/lib/simple/sql/connection/type_info.rb

@@ -1,5 +1,4 @@
 # rubocop:disable Style/SymbolLiteral
-# rubocop:disable Layout/AlignHash
 # rubocop:disable Style/HashSyntax
 
 # This module implements an adapter between the Simple::SQL interface

data/lib/simple/sql/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module SQL
-    VERSION = "0.5.14"
+    VERSION = "0.5.15"
   end
 end

data/simple-sql.gemspec

@@ -33,15 +33,15 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'digest-crc', '~> 0'
 
+  gem.add_dependency 'activerecord', '~> 4'
+
   # optional gems (required by some of the parts)
 
   # development gems
-  gem.add_development_dependency 'activerecord', '~> 4'
   gem.add_development_dependency 'pg', '0.20'
   gem.add_development_dependency 'rake', '~> 11'
   gem.add_development_dependency 'rspec', '~> 3.7'
   gem.add_development_dependency 'rubocop', '~> 0.61.1'
-  gem.add_development_dependency 'database_cleaner', '~> 1'
   gem.add_development_dependency 'simplecov', '~> 0'
 
   gem.add_development_dependency 'memory_profiler', '~> 0.9.12'

data/spec/simple/sql/connect_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe "Simple::SQL.connect" do
+  let!(:default_pg_backend_pid) { Simple::SQL.ask "SELECT pg_backend_pid()" }
+
+  def connection_count(db: nil)
+    db ||= ::Simple::SQL
+    db.ask("SELECT sum(numbackends) FROM pg_stat_database")
+  end
+  
+  context 'without an argument' do
+    let(:params) { [] }
+
+    it 'is reusing the existing ActiveRecord connection' do
+      Simple::SQL.with_connection(*params) do |db|
+        expect(default_pg_backend_pid).to eq(db.ask("SELECT pg_backend_pid()"))
+        expect(db).not_to be_a(Simple::SQL::Connection::ExplicitConnection)
+      end
+
+      expect(::Simple::SQL.ask("SELECT sum(numbackends) FROM pg_stat_database")).to eq(1)
+    end
+
+    it 'is not estabishing a new connection' do
+      initial_connection_count = connection_count
+
+      Simple::SQL.with_connection(*params) do |db|
+        db.ask("SELECT 1")
+        expect(connection_count).to eq(initial_connection_count)
+      end
+
+      expect(connection_count).to eq(initial_connection_count)
+    end
+  end
+
+  context 'with an :auto argument' do
+    let(:params) { [:auto] }
+
+    it 'is reusing the existing ActiveRecord connection' do
+      Simple::SQL.with_connection(*params) do |db|
+        expect(default_pg_backend_pid).to eq(db.ask("SELECT pg_backend_pid()"))
+        expect(db).not_to be_a(Simple::SQL::Connection::ExplicitConnection)
+      end
+    end
+
+    it 'is not estabishing a new connection' do
+      initial_connection_count = connection_count
+
+      Simple::SQL.with_connection(*params) do |db|
+        db.ask("SELECT 1")
+        expect(connection_count).to eq(initial_connection_count)
+      end
+
+      expect(connection_count).to eq(initial_connection_count)
+    end
+  end
+
+  context 'with an explicit URL' do
+    let(:params) { [Simple::SQL::Config.determine_url] }
+
+    it 'is reconnecting using the passed in URL' do
+      Simple::SQL.with_connection(*params) do |db|
+        expect(default_pg_backend_pid).not_to eq(db.ask("SELECT pg_backend_pid()"))
+        expect(db).to be_a(Simple::SQL::Connection::ExplicitConnection)
+      end
+    end
+
+    it 'is estabishing a new connection' do
+      initial_connection_count = connection_count
+
+      Simple::SQL.with_connection(*params) do |db|
+        db.ask("SELECT 1")
+        expect(connection_count).to be > initial_connection_count
+      end
+
+      expect(connection_count).to eq(initial_connection_count)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,18 +8,11 @@ ENV["RAILS_ENV"] = "test"
 
 require "byebug"
 require "rspec"
-require "awesome_print"
+
 Dir.glob("./spec/support/**/*.rb").sort.each { |path| load path }
 
 require "simple/sql"
 
-unless ENV["USE_ACTIVE_RECORD"]
-  database_url = Simple::SQL::Config.determine_url
-
-  Simple::SQL.connect! database_url
-  Simple::SQL.ask "DELETE FROM users"
-end
-
 SQL = Simple::SQL
 USER_COUNT = 2
 

data/spec/support/004_simplecov.rb

@@ -1,20 +1,11 @@
 require "simplecov"
 
-# make sure multiple runs result in multiple result set. SimpleCov will take
-# care of merging these results automatically.
-SimpleCov.command_name "test:#{ENV['USE_ACTIVE_RECORD']}"
-
-USE_ACTIVE_RECORD = ENV["USE_ACTIVE_RECORD"] == "1"
-
 SimpleCov.start do
   # return true to remove src from coverage 
   add_filter do |src|
     next true if src.filename =~ /\/spec\//
     next true if src.filename =~ /\/immutable\.rb/
 
-    next true if USE_ACTIVE_RECORD  && src.filename =~ /\/sql\/connection\/raw_connection\.rb/
-    next true if !USE_ACTIVE_RECORD && src.filename =~ /\/sql\/connection\/active_record_connection\.rb/
-
     false
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 0.5.15
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser
@@ -74,7 +74,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -137,20 +137,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.61.1
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -196,18 +182,17 @@ files:
 - bin/db_restore
 - bin/pg
 - bin/rake
+- bin/rubocop
 - config/console-init.rb
 - config/database.yml
 - lib/simple-sql.rb
 - lib/simple/sql.rb
 - lib/simple/sql/config.rb
 - lib/simple/sql/connection.rb
-- lib/simple/sql/connection/active_record_connection.rb
 - lib/simple/sql/connection/base.rb
 - lib/simple/sql/connection/duplicate.rb
 - lib/simple/sql/connection/insert.rb
 - lib/simple/sql/connection/lock.rb
-- lib/simple/sql/connection/raw_connection.rb
 - lib/simple/sql/connection/reflection.rb
 - lib/simple/sql/connection/scope.rb
 - lib/simple/sql/connection/scope/count.rb
@@ -241,6 +226,7 @@ files:
 - spec/simple/sql/ask_spec.rb
 - spec/simple/sql/associations_spec.rb
 - spec/simple/sql/config_spec.rb
+- spec/simple/sql/connect_spec.rb
 - spec/simple/sql/conversion_spec.rb
 - spec/simple/sql/count_by_groups_spec.rb
 - spec/simple/sql/count_spec.rb
@@ -257,7 +243,6 @@ files:
 - spec/simple/sql_locked_spec.rb
 - spec/spec_helper.rb
 - spec/support/001_database.rb
-- spec/support/002_database_cleaner.rb
 - spec/support/003_factories.rb
 - spec/support/004_simplecov.rb
 - spec/support/model/user.rb
@@ -282,8 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: SQL with a simple interface
@@ -294,6 +278,7 @@ test_files:
 - spec/simple/sql/ask_spec.rb
 - spec/simple/sql/associations_spec.rb
 - spec/simple/sql/config_spec.rb
+- spec/simple/sql/connect_spec.rb
 - spec/simple/sql/conversion_spec.rb
 - spec/simple/sql/count_by_groups_spec.rb
 - spec/simple/sql/count_spec.rb
@@ -310,7 +295,6 @@ test_files:
 - spec/simple/sql_locked_spec.rb
 - spec/spec_helper.rb
 - spec/support/001_database.rb
-- spec/support/002_database_cleaner.rb
 - spec/support/003_factories.rb
 - spec/support/004_simplecov.rb
 - spec/support/model/user.rb

data/lib/simple/sql/connection/active_record_connection.rb

@@ -1,13 +0,0 @@
-class Simple::SQL::Connection::ActiveRecordConnection < Simple::SQL::Connection
-  def initialize
-    ::ActiveRecord::Base.connection
-  end
-
-  def raw_connection
-    ::ActiveRecord::Base.connection.raw_connection
-  end
-
-  def transaction(&block)
-    ::ActiveRecord::Base.connection.transaction(&block)
-  end
-end

data/lib/simple/sql/connection/raw_connection.rb

@@ -1,61 +0,0 @@
-require "pg"
-
-class Simple::SQL::Connection::RawConnection < Simple::SQL::Connection
-  SELF = self
-
-  attr_reader :raw_connection
-
-  def initialize(database_url)
-    @database_url = database_url
-    @raw_connection = PG::Connection.new(@database_url)
-    ObjectSpace.define_finalizer(self, SELF.finalizer(@raw_connection))
-  end
-
-  def self.finalizer(raw_connection)
-    proc do
-      raw_connection.finish unless raw_connection.finished?
-    end
-  end
-
-  def disconnect!
-    return unless @raw_connection
-
-    @raw_connection.finish unless @raw_connection.finished?
-    @raw_connection = nil
-  end
-
-  def transaction(&_block)
-    @tx_nesting_level ||= 0
-
-    # Notes: by using "ensure" (as opposed to rescue) we are rolling back
-    # both when an exception was raised and when a value was thrown. This
-    # also means we have to track whether or not to rollback. i.e. do roll
-    # back when we yielded to &block but not otherwise.
-    #
-    # Also the transaction support is a bit limited: you cannot rollback.
-    # Rolling back from inside a nested transaction would require SAVEPOINT
-    # support; without the code is simpler at least :)
-
-    if @tx_nesting_level == 0
-      exec "BEGIN"
-      tx_started = true
-    end
-
-    @tx_nesting_level += 1
-
-    return_value = yield
-
-    # Only commit if we started a transaction here.
-    if tx_started
-      exec "COMMIT"
-      tx_committed = true
-    end
-
-    return_value
-  ensure
-    @tx_nesting_level -= 1
-    if tx_started && !tx_committed
-      exec "ROLLBACK"
-    end
-  end
-end

data/spec/support/002_database_cleaner.rb

@@ -1,14 +0,0 @@
-require "database_cleaner"
-
-RSpec.configure do |config|
-  config.before(:suite) do
-    DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
-  end
-
-  config.around(:each) do |example|
-    DatabaseCleaner.cleaning do
-      example.run
-    end
-  end
-end