activerecord-postgresql-extensions 0.2.2 → 0.3.0

data/lib/active_record/postgresql_extensions/rules.rb

@@ -53,6 +53,11 @@ module ActiveRecord
       def drop_rule(name, table)
         execute "DROP RULE #{quote_rule(name)} ON #{quote_table_name(table)};"
       end
+
+      # Renames a rule. Available in PostgreSQL 9.3+.
+      def rename_rule(old_name, table, new_name)
+        execute "ALTER RULE #{quote_rule(old_name)} ON #{quote_table_name(table)} RENAME TO #{quote_rule(new_name)};"
+      end
     end
 
     # Creates a PostgreSQL rule.

data/lib/active_record/postgresql_extensions/schemas.rb

@@ -15,8 +15,18 @@ module ActiveRecord
       # * <tt>:authorization</tt> - adds an AUTHORIZATION clause. This is
       #   used to set the owner of the schema. This can be changed with
       #   alter_schema_owner as necessary.
+      # * <tt>:if_not_exists</tt> - adds an IF NOT EXISTS clause. Available
+      #   in PostgreSQL 9.3+.
       def create_schema(schema, options = {})
-        sql = "CREATE SCHEMA #{quote_schema(schema)}"
+        sql = 'CREATE SCHEMA '
+
+        if options.key?(:if_not_exists)
+          ActiveRecord::PostgreSQLExtensions::Features.check_feature(:create_schema_if_not_exists)
+
+          sql << 'IF NOT EXISTS ' if options[:if_not_exists]
+        end
+
+        sql << quote_schema(schema)
         sql << " AUTHORIZATION #{quote_role(options[:authorization])}" if options[:authorization]
         execute("#{sql};")
       end
@@ -27,10 +37,13 @@ module ActiveRecord
       #
       # * <tt>:if_exists</tt> - adds IF EXISTS.
       # * <tt>:cascade</tt> - adds CASCADE.
-      def drop_schema(schemas, options = {})
+      def drop_schema(*args)
+        options = args.extract_options!
+        args.flatten!
+
         sql = 'DROP SCHEMA '
         sql << 'IF EXISTS ' if options[:if_exists]
-        sql << Array(schemas).collect { |s| quote_schema(s) }.join(', ')
+        sql << Array.wrap(args).collect { |s| quote_schema(s) }.join(', ')
         sql << ' CASCADE' if options[:cascade]
         execute("#{sql};")
       end
@@ -44,6 +57,29 @@ module ActiveRecord
       def alter_schema_owner(schema, role)
         execute("ALTER SCHEMA #{quote_schema(schema)} OWNER TO #{quote_role(role)};")
       end
+
+      # Creates a schema based on a role name. This is a shortcut to using
+      # <tt>create_schema</tt> with the <tt>:authorization</tt> option and
+      # ensures that the schema created has the same name as the role
+      # specified.
+      #
+      # ==== Options
+      #
+      # * <tt>:if_not_exists</tt> - adds IF NOT EXISTS. Available in PostgreSQL
+      #   9.3+.
+      def create_schema_authorization(name, options = {})
+        sql = 'CREATE SCHEMA'
+
+        if options.key?(:if_not_exists)
+          ActiveRecord::PostgreSQLExtensions::Features.check_feature(:create_schema_if_not_exists)
+
+          sql << ' IF NOT EXISTS' if options[:if_not_exists]
+        end
+
+        sql << " AUTHORIZATION #{quote_role(name)}"
+
+        execute("#{sql};")
+      end
     end
   end
 end

data/lib/active_record/postgresql_extensions/sequences.rb

@@ -63,10 +63,13 @@ module ActiveRecord
       # * <tt>:if_exists</tt> - adds IF EXISTS.
       # * <tt>:cascade</tt> - cascades the operation down to objects
       #   referring to the sequence.
-      def drop_sequence(name, options = {})
+      def drop_sequence(*args)
+        options = args.extract_options!
+        args.flatten!
+
         sql = 'DROP SEQUENCE '
         sql << 'IF EXISTS ' if options[:if_exists]
