pg_helper 0.2.0 → 0.2.1

data/HISTORY.md

@@ -0,0 +1,8 @@
+## 0.2.1 (2011.03.31)
+* yard documentation added
+
+## 0.2.0 (2011.03.31)
+* changed Jeweler to Bundler
+
+## 0.1.0 (2011.03.21)
+* Hello World!

data/README.md

@@ -0,0 +1,14 @@
+PgHelper
+=============
+
+Because sometimes I don't want ActiveRecord to parse all fields, nor think about connection.
+All features are actually provided by [Pg gem](http://rubygems.org/gems/pg)
+
+
+Features
+-------
+
+* Small
+* Ability to pass query params to PostgreSql
+* No parsing of strings
+* also works as rails plugin `rails plugin install https://github.com/webervin/pg_helper.git`

data/lib/pg_helper/query_helper.rb

@@ -1,20 +1,44 @@
-
+#Main module of PgHelper gem/plugin
 module PgHelper
+
+#Indicates that query returned unexpected columnt count
 class PgHelperErrorInvalidColumnCount < PGError; end
+
+#Indicates that query returned too much rows
 class PgHelperErrorInvalidRowCount < PGError; end
+
+# Indicates that transaction was called while inside transaction
 class PgHelperErrorNestedTransactionNotAllowed  < PGError; end
+
+#For use inside transaction to cause rollback.
 class PgHelperErrorRollback < PGError; end
+
+#Indicates that call is invalid outside transaction
 class PgHelperErrorInvalidOutsideTransaction < PGError; end
+
+#Invalid argument
 class PgHelperErrorParamsMustBeArrayOfStrings < PGError; end
 
+#Main api class
 class QueryHelper
-  attr_accessor :connection_params, :pg_connection
 
+  # @return [Hash]  connection params
+  attr_accessor :connection_params
+
+  # Active database connection
+  # @return [PGconn]  connection see {http://rubygems.org/gems/pg Pg gem on rubygems} for details
+  attr_accessor :pg_connection
+
+
+  # Creates a new instance of  the QueryHelper
   def initialize(params)
     @connection_params = params
     reconnect
   end
 
+  # @param [String]  query SQL select that should return one cell, may include $1, $2 etc to be replaced by arguments
+  # @param [Array<String>]  params query arguments to be passed on to PostgreSql
+  # @return [String]
   def value(query, params = [])
     exec(query, params) do |pg_result|
       verify_single_cell!(pg_result)
@@ -22,6 +46,9 @@ class QueryHelper
     end
   end
 
+  # @param [String]  query SQL select that should return one column, may include $1, $2 etc to be replaced by arguments
+  # @param [Array<String>]  params query arguments to be passed on to PostgreSql
+  # @return [Array<String>]  Values of selected column
   def get_column(query, params = [])
     exec(query, params) do |pg_result|
       require_single_column!(pg_result)
@@ -29,17 +56,24 @@ class QueryHelper
     end
   end
 
+  # @param [String]  query SQL update, may include $1, $2 etc to be replaced by arguments
+  # @param [Array<String>]  params query arguments to be passed on to PostgreSql
+  # @return [Integer]  Number of rows changed
   def modify(query, params = [])
     exec(query, params) do |pg_result|
       pg_result.cmd_tuples
     end
   end
 
+  # Executes content of given block inside database transaction
+  #@yield [QueryHelper] 
   def transaction(&block)
     verify_transaction_possible!(&block)
     perform_transaction(&block)
   end
 
+  # Aborts current transaction, or raises exception if invoked outside transaction.
+  #@return [void]
   def rollback!
     raise PgHelperErrorInvalidOutsideTransaction if connection_idle?
     raise PgHelperErrorRollback.new

data/lib/pg_helper/version.rb

@@ -1,3 +1,5 @@
+#Main module of PgHelper gem/plugin
 module PgHelper
-  VERSION = "0.2.0"
+  # @return [String]  gem version
+  VERSION = "0.2.1"
 end

data/lib/pg_helper.rb

@@ -4,4 +4,4 @@ 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'
+require 'pg_helper/query_helper.rb'

data/pg_helper.gemspec

@@ -9,11 +9,10 @@ Gem::Specification.new do |s|
   s.authors = ["Ervin"]
   s.email = %q{webervin@gmail.com}
   s.homepage = %q{http://github.com/webervin/pg_helper}
+  s.rubyforge_project = "pg_helper"
   s.summary = %q{Tiny wraper for 'pg' gem}
   s.description = %q{Makes even easier to use postgresql without activerecord}
-
-
-  s.rubyforge_project = "pg_helper"
+  s.has_rdoc = 'yard'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -27,4 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'wirble'
   s.add_development_dependency 'metric_fu'
   s.add_development_dependency 'ZenTest'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bluecloth' #yard hidden dependency
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pg_helper
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ervin
@@ -102,6 +102,34 @@ dependencies:
         version: "0"
   version_requirements: *id006
   name: ZenTest
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: yard
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: bluecloth
 description: Makes even easier to use postgresql without activerecord
 email: webervin@gmail.com
 executables: []
@@ -113,8 +141,9 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- HISTORY.md
+- README.md
 - Rakefile
-- VERSION
 - autotest/discover.rb
 - init.rb
 - lib/pg_helper.rb
@@ -123,7 +152,7 @@ files:
 - pg_helper.gemspec
 - spec/lib/pg_helper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://github.com/webervin/pg_helper
 licenses: []
 

data/VERSION

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