pg_helper 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'pg'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'wirble'
+  gem 'metric_fu'
+  gem 'ZenTest'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    ZenTest (4.5.0)
+    abstract (1.0.0)
+    activesupport (3.0.5)
+    arrayfields (4.7.4)
+    chronic (0.3.0)
+    churn (0.0.13)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    colored (1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fattr (2.2.0)
+    flay (1.4.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    git (1.2.5)
+    haml (3.0.25)
+    hirb (0.4.0)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.5.1)
+    main (4.4.0)
+      arrayfields (>= 4.7.4)
+      fattr (>= 2.1.0)
+    metric_fu (2.1.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.3.0)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.3.0)
+      rails_best_practices (>= 0.6.4)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+      syntax
+    pg (0.10.1)
+    rails_best_practices (0.7.2)
+      activesupport
+      colored (~> 1.2)
+      erubis (~> 2.6.6)
+      haml (~> 3.0.18)
+      i18n
+      ruby-progressbar (~> 0.0.9)
+      ruby_parser (~> 2.0.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-progressbar (0.0.9)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    syntax (1.0.0)
+    wirble (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  jeweler
+  metric_fu
+  pg
+  rake
+  rspec
+  wirble

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler/setup'
+
+ENV['RAILS_ENV'] ||= 'development'
+
+Bundler.require(:default, ENV['RAILS_ENV'])
+
+require 'lib/pg_helper'
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--color"]
+end
+task :default  => :spec
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "pg_helper"
+  gem.homepage = "http://github.com/webervin/pg_helper"
+  gem.license = "MIT"
+  gem.summary = "Tiny wraper for 'pg' gem"
+  gem.description = "Makes even easier to use postgresql without activerecord"
+  gem.email = "webervin@gmail.com"
+  gem.authors = ["Ervin"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+    gem.add_runtime_dependency 'pg', '~> 0.10'
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'rake'
+    gem.add_development_dependency 'wirble'
+    gem.add_development_dependency 'metric_fu'
+    gem.add_development_dependency 'ZenTest'
+    gem.add_development_dependency 'jeweler'
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/init.rb

@@ -0,0 +1 @@
+require 'pg_helper'

data/lib/pg_helper/query_helper.rb

@@ -0,0 +1,100 @@
+
+module PgHelper
+class PgHelperErrorInvalidColumnCount < PGError; end
+class PgHelperErrorInvalidRowCount < PGError; end
+class PgHelperErrorNestedTransactionNotAllowed  < PGError; end
+class PgHelperErrorRollback < PGError; end
+class PgHelperErrorInvalidOutsideTransaction < PGError; end
+class PgHelperErrorParamsMustBeArrayOfStrings < PGError; end
+
+class QueryHelper
+  attr_accessor :connection_params, :pg_connection
+
+  def initialize(params)
+    @connection_params = params
+    reconnect
+  end
+
+  def value(query, params = [])
+    exec(query, params) do |pg_result|
+      verify_single_cell!(pg_result)
+      pg_result.getvalue(0,0)
+    end
+  end
+
+  def get_column(query, params = [])
+    exec(query, params) do |pg_result|
+      require_single_column!(pg_result)
+      pg_result.column_values(0)
+    end
+  end
+
+  def modify(query, params = [])
+    exec(query, params) do |pg_result|
+      pg_result.cmd_tuples
+    end
+  end
+
+  def transaction(&block)
+    verify_transaction_possible!(&block)
+    perform_transaction(&block)
+  end
+
+  def rollback!
+    raise PgHelperErrorInvalidOutsideTransaction if connection_idle?
+    raise PgHelperErrorRollback.new
+  end
+
+  protected
+
+  def connection_idle?
+    PGconn::PQTRANS_IDLE == @pg_connection.transaction_status
+  end
+
+  def require_single_row!(pg_result)
+    raise PgHelperErrorInvalidRowCount.new if pg_result.ntuples != 1
+  end
+
+  def require_single_column!(pg_result)
+    raise PgHelperErrorInvalidColumnCount.new if pg_result.nfields != 1
+  end
+
+  def exec(query, params=[], &block)
+    check_query_params(params)
+    pg_result = nil
+    begin
+      pg_result = @pg_connection.exec(query, params)
+      block.call(pg_result)
+    ensure
+      pg_result && pg_result.clear
+    end
+  end
+
+  def check_query_params(params)
+    raise PgHelperErrorParamsMustBeArrayOfStrings.new unless params.is_a?(Array)
+  end
+  def reconnect
+    @pg_connection = PGconn.open(@connection_params)
+  end
+
+  def perform_transaction(&block)
+    @pg_connection.transaction do
+      begin
+      block.call(self)
+      rescue PgHelperErrorRollback
+        true
+      end
+    end
+  end
+
+  def verify_transaction_possible!(&block)
+    raise PgHelperErrorNestedTransactionNotAllowed.new unless connection_idle?
+    raise ArgumentError.new('missing block') unless block_given?
+  end
+
+  def verify_single_cell!(pg_result)
+    require_single_row!(pg_result)
+    require_single_column!(pg_result)
+  end
+end
+end

data/lib/pg_helper.rb

@@ -0,0 +1,7 @@
+
+require 'rubygems'
+require 'pg'
+
+# require all of the library files
+# note, you may need to specify these explicitly if there are any load order dependencies
+require 'pg_helper/query_helper.rb'

data/spec/lib/pg_helper_spec.rb

@@ -0,0 +1,229 @@
+require File.expand_path('../../spec_helper', __FILE__)
+include PgHelper
+describe QueryHelper do
+  describe 'connection params' do
+    let(:params) {
+      {
+        :host => 'my host',
+        :port => 1234,
+        :username => 'my user',
+        :password => 'my password',
+        :database => 'my base'
+      }
+    }
+
+    it 'are stored upon initializetion' do
+      PGconn.stub!(:open => true)
+      QueryHelper.new(params).connection_params.should == params
+    end
+
+    it 'are passed to pgconn' do
+      mock(:conn).tap do |conn|
+        PGconn.should_receive(:open).with(params).and_return(conn)
+        QueryHelper.new(params).pg_connection.should == conn
+      end
+    end
+  end
+
+  def build_result(params={})
+    mock(:result,
+         {
+           :nfields => 1,
+           :ntuples => 1
+         }.merge(params)
+      ).as_null_object
+  end
+  
+  def mock_result(params = {}, *args)
+    build_result(params).tap do |result_mock|
+      if args.empty?
+        pg_helper.pg_connection.should_receive(:exec).and_return(result_mock)
+      else
+        pg_helper.pg_connection.should_receive(:exec).with(*args).and_return(result_mock)
+      end
+    end
+  end
+
+  let(:pg_helper) { QueryHelper.new({:database => 'postgres'})}
+
+  describe 'single value' do
+    it 'is returned as string' do
+      pg_helper.value('select 1').should == '1'
+    end
+
+    it 'raises error if gets non array as params' do
+      lambda {
+        pg_helper.value('select 1', 'bar')
+      }.should raise_error(PgHelperErrorParamsMustBeArrayOfStrings)
+    end
+
+    it 'allows to pass params to query' do
+      param = ["foo; > 'bar'"]
+      pg_helper.value('select $1::text', param).should == "foo; > 'bar'"
+    end
+
+    it 'raises error if more than 1 row returned' do
+      lambda {
+        pg_helper.value('select 1, 2')
+      }.should raise_error(PgHelperErrorInvalidColumnCount)
+    end
+
+    it 'raises error if more than 1 row returned' do
+      lambda {
+        pg_helper.value('select 1 union select 2')
+      }.should raise_error(PgHelperErrorInvalidRowCount)
+    end
+
+    it 'clears pg result on success' do
+      mock_result.should_receive(:clear)
+      pg_helper.value('foo')
+    end
+
+    it 'clears pg result on failure' do
+      lambda {
+        mock_result({:nfields => 2}).should_receive(:clear)
+        pg_helper.value('foo')
+      }
+    end
+  end
+
+  describe 'array of column values' do
+    it 'returns values of column as array of stirngs' do
+      pg_helper.get_column( 'select 1 union (select 2 union select 3)').should == ['1','2','3']
+    end
+
+    it 'raises error if gets non array as params' do
+       lambda {
+         pg_helper.get_column('select 1', 'bar')
+       }.should raise_error(PgHelperErrorParamsMustBeArrayOfStrings)
+     end
+
+     it 'allows to pass params to query' do
+       param = ['foo', ";'bar'"]
+       pg_helper.get_column('select $1::text as str union select $2::text as str order by str', param).should == [";'bar'", 'foo']
+     end
+
+    it 'raises error if more than one column returned' do
+       lambda {
+        pg_helper.get_column('select 1, 2')
+      }.should raise_error(PgHelperErrorInvalidColumnCount)
+    end
+
+    it 'clears pg result on success' do
+      mock_result.should_receive(:clear)
+      pg_helper.get_column('foo')
+    end
+
+    it 'clears pg result on failure' do
+      lambda {
+        mock_result({:nfields => 2}).should_receive(:clear)
+        pg_helper.get_column('foo')
+      }
+    end
+  end
+
+  describe 'executing operation' do
+    it 'returns number of rows changed by query' do
+      pg_helper.modify('select 1').should == 0
+    end
+
+    it 'uses cmd_tuples of pg_result internally' do
+      mock(:value).tap do |value|
+        mock_result(:cmd_tuples => value)
+        pg_helper.modify('foo').should == value
+      end
+    end
+
+    it 'raises error if gets non array as params' do
+      lambda {
+        pg_helper.modify('select 1', 'bar')
+      }.should raise_error(PgHelperErrorParamsMustBeArrayOfStrings)
+    end
+
+    it 'allows to pass params to query' do
+      sql = 'update foo set test_text =  $1::text'
+      mock(:value).tap do |result|
+        mock_result({:cmd_tuples => result}, sql, ['foo'])
+        pg_helper.modify(sql, ["foo"]).should == result
+      end
+    end
+
+
+    it 'clears pg result on success' do
+      mock_result.should_receive(:clear)
+      pg_helper.modify('foo')
+    end
+
+    it 'clears pg result on failure' do
+      lambda {
+        mock_result.tap do |result|
+          result.should_receive(:cmd_tuples).and_raise(Exception)
+          result.should_receive(:clear)
+        end
+        pg_helper.modify('foo')
+      }
+    end
+  end
+
+  describe 'transaction' do
+    it 'raises error if no block given' do
+      lambda { pg_helper.transaction}.should raise_error(ArgumentError)
+    end
+
+    it 'allows to rollback' do
+      pg_helper.transaction do |t|
+        t.rollback!
+      end
+    end
+
+    it 'does not allow rollback if not in transaction' do
+      lambda {pg_helper.rollback!}.should raise_error(PgHelperErrorInvalidOutsideTransaction)
+    end
+
+
+    describe 'using temporary table' do
+      let(:test_table_name){'pg_helper_test_'+Time.now.to_i.to_s}
+
+      before(:all) do
+        sql = <<SQL
+        CREATE TEMP TABLE #{test_table_name}
+        (
+          test_text text
+        )
+SQL
+        pg_helper.modify(sql)
+      end
+
+      before(:each) do
+        pg_helper.modify("delete from #{test_table_name}")
+      end
+
+      it 'will rollback on failure' do
+        lambda {
+          pg_helper.transaction do |t|
+            t.modify( "INSERT INTO #{test_table_name} VALUES ('one'), ('two'), ('three')" )
+            t.value("SELECT COUNT(*) FROM #{test_table_name}").should == '3'
+				    raise Exception.new('roll it back')
+          end
+        }.should raise_error('roll it back')
+        pg_helper.value("SELECT COUNT(*) FROM #{test_table_name}").should == '0'
+      end
+
+      it 'will commit in the end' do
+        pg_helper.transaction do |t|
+          t.modify("INSERT INTO #{test_table_name} VALUES ('pass')")
+          t.modify("INSERT INTO #{test_table_name} VALUES ('correct')")
+        end
+        pg_helper.get_column("SELECT test_text FROM #{test_table_name} order by test_text").should == ["correct", "pass"]
+      end
+    end
+
+    it 'will not allow nested transaction' do
+      lambda {
+        pg_helper.transaction do |trans|
+          trans.transaction {nil}
+        end
+      }.should raise_error(PgHelperErrorNestedTransactionNotAllowed)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+ENV['RAILS_ENV'] ||= 'development'
+
+Bundler.require(:default, ENV['RAILS_ENV'])
+
+require File.expand_path('../../lib/pg_helper', __FILE__)

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification 
+name: pg_helper
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ervin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: wirble
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 10
+        version: "0.10"
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: wirble
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id014
+description: Makes even easier to use postgresql without activerecord
+email: webervin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- init.rb
+- lib/pg_helper.rb
+- lib/pg_helper/query_helper.rb
+- spec/lib/pg_helper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/webervin/pg_helper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Tiny wraper for 'pg' gem
+test_files: 
+- spec/lib/pg_helper_spec.rb
+- spec/spec_helper.rb