-        sql << Array(name).collect { |s| quote_sequence(s) }.join(', ')
+        sql << Array.wrap(args).collect { |s| quote_sequence(s) }.join(', ')
         sql << ' CASCADE' if options[:cascade]
         execute("#{sql};")
       end
@@ -116,7 +119,7 @@ module ActiveRecord
 
       # Returns an Array of available sequences.
       def sequences(name = nil)
-        query(<<-SQL, name).map { |row| row[0] }
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL), name).map { |row| row[0] }
           SELECT c.relname AS sequencename
           FROM pg_class c
           WHERE c.relkind = 'S'::"char";

data/lib/active_record/postgresql_extensions/tables.rb

@@ -51,6 +51,9 @@ module ActiveRecord
       # * <tt>:of_type</tt> - for "OF type_name" clauses.
       # * <tt>:if_not_exists</tt> - adds the "IF NOT EXISTS" clause.
       # * <tt>:unlogged</tt> - creates an UNLOGGED table.
+      # * <tt>:storage_parameters</tt> - a simple String or Hash used to
+      #   assign table storage parameters. See the PostgreSQL docs for
+      #   details on the various storage parameters available.
       #
       # We're expanding the doors of table definition perception with
       # this exciting new addition to the world of ActiveRecord
@@ -112,7 +115,7 @@ module ActiveRecord
         execute table_definition.to_s
         unless table_definition.post_processing.blank?
           table_definition.post_processing.each do |pp|
-            execute pp
+            execute pp.to_s
           end
         end
       end
@@ -130,10 +133,13 @@ module ActiveRecord
       #   dropped as well. See the PostgreSQL documentation for details.
       #
       # You can still access the original method via original_drop_table.
-      def drop_table(tables, options = {})
+      def drop_table(*args)
+        options = args.extract_options!
+        args.flatten!
+
         sql = 'DROP TABLE '
         sql << 'IF EXISTS ' if options[:if_exists]
-        sql << Array(tables).collect { |t| quote_table_name(t) }.join(', ')
+        sql << Array.wrap(args).collect { |t| quote_table_name(t) }.join(', ')
         sql << ' CASCADE' if options[:cascade]
         execute("#{sql};")
       end
@@ -172,10 +178,9 @@ module ActiveRecord
     # been created. See the source code for PostgreSQLAdapter#create_table
     # and PostgreSQLTableDefinition#geometry for an example of its use.
     class PostgreSQLTableDefinition < TableDefinition
-      attr_accessor :base, :table_name, :options, :post_processing
+      attr_accessor :base, :table_name, :options
 
       def initialize(base, table_name, options = {}) #:nodoc:
-        @table_constraints = Array.new
         @table_name, @options = table_name, options
         super(base)
       end
@@ -193,6 +198,12 @@ module ActiveRecord
           end
         end
 
+        if options.key?(:if_not_exists)
+          ActiveRecord::PostgreSQLExtensions::Features.check_feature(:create_table_if_not_exists)
+        elsif options.key?(:unlogged)
+          ActiveRecord::PostgreSQLExtensions::Features.check_feature(:create_table_unlogged)
+        end
+
         unless options[:id] == false
           self.primary_key(options[:primary_key] || Base.get_primary_key(table_name))
 
@@ -213,7 +224,7 @@ module ActiveRecord
           ary << @columns.collect(&:to_sql)
           ary << @like if defined?(@like) && @like
         end
-        ary << @table_constraints unless @table_constraints.empty?
+        ary << table_constraints unless table_constraints.empty?
 
         unless ary.empty?
           sql << " (\n  "
@@ -221,7 +232,8 @@ module ActiveRecord
           sql << "\n)"
         end
 
-        sql << "\nINHERITS (" << Array(options[:inherits]).collect { |i| base.quote_table_name(i) }.join(', ') << ')' if options[:inherits]
+        sql << "\nINHERITS (" << Array.wrap(options[:inherits]).collect { |i| base.quote_table_name(i) }.join(', ') << ')' if options[:inherits]
+        sql << "\nWITH (#{ActiveRecord::PostgreSQLExtensions::Utils.options_from_hash_or_string(options[:storage_parameters], base)})" if options[:storage_parameters].present?
         sql << "\nON COMMIT #{options[:on_commit].to_s.upcase.gsub(/_/, ' ')}" if options[:on_commit]
         sql << "\n#{options[:options]}" if options[:options]
         sql << "\nTABLESPACE #{base.quote_tablespace(options[:tablespace])}" if options[:tablespace]
