pgtk 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '086e1f1a4816734b011bc9098f6f893f316e3c9390b07d3d1276bb9f6ecb8ddd'
-  data.tar.gz: 5368c2f9d9340123d49d564cc73c3843a3113329d1aabc52471e023db9cfed4b
+  metadata.gz: 43d3924569fc077b07d4db33232357d4d761af2cb81ccdad35d80ef7aae042b7
+  data.tar.gz: 02473caa0bc03c9138afda1213cc128819d72f4e464f9589a17e0f1a940f4dd2
 SHA512:
-  metadata.gz: a1e4bb81b2048ef7e91add95a53a3a0d3901905fc9da7e817ec9284bf9857f0af313f9fdeff09b27936edab995c75a218381b81307ce422ef0ee96c457491d15
-  data.tar.gz: c30da95c961a30e558f48500a3dafd7434c462b9288b09ffa006713ccbb340bdc118a64996381d07f30f741b89280396043e763ec8d6fba3a4f9eacfc39550df
+  metadata.gz: 1a1796c83e25523b9113591ce9edfc4bd2078c23b3338a417cb2519be34a420545dd8b5fffb3d6fc2f6a351b89d3ca566b758efecb3d51513a3a25836ccbb287
+  data.tar.gz: 13f8ef96a5e44c8230fc7cffc7c3e785a8fdc028d7e897c31e0834217ae3f2b037a9feae704ab466f585f83dd8acb28233c5cd44a72dcce10925a2370d804a3e

data/README.md

@@ -46,7 +46,7 @@ Pgtk::PgsqlTask.new :pgsql do |t|
   t.user = 'test'
   t.password = 'test'
   t.dbname = 'test'
-  t.yaml = 'target/config.yml' # YAML file to be created with connection details
+  t.yaml = 'target/pgsql-config.yml' # YAML file to be created with connection details
 end
 ```
 
@@ -56,7 +56,7 @@ And this too:
 require 'pgtk/liquibase_task'
 Pgtk::LiquibaseTask.new liquibase: :pgsql do |t|
   t.master = 'liquibase/master.xml' # Master XML file path
-  t.yaml = 'target/config.yml' # YAML file with connection details
+  t.yaml = ['target/pgsql-config.yml', 'config.yml'] # YAML files with connection details
 end
 ```
 
@@ -79,7 +79,7 @@ From inside your app you may find this class useful:
 
 ```ruby
 require 'pgtk/pool'
-yaml = YAML.load_file('target/config.yml')
+yaml = YAML.load_file('config.yml')
 pgsql = Pgtk::Pool.new(
   port: yaml['pgsql']['port'],
   dbname: yaml['pgsql']['dbname'],
@@ -102,6 +102,30 @@ pgsql.connect do |c|
 end
 ```
 
