pgtk 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43d3924569fc077b07d4db33232357d4d761af2cb81ccdad35d80ef7aae042b7
-  data.tar.gz: 02473caa0bc03c9138afda1213cc128819d72f4e464f9589a17e0f1a940f4dd2
+  metadata.gz: 0a9ed47e9a89eea192bf6ee2734fc45549044a73ec9bc4add20ac30c2e692014
+  data.tar.gz: b13bb7742969615d67aa8b3d340042c8fdc2dc5a8360c5c092a6f775c4887edc
 SHA512:
-  metadata.gz: 1a1796c83e25523b9113591ce9edfc4bd2078c23b3338a417cb2519be34a420545dd8b5fffb3d6fc2f6a351b89d3ca566b758efecb3d51513a3a25836ccbb287
-  data.tar.gz: 13f8ef96a5e44c8230fc7cffc7c3e785a8fdc028d7e897c31e0834217ae3f2b037a9feae704ab466f585f83dd8acb28233c5cd44a72dcce10925a2370d804a3e
+  metadata.gz: 1ce328f09d0ae039cc6819a162bd5a14af315cf1ddb05eccb416d3deca13d9d59f64cefe28ac32b204912ec6768cbd2f78d2bb0f66cb9c70ab247757ddfa9895
+  data.tar.gz: c4a7a8f75b4eb86ce149538374cc43120601243894bc3e6ce35417e34bcb46010cd632b54e9ee81a3a44e8948386ffa988079078f6a103453080c7910f0b23cd

data/.rultor.yml

@@ -27,8 +27,8 @@ architect:
 merge:
   script: |-
     bundle install
-    rake
-    pdd
+    bundle exec rake
+    pdd -f /dev/null
 deploy:
   script: |-
     echo "There is nothing to deploy"

data/README.md