@@ -253,11 +265,11 @@ module ActiveRecord
         @like = "LIKE #{@base.quote_table_name(parent_table)}"
 
         if options[:including]
-          @like << Array(options[:including]).collect { |l| " INCLUDING #{l.to_s.upcase}" }.join
+          @like << Array.wrap(options[:including]).collect { |l| " INCLUDING #{l.to_s.upcase}" }.join
         end
 
         if options[:excluding]
-          @like << Array(options[:excluding]).collect { |l| " EXCLUDING #{l.to_s.upcase}" }.join
+          @like << Array.wrap(options[:excluding]).collect { |l| " EXCLUDING #{l.to_s.upcase}" }.join
         end
         @like
       end
@@ -265,29 +277,29 @@ module ActiveRecord
       # Add a CHECK constraint to the table. See
       # PostgreSQLCheckConstraint for more details.
       def check_constraint(expression, options = {})
-        @table_constraints << PostgreSQLCheckConstraint.new(@base, expression, options)
+        table_constraints << PostgreSQLCheckConstraint.new(@base, expression, options)
       end
 
       # Add a UNIQUE constraint to the table. See
       # PostgreSQLUniqueConstraint for more details.
       def unique_constraint(columns, options = {})
-        @table_constraints << PostgreSQLUniqueConstraint.new(@base, columns, options)
+        table_constraints << PostgreSQLUniqueConstraint.new(@base, columns, options)
       end
 
       # Add a FOREIGN KEY constraint to the table. See
       # PostgreSQLForeignKeyConstraint for more details.
       def foreign_key(columns, ref_table, *args)
-        @table_constraints << PostgreSQLForeignKeyConstraint.new(@base, columns, ref_table, *args)
+        table_constraints << PostgreSQLForeignKeyConstraint.new(@base, columns, ref_table, *args)
       end
 
       # Add an EXCLUDE constraint to the table. See PostgreSQLExcludeConstraint
       # for more details.
       def exclude(excludes, options = {})
-        @table_constraints << PostgreSQLExcludeConstraint.new(@base, table_name, excludes, options)
+        table_constraints << PostgreSQLExcludeConstraint.new(@base, table_name, excludes, options)
       end
 
       def primary_key_constraint(columns, options = {})
-        @table_constraints << PostgreSQLPrimaryKeyConstraint.new(@base, columns, options)
+        table_constraints << PostgreSQLPrimaryKeyConstraint.new(@base, columns, options)
       end
 
       def column_with_constraints(name, type, *args) #:nodoc:
@@ -305,7 +317,7 @@ module ActiveRecord
             check
           end
 
-          @table_constraints << check.collect do |c|
+          table_constraints << check.collect do |c|
             if c.is_a?(Hash)
               PostgreSQLCheckConstraint.new(@base, c.delete(:expression), c)
             else
@@ -321,7 +333,7 @@ module ActiveRecord
             [ references, {} ]
           end
 
