pgtk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df81fe94f842797b07e43250ce3c554de8ce3dcb3149529e596ceb946e5476f4
+  data.tar.gz: a995aff368837b7dcf118e06db328e47f7aa49a08db945264503ea72f2c0ef5c
+SHA512:
+  metadata.gz: de8a01282af8ca4cef9eb2d3c91ea3631ecb0f2960491472bc43f8ac89767478b845153ec256b91ef3e35dcaffba21fc64681561ee9aca0a6ed2aee683befb43
+  data.tar.gz: 0a0342d5bf4b22c46f16366975cf7e972ff4a508e07753cce2917989c0da79b80951a4b724cb879abda576f63b4f2ba288bfafe0f4da82ee18dd83b126d4a5c9

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitattributes

@@ -0,0 +1,7 @@
+# Check out all text files in UNIX format, with LF as end of line
+# Don't change this file. If you have any ideas about it, please
+# submit a separate issue about it and we'll discuss.
+
+* text=auto eol=lf
+*.rb ident
+*.xml ident

data/.gitignore

@@ -0,0 +1,7 @@
+coverage/
+Gemfile.lock
+.idea/
+*.gem
+.bundle/
+.DS_Store
+rdoc/

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude coverage/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Metrics/BlockLength:
+  Max: 50
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 50
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/MethodLength:
+  Max: 100
+Metrics/PerceivedComplexity:
+  Max: 10

data/.rultor.yml

@@ -0,0 +1,35 @@
+assets:
+  rubygems.yml: zerocracy/home#assets/rubygems.yml
+  s3cfg: zerocracy/home#assets/s3cfg
+install: |
+  export PATH=$PATH:/usr/lib/postgresql/10/bin
+  sudo apt-get -y update
+  sudo apt-get -y install libpq-dev
+  export GEM_HOME=~/.ruby
+  export GEM_PATH=$GEM_HOME:$GEM_PATH
+  sudo apt-get -y update
+  sudo gem install pdd
+release:
+  script: |-
+    bundle install
+    rake
+    rm -rf *.gem
+    sed -i "s/1\.0\.snapshot/${tag}/g" lib/pgtk/version.rb
+    git add lib/pgtk/version.rb
+    git commit -m "version set to ${tag}"
+    gem build pgtk.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+  commanders:
+  - yegor256
+architect:
+- yegor256
+merge:
+  script: |-
+    bundle install
+    rake
+    pdd
+deploy:
+  script: |-
+    echo "There is nothing to deploy"
+    exit -1

data/.simplecov

