pg-app-name 0.1.0

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-app-name.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vagmi Mudumbai
+
+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,31 @@
+# Pg::App::Name
+
+It sets the application name for postgres database connections. It is available in PostgreSQL server 9.x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg-app-name'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg-app-name
+
+## Usage
+
+It uses the environment variable `PG_APP_NAME` to set the application name. If you are using Rails, it automatically sets the rails app name as the application name for the database. Setting the environment variable will overwrite the Rails application name.
+
+Start your app. Launch `psql` and query the `pg_stat_activity` table to watch the gem in action.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/pg-app-name/version.rb

@@ -0,0 +1,7 @@
+module Pg
+  module App
+    module Name
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/pg-app-name.rb

@@ -0,0 +1,61 @@
+require "pg-app-name/version"
+require 'active_record'
+module PG
+  module ApplicationName
+    def self.included(base)
+      unless base.respond_to? :establish_connection_with_application_name
+          base.extend ClassMethods
+          base.class_eval do
+            class << self
+              alias_method_chain :establish_connection, :application_name
+            end
+          end
+      end
+    end
+
+    module ClassMethods
+      def establish_connection_with_application_name(*args)
+        result = establish_connection_without_application_name(*args)
+        appname = ENV['PG_APP_NAME'] || "ruby"
+        appname = "#{appname}_without_pool"
+        ::ActiveRecord::Base.connection.execute("set application_name = '#{appname}';")
+        result
+      end
+    end
+  end
+
+  module PoolApplicationName
+    def self.included(base)
+      unless base.respond_to? :new_connection_with_application_name
+        base.class_eval do
+          include InstanceMethods
+          alias_method_chain :new_connection, :application_name
+        end
+      end
+    end
+
+    module InstanceMethods
+      def new_connection_with_application_name(*args)
+        result = new_connection_without_application_name(*args)
+        appname = ENV['PG_APP_NAME'] || "ruby"
+        @pool_number ||= 1
+        appname = "#{appname}_with_pool_#{@pool_number}"
+        result.execute("set application_name = '#{appname}';")
+        @pool_number = @pool_number + 1
+        result
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include PG::ApplicationName
+end
+
+class ActiveRecord::ConnectionAdapters::ConnectionPool
+  include PG::PoolApplicationName
+end
+
+if defined?(RAILS)
+  ENV['PG_APP_NAME'] ||= Rails.application.class.name.split('::')[0].tableize rescue 'rails'
+end

data/pg-app-name.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pg-app-name/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vagmi Mudumbai"]
+  gem.email         = ["vagmi.mudumbai@gmail.com"]
+  gem.description   = %q{Sets the application name for a postgres connection}
+  gem.summary       = %q{Sets the application name for a postgres connection}
+  gem.homepage      = "https://github.com/vagmi/pg-app-name"
+
+  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.name          = "pg-app-name"
+  gem.require_paths = ["lib"]
+  gem.version       = Pg::App::Name::VERSION
+  gem.add_dependency 'activerecord', '~> 3'
+  gem.add_dependency 'pg', '~> 0'
+  gem.add_development_dependency 'rspec', '~> 2'
+end

data/spec/pg-app-name_spec.rb

@@ -0,0 +1,35 @@
+require 'pg-app-name'
+
+connection_params = {adapter: 'postgresql', username: 'postgres', database: 'pg_app_name_test'}
+connection_params['password'] = ENV['PG_PASS'] if ENV['PG_PASS']
+ENV['PG_APP_NAME']="pgtest"
+
+describe "Set PG App Name" do
+  it "should monkey patch ActiveRecord::Base" do
+    ActiveRecord::Base.respond_to?(:establish_connection_with_application_name).should be_true
+  end
+
+  it "should monkey patch ConnectionPool" do
+    cp = ActiveRecord::ConnectionAdapters::ConnectionPool.new(ActiveRecord::Base::ConnectionSpecification.new(connection_params,"postgresql_connection"))
+    cp.respond_to?(:new_connection_with_application_name).should be_true
+  end
+
+  it "should set the application name while establishing connection" do
+    ActiveRecord::Base.establish_connection connection_params
+    result = ActiveRecord::Base.connection.exec_query "select application_name from pg_stat_activity where datname='"+connection_params[:database]+"'"
+    result.rows.count.should == 1
+    result.rows[0][0].should=="pgtest_without_pool"
+    ActiveRecord::Base.connection.close
+  end
+
+  it "should set the application name while establishing connection with connection pool" do
+    cp = ActiveRecord::ConnectionAdapters::ConnectionPool.new(ActiveRecord::Base::ConnectionSpecification.new(connection_params,"postgresql_connection"))
+    conn = cp.checkout
+    result = conn.exec_query "select application_name from pg_stat_activity where datname='"+connection_params[:database]+"'"
+    result.rows.flatten!
+    result.rows.count.should == 2
+    result.rows.index("pgtest_with_pool_1").should_not be_nil
+    result.rows.index("pgtest_without_pool").should_not be_nil
+    cp.disconnect!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'pg-app-name'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pg-app-name
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Vagmi Mudumbai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Sets the application name for a postgres connection
+email:
+- vagmi.mudumbai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pg-app-name.rb
+- lib/pg-app-name/version.rb
+- pg-app-name.gemspec
+- spec/pg-app-name_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vagmi/pg-app-name
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Sets the application name for a postgres connection
+test_files:
+- spec/pg-app-name_spec.rb
+- spec/spec_helper.rb