pg_power 1.0.0

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

@@ -0,0 +1,42 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::SchemaStatements}
+# to support index features.
+module PgPower::ConnectionAdapters::PostgreSQLAdapter::IndexMethods
+  def supports_partial_index?
+    true
+  end
+
+  # Overrides ActiveRecord::ConnectionAdapters::SchemaStatements.index_name
+  # to support schema notation.  Converts dots in index name to underscores.
+  #
+  # === Example
+  #  add_index 'demography.citizens', :country_id
+  #  # produces
+  #  CREATE INDEX "index_demography_citizens_on_country_id" ON "demography"."citizens" ("country_id")
+  #  # instead of
+  #  CREATE INDEX "index_demography.citizens_on_country_id" ON "demography"."citizens" ("country_id")
+  #
+  def index_name(table_name, options) #:nodoc:
+    super.gsub('.','_')
+  end
+
+  # Overrides ActiveRecord::ConnectionAdapters::SchemaStatements.index_name_for_remove
+  # to support schema notation. Prepends the schema name to the index name.
+  #
+  # === Example
+  #  drop_index 'demography.citizens', :country_id
+  #  # produces
+  #  DROP INDEX "demography"."index_demography_citizens_on_country_id"
+  #  # instead of
+  #  DROP INDEX "index_demography_citizens_on_country_id"
+  #
+  def index_name_for_remove(table_name, options = {})
+    index_name = super
+
+    if table_name.include?('.') # schema notation
+      schema = table_name.split('.').first
+      "#{schema}.#{index_name}"
+    else
+      index_name
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::PostgreSQLAdapter}
+# to support schemas feature.
+module PgPower::ConnectionAdapters::PostgreSQLAdapter::SchemaMethods
+  # Creates new schema in DB.
+  # @param [String] schema_name
+  def create_schema(schema_name)
+    ::PgPower::Tools.create_schema(schema_name)
+  end
+
+  # Drops schema in DB.
+  # @param [String] schema_name
+  def drop_schema(schema_name)
+    ::PgPower::Tools.drop_schema(schema_name)
+  end
+
+  # Move table to another schema
+  # @param [String] table table name. Can be with schema prefix e.g. "demography.people"
+  # @param [String] schema schema where table should be moved to.
+  def move_table_to_schema(table, schema)
+    ::PgPower::Tools.move_table_to_schema(table, schema)
+  end
+end

data/lib/pg_power/connection_adapters/table.rb

@@ -0,0 +1,17 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::Table}
+# to support pg_power features.
+module PgPower::ConnectionAdapters::Table
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
+
+  autoload :CommentMethods
+  autoload :ForeignerMethods
+
+  include CommentMethods
+  include ForeignerMethods
+
+  
+  included do
+    alias_method_chain :references, :foreign_keys
+  end
+end

data/lib/pg_power/connection_adapters/table/comment_methods.rb

@@ -0,0 +1,58 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::Table}
+# to support comments feature.
+module PgPower::ConnectionAdapters::Table::CommentMethods
+  # Sets the comment on the table
+  #
+  # ===== Example
+  # ====== Set comment on table
+  #   t.set_table_comment 'This table stores phone numbers that conform to the North American Numbering Plan.'
+  def set_table_comment(comment)
+    @base.set_table_comment(@table_name, comment)
+  end
+
+  # Removes any comment from the table
+  #
+  # ===== Example
+  # ====== Remove table comment
+  #   t.remove_table_comment
+  def remove_table_comment
+    @base.remove_table_comment(@table_name)
+  end
+
+  # Sets the comment for a given column
+  #
+  # ===== Example
+  # ====== Set comment on the npa column
+  #   t.set_column_comment :npa, 'Numbering Plan Area Code - Allowed ranges: [2-9] for first digit, [0-9] for second and third digit.'
+  def set_column_comment(column_name, comment)
+    @base.set_column_comment(@table_name, column_name, comment)
+  end
+
+  # Sets comments on multiple columns.  'comments' is a hash of column_name => comment pairs.
+  #
+  # ===== Example
+  # ====== Setting comments on the columns of the phone_numbers table
+  #  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'
+  def set_column_comments(comments)
+    @base.set_column_comments(@table_name, comments)
+  end
+
+  # Removes any comment for a given column
+  #
+  # ===== Example
+  # ====== Remove comment from the npa column
+  #   t.remove_column_comment :npa
+  def remove_column_comment(column_name)
+    @base.remove_column_comment(@table_name, column_name)
+  end
+
+  # Removes any comments from the given columns
+  #
+  # ===== Example
+  # ====== Remove comment from the npa and nxx columns
+  #   t.remove_column_comment :npa, :nxx
+  def remove_column_comments(*column_names)
+    @base.remove_column_comments(@table_name, *column_names)
+  end
+end

data/lib/pg_power/connection_adapters/table/foreigner_methods.rb

