pg-connection-general_log 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 867e6e436c5d596d967ce3752bb0d6628ce265ee
-  data.tar.gz: '092e57f1a54da5a7d549e46731e3a25950f7cbb6'
+  metadata.gz: 136b9087c2627d7e15e8b9628d481a2226998a91
+  data.tar.gz: da67bac81d731c05daa133e8084d7ae4b3523ad6
 SHA512:
-  metadata.gz: bd28c680fc41cd5373a542b6f53824026c0faf0f6363c520e6b349a5bae2500dfa0737d51912d7b80886bc84fab5faf43675e1a53e9d4dfeada2ef50d4e4b111
-  data.tar.gz: daa5b3ccefa426f44ab11f42d7a2943aa1de20d50514a0151e4691525dd1a98550cc4e8dae2196955765a22d2c4f6ea8c6124f06856540a3dcafb45a3ebd4fb7
+  metadata.gz: 472166a3d5f5dcf0f0e641c19a9e35b5fc264a44f3d8229d58c61859ced3280496935be28c8603ada34a7d588e2fb31114547be57bb2e599d8fd1870673ace63
+  data.tar.gz: 5285b8473499fc7928741ada338487835dbb7b561e40f3f8debb1db425f661e958d016970e3aede1ca8ec9bb3d7a482cfb36c60586807de07f757f20e04ff5e0

data/README.md

@@ -1,7 +1,7 @@
 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)