@@ -10,7 +10,9 @@
 [![PDD status](http://www.0pdd.com/svg?name=yegor256/pgtk)](http://www.0pdd.com/p?name=yegor256/pgtk)
 [![Gem Version](https://badge.fury.io/rb/pgtk.svg)](http://badge.fury.io/rb/pgtk)
 [![Maintainability](https://api.codeclimate.com/v1/badges/3a5bebac001e5288b00d/maintainability)](https://codeclimate.com/github/yegor256/pgtk/maintainability)
+
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/pgtk.svg)](https://codecov.io/github/yegor256/pgtk?branch=master)
+[![Hits-of-Code](https://hitsofcode.com/github/yegor256/pgtk)](https://hitsofcode.com/view/github/yegor256/pgtk)
 
 This small Ruby gem helps you integrate PostgreSQL with your Ruby
 web app, through [Liquibase](https://www.liquibase.org/). It also adds a simple connection pool
@@ -90,15 +92,12 @@ pgsql.start(5) # Start it with five simultaneous connections
 name = pgsql.exec('SELECT name FROM user WHERE id = $1', [id])[0]['name']
 ```
 
-You may also use it if you need direct access to the connection,
-for example in order to run a set of requests in a transaction:
+You may also use it if you need to run a transaction:
 
 ```ruby
-pgsql.connect do |c|
-  c.transaction do |conn|
-    conn.exec_params('DELETE FROM user WHERE id = $1', [id])
-    conn.exec_params('INSERT INTO user (name, phone) VALUES ($1, $2)', [name, phone])
-  end
+pgsql.transaction do |t|
+  t.exec('DELETE FROM user WHERE id = $1', [id])
+  t.exec('INSERT INTO user (name, phone) VALUES ($1, $2)', [name, phone])
 end
 ```
 
@@ -114,7 +113,7 @@ module Minitest
   class Test
     def test_pgsql
       config = YAML.load_file('target/pgsql-config.yml')
-      @test_pgsql ||= Pgtk::Pool.new(
+      @@test_pgsql ||= Pgtk::Pool.new(
         host: config['pgsql']['host'],
         port: config['pgsql']['port'],
         dbname: config['pgsql']['dbname'],

data/lib/pgtk/pool.rb

@@ -32,7 +32,6 @@ class Pgtk::Pool
   def initialize(host: 'localhost', port:, dbname:, user:, password:)
     @host = host
     @port = port
-    @port = port
     @dbname = dbname
     @user = user
     @password = password
@@ -91,7 +90,40 @@ class Pgtk::Pool
   # here: https://www.rubydoc.info/gems/pg/0.17.1/PG%2FConnection:exec_params
   def exec(query, args = [], result = 0)
     connect do |c|
-      c.exec_params(query, args, result) do |res|
+      t = Txn.new(c)
+      if block_given?
+        t.exec(query, args, result) do |res|
+          yield res
+        end
+      else
+        t.exec(query, args, result)
+      end
+    end
+  end
+
+  # Run a transaction. The block has to be provided. It will receive
+  # a temporary object, which implements method +exec+, which works
+  # exactly like the method +exec+ of class +Pool+, for example:
+  #
+  #  pgsql.transaction do |t|
+  #    t.exec('DELETE FROM user WHERE id = $1', [id])
+  #    t.exec('INSERT INTO user (name) VALUES ($1)', [name])
+  #  end
+  def transaction
+    connect do |c|
+      t = Txn.new(c)
+      yield t
+    end
+  end
+
+  # A temporary class to execute a single SQL request.
+  class Txn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    def exec(query, args = [], result = 0)
+      @conn.exec_params(query, args, result) do |res|
         if block_given?
           yield res
         else
@@ -103,15 +135,8 @@ class Pgtk::Pool
     end
   end
 
-  # Get a connection from the pool and let us work with it. The block
-  # has to be provided, for example:
-  #
-  #  pgsql.connect do |c|
-  #    c.transaction do |conn|
-  #      conn.exec_params('DELETE FROM user WHERE id = $1', [id])
-  #      conn.exec_params('INSERT INTO user (name) VALUES ($1)', [name])
-  #    end
-  #  end
+  private
+
   def connect
     conn = @pool.pop
     begin

data/lib/pgtk/version.rb

@@ -28,5 +28,5 @@ require_relative '../pgtk'
 # License:: MIT
 module Pgtk
   # Current version of the library.
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/test/test_liquibase_task.rb

@@ -45,7 +45,7 @@ class TestLiquibaseTask < Minitest::Test
       Rake::Task['pgsql2'].invoke
       Pgtk::LiquibaseTask.new(:liquibase2) do |t|
         t.master = File.join(__dir__, '../test-resources/master.xml')
-        t.yaml = ['file-is-absent', File.join(dir, 'cfg.yml')]
+        t.yaml = ['file-is-absent', File.join(dir, 'cfg.yml'), 'another']
         t.quiet = true
       end
       Rake::Task['liquibase2'].invoke

data/test/test_pool.rb

@@ -34,8 +34,34 @@ require_relative '../lib/pgtk/pool'
 # License:: MIT
 class TestPool < Minitest::Test
   def test_basic
+    bootstrap do |pool|
+      id = pool.exec(
+        'INSERT INTO book (title) VALUES ($1) RETURNING id',
+        ['Elegant Objects']
+      )[0]['id'].to_i
+      assert(id.positive?)
+    end
+  end
+
+  def test_transaction
+    bootstrap do |pool|
+      id = pool.transaction do |t|
+        t.exec('DELETE FROM book')
+        t.exec(
+          'INSERT INTO book (title) VALUES ($1) RETURNING id',
+          ['Object Thinking']
+        )[0]['id'].to_i
+      end
+      assert(id.positive?)
+    end
+  end
+
+  private
+
+  def bootstrap
     Dir.mktmpdir 'test' do |dir|
-      Pgtk::PgsqlTask.new(:pgsql1) do |t|
+      id = rand(100..999)
+      Pgtk::PgsqlTask.new("pgsql#{id}") do |t|
         t.dir = File.join(dir, 'pgsql')
         t.user = 'hello'
         t.password = 'A B C привет ! & | !'
@@ -43,13 +69,13 @@ class TestPool < Minitest::Test
         t.yaml = File.join(dir, 'cfg.yml')
         t.quiet = true
       end
-      Rake::Task['pgsql1'].invoke
-      Pgtk::LiquibaseTask.new(:liquibase1) do |t|
+      Rake::Task["pgsql#{id}"].invoke
+      Pgtk::LiquibaseTask.new("liquibase#{id}") do |t|
         t.master = File.join(__dir__, '../test-resources/master.xml')
         t.yaml = File.join(dir, 'cfg.yml')
         t.quiet = true
       end
-      Rake::Task['liquibase1'].invoke
+      Rake::Task["liquibase#{id}"].invoke
       yaml = YAML.load_file(File.join(dir, 'cfg.yml'))
       pool = Pgtk::Pool.new(
         port: yaml['pgsql']['port'],
@@ -58,11 +84,7 @@ class TestPool < Minitest::Test
         password: yaml['pgsql']['password']
       )
       pool.start(1)
-      id = pool.exec(
-        'INSERT INTO book (title) VALUES ($1) RETURNING id',
-        ['Elegant Objects']
-      )[0]['id'].to_i
-      assert(id.positive?)
+      yield pool
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgtk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace