pg_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6afdebc43b6ddb32e59f81810ec40be2d41a0691
+  data.tar.gz: 7c42740f65d80c3579dbe3dcb3cab6792fe91982
+SHA512:
+  metadata.gz: 920058d517e5bee8757e0041dd4c42a6605470c843052f8ded2ceb177a7e69bde24a0c30285e23533bc25ebbdcaaa3509e094f93b527ee7612296f91baa5ea6c
+  data.tar.gz: 2084f15a2256d92d34f00935911df87a153ffd25aa82a40152e957aabc74ca96ab2c188986f3481d39053098cff541dbd39543c5398bf2e8ddf9a4a190150d23

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 3.2.0", '< 3.3'
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 WeTransfer
+
+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,24 @@
+# pg_logger
+
+Generates a Proc that can be fed to a "pg"-driven PostgreSQL adapter. The proc will convert the PostgreSQL
+messages to the Ruby logger messages of a comparable warning level and send them to your logger.
+
+For example, to use via Sequel:
+
+    db = Sequel.connect('postgres://...', notice_receiver: PgLogger.notice_proc_for_logger(MyApp.logger))
+
+## Contributing to pg_logger
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 WeTransfer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = '1.0.0'
+  gem.name = "pg_logger"
+  gem.homepage = "https://github.com/WeTransfer/pg_logger"
+  gem.license = "MIT"
+  gem.description = %Q{Convert PostgreSQL notices to Ruby logger messages, in one proc}
+  gem.summary = %Q{Convert PostgreSQL notices to Ruby logger messages, in one proc}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pg_logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/pg_logger.rb

@@ -0,0 +1,44 @@
+module PgLogger
+  # Maps PG notice levels to Ruby Logger levels
+  POSTGRES_ERROR_MAPPING = {
+    'DEBUG' => :debug,
+    'LOG' => :info,
+    'INFO' => :info, 
+    'NOTICE' => :warn,
+    'WARNING' => :warn,
+    'EXCEPTION' => :error,
+  }
+  
+  DEFAULT_FORMAT = '[pg] %s'.freeze
+  
+  # Creates a Proc from the given Logger object. The
+  # proc will accept PG::Result objects from notices
+  # and forward their contents into the given logger
+  #
+  # @param logger[Logger] the Ruby Logger object or a compatible
+  # @param format_str[String] the default format string
+  # @return [Proc] the proc that can be passed to the connection adapter
+  def self.notice_proc_for_logger(logger, format_str = DEFAULT_FORMAT)
+    ->(*pg_results) {
+      pg_results.each do |pg_result|
+        # message is a PG::Result, we need to extract the errors from it
+        # Only use the PG constants _within_ the proc so that the gem can still be loaded
+        # before the "pg" gem.
+        severity = pg_result.error_field(PG::Result::PG_DIAG_SEVERITY)
+      
+        message_consts = [
+          PG::Result::PG_DIAG_MESSAGE_PRIMARY, 
+          PG::Result::PG_DIAG_MESSAGE_DETAIL,
+          PG::Result::PG_DIAG_MESSAGE_HINT,
+        ]
+        
+        message = message_consts.map do |err_const|
+            pg_result.error_field(err_const)
+        end.join(' ')
+      
+        logger_method_name = POSTGRES_ERROR_MAPPING.fetch(severity)
+        logger.public_send(logger_method_name) { format_str % message }
+      end
+    }
+  end
+end

data/pg_logger.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: pg_logger 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "pg_logger"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2016-02-26"
+  s.description = "Convert PostgreSQL notices to Ruby logger messages, in one proc"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/pg_logger.rb",
+    "pg_logger.gemspec",
+    "spec/pg_logger_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/WeTransfer/pg_logger"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Convert PostgreSQL notices to Ruby logger messages, in one proc"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["< 3.3", "~> 3.2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<rspec>, ["< 3.3", "~> 3.2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["< 3.3", "~> 3.2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/spec/pg_logger_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module PG
+  module Result
+    PG_DIAG_SEVERITY = :PG_DIAG_SEVERITY
+    PG_DIAG_MESSAGE_PRIMARY = :PG_DIAG_MESSAGE_DETAIL
+    PG_DIAG_MESSAGE_DETAIL = :PG_DIAG_MESSAGE_DETAIL
+    PG_DIAG_MESSAGE_HINT = :PG_DIAG_MESSAGE_HINT
+  end
+end
+
+describe "PgLogger" do
+  it "converts the messages and sends them to the logger" do
+    out = StringIO.new
+    logger = double('Logger')
+    
+    proc = PgLogger.notice_proc_for_logger(logger)
+    expect(proc).to respond_to(:call)
+    
+    fake_notice = double('PG::Result')
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_SEVERITY) { 'NOTICE' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_PRIMARY) { 'Something bad happened' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_DETAIL) { 'in a detailed way' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_HINT) { 'may be fixable' }
+    
+    expect(logger).to receive(:warn) {|&blk|
+      expect(blk.call).to eq('[pg] Something bad happened in a detailed way may be fixable')
+    }
+    
+    proc.call(fake_notice)
+  end
+  
+  it "honors the format string" do
+    out = StringIO.new
+    logger = double('Logger')
+    
+    proc = PgLogger.notice_proc_for_logger(logger, 'PostgreSQL said %s')
+    expect(proc).to respond_to(:call)
+    
+    fake_notice = double('PG::Result')
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_SEVERITY) { 'NOTICE' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_PRIMARY) { 'Something bad happened' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_DETAIL) { 'in a detailed way' }
+    expect(fake_notice).to receive(:error_field).with(PG::Result::PG_DIAG_MESSAGE_HINT) { 'may be fixable' }
+    
+    expect(logger).to receive(:warn) {|&blk|
+      expect(blk.call).to eq('PostgreSQL said Something bad happened in a detailed way may be fixable')
+    }
+    
+    proc.call(fake_notice)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'pg_logger'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pg_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Convert PostgreSQL notices to Ruby logger messages, in one proc
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_logger.rb
+- pg_logger.gemspec
+- spec/pg_logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/WeTransfer/pg_logger
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Convert PostgreSQL notices to Ruby logger messages, in one proc
+test_files: []