@@ -0,0 +1,38 @@
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+if Gem.win_platform? then
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+  end
+else
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter]
+  )
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+    minimum_coverage 60
+  end
+end

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: required
+rvm:
+  - 2.6.0
+cache: bundler
+branches:
+  only:
+    - master
+addons:
+  postgresql: "10"
+  apt:
+    packages:
+      - postgresql-10
+      - postgresql-client-10
+install:
+  - travis_retry bundle update
+services:
+  - postgresql
+script:
+  - bundle exec rake
+after_success:
+  - "bash <(curl -s https://codecov.io/bash)"
+

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+source 'https://rubygems.org'
+ruby '~>2.3'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2019 Yegor Bugayenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+<img src="https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg" height="64px"/>
+
+[![EO principles respected here](http://www.elegantobjects.org/badge.svg)](http://www.elegantobjects.org)
+[![Managed by Zerocracy](https://www.0crat.com/badge/C3RFVLU72.svg)](https://www.0crat.com/p/C3RFVLU72)
+[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/pgtk)](http://www.rultor.com/p/yegor256/pgtk)
+[![We recommend RubyMine](http://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
+
+[![Build Status](https://travis-ci.org/yegor256/pgtk.svg)](https://travis-ci.org/yegor256/pgtk)
+[![Build status](https://ci.appveyor.com/api/projects/status/tbeaa0d4dk38xdb5?svg=true)](https://ci.appveyor.com/project/yegor256/pgtk)
+[![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)
+
+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
+and query processor, to make SQL manipulation simpler.
+
+First of all, on top of
+[Ruby](https://www.ruby-lang.org/en/) and
+[Bundler](https://bundler.io/)
+you need to have
+[PostgreSQL](https://www.postgresql.org/),
+[Java 8+](https://java.com/en/download/), and
+[Maven 3.2+](https://maven.apache.org/) installed.
+In Ubuntu 16+ this should be enough:
+
+```bash
+$ sudo apt-get install -y postgresql-10 postgresql-client-10
+$ sudo apt-get install -y default-jre maven
+```
+
+Then, add this to your [`Gemfile`](https://bundler.io/gemfile.html):
+
+```ruby
+gem 'pgtk'
+```
+
+Then, add this to your [`Rakefile`](https://github.com/ruby/rake/blob/master/doc/rakefile.rdoc):
+
+```ruby
+require 'pgtk/pgsql_task'
+Pgtk::PgsqlTask.new :pgsql do |t|
+  t.dir = 'target/pgsql' # Temp directory with PostgreSQL files
+  t.fresh_start = true # To delete the directory on every start
+  t.user = 'test'
+  t.password = 'test'
+  t.dbname = 'test'
+  t.yaml = 'target/config.yml' # YAML file to be created with connection details
+end
+```
+
+And this too:
+
+```ruby
+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
+end
+```
+
+You should create that `liquibase/master.xml` file in your repository,
+and a number of other XML files with Liquibase changes. This
+[example](https://github.com/zold-io/wts.zold.io/tree/master/liquibase)
+will help you understand them.
+
+Now, you can do this:
+
+```bash
+$ bundle exec rake pgsql liquibase
+```
+
+A temporary PostgreSQL server will be started and the entire set of
+Liquibase SQL changes will be applied. You will be able to connect
+to it from your application, using the file `target/config.yml`.
+
+From inside your app you may find this class useful:
+
+```ruby
+require 'pgtk/pool'
+yaml = YAML.load_file('target/config.yml')
+pgsql = Pgtk::Pool.new(
+  port: yaml['pgsql']['port'],
+  dbname: yaml['pgsql']['dbname'],
+  user: yaml['pgsql']['user'],
+  password: yaml['pgsql']['password']
+)
+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:
+
+```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
+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`.
+
+## How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure your build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ bundle exec rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.
+

data/Rakefile

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'rake/clean'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test rubocop xcop copyright]
+
+require 'rake/testtask'
+desc 'Run all unit tests'
+Rake::TestTask.new(:test) do |test|
+  Rake::Cleaner.cleanup_files(['coverage'])
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'rdoc/task'
+desc 'Build RDoc documentation'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+require 'xcop/rake_task'
+desc 'Validate all XML/XSL/XSD/HTML files for formatting'
+Xcop::RakeTask.new :xcop do |task|
+  task.license = 'LICENSE.txt'
+  task.includes = ['**/*.xml', '**/*.xsl', '**/*.xsd', '**/*.html']
+  task.excludes = ['target/**/*', 'coverage/**/*']
+end
+
+task :copyright do
+  sh "grep -q -r '#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/appveyor.yml

@@ -0,0 +1,21 @@
+version: '{build}'
+skip_tags: true
+clone_depth: 10
+branches:
+  only:
+    - master
+  except:
+    - gh-pages
+os: Windows Server 2012
+install:
+  - cmd: SET PATH=C:\Ruby23-x64\bin;%PATH%
+  - cmd: ruby --version
+  - cmd: git --version
+build_script:
+  - bundle update
+  - bundle install
+test_script:
+  - rake
+cache:
+  - C:\Ruby200\bin -> pgtk.gemspec
+  - C:\Ruby200\lib\ruby\gems\2.0.0 -> pgtk.gemspec

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format pretty
+travis: --format progress
+html_report: --format progress --format html --out=features_report.html