pg_power 1.0.0 → 1.0.1

data/README.markdown

@@ -1,5 +1,9 @@
 # PgPower
 
+[![Build Status](https://secure.travis-ci.org/TMXCredit/pg_power.png)](http://travis-ci.org/TMXCredit/pg_power)
+[![Dependency Status](https://gemnasium.com/TMXCredit/pg_power.png)](https://gemnasium.com/TMXCredit/pg_power)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/TMXCredit/pg_power)
+
 ActiveRecord extension to get more from PostgreSQL:
 
 * Create/drop schemas.
@@ -17,28 +21,28 @@ It was tested with Rails 3.1.x and 3.2.x, Ruby 1.8.7 REE and 1.9.3.
 ### Create schema
 
 In migrations you can use `create_schema` and `drop_schema` methods like this:
-
-    class ReplaceDemographySchemaWithPolitics < ActiveRecord::Migration
-      def change
-        drop_schema 'demography'
-        create_schema 'politics'
-      end
-    end
-
+```ruby
+class ReplaceDemographySchemaWithPolitics < ActiveRecord::Migration
+  def change
+    drop_schema 'demography'
+    create_schema 'politics'
+  end
+end
+```
 ### Create table
 
 Use schema `:schema` option to specify schema name:
-
-    create_table "countries", :schema => "demography" do |t|
-      # columns goes here
-    end
-
+```ruby
+create_table "countries", :schema => "demography" do |t|
+  # columns goes here
+end
+```
 ### Move table to another schema
 
 Move table `countries` from `demography` schema to `public`:
-
-    move_table_to_schema 'demography.countries', :public
-
+```ruby
+move_table_to_schema 'demography.countries', :public
+```
 ## Table and column comments
 
 Provides the following methods to manage comments:
@@ -54,55 +58,55 @@ Provides the following methods to manage comments:
 ### Examples
 
 Set a comment on the given table.
-
-    set_table_comment :phone_numbers, 'This table stores phone numbers that conform to the North American Numbering Plan.'
-
+```ruby
+set_table_comment :phone_numbers, 'This table stores phone numbers that conform to the North American Numbering Plan.'
+```
 Sets a comment on a given column of a given table.
-
-    set_column_comment :phone_numbers, :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
-
+```ruby
+set_column_comment :phone_numbers, :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
+```
 Removes any comment from the given table.
-
-    remove_table_comment :phone_numbers
-
+```ruby
+remove_table_comment :phone_numbers
+```
 Removes any comment from the given column of a given table.
-
-    remove_column_comment :phone_numbers, :npa
-
+```ruby
+remove_column_comment :phone_numbers, :npa
+```
 Set comments on multiple columns in the table.
-
-    set_column_comments :phone_numbers, :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
-                                        :nxx => 'Central Office Number'
-
+```ruby
+set_column_comments :phone_numbers, :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+                                    :nxx => 'Central Office Number'
+```
 Remove comments from multiple columns in the table.
-
-    remove_column_comments :phone_numbers, :npa, :nxx
-
+```ruby
+remove_column_comments :phone_numbers, :npa, :nxx
+```
 PgPower also adds extra methods to change_table.
 
 Set comments:
-
-    change_table :phone_numbers do |t|
-        t.set_table_comment 'This table stores phone numbers that conform to the North American Numbering Plan.'
-        t.set_column_comment :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
-    end
-
-    change_table :phone_numbers do |t|
-        t.set_column_comments :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
-                              :nxx => 'Central Office Number'
-    end
-
+```ruby
+change_table :phone_numbers do |t|
+  t.set_table_comment 'This table stores phone numbers that conform to the North American Numbering Plan.'
+  t.set_column_comment :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
+end
+
+change_table :phone_numbers do |t|
+  t.set_column_comments :npa => 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.',
+                        :nxx => 'Central Office Number'
+end
+```
 Remove comments:
-
-    change_table :phone_numbers do |t|
-        t.remove_table_comment
-        t.remove_column_comment :npa
-    end
-
-    change_table :phone_numbers do |t|
-      t.remove_column_comments :npa, :nxx
-    end
-
+```ruby
+change_table :phone_numbers do |t|
+  t.remove_table_comment
+  t.remove_column_comment :npa
+end
+
+change_table :phone_numbers do |t|
+  t.remove_column_comments :npa, :nxx
+end
+```
 ## Foreign keys
 
 We imported some code of [foreigner](https://github.com/matthuhiggins/foreigner)
@@ -116,23 +120,29 @@ The syntax is compatible with `foreigner`:
 
 
 Add foreign key from `comments` to `posts` using `post_id` column as key by default:
-    add_foreign_key(:comments, :posts)
-
+```ruby
+add_foreign_key(:comments, :posts)
+```
 Specify key explicitly:
-    add_foreign_key(:comments, :posts, :column => :blog_post_id)
-
+```ruby
+add_foreign_key(:comments, :posts, :column => :blog_post_id)
+```
 Specify name of foreign key constraint:
-    add_foreign_key(:comments, :posts, :name => "comments_posts_fk")
-
+```ruby
+add_foreign_key(:comments, :posts, :name => "comments_posts_fk")
+```
 It works with schemas as expected:
-    add_foreign_key('blog.comments', 'blog.posts')
-
+```ruby
+add_foreign_key('blog.comments', 'blog.posts')
+```
 Adds the index 'index_comments_on_post_id':
-    add_foreign_key(:comments, :posts)
-
+```ruby
+add_foreign_key(:comments, :posts)
+```
 Does not add an index:
+```ruby
     add_foreign_key(:comments, :posts, :exclude_index => true)
-
+```
 ## Partial Indexes
 
 We used a Rails 4.x [pull request](https://github.com/rails/rails/pull/4956) as a
@@ -141,13 +151,13 @@ starting point, backported to Rails 3.1.x and patched it to be schema-aware.
 ### Examples
 
 Add a partial index to a table
-
-    add_index(:comments, [:country_id, :user_id], :where => 'active')
-
+```ruby
+add_index(:comments, [:country_id, :user_id], :where => 'active')
+```
 Add a partial index to a schema table
-
-    add_index('blog.comments', :user_id, :where => 'active')
-
+```ruby
+add_index('blog.comments', :user_id, :where => 'active')
+```
 ## Indexes on Expressions
 
 PostgreSQL supports indexes on expressions. Right now, only basic functional
@@ -156,19 +166,19 @@ expressions are supported.
 ### Examples
 
 Add an index to a column with a function
-
-    add_index(:comments, "lower(text)")
-
+```ruby
+add_index(:comments, "lower(text)")
+```
 ## Tools
 
 PgPower::Tools provides number of useful methods:
-
-    PgPower::Tools.create_schema "services"                 # => create new PG schema "services"
-    PgPower::Tools.create_schema "nets"                     # => create new PG schema "nets"
-    PgPower::Tools.drop_schema "services"                   # => remove the PG schema "services"
-    PgPower::Tools.schemas                                  # => ["public", "information_schema", "nets"]
-    PgPower::Tools.index_exists?(table, columns, options)   # => returns true if an index exists for the given params
-
+```ruby
+PgPower::Tools.create_schema "services"                 # => create new PG schema "services"
+PgPower::Tools.create_schema "nets"                     # => create new PG schema "nets"
+PgPower::Tools.drop_schema "services"                   # => remove the PG schema "services"
+PgPower::Tools.schemas                                  # => ["public", "information_schema", "nets"]
+PgPower::Tools.index_exists?(table, columns, options)   # => returns true if an index exists for the given params
+```
 ## Running tests:
 
 * Configure `spec/dummy/config/database.yml` for development and test environments.
@@ -178,11 +188,11 @@ PgPower::Tools provides number of useful methods:
 ## TODO:
 
 Add next syntax to create table:
-
-    create_table "table_name", :schema => "schema_name" do |t|
-      # columns goes here
-    end
-
+```ruby
+create_table "table_name", :schema => "schema_name" do |t|
+  # columns goes here
+end
+```
 Support for JRuby:
 
 * Jdbc driver provides its own `create_schema(schema, user)` method - solve conflicts.

data/lib/core_ext/active_record/errors.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  # Raised when an DB operation cannot be carried out because the current
+  # database user lacks the required privileges.
+  class InsufficientPrivilege < WrappedDatabaseException
+  end
+end

data/lib/pg_power/connection_adapters/postgresql_adapter.rb

@@ -4,13 +4,16 @@ module PgPower::ConnectionAdapters::PostgreSQLAdapter
   extend ActiveSupport::Autoload
   extend ActiveSupport::Concern
 
-  autoload :SchemaMethods   , 'pg_power/connection_adapters/postgresql_adapter/schema_methods'
-  autoload :CommentMethods  , 'pg_power/connection_adapters/postgresql_adapter/comment_methods'
-  autoload :ForeignerMethods, 'pg_power/connection_adapters/postgresql_adapter/foreigner_methods'
-  autoload :IndexMethods    , 'pg_power/connection_adapters/postgresql_adapter/index_methods'
+  # TODO: Looks like explicit path specification can be omitted -- aignatyev 20120904
+  autoload :SchemaMethods,      'pg_power/connection_adapters/postgresql_adapter/schema_methods'
+  autoload :CommentMethods,     'pg_power/connection_adapters/postgresql_adapter/comment_methods'
+  autoload :ForeignerMethods,   'pg_power/connection_adapters/postgresql_adapter/foreigner_methods'
+  autoload :IndexMethods,       'pg_power/connection_adapters/postgresql_adapter/index_methods'
+  autoload :TranslateException, 'pg_power/connection_adapters/postgresql_adapter/translate_exception'
 
   include SchemaMethods
   include CommentMethods
   include ForeignerMethods
   include IndexMethods
+  include TranslateException
 end

data/lib/pg_power/connection_adapters/postgresql_adapter/translate_exception.rb

@@ -0,0 +1,18 @@
+# Extend ActiveRecord::ConnectionAdapter::PostgreSQLAdapter logic
+# to wrap more pg-specific errors into specific exception classes
+module PgPower::ConnectionAdapters::PostgreSQLAdapter::TranslateException
+  # # See http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
+  INSUFFICIENT_PRIVILEGE = "42501"
+
+  # Intercept insufficient privilege PGError and raise active_record wrapped database exception
+  def translate_exception(exception, message)
+    case exception.result.try(:error_field, PGresult::PG_DIAG_SQLSTATE)
+      when INSUFFICIENT_PRIVILEGE
+        exc_message = exception.result.try(:error_field, PGresult::PG_DIAG_MESSAGE_PRIMARY)
+        exc_message ||= message
+        ::ActiveRecord::InsufficientPrivilege.new(exc_message, exception)
+      else
+        super
+    end
+  end
+end

data/lib/pg_power/engine.rb

@@ -6,6 +6,7 @@ module PgPower
       ActiveSupport.on_load(:active_record) do
         # load monkey patches
         ['schema_dumper',
+         'errors',
          'connection_adapters/postgresql_adapter',
          'connection_adapters/abstract/schema_statements'].each do |path|
           require PgPower::Engine.root + 'lib/core_ext/active_record/' + path

data/lib/pg_power/schema_dumper/schema_methods.rb

@@ -30,7 +30,11 @@ module PgPower::SchemaDumper::SchemaMethods
   # Dumps tables from schemas other than public
   def non_public_schema_tables(stream)
     get_non_public_schema_table_names.each do |name|
-      table(name, stream)
+      begin
+        table(name, stream)
+      rescue ::ActiveRecord::InsufficientPrivilege => exc
+        with_warnings(false) { warn("#{exc.class.name}: #{exc.message}. Skipping #{name.inspect}...") }
+      end
     end
   end
   private :non_public_schema_tables

data/lib/pg_power/version.rb

@@ -1,4 +1,4 @@
 module PgPower
   # Version of pg_power gem.
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,150 +1,159 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pg_power
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Potapov Sergey
 - Arthur Shagall
+- TMX Credit
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
+date: 2012-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: pg
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
-  name: rspec-rails
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
-  version_requirements: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
   name: rcov
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id005
-  name: yard
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
-  name: metrical
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: metrical
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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: ruby-debug
   prerelease: false
-description: ActiveRecord extensions for PostgreSQL. Provides useful tools and ability to create/drop schemas in migrations.
-email: 
-- blake131313@gmail.com
-- arthur.shagall@gmail.com
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord extensions for PostgreSQL. Provides useful tools and ability
+  to create/drop schemas in migrations.
+email:
+- rubygems@tmxcredit.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - README.markdown
 - lib/core_ext/active_record/connection_adapters/abstract/schema_statements.rb
 - lib/core_ext/active_record/connection_adapters/postgresql_adapter.rb
+- lib/core_ext/active_record/errors.rb
 - lib/core_ext/active_record/schema_dumper.rb
 - lib/pg_power.rb
 - lib/pg_power/connection_adapters.rb
@@ -160,6 +169,7 @@ files:
 - lib/pg_power/connection_adapters/postgresql_adapter/foreigner_methods.rb
 - lib/pg_power/connection_adapters/postgresql_adapter/index_methods.rb
 - lib/pg_power/connection_adapters/postgresql_adapter/schema_methods.rb
+- lib/pg_power/connection_adapters/postgresql_adapter/translate_exception.rb
 - lib/pg_power/connection_adapters/table.rb
 - lib/pg_power/connection_adapters/table/comment_methods.rb
 - lib/pg_power/connection_adapters/table/foreigner_methods.rb
@@ -178,36 +188,29 @@ files:
 - lib/tasks/pg_power_tasks.rake
 homepage: https://github.com/TMXCredit/pg_power
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3609710966930791506
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ActiveRecord extensions for PostgreSQL.
 test_files: []
-