+To make your PostgreSQL database visible in your unit test, I would
+recommend you create a method `test_pgsql` in your `test__helper.rb` file
+(which is `required` in all unit tests) and implement it like this:
+
+```ruby
+require 'yaml'
+require 'minitest/autorun'
+require 'pgtk/pool'
+module Minitest
+  class Test
+    def test_pgsql
+      config = YAML.load_file('target/pgsql-config.yml')
+      @test_pgsql ||= Pgtk::Pool.new(
+        host: config['pgsql']['host'],
+        port: config['pgsql']['port'],
+        dbname: config['pgsql']['dbname'],
+        user: config['pgsql']['user'],
+        password: config['pgsql']['password']
+      ).start
+    end
+  end
+end
+```
+
 Should work. Well, it works in [zold-io/wts.zold.io](https://github.com/zold-io/wts.zold.io)
 and [yegor256/mailanes](https://github.com/yegor256/mailanes). They both are
 open source, you can see how they use `pgtk`.

data/appveyor.yml

@@ -2,7 +2,7 @@ version: '{build}'
 skip_tags: true
 clone_depth: 10
 services:
-  - postgresql101
+  - postgresql
 branches:
   only:
     - master
@@ -15,13 +15,13 @@ install:
   - cmd: git --version
   - cmd: java -version
   - cmd: mvn --version
-  - cmd: PATH=C:\Program Files\PostgreSQL\10\bin\;%PATH%
+  - cmd: PATH=C:\Program Files\PostgreSQL\9.6\bin\;%PATH%
   - cmd: psql --version
 build_script:
   - bundle update
   - bundle install
 test_script:
-  - rake
+  - bundle exec rake
 cache:
   - C:\Ruby200\bin -> pgtk.gemspec
   - C:\Ruby200\lib\ruby\gems\2.0.0 -> pgtk.gemspec

data/lib/pgtk/liquibase_task.rb

@@ -56,7 +56,13 @@ class Pgtk::LiquibaseTask < Rake::TaskLib
   def run
     raise "Option 'master' is mandatory" unless @master
     raise "Option 'yaml' is mandatory" unless @yaml
-    yml = YAML.load_file(@yaml)
+    yml = YAML.load_file(
+      if @yaml.is_a?(Array)
+        @yaml.drop_while { |f| !File.exist?(f) }.first
+      else
+        @yaml
+      end
+    )
     raise "YAML at #{yaml} is missing 'pgsql' section" unless yml['pgsql']
     pom = File.expand_path(File.join(__dir__, '../../resources/pom.xml'))
     raise "Liquibase master is absent at #{@master}" unless File.exist?(@master)

data/lib/pgtk/pool.rb

@@ -39,8 +39,13 @@ class Pgtk::Pool
     @pool = Queue.new
   end
 
-  # Start it with a fixed number of connections.
-  def start(max = 1)
+  # Start it with a fixed number of connections. The amount of connections
+  # is specified in +max+ argument and should be big enough to handle
+  # the amount of parallel connections you may have to the database. However,
+  # keep in mind that not all servers will allow you to have many connections
+  # open at the same time. For example, Heroku free PostgreSQL database
+  # allows only one connection open.
+  def start(max = 8)
     max.times do
       @pool << PG.connect(
         dbname: @dbname, host: @host, port: @port,
@@ -50,7 +55,40 @@ class Pgtk::Pool
     self
   end
 
-  # Make a query and return the result as an array of hashes.
+  # Make a query and return the result as an array of hashes. For example,
+  # in order to fetch the list of all books belonging to the user:
+  #
+  #  books = pool.exec('SELECT * FROM book WHERE owner = $1', ['yegor256'])
+  #  books.each do |row|
+  #    puts 'ID: ' + row['id'].to_i
+  #    puts 'Created: ' + Time.parse(row['created'])
+  #    puts 'Title: ' + row['title']
+  #  end
+  #
+  # All values in the retrieved hash are strings. No matter what types of
+  # of data you have in the database, you get strings here. It's your job
+  # to convert them to the type you need.
+  #
+  # In order to insert a new row (pay attention to the +RETURNING+ clause
+  # at the end of the SQL query):
+  #
+  #  id = pool.exec(
+  #    'INSERT INTO book (owner, title) VALUES ($1, $2) RETURNING id',
+  #    ['yegor256', 'Elegant Objects']
+  #  )[0]['id'].to_i
+  #
+  # You can also pass a block to this method, if you want to get an instance
+  # of +PG::Result+ instead of an array of hashes:
+  #
+  #  pool.exec('SELECT * FROM book WHERE owner = $1', ['yegor256']) do |res|
+  #    res.each do |row|
+  #      puts 'ID: ' + row['id'].to_i
+  #      puts 'Title: ' + row['title']
+  #    end
+  #  end
+  #
+  # More details about +exec_params+, which is called here, you can find
+  # 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|

data/lib/pgtk/version.rb

@@ -28,5 +28,5 @@ require_relative '../pgtk'
 # License:: MIT
 module Pgtk
   # Current version of the library.
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 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.join(dir, 'cfg.yml')
+        t.yaml = ['file-is-absent', File.join(dir, 'cfg.yml')]
         t.quiet = true
       end
       Rake::Task['liquibase2'].invoke

metadata

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