pgtk 0.1.0

data/lib/pgtk.rb

@@ -0,0 +1,29 @@
+# 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 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.
+
+# Pgtk main module.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+module Pgtk
+  # Nothing here.
+end

data/lib/pgtk/liquibase_task.rb

@@ -0,0 +1,82 @@
+# 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 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.
+
+require 'English'
+require 'rake'
+require 'rake/tasklib'
+require 'shellwords'
+require 'yaml'
+require_relative '../pgtk'
+
+# Liquibase rake task.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+class Pgtk::LiquibaseTask < Rake::TaskLib
+  attr_accessor :name
+  attr_accessor :master
+  attr_accessor :yaml
+  attr_accessor :quiet
+
+  def initialize(*args, &task_block)
+    @name = args.shift || :liquibase
+    @quite = false
+    unless ::Rake.application.last_description
+      desc 'Deploy Liquibase changes to the running PostgreSQL server'
+    end
+    task(name, *args) do |_, task_args|
+      RakeFileUtils.send(:verbose, true) do
+        yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+        run
+      end
+    end
+  end
+
+  private
+
+  def run
+    raise "Option 'master' is mandatory" unless @master
+    raise "Option 'yaml' is mandatory" unless @yaml
+    yml = YAML.load_file(@yaml)
+    raise "YAML at #{yaml} is missing 'pgsql' section" unless yml['pgsql']
+    pom = File.expand_path(File.join(__dir__, '../resources/pom.xml'))
+    Dir.chdir(File.dirname(@master)) do
+      system(
+        [
+          'mvn verify',
+          '--errors',
+          @quiet ? '--quiet' : '',
+          '--file',
+          Shellwords.escape(pom),
+          '--define',
+          "liquibase.changeLogFile=#{@master}",
+          '--define',
+          "liquibase.url=#{Shellwords.escape(yml['pgsql']['url'])}",
+          '--define',
+          "liquibase.logging=#{@quiet ? 'severe' : 'info'}",
+          '2>&1'
+        ].join(' ')
+      )
+    end
+    raise unless $CHILD_STATUS.exitstatus.zero?
+  end
+end

data/lib/pgtk/pgsql_task.rb

@@ -0,0 +1,136 @@
+# 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 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.
+
+require 'cgi'
+require 'English'
+require 'rake'
+require 'rake/tasklib'
+require 'random-port'
+require 'shellwords'
+require 'tempfile'
+require 'yaml'
+require_relative '../pgtk'
+
+# Pgsql rake task.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+class Pgtk::PgsqlTask < Rake::TaskLib
+  attr_accessor :name
+  attr_accessor :dir
+  attr_accessor :fresh_start
+  attr_accessor :user
+  attr_accessor :password
+  attr_accessor :dbname
+  attr_accessor :yaml
+  attr_accessor :quiet
+
+  def initialize(*args, &task_block)
+    @name = args.shift || :pgsql
+    @fresh_start = false
+    @quite = false
+    @user = 'test'
+    @password = 'test'
+    @dbname = 'test'
+    unless ::Rake.application.last_description
+      desc 'Start a local PostgreSQL server'
+    end
+    task(name, *args) do |_, task_args|
+      RakeFileUtils.send(:verbose, true) do
+        yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+        run
+      end
+    end
+  end
+
+  private
+
+  def run
+    raise "Option 'dir' is mandatory" unless @dir
+    raise "Option 'yaml' is mandatory" unless @yaml
+    home = File.expand_path(@dir)
+    FileUtils.rm_rf(home) if @fresh_start
+    if File.exist?(home)
+      raise "Directory/file #{home} is present, use fresh_start=true"
+    end
+    out = "2>&1 #{@quiet ? '>/dev/null' : ''}"
+    Tempfile.open do |pwfile|
+      IO.write(pwfile.path, @password)
+      system(
+        [
+          'initdb --auth=trust',
+          "-D #{Shellwords.escape(home)}",
+          '--username',
+          Shellwords.escape(@user),
+          '--pwfile',
+          Shellwords.escape(pwfile.path),
+          out
+        ].join(' ')
+      )
+    end
+    raise unless $CHILD_STATUS.exitstatus.zero?
+    port = RandomPort::Pool.new.acquire
+    pid = Process.spawn('postgres', '-k', home, '-D', home, "--port=#{port}")
+    at_exit do
+      `kill -TERM #{pid}`
+      puts "PostgreSQL killed in PID #{pid}"
+    end
+    sleep 1
+    attempt = 0
+    begin
+      system(
+        [
+          "createdb -h localhost -p #{port}",
+          '--username',
+          Shellwords.escape(@user),
+          Shellwords.escape(@dbname),
+          out
+        ].join(' ')
+      )
+      raise unless $CHILD_STATUS.exitstatus.zero?
+    rescue StandardError => e
+      puts e.message
+      sleep(5)
+      attempt += 1
+      raise if attempt > 10
+      retry
+    end
+    IO.write(
+      @yaml,
+      {
+        'pgsql' => {
+          'host' => 'localhost',
+          'port' => port,
+          'dbname' => @dbname,
+          'user' => @user,
+          'password' => @password,
+          'url' => [
+            "jdbc:postgresql://localhost:#{port}/",
+            "#{CGI.escape(@dbname)}?user=#{CGI.escape(@user)}",
+            "&password=#{CGI.escape(@password)}"
+          ].join
+        }
+      }.to_yaml
+    )
+    puts "PostgreSQL is running in PID #{pid}"
+  end
+end