+[![Build Status](https://travis-ci.org/abcang/pg-connection-general_log.svg?branch=master)](https://travis-ci.org/abcang/pg-connection-general_log)
 
 A monkey patch for pg.
 Stock all general logs.
@@ -16,7 +16,7 @@ require "pg/connection/general_log"
 client = PG::Connection.new(config)
 client.query("SELECT * FROM users LIMIT 1")
 
-p client.general_log #=>
+p PG::Connection::GeneralLog.general_log #=>
 # [
 #   #<struct PG::Connection::GeneralLog::Log
 #     sql="SELECT * FROM users LIMIT 1",
@@ -30,6 +30,16 @@ p client.general_log #=>
 
 ### sinatra
 
+config.ru:
+```ruby
+require_relative './test'
+
+require 'pg/connection/general_log'
+
+use PG::Connection::GeneralLog::Middleware, enabled: true, backtrace: true, path: '/tmp/general_log'
+run Sinatra::Application
+```
+
 test.rb:
 ```ruby
 require 'sinatra'
@@ -50,13 +60,9 @@ get '/' do
   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:
+/tmp/general_log/2017-11-19.log:
 ```
 REQUEST GET	/	4
 SQL	(0000.89ms)	SELECT * FROM users WHERE name = 'hoge'	[]	/path/to/test.rb:12:in `block in <main>'
@@ -78,6 +84,18 @@ And then execute:
     $ bundle
 
 
+## Test
+
+```ruby
+$ bundle exec rake
+```
+
+## example server
+
+```ruby
+$ bundle exec rake example
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -4,4 +4,8 @@ task :test do
   sh "rgot -v #{Dir.glob('lib/**/*_test.rb').join(' ')}"
 end
 
+task :example do
+  sh 'rackup example/config.ru'
+end
+
 task default: [:test]

data/example/config.ru

@@ -0,0 +1,6 @@
+require_relative './test'
+
+require 'pg/connection/general_log'
+
+use PG::Connection::GeneralLog::Middleware, enabled: true, backtrace: true, path: '/tmp/general_log'
+run Sinatra::Application

data/example/test.rb

@@ -1,6 +1,5 @@
 require 'sinatra'
 require 'pg'
-require 'pg/connection/general_log'
 
 helpers do
   def db
@@ -11,6 +10,13 @@ helpers do
     )
   end
 
+  def pg
+    PG.connect(
+      host: '127.0.0.1',
+      user: 'postgres'
+    )
+  end
+
   def init
     db.exec('DROP TABLE IF EXISTS users')
     db.exec(<<-SQL)
@@ -37,12 +43,21 @@ get '/' do
   db.prepare('select', 'SELECT * FROM users WHERE name = $1')
   db.exec_prepared('select', ['bar'])
   db.exec_prepared('select', ['foo'])
+
+  'ok'
 end
 
 get '/init' do
+  pg.exec('DROP DATABASE IF EXISTS pg_connection_general_log_test')
+  pg.exec('CREATE DATABASE pg_connection_general_log_test')
+
   init
+
+  'init'
 end
 
-after do
-  db.general_log.writefile(req: request, backtrace: true)
+get '/down' do
+  pg.exec('DROP DATABASE IF EXISTS pg_connection_general_log_test')
+
+  'down'
 end

data/lib/pg/connection/general_log.rb

@@ -1,89 +1,24 @@
 require 'pg'
 require 'benchmark'
 
+require 'pg/connection/general_log/connection_ext'
+require 'pg/connection/general_log/log'
+require 'pg/connection/general_log/logger'
+require 'pg/connection/general_log/middleware'
+require 'pg/connection/general_log/version'
+
 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
+      class << self
+        def general_log
+          Thread.current[:general_log] ||= Logger.new
         end
 
-        def push(sql, args, backtrace, time)
-          super(Log.new(sql, args, backtrace, time))
+        def prepend_module
+          PG::Connection.send(:prepend, ConnectionExt)
         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/connection_ext.rb

@@ -0,0 +1,49 @@
+module PG
+  class Connection
+    module GeneralLog
+      module ConnectionExt
+        def initialize(*)
+          @stmt_map = {}
+          super
+        end
+
+        def exec(sql)
+          ret = nil
+          time = Benchmark.realtime do
+            ret = super
+          end
+          GeneralLog.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
+          GeneralLog.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
+          GeneralLog.general_log.push(sql, params, caller_locations, time)
+          ret
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module PG
+  class Connection
+    module GeneralLog
+      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
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'fileutils'
+require 'date'
+
+module PG
+  class Connection
+    module GeneralLog
+      class Logger < Array
+        def writefile(req)
+          FileUtils.mkdir_p(Middleware.path)
+          File.open(File.join(Middleware.path, "#{Date.today}.txt"), 'a') do |file|
+            if req
+              file.puts "REQUEST\t#{req.request_method}\t#{req.fullpath}\t#{self.length}"
+            end
+
+            file.puts self.map { |log| log.format(Middleware.backtrace) }.join("\n") + "\n\n"
+          end
+        end
+
+        def push(sql, args, backtrace, time)
+          super(Log.new(sql, args, backtrace, time))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module PG
+  class Connection
+    module GeneralLog
+      class Middleware
+        class << self
+          attr_accessor :enabled, :path, :backtrace
+        end
+
+        def initialize(app, options = {})
+          @app = app
+          Middleware.enabled = options[:enabled]
+          Middleware.path = options[:path] || '/tmp/general_log'
+          Middleware.backtrace = options[:backtrace] || false
+
+          GeneralLog.prepend_module if Middleware.enabled
+        end
+
+        def call(env)
+          GeneralLog.general_log.clear if Middleware.enabled
+          @app.call(env)
+        ensure
+          if Middleware.enabled
+            request = Rack::Request.new env
+            puts request.path
+            GeneralLog.general_log.writefile(request)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 module PG
-  module GeneralLog
-    VERSION = "0.0.1"
+  class Connection
+    module GeneralLog
+      VERSION = "0.0.2"
+    end
   end
 end

data/lib/pg/connection/general_log_test.rb

@@ -2,6 +2,7 @@ require 'pg/connection/general_log'
 
 module PGConnectionGeneralLogTest
   def test_main(m)
+    PG::Connection::GeneralLog.prepend_module
     client = PG.connect(
       host: '127.0.0.1',
       user: 'postgres'
@@ -14,6 +15,7 @@ module PGConnectionGeneralLogTest
       user: 'postgres',
       dbname: 'pg_connection_general_log_test'
     )
+    PG::Connection::GeneralLog.general_log.clear
     exit m.run
 
     client.exec('DROP DATABASE IF EXISTS pg_connection_general_log_test')
@@ -35,15 +37,15 @@ module PGConnectionGeneralLogTest
                     ('bar', 'barr')
       ;
     SQL
-    @client.general_log.clear
+    PG::Connection::GeneralLog.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}")
+    unless PG::Connection::GeneralLog.general_log.is_a?(Array)
+      t.error("initial value expect Array class got #{PG::Connection::GeneralLog.general_log.class}")
     end