@@ -0,0 +1,51 @@
+# Provides methods to extend {ActiveRecord::ConnectionAdapters::Table}
+# to support foreign keys feature.
+module PgPower::ConnectionAdapters::Table::ForeignerMethods
+  # Adds a new foreign key to the table. +to_table+ can be a single Symbol, or
+  # an Array of Symbols. See SchemaStatements#add_foreign_key
+  #
+  # ===== Examples
+  # ====== Creating a simple foreign key
+  # t.foreign_key(:people)
+  # ====== Defining the column
+  # t.foreign_key(:people, :column => :sender_id)
+  # ====== Creating a named foreign key
+  # t.foreign_key(:people, :column => :sender_id, :name => 'sender_foreign_key')
+  # ====== Defining the column of the +to_table+.
+  # t.foreign_key(:people, :column => :sender_id, :primary_key => :person_id)
+  def foreign_key(to_table, options = {})
+    @base.add_foreign_key(@table_name, to_table, options)
+  end
+
+  # Remove the given foreign key from the table.
+  #
+  # ===== Examples
+  # ====== Remove the suppliers_company_id_fk in the suppliers table.
+  # change_table :suppliers do |t|
+  # t.remove_foreign_key :companies
+  # end
+  # ====== Remove the foreign key named accounts_branch_id_fk in the accounts table.
+  # change_table :accounts do |t|
+  # t.remove_foreign_key :column => :branch_id
+  # end
+  # ====== Remove the foreign key named party_foreign_key in the accounts table.
+  # change_table :accounts do |t|
+  # t.remove_index :name => :party_foreign_key
+  # end
+  def remove_foreign_key(options)
+    @base.remove_foreign_key(@table_name, options)
+  end
+
+  # Deprecated
+  def references_with_foreign_keys(*args)
+    options = args.extract_options!
+
+    if fk_options = options.delete(:foreign_key)
+      p ActiveSupport::Deprecation.send(:deprecation_message, caller,
+        ":foreign_key in t.references is deprecated. " \
+        "Use t.foreign_key instead")
+    end
+
+    references_without_foreign_keys(*(args.dup << options))
+  end
+end

data/lib/pg_power/engine.rb

@@ -0,0 +1,46 @@
+module PgPower
+  # :nodoc
+  class Engine < Rails::Engine
+
+    initializer 'pg_power' do
+      ActiveSupport.on_load(:active_record) do
+        # load monkey patches
+        ['schema_dumper',
+         'connection_adapters/postgresql_adapter',
+         'connection_adapters/abstract/schema_statements'].each do |path|
+          require PgPower::Engine.root + 'lib/core_ext/active_record/' + path
+        end
+
+        ActiveRecord::SchemaDumper.class_eval do
+          include PgPower::SchemaDumper
+        end
+
+        if defined?(ActiveRecord::Migration::CommandRecorder)
+          ActiveRecord::Migration::CommandRecorder.class_eval do
+            include ::PgPower::Migration::CommandRecorder
+          end
+        end
+
+        ActiveRecord::ConnectionAdapters::Table.module_eval do
+          include PgPower::ConnectionAdapters::Table
+        end
+
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.module_eval do
+          include PgPower::ConnectionAdapters::AbstractAdapter
+        end
+
+        if defined?(ActiveRecord::ConnectionAdapters::JdbcAdapter)
+          sql_adapter_class = ActiveRecord::ConnectionAdapters::JdbcAdapter
+        else
+          sql_adapter_class = ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+        end
+
+        sql_adapter_class.class_eval do
+          include PgPower::ConnectionAdapters::PostgreSQLAdapter
+        end
+
+      end
+    end
+
+  end
+end

data/lib/pg_power/migration.rb

@@ -0,0 +1,4 @@
+module PgPower::Migration  # :nordoc:
+  extend ActiveSupport::Autoload
+  autoload :CommandRecorder
+end

data/lib/pg_power/migration/command_recorder.rb

@@ -0,0 +1,13 @@
+# Provides methods to extend {ActiveRecord::Migration::CommandRecorder} to 
+# support pg_power features.
+module PgPower::Migration::CommandRecorder
+  extend ActiveSupport::Autoload
+
+  autoload :SchemaMethods
+  autoload :CommentMethods
+  autoload :ForeignerMethods
+
+  include SchemaMethods
+  include CommentMethods
+  include ForeignerMethods
+end

data/lib/pg_power/migration/command_recorder/comment_methods.rb

