pg-connection-general_log 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 867e6e436c5d596d967ce3752bb0d6628ce265ee
+  data.tar.gz: '092e57f1a54da5a7d549e46731e3a25950f7cbb6'
+SHA512:
+  metadata.gz: bd28c680fc41cd5373a542b6f53824026c0faf0f6363c520e6b349a5bae2500dfa0737d51912d7b80886bc84fab5faf43675e1a53e9d4dfeada2ef50d4e4b111
+  data.tar.gz: daa5b3ccefa426f44ab11f42d7a2943aa1de20d50514a0151e4691525dd1a98550cc4e8dae2196955765a22d2c4f6ea8c6124f06856540a3dcafb45a3ebd4fb7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg-connection-general_log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 abcang
+
+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,83 @@
+PG:Connection::GeneralLog
+===
+
+[![Build Status](https://travis-ci.org/abcang/pg-connection-general_log.svg?branch=v0.0.1)](https://travis-ci.org/abcang/pg-connection-general_log)
+
+A monkey patch for pg.
+Stock all general logs.
+
+Inspired by [mysql2-client-general_log](https://github.com/ksss/mysql2-client-general_log)
+
+```ruby
+#! /usr/bin/env ruby
+
+require "pg/connection/general_log"
+
+client = PG::Connection.new(config)
+client.query("SELECT * FROM users LIMIT 1")
+
+p client.general_log #=>
+# [
+#   #<struct PG::Connection::GeneralLog::Log
+#     sql="SELECT * FROM users LIMIT 1",
+#     args=[],
+#     backtrace=["script.rb:6:in `<main>'"],
+#     time=0.0909838349907659>
+# ]
+```
+
+## Examples
+
+### sinatra
+
+test.rb:
+```ruby
+require 'sinatra'
+require 'pg'
+require "pg/connection/general_log"
+
+helpers do
+  def db
+    Thread.current[:db] ||= PG::Connection.new(config)
+  end
+end
+
+get '/' do
+  db.exec("SELECT * FROM users WHERE name = 'hoge'")
+  db.exec_params('SELECT * FROM users WHERE name = $1', ['hoge'])
+
+  db.prepare('select', 'SELECT * FROM users WHERE name = $1')
+  db.exec_prepared('select', ['bar'])
+  db.exec_prepared('select', ['foo'])
+end
+
+after do
+  db.general_log.writefile(path: '/tmp/sql.log', req: request, backtrace: true)
+end
+```
+
+/tmp/sql.log:
+```
+REQUEST GET	/	4
+SQL	(0000.89ms)	SELECT * FROM users WHERE name = 'hoge'	[]	/path/to/test.rb:12:in `block in <main>'
+SQL	(0000.78ms)	SELECT * FROM users WHERE name = $1	["hoge"]	/path/to/test.rb:13:in `block in <main>'
+SQL	(0000.66ms)	SELECT * FROM users WHERE name = $1	["barr"]	/path/to/test.rb:16:in `block in <main>'
+SQL	(0000.65ms)	SELECT * FROM users WHERE name = $1	["foo"]	/path/to/test.rb:17:in `block in <main>'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg-connection-general_log'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+task :test do
+  sh "rgot -v #{Dir.glob('lib/**/*_test.rb').join(' ')}"
+end
+
+task default: [:test]

data/example/test.rb

@@ -0,0 +1,48 @@
+require 'sinatra'
+require 'pg'
+require 'pg/connection/general_log'
+
+helpers do
+  def db
+    Thread.current[:db] ||= PG.connect(
+      host: '127.0.0.1',
+      user: 'postgres',
+      dbname: 'pg_connection_general_log_test'
+    )
+  end
+
+  def init
+    db.exec('DROP TABLE IF EXISTS users')
+    db.exec(<<-SQL)
+    CREATE TABLE users (
+      id SERIAL NOT NULL PRIMARY KEY,
+      name varchar(255) NOT NULL UNIQUE,
+      password varchar(255) NOT NULL
+    );
+    SQL
+    db.exec(<<-SQL)
+    INSERT INTO users (name, password)
+    VALUES ('hoge', 'cheap-pass'),
+    ('foo', 'fooo'),
+    ('bar', 'barr')
+    ;
+    SQL
+  end
+end
+
+get '/' do
+  db.exec("SELECT * FROM users WHERE name = 'hoge'")
+  db.exec_params('SELECT * FROM users WHERE name = $1', ['hoge'])
+
+  db.prepare('select', 'SELECT * FROM users WHERE name = $1')
+  db.exec_prepared('select', ['bar'])
+  db.exec_prepared('select', ['foo'])
+end
+
+get '/init' do
+  init
+end
+
+after do
+  db.general_log.writefile(req: request, backtrace: true)
+end

data/lib/pg/connection/general_log.rb

@@ -0,0 +1,89 @@
+require 'pg'
+require 'benchmark'
+
+module PG
+  class Connection
+    module GeneralLog
+      require 'pg/connection/general_log/version'
+
+      class Log < Struct.new(:sql, :args, :backtrace, :time)
+        def format(use_bt = false)
+          ret = [
+            'SQL',
+            '(%07.2fms)' % (time * 1000),
+            sql.gsub(/[\r\n]/, ' ').gsub(/ +/, ' ').strip,
+            args.to_s
+          ]
+          ret << backtrace[0] if use_bt
+
+          ret.join("\t")
+        end
+      end
+
+      class Logger < Array
+        def writefile(path: '/tmp/sql.log', req: nil, backtrace: false)
+          File.open(path, 'a') do |file|
+            if req
+              file.puts "REQUEST\t#{req.request_method}\t#{req.path}\t#{self.length}"
+            end
+
+            file.puts self.map { |log| log.format(backtrace) }.join("\n")
+            file.puts ''
+          end
+          self.clear
+        end
+
+        def push(sql, args, backtrace, time)
+          super(Log.new(sql, args, backtrace, time))
+        end
+      end
+
+      attr_accessor :general_log
+
+      def initialize(opts = {})
+        @general_log = Logger.new
+        @stmt_map = {}
+        super
+      end
+
+      def exec(sql)
+        ret = nil
+        time = Benchmark.realtime do
+          ret = super
+        end
+        @general_log.push(sql, [], caller_locations, time)
+        ret
+      end
+
+      def exec_params(*args)
+        sql, params = args
+        ret = nil
+        time = Benchmark.realtime do
+          ret = super
+        end
+        @general_log.push(sql, params, caller_locations, time)
+        ret
+      end
+
+      def prepare(*args)
+        stmt_name, sql = args
+        @stmt_map[stmt_name] = sql
+        super
+      end
+
+      def exec_prepared(*args)
+        stmt_name, params = args
+        sql = @stmt_map[stmt_name]
+
+        ret = nil
+        time = Benchmark.realtime do
+          ret = super
+        end
+        @general_log.push(sql, params, caller_locations, time)
+        ret
+      end
+    end
+
+    prepend GeneralLog
+  end
+end

data/lib/pg/connection/general_log/version.rb

@@ -0,0 +1,5 @@
+module PG
+  module GeneralLog
+    VERSION = "0.0.1"
+  end
+end

data/lib/pg/connection/general_log_test.rb

@@ -0,0 +1,144 @@
+require 'pg/connection/general_log'
+
+module PGConnectionGeneralLogTest
+  def test_main(m)
+    client = PG.connect(
+      host: '127.0.0.1',
+      user: 'postgres'
+    )
+    client.exec('DROP DATABASE IF EXISTS pg_connection_general_log_test')
+    client.exec('CREATE DATABASE pg_connection_general_log_test')
+
+    @client = PG.connect(
+      host: '127.0.0.1',
+      user: 'postgres',
+      dbname: 'pg_connection_general_log_test'
+    )
+    exit m.run
+
+    client.exec('DROP DATABASE IF EXISTS pg_connection_general_log_test')
+  end
+
+  def db_init
+    @client.exec('DROP TABLE IF EXISTS users')
+    @client.exec(<<~SQL)
+      CREATE TABLE users (
+        id SERIAL NOT NULL PRIMARY KEY,
+        name varchar(255) NOT NULL UNIQUE,
+        password varchar(255) NOT NULL
+      );
+    SQL
+    @client.exec(<<~SQL)
+      INSERT INTO users (name, password)
+             VALUES ('hoge', 'cheap-pass'),
+                    ('foo', 'fooo'),
+                    ('bar', 'barr')
+      ;
+    SQL
+    @client.general_log.clear
+  end
+
+  def test_init(t)
+    unless @client.general_log.is_a?(Array)
+      t.error("initial value expect Array class got #{@client.general_log.class}")
+    end
+    unless @client.general_log.empty?
+      t.error("initial value expect [] got #{@client.general_log}")
+    end
+  end
+
+  def test_values(t)
+    db_init
+    ret = @client.exec("SELECT * FROM users WHERE name = '#{'hoge'}'").first
+    @client.exec("SELECT * FROM users WHERE name = '#{'bar'}'")
+    @client.exec("SELECT * FROM users WHERE name = '#{'foo'}'")
+
+    if @client.general_log.length != 3
+      t.error("expect log length 3 got #{@client.general_log.length}")
+    end
+    if @client.general_log.any?{|log| !log.is_a?(PG::Connection::GeneralLog::Log)}
+      t.error("expect all collection item is instance of PG::Connection::GeneralLog::Log got #{@client.general_log.map(&:class).uniq}")
+    end
+    expect = { 'id' => '1', 'name' => 'hoge', 'password' => 'cheap-pass' }
+    if ret != expect
+      t.error("expect exec output not change from #{expect} got #{ret}")
+    end
+    unless @client.general_log.first.format =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = 'hoge'\t\[\]$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format}`")
+    end
+    unless @client.general_log.first.format(true) =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = 'hoge'\t\[\].+in `test_values'$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format(true)}`")
+    end
+  end
+
+  def test_params_values(t)
+    db_init
+    ret = @client.exec_params('SELECT * FROM users WHERE name = $1', ['hoge']).first
+    @client.exec_params('SELECT * FROM users WHERE name = $1', ['bar'])
+    @client.exec_params('SELECT * FROM users WHERE name = $1', ['foo'])
+
+    if @client.general_log.length != 3
+      t.error("expect log length 3 got #{@client.general_log.length}")
+    end
+    if @client.general_log.any?{|log| !log.is_a?(PG::Connection::GeneralLog::Log)}
+      t.error("expect all collection item is instance of PG::Connection::GeneralLog::Log got #{@client.general_log.map(&:class).uniq}")
+    end
+    expect = { 'id' => '1', 'name' => 'hoge', 'password' => 'cheap-pass' }
+    if ret != expect
+      t.error("expect exec output not change from #{expect} got #{ret}")
+    end
+    unless @client.general_log.first.format =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = \$1\t\["hoge"\]$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format}`")
+    end
+    unless @client.general_log.first.format(true) =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = \$1\t\["hoge"\].+in `test_params_values'$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format(true)}`")
+    end
+  end
+
+  def test_prepare_values(t)
+    db_init
+    @client.prepare('select', 'SELECT * FROM users WHERE name = $1')
+    ret = @client.exec_prepared('select', ['hoge']).first
+    @client.exec_prepared('select', ['bar'])
+    @client.exec_prepared('select', ['foo'])
+
+    if @client.general_log.length != 3
+      t.error("expect log length 3 got #{@client.general_log.length}")
+    end
+    if @client.general_log.any?{|log| !log.is_a?(PG::Connection::GeneralLog::Log)}
+      t.error("expect all collection item is instance of PG::Connection::GeneralLog::Log got #{@client.general_log.map(&:class).uniq}")
+    end
+    expect = { 'id' => '1', 'name' => 'hoge', 'password' => 'cheap-pass' }
+    if ret != expect
+      t.error("expect exec output not change from #{expect} got #{ret}")
+    end
+    unless @client.general_log.first.format =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = \$1\t\["hoge"\]$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format}`")
+    end
+    unless @client.general_log.first.format(true) =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = \$1\t\["hoge"\].+in `test_prepare_values'$/
+      t.error("expect log format not correct got `#{@client.general_log.first.format(true)}`")
+    end
+  end
+
+  def test_log_class(t)
+    if PG::Connection::GeneralLog::Log.members != %i[sql args backtrace time]
+      t.error("expect PG::Connection::GeneralLog::Log.members is [:sql, :args, :backtrace, :time] got #{PG::Connection::GeneralLog::Log.members}")
+    end
+  end
+
+  def example_general_log
+    db_init
+    @client.exec("SELECT * FROM users WHERE name = '#{'hoge'}'")
+    @client.exec_params('SELECT * FROM users WHERE name = $1', ['hoge'])
+
+    @client.prepare('select2', 'SELECT * FROM users WHERE name = $1')
+    @client.exec_prepared('select2', ['bar'])
+    @client.exec_prepared('select2', ['foo'])
+    puts @client.general_log.map { |log| [log.sql, log.args.to_s, log.backtrace.find{|c| %r{/gems/} !~ c.to_s}.to_s.gsub(/.*?:/, '')].join(' ') }
+    # Output:
+    # SELECT * FROM users WHERE name = 'hoge' [] in `example_general_log'
+    # SELECT * FROM users WHERE name = $1 ["hoge"] in `example_general_log'
+    # SELECT * FROM users WHERE name = $1 ["bar"] in `example_general_log'
+    # SELECT * FROM users WHERE name = $1 ["foo"] in `example_general_log'
+  end
+end

data/pg-connection-general_logs.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+File.read('lib/pg/connection/general_log/version.rb') =~ /.*VERSION\s*=\s*['"](.*?)['"]\s.*/
+version = Regexp.last_match(1)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg-connection-general_log'
+  spec.version       = version
+  spec.authors       = ['abcang']
+  spec.email         = ['abcang1015@gmail.com']
+
+  spec.summary       = 'Simple stocker general log for pg gem.'
+  spec.description   = 'Simple stocker general log for pg gem.'
+  spec.homepage      = 'https://github.com/abcang/pg-connection-general_log'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pg'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.2'
+  spec.add_development_dependency 'rgot'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: pg-connection-general_log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- abcang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: rgot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple stocker general log for pg gem.
+email:
+- abcang1015@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/test.rb
+- lib/pg/connection/general_log.rb
+- lib/pg/connection/general_log/version.rb
+- lib/pg/connection/general_log_test.rb
+- pg-connection-general_logs.gemspec
+homepage: https://github.com/abcang/pg-connection-general_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Simple stocker general log for pg gem.
+test_files: []