-          @table_constraints << PostgreSQLForeignKeyConstraint.new(
+          table_constraints << PostgreSQLForeignKeyConstraint.new(
             @base,
             name,
             ref_table,
@@ -333,26 +345,42 @@ module ActiveRecord
           unless unique.is_a?(Hash)
             unique = {}
           end
-          @table_constraints << PostgreSQLUniqueConstraint.new(@base, name, unique)
+          table_constraints << PostgreSQLUniqueConstraint.new(@base, name, unique)
         end
 
         if primary_key
           unless primary_key.is_a?(Hash)
             primary_key = {}
           end
-          @table_constraints << PostgreSQLPrimaryKeyConstraint.new(@base, name, primary_key)
+          table_constraints << PostgreSQLPrimaryKeyConstraint.new(@base, name, primary_key)
         end
 
         self
       end
       alias_method_chain :column, :constraints
 
+      # Add an INDEX to the table. This INDEX will be added during post
+      # processing after the table has been created. See
+      # PostgreSQLIndexDefinition for more details.
+      def index(name, columns, options = {})
+        post_processing << PostgreSQLIndexDefinition.new(@base, name, self.table_name, columns, options)
+      end
+
+      # Add statements to execute to after a table has been created.
+      def post_processing
+        @post_processing ||= []
+      end
+
       private
         LIKE_TYPES = %w{ defaults constraints indexes }.freeze
 
+        def table_constraints
+          @table_constraints ||= []
+        end
+
         def assert_valid_like_types(likes) #:nodoc:
           unless likes.blank?
-            check_likes = Array(likes).collect(&:to_s) - LIKE_TYPES
+            check_likes = Array.wrap(likes).collect(&:to_s) - LIKE_TYPES
             if !check_likes.empty?
               raise ActiveRecord::InvalidLikeTypes.new(check_likes)
             end

data/lib/active_record/postgresql_extensions/tablespaces.rb

@@ -76,7 +76,7 @@ module ActiveRecord
 
         def assert_valid_tablespace_parameter(parameter)
           if !TABLESPACE_PARAMETERS.include? parameter.to_s.downcase
-            raise ActiveRecord::InvalidTablespaceParameter.new(option)
+            raise ActiveRecord::InvalidTablespaceParameter.new(parameter)
           end
         end
     end

data/lib/active_record/postgresql_extensions/text_search.rb

@@ -54,13 +54,13 @@ module ActiveRecord
         add_or_alter = options[:action].to_s.upcase
 
         sql = "ALTER TEXT SEARCH CONFIGURATION #{quote_generic_with_schema(name)} #{add_or_alter} MAPPING FOR "
-        sql << Array(tokens).collect { |token|
+        sql << Array.wrap(tokens).collect { |token|
           quote_generic(token)
         }.join(', ')
 
         sql << ' WITH '
 
-        sql << Array(dictionaries).collect { |dictionary|
+        sql << Array.wrap(dictionaries).collect { |dictionary|
           quote_generic(dictionary)
         }.join(', ')
 
@@ -80,7 +80,7 @@ module ActiveRecord
         end
 
         sql = "ALTER TEXT SEARCH CONFIGURATION #{quote_generic_with_schema(name)} ALTER MAPPING FOR "
-        sql << Array(mappings).collect { |token_type|
+        sql << Array.wrap(mappings).collect { |token_type|
           quote_generic(token_type)
         }.join(', ')
         sql << " REPLACE #{quote_generic(old_dictionary)} WITH #{quote_generic(new_dictionary)}"

data/lib/active_record/postgresql_extensions/triggers.rb

@@ -117,8 +117,8 @@ module ActiveRecord
 
       def to_sql #:nodoc:
         sql = "CREATE TRIGGER #{base.quote_generic(name)} #{called.to_s.upcase} "
-        sql << Array(events).collect { |e| e.to_s.upcase }.join(' OR ')
-        sql << " OF " << Array(options[:of]).collect { |o| base.quote_generic(o) }.join(', ') if options[:of].present?
+        sql << Array.wrap(events).collect { |e| e.to_s.upcase }.join(' OR ')
+        sql << " OF " << Array.wrap(options[:of]).collect { |o| base.quote_generic(o) }.join(', ') if options[:of].present?
         sql << " ON #{base.quote_table_name(table)}"
         sql << " FOR EACH #{options[:for_each].to_s.upcase}" if options[:for_each]
         sql << " EXECUTE PROCEDURE #{base.quote_function(function)}(#{options[:args]})"
@@ -138,7 +138,7 @@ module ActiveRecord
         end
 
         def assert_valid_events(events) #:nodoc:
-          check_events = Array(events).collect(&:to_s) - EVENT_TYPES
+          check_events = Array.wrap(events).collect(&:to_s) - EVENT_TYPES
           if !check_events.empty?
             raise ActiveRecord::InvalidTriggerEvent.new(check_events)
           end

data/lib/active_record/postgresql_extensions/types.rb

@@ -2,16 +2,119 @@
 require 'active_record/connection_adapters/postgresql_adapter'
 
 module ActiveRecord
+  class InvalidAddEnumValueOptions < ActiveRecordError #:nodoc:
+  end
+
   module ConnectionAdapters
     class PostgreSQLAdapter
       # Returns an Array of available languages.
       def types(name = nil)
-        query(%{SELECT typname FROM pg_type;}, name).map { |row| row[0] }
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL), name).map(&:first)
+          SELECT t.typname as type
+            FROM pg_type t
+            LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+            WHERE (t.typrelid = 0 OR (
+              SELECT c.relkind = 'c'
+                FROM pg_catalog.pg_class c
+                WHERE c.oid = t.typrelid
+            )) AND
+              NOT EXISTS(
+                SELECT 1
+                  FROM pg_catalog.pg_type el
+                  WHERE el.oid = t.typelem
+                    AND el.typarray = t.oid
+              ) AND
+              n.nspname NOT IN ('information_schema');
+        SQL
       end
 
       def type_exists?(name)
         types.include?(name.to_s)
       end
+
+      # Creates an ENUM TYPE. An ENUM can contain zero or more values. ENUMs
+      # can be dropped with #drop_type.
+      def create_enum(name, *values)
+        execute PostgreSQLEnumDefinition.new(self, name, *values).to_s
+      end
+
+      # Adds a new value to an ENUM.
+      #
+      # ==== Options
+      #
+      # * <tt>:before</tt> - add the new value before this value.
+      # * <tt>:after</tt> - add the new value after this value.
+      # * <tt>:if_not_exists</tt> - adds the value if it doesn't already
+      #   exist. Available in PostgreSQL 9.3+.
+      def add_enum_value(enum, value, options = {})
+        assert_valid_add_enum_value_options(options)
+
+        sql = "ALTER TYPE #{quote_generic(enum)} ADD VALUE"
+
+        if options.key?(:if_not_exists)
+          ActiveRecord::PostgreSQLExtensions::Features.check_feature(:type_if_not_exists)
+
+          sql << " IF NOT EXISTS" if options[:if_not_exists]
+        end
+
+        sql << " #{quote(value)}"
+
+        if options[:before]
+          sql << " BEFORE #{quote(options[:before])}"
+        elsif options[:after]
+          sql << " AFTER #{quote(options[:after])}"
+        end
+
+        execute("#{sql};")
+      end
+
+      # Drop TYPEs.
+      #
+      # ==== Options
+      #
+      # * <tt>:if_exists</tt> - adds IF EXISTS.
+      # * <tt>:cascade</tt> - adds CASCADE.
+      def drop_type(*args)
+        options = args.extract_options!
+        args.flatten!
+
+        sql = 'DROP TYPE '
+        sql << 'IF EXISTS ' if options[:if_exists]
+        sql << Array.wrap(args).collect { |i| quote_generic(i) }.join(', ')
+        sql << ' CASCADE' if options[:cascade]
+        execute("#{sql};")
+      end
+
+      # Returns an Array of possible
+      def enum_values(name)
+        query(%{SELECT unnest(enum_range(NULL::#{quote_generic(name)}))}, 'Enum values').map(&:first)
+      end
+
+      private
+        def assert_valid_add_enum_value_options(options)
+          if options[:before] && options[:after]
+            raise InvalidAddEnumValueOptions.new("Can't use both :before and :after options together")
+          end
+        end
+    end
+  end
+
+  # Creates a PostgreSQL enum type definition. This class isn't really meant
+  # to be used directly. Instead, see PostgreSQLAdapter#create_enum for
+  # usage.
+  class PostgreSQLEnumDefinition
+    attr_accessor :base, :name, :values
+
+    def initialize(base, name, *values)
+      @base, @name, @values = base, name, values.flatten
+    end
+
+    def to_sql #:nodoc:
+      sql = "CREATE TYPE #{base.quote_generic(name)} AS ENUM ("
+      sql << values.collect { |t| base.quote(t.to_s) }.join(', ')
+      sql << ")"
+      "#{sql};"
     end
+    alias :to_s :to_sql
   end
 end