pg_decorator 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ervin Weber
+
+MIT License
+
+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,47 @@
+# PgDecorator
+
+This gem is inspired by [marginalia by 37signals](https://github.com/37signals/marginalia) but instead of patching
+Rails, patches [Pg gem](https://bitbucket.org/ged/ruby-pg/wiki/Home)
+
+PgDecorator adds first line of caller (tries to detect place in *your* code by ignoring gems, ruby and rbenv lines) as
+/* SQL comment */ so you could later identify "strange" or long queries in your PostgreSQL log directly.
+
+Several reasons for creating gem:
+
+ * marginalia did not decorate some of PostgreSQL adapter queries
+ * no Rails 'dependency', you can use this gem if you use pg gem directly, or if you have non rails wrapper, such as [pg_helper](https://github.com/webervin/pg_helper)
+ * having aggressive connection pooler in front of database server may lead to loss of "set application_name = 'newappname';",
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_decorator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_decorator
+
+## Usage
+
+in your ruby script add following:
+
+     require 'rubygems'
+     require 'pg_decorator'
+     PgDecorator::Injector.inject('AppToRuleWorld')
+
+If you use Rails then you could create config/initializers/pg_decorator
+
+     PgDecorator::Injector.inject('AppToRuleWorld')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pg_decorator.rb

@@ -0,0 +1,10 @@
+require "pg_decorator/version"
+require "pg_decorator/injector"
+
+
+module PgDecorator
+  module PgInstrumentation
+  end
+
+
+end

data/lib/pg_decorator/decorator.rb

@@ -0,0 +1,74 @@
+module PgDecorator
+  module Decorator
+    def self.included(instrumented_class)
+      instrumented_class.class_eval do
+        alias_method :async_exec_without_sql_decorator, :async_exec
+        alias_method :async_exec, :async_exec_with_sql_decorator
+
+        alias_method :async_query_without_sql_decorator, :async_query
+        alias_method :async_query, :async_query_with_sql_decorator
+
+        alias_method :exec_without_sql_decorator, :exec
+        alias_method :exec, :exec_with_sql_decorator
+
+        alias_method :query_without_sql_decorator, :query
+        alias_method :query, :query_with_sql_decorator
+
+        alias_method :prepare_without_sql_decorator, :prepare
+        alias_method :prepare, :prepare_with_sql_decorator
+
+        alias_method :send_prepare_without_sql_decorator, :send_prepare
+        alias_method :send_prepare, :send_prepare_with_sql_decorator
+
+        alias_method :send_query_without_sql_decorator, :send_query
+        alias_method :send_query, :send_query_with_sql_decorator
+      end
+    end
+
+    def decorate_sql(sql)
+      last_line = caller.detect{|l|  l !~ /\.?(rvm|gem|vendor|rbenv|pg_decorator)/ }
+      if last_line
+        if last_line.starts_with? Rails.root.to_s
+          last_line = last_line[Rails.root.to_s.length..-1]
+        end
+        "/* #{ escape_string(app_name) } #{escape_comment(last_line)} */\n#{sql}"
+      else
+        "/* #{ escape_string(app_name) } outside code tree */\n#{sql}"
+      end
+    end
+
+    def escape_comment(str)
+      escape_string( str.gsub('*/','* /'))
+    end
+
+
+    def async_exec_with_sql_decorator(sql,*args, &block)
+      async_exec_without_sql_decorator(decorate_sql(sql), *args, &block)
+    end
+
+    def exec_with_sql_decorator(sql,*args, &block)
+      exec_without_sql_decorator(decorate_sql(sql), *args, &block)
+    end
+
+    def query_with_sql_decorator(sql, *args, &block)
+      query_without_sql_decorator(decorate_sql(sql), *args, &block)
+    end
+
+    def async_query_with_sql_decorator(sql, *args, &block)
+      async_query_without_sql_decorator(decorate_sql(sql), *args, &block)
+    end
+
+    def prepare_with_sql_decorator(stmt_name, sql, *args, &block)
+      prepare_without_sql_decorator(stmt_name, decorate_sql(sql), *args, &block)
+    end
+
+    def send_prepare_with_sql_decorator(stmt_name, sql, *args, &block)
+      send_prepare_without_sql_decorator(stmt_name, decorate_sql(sql), *args, &block)
+    end
+
+    def send_query_with_sql_decorator(sql, *args, &block)
+      send_query_without_sql_decorator(decorate_sql(sql), *args, &block)
+    end
+
+  end
+end

data/lib/pg_decorator/injector.rb

@@ -0,0 +1,13 @@
+module PgDecorator
+  class Injector
+    def self.inject(custom_app_name='Ruby pg app')
+      require 'pg' unless defined?( PG )
+      require_relative 'decorator'
+      PG::Connection.module_eval do
+        define_method(:app_name) { custom_app_name }
+        include PgDecorator::Decorator
+      end
+      true
+    end
+  end
+end

data/lib/pg_decorator/version.rb

@@ -0,0 +1,3 @@
+module PgDecorator
+  VERSION = "0.0.2"
+end

data/pg_decorator.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_decorator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pg_decorator"
+  gem.version       = PgDecorator::VERSION
+  gem.authors       = ["Ervin Weber"]
+  gem.email         = ["webervin@gmail.com"]
+  gem.description   = %q{adds caller method as SQL comment}
+  gem.summary       = %q{Makes ruby caller visible in PostgreSQL log}
+  gem.homepage      = 'https://github.com/webervin/pg_decorator'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: pg_decorator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ervin Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: adds caller method as SQL comment
+email:
+- webervin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_decorator.rb
+- lib/pg_decorator/decorator.rb
+- lib/pg_decorator/injector.rb
+- lib/pg_decorator/version.rb
+- pg_decorator.gemspec
+homepage: https://github.com/webervin/pg_decorator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3810251013660995226
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3810251013660995226
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Makes ruby caller visible in PostgreSQL log
+test_files: []