data/lib/pgtk/pool.rb

@@ -0,0 +1,85 @@
+# 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 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.
+
+require 'pg'
+require_relative '../pgtk'
+
+# Pool.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+class Pgtk::Pool
+  # Constructor.
+  def initialize(host: 'localhost', port:, dbname:, user:, password:)
+    @host = host
+    @port = port
+    @port = port
+    @dbname = dbname
+    @user = user
+    @password = password
+    @pool = Queue.new
+  end
+
+  # Start it with a fixed number of connections.
+  def start(max = 1)
+    max.times do
+      @pool << PG.connect(
+        dbname: @dbname, host: @host, port: @port,
+        user: @user, password: @password
+      )
+    end
+    self
+  end
+
+  # Make a query and return the result as an array of hashes.
+  def exec(query, args = [], result = 0)
+    connect do |c|
+      c.exec_params(query, args, result) do |res|
+        if block_given?
+          yield res
+        else
+          rows = []
+          res.each { |r| rows << r }
+          rows
+        end
+      end
+    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
+  def connect
+    conn = @pool.pop
+    begin
+      yield conn
+    ensure
+      @pool << conn
+    end
+  end
+end

data/lib/pgtk/version.rb

@@ -0,0 +1,32 @@
+# 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 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.
+
+require_relative '../pgtk'
+
+# Pgtk version.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2019 Yegor Bugayenko
+# License:: MIT
+module Pgtk
+  # Current version of the library.
+  VERSION = '0.1.0'
+end

data/lib/resources/pom.xml

@@ -0,0 +1,63 @@
+<?xml version="1.0"?>
+<!--
+(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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>pgtk</groupId>
+  <artifactId>pgtk</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>pom</packaging>
+  <dependencies>
+    <dependency>
+      <groupId>org.postgresql</groupId>
+      <artifactId>postgresql</artifactId>
+      <version>9.4.1212</version>
+      <scope>runtime</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.liquibase</groupId>
+        <artifactId>liquibase-maven-plugin</artifactId>
+        <version>3.2.2</version>
+        <configuration>
+          <driver>org.postgresql.Driver</driver>
+          <logging>info</logging>
+          <verbose>false</verbose>
+          <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
+        </configuration>
+        <executions>
+          <execution>
+            <id>update</id>
+            <goals>
+              <goal>update</goal>
+            </goals>
+            <phase>verify</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>

data/pgtk.gemspec

@@ -0,0 +1,58 @@
+# 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 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/pgtk/version'
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.2'
+  s.required_ruby_version = '>= 2.3'
+  s.name = 'pgtk'
+  s.version = Pgtk::VERSION
+  s.license = 'MIT'
+  s.summary = 'PostgreSQL ToolKit for Ruby apps'
+  s.description = '...'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/pgtk'
+  s.files = `git ls-files`.split($RS)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  s.add_runtime_dependency 'backtrace', '~> 0.3'
+  s.add_runtime_dependency 'pg', '1.1.3'
+  s.add_runtime_dependency 'random-port', '~> 0.3'
+  s.add_development_dependency 'codecov', '0.1.10'
+  s.add_development_dependency 'minitest', '5.5.0'
+  s.add_development_dependency 'rake', '12.0.0'
+  s.add_development_dependency 'rspec-rails', '3.1.0'
+  s.add_development_dependency 'rubocop', '0.61.0'
+  s.add_development_dependency 'rubocop-rspec', '1.31.0'
+  s.add_development_dependency 'xcop', '0.6'
+end