@@ -0,0 +1,52 @@
+# Provides methods to extend {ActiveRecord::Migration::CommandRecorder} to
+# support comments feature.
+module  PgPower::Migration::CommandRecorder::CommentMethods
+  # :nodoc:
+  def set_table_comment(*args)
+    record(:set_table_comment, args)
+  end
+
+  # :nodoc:
+  def remove_table_comment(*args)
+    record(:remove_table_comments, args)
+  end
+
+  # :nodoc:
+  def set_column_comment(*args)
+    record(:set_column_comment, args)
+  end
+
+  # :nodoc:
+  def set_column_comments(*args)
+    record(:set_column_comments, args)
+  end
+
+  # :nodoc:
+  def remove_column_comment(*args)
+    record(:remove_column_comment, args)
+  end
+
+  # :nodoc:
+  def remove_column_comments(*args)
+    record(:remove_column_comments, args)
+  end
+
+  # :nodoc:
+  def invert_set_table_comment(args)
+    table_name = args.first
+    [:remove_table_comment, [table_name]]
+  end
+
+  # :nodoc:
+  def invert_set_column_comment(args)
+    table_name = args[0]
+    column_name = args[1]
+    [:remove_column_comment, [table_name, column_name]]
+  end
+
+  # :nodoc:
+  def invert_set_column_comments(args)
+    i_args = [args[0]] + args[1].collect{|name, value| name  }
+    [:remove_column_comments, i_args]
+  end
+end

data/lib/pg_power/migration/command_recorder/foreigner_methods.rb

@@ -0,0 +1,29 @@
+# Provides methods to extend {ActiveRecord::Migration::CommandRecorder} to
+# support foreign keys feature.
+module PgPower::Migration::CommandRecorder::ForeignerMethods
+  # :nodoc:
+  def add_foreign_key(*args)
+    record(:add_foreign_key, args)
+  end
+
+  # :nodoc:
+  def remove_foreign_key(*args)
+    record(:remove_foreign_key, args)
+  end
+
+  # :nodoc:
+  def invert_add_foreign_key(args)
+    from_table, to_table, add_options = *args
+    add_options ||= {}
+
+    if add_options[:name]
+      options = {:name => add_options[:name]}
+    elsif add_options[:column]
+      options = {:column => add_options[:column]}
+    else
+      options = to_table
+    end
+
+    [:remove_foreign_key, [from_table, options]]
+  end
+end

data/lib/pg_power/migration/command_recorder/schema_methods.rb

@@ -0,0 +1,39 @@
+# Provides methods to extend {ActiveRecord::Migration::CommandRecorder} to
+# support multi schemas feature.
+module  PgPower::Migration::CommandRecorder::SchemaMethods
+  # :nodoc:
+  def create_schema(*args)
+    record(:create_schema, args)
+  end
+
+  # :nodoc:
+  def drop_schema(*args)
+    record(:drop_schema, args)
+  end
+
+  # :nodoc:
+  def move_table_to_schema(*args)
+    record(:move_table_to_schema, args)
+  end
+
+  # :nodoc:
+  def invert_create_schema(args)
+    [:drop_schema, [args.first]]
+  end
+
+  # :nodoc:
+  def invert_drop_schema(args)
+    [:create_schema, [args.first]]
+  end
+
+  # :nodoc:
+  def invert_move_table_to_schema(args)
+    table_name     = args.first
+    current_schema = args.second
+
+    new_schema, table = ::PgPower::Tools.to_schema_and_table(table_name)
+
+    invert_args = ["#{current_schema}.#{table}", new_schema]
+    [:move_table_to_schema, invert_args]
+  end
+end

data/lib/pg_power/schema_dumper.rb

@@ -0,0 +1,21 @@
+# Provides methods to extend {ActiveRecord::SchemaDumper} to appropriately
+# build schema.rb file with schemas, foreign keys and comments on columns
+# and tables.
+module PgPower::SchemaDumper
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
+
+  autoload :CommentMethods
+  autoload :SchemaMethods
+  autoload :ForeignerMethods
+
+  include CommentMethods
+  include SchemaMethods
+  include ForeignerMethods
+
+  included do
+    alias_method_chain :tables, :schemas
+    alias_method_chain :tables, :comments
+    alias_method_chain :tables, :foreign_keys
+  end
+end

data/lib/pg_power/schema_dumper/comment_methods.rb

@@ -0,0 +1,36 @@
+# Extends ActiveRecord::SchemaDumper class to dump comments on tables and columns.
+module PgPower::SchemaDumper::CommentMethods
+  # Hooks {ActiveRecord::SchemaDumper#table} method to dump comments on
+  # table and columns.
+  def tables_with_comments(stream)
+    tables_without_comments(stream)
+
+    table_names = @connection.tables.sort
+    table_names += get_non_public_schema_table_names.sort
+
+    table_names.each do |table_name|
+      dump_comments(table_name, stream)
+    end
+  end
+
+  # Finds all comments related to passed table and writes appropriated
+  # statements to stream.
+  def dump_comments(table_name, stream)
+    unless (comments = @connection.comments(table_name)).empty?
+      comment_statements = comments.map do |row|
+        column_name = row[0]
+        comment = row[1].gsub(/'/, "\\\\'")
+        if column_name
+          "  set_column_comment '#{table_name}', '#{column_name}', '#{comment}'"
+        else
+          "  set_table_comment '#{table_name}', '#{comment}'"
+        end
+
+      end
+
+      stream.puts comment_statements.join("\n")
+      stream.puts
+    end
+  end
+  private :dump_comments
+end