-    unless @client.general_log.empty?
-      t.error("initial value expect [] got #{@client.general_log}")
+    unless PG::Connection::GeneralLog.general_log.empty?
+      t.error("initial value expect [] got #{PG::Connection::GeneralLog.general_log}")
     end
   end
 
@@ -53,21 +55,21 @@ module PGConnectionGeneralLogTest
     @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}")
+    if PG::Connection::GeneralLog.general_log.length != 3
+      t.error("expect log length 3 got #{PG::Connection::GeneralLog.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}")
+    if PG::Connection::GeneralLog.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 #{PG::Connection::GeneralLog.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}`")
+    unless PG::Connection::GeneralLog.general_log.first.format =~ /^SQL\t\(\d+\.\d+ms\)\tSELECT \* FROM users WHERE name = 'hoge'\t\[\]$/
+      t.error("expect log format not correct got `#{PG::Connection::GeneralLog.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)}`")
+    unless PG::Connection::GeneralLog.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 `#{PG::Connection::GeneralLog.general_log.first.format(true)}`")
     end
   end
 
@@ -77,21 +79,21 @@ module PGConnectionGeneralLogTest
     @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}")
+    if PG::Connection::GeneralLog.general_log.length != 3
+      t.error("expect log length 3 got #{PG::Connection::GeneralLog.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}")
+    if PG::Connection::GeneralLog.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 #{PG::Connection::GeneralLog.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}`")
+    unless PG::Connection::GeneralLog.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 `#{PG::Connection::GeneralLog.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)}`")
+    unless PG::Connection::GeneralLog.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 `#{PG::Connection::GeneralLog.general_log.first.format(true)}`")
     end
   end
 
@@ -102,21 +104,21 @@ module PGConnectionGeneralLogTest
     @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}")
+    if PG::Connection::GeneralLog.general_log.length != 3
+      t.error("expect log length 3 got #{PG::Connection::GeneralLog.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}")
+    if PG::Connection::GeneralLog.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 #{PG::Connection::GeneralLog.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}`")
+    unless PG::Connection::GeneralLog.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 `#{PG::Connection::GeneralLog.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)}`")
+    unless PG::Connection::GeneralLog.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 `#{PG::Connection::GeneralLog.general_log.first.format(true)}`")
     end
   end
 
@@ -134,7 +136,7 @@ module PGConnectionGeneralLogTest
     @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(' ') }
+    puts PG::Connection::GeneralLog.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'

data/pg-connection-general_logs.gemspec

@@ -1,11 +1,10 @@
 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)
+require 'pg/connection/general_log/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'pg-connection-general_log'
-  spec.version       = version
+  spec.version       = PG::Connection::GeneralLog::VERSION
   spec.authors       = ['abcang']
   spec.email         = ['abcang1015@gmail.com']
 
@@ -21,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 12.2'
   spec.add_development_dependency 'rgot'
+  spec.add_development_dependency 'sinatra'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-connection-general_log
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - abcang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-12 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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
@@ -79,8 +93,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/config.ru
 - example/test.rb
 - lib/pg/connection/general_log.rb
+- lib/pg/connection/general_log/connection_ext.rb
+- lib/pg/connection/general_log/log.rb
+- lib/pg/connection/general_log/logger.rb
+- lib/pg/connection/general_log/middleware.rb
 - lib/pg/connection/general_log/version.rb
 - lib/pg/connection/general_log_test.rb
 - pg-connection-general_logs.gemspec