activerecord-postgresql-extensions 0.2.2 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDVjMzkzNjNhYzc2MzQxNDkyZTA3MWQzM2FlZGZlZmQzYzkxMDkxNA==
+  data.tar.gz: !binary |-
+    NjMzOTZjOTFkOGE3NTQyMmU1ODg2NzJhNmQ3MzQ3NjgwNTRkNzZhNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MzEzN2MzMjg4YjYzZWI5NjIyNWJmNmNjNjc1NmZiMjNkYjZmODM5MjUyN2Iw
+    NTJjYzBkYzMxZTZjYTk3OTE2ODZhZDZmZjc5YmUxNzY2YmIxMDdjZjRiMzk1
+    YjRjZjk0NTkxMDdjN2Q5MTRkYmM3YmMxMWU4MDhkZGFhMWMxMDA=
+  data.tar.gz: !binary |-
+    ZTUyOGIwZTc5MjAwMDRlZGE4ZTI0MzI5OTk1YTM1NjM3MTVkZGJlYjA2MTA0
+    MzczY2U4NTMwNDdhZTU2MmJhNTJmMjBlYjFmZDU1NzExMDI2ZjRhZmVhNzAz
+    YWNjYmE1NWU1MzkxMDk3ZDMwYzBiMzNkZGNhZjUyMTg5OTAzN2I=

data/.gitignore

@@ -1,3 +1,6 @@
+.*.swp
+.*.swo
+*.tmp
 *.kpf
 *.komodoproject
 *~
@@ -5,6 +8,7 @@
 *tmp*
 pkg/
 doc/
+coverage/
 *.orig
 *.patch
 .vimrc_local

data/Gemfile

@@ -13,6 +13,7 @@ gem "rake", "~> 10.0"
 gem "minitest"
 gem "minitest-reporters"
 gem "guard-minitest"
+gem "simplecov"
 
 if RbConfig::CONFIG['host_os'] =~ /^darwin/
   gem "rb-fsevent"

data/Guardfile

@@ -1,9 +1,9 @@
 
-guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_tests.rb' do
+guard 'minitest', :test_folders => 'test', :test_file_patterns => '*_tests.rb', :all_on_start => false do
   watch(%r|^test/(.+)_tests\.rb|)
 
-  watch(%r|^lib/(.*)([^/]+)\.rb|) do |m|
-    "test/#{m[1]}#{m[2]}_tests.rb"
+  watch(%r|^lib/(.*/)?(.+)\.rb|) do |m|
+    "test/#{m[2]}_tests.rb"
   end
 
   watch(%r|^test/test_helper\.rb|) do

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 2167961 Ontario Inc., Zoocasa <code@zoocasa.com>
+Copyright (c) 2013 2167961 Ontario Inc., Zoocasa <code@zoocasa.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.rdoc

@@ -9,7 +9,8 @@ PostgreSQL adapter including:
   and per table.
 
 * some methods for manipulating all sorts of stuff like procedural languages,
-  functions, sequences, views, schemas and triggers.
+  functions, sequences, views, schemas, triggers, types, extensions,
+  materialized views and event triggers.
 
 * better support for creating indexes with expressions so you can use functions
   and GiST and GIN indexes.
@@ -26,8 +27,8 @@ PostgreSQL adapter including:
 
 * support for some PostGIS functionality including some support for using
   PostGIS columns in migrations. For manipulating PostGIS data, see our
-  geos-extensions gem at https://github.com/zoocasa/geos-extensions or
-  the RGeo project at https://github.com/dazuma/rgeo .
+  activerecord-spatial gem at https://github.com/zoocasa/activerecord-spatial
+  or the RGeo project at https://github.com/dazuma/rgeo .
 
 == Building db/schema.rb
 
@@ -46,3 +47,9 @@ containing the database schema in db/development_structure.sql.
 Details on this configuration option can be found here:
 
 http://guides.rubyonrails.org/configuring.html
+
+== License
+
+This gem is licensed under an MIT-style license. See the +MIT-LICENSE+ file for
+details.
+

data/lib/active_record/postgresql_extensions/adapter_extensions.rb

@@ -1,39 +1,10 @@
 
 module ActiveRecord
+  class InvalidCopyFromOptions < ActiveRecordError #:nodoc:
+  end
+
   module ConnectionAdapters
     class PostgreSQLAdapter
-      if defined?(Rails)
-        LOGGER_REGEXP = /^#{Rails.root}(?!\/vendor\/rails)/
-
-        def query_with_extra_logging(*args) #:nodoc:
-          if ActiveRecord::Base.enable_extended_logging && Rails.logger && Rails.logger.level == Logger::DEBUG
-            sql = args.first
-            unless (sql =~ /(pg_get_constraintdef|pg_attribute|pg_class)/)
-              Rails.logger.debug
-              Rails.logger.debug(caller.select { |x|
-                ActiveRecord::Base.enable_really_extended_logging || x.match(LOGGER_REGEXP)
-              }.join("\n"))
-            end
-          end
-          query_without_extra_logging(*args)
-        end
-        alias_method_chain :query, :extra_logging
-
-        def execute_with_extra_logging(*args) #:nodoc:
-          if ActiveRecord::Base.enable_extended_logging && Rails.logger && Rails.logger.level == Logger::DEBUG
-            sql = args.first
-            unless (sql =~ /(pg_get_constraintdef|pg_attribute|pg_class)/)
-              Rails.logger.debug
-              Rails.logger.debug(caller.select { |x|
-                ActiveRecord::Base.enable_really_extended_logging || x.match(LOGGER_REGEXP)
-              }.join("\n"))
-            end
-          end
-          execute_without_extra_logging(*args)
-        end
-        alias_method_chain :execute, :extra_logging
-      end
-
       # with_schema is kind of like with_scope. It wraps various
       # object names in SQL statements into a PostgreSQL schema. You
       # can have multiple with_schemas wrapped around each other, and
@@ -301,16 +272,27 @@ module ActiveRecord
       # * <tt>:not_null</tt> - allows you to specify one or more columns
       #   to be inserted with a default value rather than NULL for any
       #   missing values.
+      # * <tt>:freeze</tt> - a performance enhancement added in PostgreSQL 9.3.
+      #   See the PostgreSQL documentation for details.
+      # * <tt>:encoding</tt> - set the encoding of the input. Available in
+      #   PostgreSQL 9.1+.
       #
-      # ==== Local Server Files vs. Local Client Files
+      # ==== Local Server Files vs. Local Client Files vs. PROGRAM
       #
-      # The copy_from_file method allows you to import rows from a file
+      # The copy_from method allows you to import rows from a file
       # that exists on either your client's file system or on the
       # database server's file system using the <tt>:local</tt> option.
       #
+      # PostgreSQL 9.3 additionally introduced the PROGRAM option to COPY
+      # FROM that allows you to pipe the output of a shell command to
+      # STDIN. This option requires that the COPY FROM command be run from on
+      # the server and as such may be limited by server restrictions such as
+      # access controls and permissions.
+      #
       # To process a file on the remote database server's file system:
       #
-      # * the file must be given as an absolute path;
+      # * the file must be given as an absolute path or as a valid shell
+      #   command if using the PROGRAM option;
       # * must be readable by the user that the actual PostgreSQL
       #   database server runs under; and
       # * the COPY FROM command itself can only be performed by database
@@ -336,27 +318,33 @@ module ActiveRecord
       #   exists on the file system accessible to the database server,
       #   something that you may not even have access to in the first
       #   place.
-      def copy_from_file(table_name, file, options = {})
+      def copy_from(table_name, file, options = {})
         options = {
           :local => true
         }.merge(options)
 
-        sql = "COPY #{quote_table_name(table_name)} "
+        assert_valid_copy_from_options(options)
+
+        sql = "COPY #{quote_table_name(table_name)}"
 
         unless options[:columns].blank?
-          sql << '(' << Array(options[:columns]).collect { |c| quote_column_name(c) }.join(', ') << ')'
+          sql << ' (' << Array.wrap(options[:columns]).collect { |c| quote_column_name(c) }.join(', ') << ')'
         end
 
-        if options[:local]
+        if options[:program]
+          sql << " FROM PROGRAM #{quote(file)}"
+        elsif options[:local]
           sql << " FROM STDIN"
         else
           sql << " FROM #{quote(file)}"
         end
 
+        sql << ' FREEZE' if options[:freeze]
         sql << ' BINARY' if options[:binary]
         sql << ' OIDS' if options[:oids]
         sql << " DELIMITER AS #{quote(options[:delimiter])}" if options[:delimiter]
         sql << " NULL AS #{quote(options[:null_as])}" if options[:null]
+        sql << " ENCODING #{quote(options[:encoding])}" if options[:encoding]
 
         if options[:csv]
           sql << ' CSV'
@@ -364,25 +352,39 @@ module ActiveRecord
             sql << ' HEADER' if options[:csv][:header]
             sql << " QUOTE AS #{quote(options[:csv][:quote])}" if options[:csv][:quote]
             sql << " ESCAPE AS #{quote(options[:csv][:escape])}" if options[:csv][:escape]
-            sql << ' FORCE NOT NULL ' << Array(options[:csv][:not_null]).collect do |c|
+            sql << ' FORCE NOT NULL ' << Array.wrap(options[:csv][:not_null]).collect do |c|
               quote_column_name(c)
             end.join(', ') if options[:csv][:not_null]
           end
         end
 
-        execute sql
+        sql << ';'
+
+        if options[:program] || !options[:local]
+          execute sql
+        else
+          fp = File.open(file, 'r')
 
-        if options[:local]
-          File.open(file, 'r').each do |l|
-            self.raw_connection.put_copy_data(l)
+          if self.raw_connection.respond_to?(:copy_data)
+            self.raw_connection.copy_data(sql) do
+              fp.each do |l|
+                self.raw_connection.put_copy_data(l)
+              end
+            end
+          else
+            execute sql
+            fp.each do |l|
+              self.raw_connection.put_copy_data(l)
+            end
+            self.raw_connection.put_copy_end
           end
-          self.raw_connection.put_copy_end
         end
       end
+      alias :copy_from_file :copy_from
 
       # Returns an Array of database views.
       def views(name = nil)
-        query(<<-SQL, name).map { |row| row[0] }
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL), name).map { |row| row[0] }
           SELECT viewname
           FROM pg_views
           WHERE schemaname = ANY (current_schemas(false))
@@ -403,7 +405,7 @@ module ActiveRecord
           schema = nil
         end
 
-        query(<<-SQL).first[0].to_i > 0
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL)).first[0].to_i > 0
           SELECT COUNT(*)
           FROM pg_views
           WHERE viewname = '#{view.gsub(/(^"|"$)/,'')}'
@@ -412,7 +414,7 @@ module ActiveRecord
       end
 
       def roles(name = nil)
-        query(<<-SQL, name).map { |row| row[0] }
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL), name).map { |row| row[0] }
           SELECT rolname
           FROM pg_roles
         SQL
@@ -450,7 +452,7 @@ module ActiveRecord
 
       # Returns an Array of tables to ignore.
       def ignored_tables(name = nil)
-        query(<<-SQL, name).map { |row| row[0] }
+        query(PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL), name).map { |row| row[0] }
           SELECT tablename
           FROM pg_tables
           WHERE schemaname IN ('pg_catalog');
@@ -506,7 +508,7 @@ module ActiveRecord
           'ALL'
         end
 
-        Array(triggers).each do |trigger|
+        Array.wrap(triggers).each do |trigger|
           execute("ALTER TABLE #{quoted_table_name} ENABLE TRIGGER #{trigger};")
         end
       end
@@ -523,7 +525,7 @@ module ActiveRecord
           'ALL'
         end
 
-        Array(triggers).each do |trigger|
+        Array.wrap(triggers).each do |trigger|
           execute("ALTER TABLE #{quoted_table_name} DISABLE TRIGGER #{trigger};")
         end
       end
@@ -542,7 +544,7 @@ module ActiveRecord
       # contains the table being referenced, the foreign key and the
       # name of the column in the referenced table.
       def foreign_keys(table_name, name = nil)
-        sql = <<-SQL
+        sql = PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL)
           SELECT
             confrelid::regclass AS referenced_table_name,
             a.attname AS foreign_key,
@@ -600,7 +602,7 @@ module ActiveRecord
       # particular Array contains the referencing table, the foreign key
       # and the name of the column in the referenced table.
       def referenced_foreign_keys(table_name, name = nil)
-        sql = <<-SQL
+        sql = PostgreSQLExtensions::Utils.strip_heredoc(<<-SQL)
           SELECT
             c2.relname AS table_name,
             a.attname AS foreign_key,
@@ -656,6 +658,36 @@ module ActiveRecord
         end
       end
 
+      # Run the CLUSTER command on all previously clustered tables available
+      # to be clustered by the current user.
+      #
+      # ==== Options
+      #
+      # * <tt>:verbose</tt> - Adds the VERBOSE clause.
+      def cluster_all(options = {})
+        sql = 'CLUSTER'
+        sql << ' VERBOSE' if options[:verbose]
+
+        execute "#{sql};"
+      end
+
+      # Cluster a table or materialized view on an index.
+      #
+      # ==== Options
+      #
+      # * <tt>:using</tt> - adds a USING clause to cluster on. If no
+      #   <tt>:using</tt> option is provided, the object itself will be
+      #   re-clustered.
+      # * <tt>:verbose</tt> - Adds the VERBOSE clause.
+      def cluster(name, options = {})
+        sql = 'CLUSTER '
+        sql << 'VERBOSE ' if options[:verbose]
+        sql << quote_table_name(name)
+        sql << " USING #{quote_generic(options[:using])}" if options[:using]
+
+        execute "#{sql};"
+      end
+
       def add_column_options_with_expression!(sql, options) #:nodoc:
         if options_include_default?(options) &&
           options[:default].is_a?(Hash) &&
@@ -688,6 +720,21 @@ module ActiveRecord
         end
       end
       alias_method_chain :change_column_null, :expression
+
+      private
+        def assert_valid_copy_from_options(options)
+          if options[:program] && !ActiveRecord::PostgreSQLExtensions::Features.copy_from_program?
+            raise InvalidCopyFromOptions.new("The :program option is only available in PostgreSQL 9.3+.")
+          end
+
+          if options[:freeze] && !ActiveRecord::PostgreSQLExtensions::Features.copy_from_freeze?
+            raise InvalidCopyFromOptions.new("The :freeze option is only available in PostgreSQL 9.3+.")
+          end
+
+          if options[:encoding] && !ActiveRecord::PostgreSQLExtensions::Features.copy_from_encoding?
+            raise InvalidCopyFromOptions.new("The :encoding option is only available in PostgreSQL 9.1+.")
+          end
+        end
     end
 
     class PostgreSQLColumn
@@ -742,10 +789,3 @@ module ActiveRecord
   end
 end
 
-ActiveRecord::Base.class_eval do
-  # Enable extended query logging
-  cattr_accessor :enable_extended_logging
-
-  # Enable REALLY extended query logging
-  cattr_accessor :enable_really_extended_logging
-end

data/lib/active_record/postgresql_extensions/constraints.rb

@@ -21,12 +21,6 @@ module ActiveRecord
     end
   end
 
-  class InvalidConstraintDependencyAction < ActiveRecordError #:nodoc:
-    def initialize(option)
-      super("Invalid constraint dependency action - #{option}")
-    end
-  end
-
   module ConnectionAdapters
     class PostgreSQLAdapter
       # Adds a CHECK constraint to the table. See
@@ -94,6 +88,8 @@ module ActiveRecord
     # This is a base class for other PostgreSQL constraint classes. It
     # isn't really meant to be used directly.
     class PostgreSQLConstraint
+      include ActiveRecord::PostgreSQLExtensions::Utils
+
       attr_accessor :base, :options
 
       def initialize(base, options) #:nodoc:
@@ -129,7 +125,7 @@ module ActiveRecord
 
         def storage_parameters
           if options[:index_parameters] || options[:storage_parameters]
-            " WITH (#{options[:index_parameters] || options[:storage_parameters]})"
+            " WITH (#{options_from_hash_or_string(options[:index_parameters] || options[:storage_parameters])})"
           else
             ''
           end
@@ -395,8 +391,8 @@ module ActiveRecord
     # * <tt>:name</tt> - specifies a name for the constraint.
     # * <tt>:storage_parameters</tt> - PostgreSQL allows you to add a
     #   couple of additional parameters to indexes to govern disk usage and
-    #   such. This option is a simple String that lets you insert these
-    #   options as necessary. See the PostgreSQL documentation on index
+    #   such. This option is a simple String or a Hash that lets you insert
+    #   these options as necessary. See the PostgreSQL documentation on index
     #   storage parameters for details. <tt>:index_parameters</tt> can also
     #   be used.
     # * <tt>:tablespace</tt> - allows you to specify a tablespace for the
@@ -424,7 +420,7 @@ module ActiveRecord
 
       def to_sql #:nodoc:
         sql = "#{constraint_name}UNIQUE ("
-        sql << Array(columns).collect { |c| base.quote_column_name(c) }.join(', ')
+        sql << Array.wrap(columns).collect { |c| base.quote_column_name(c) }.join(', ')
         sql << ")"
         sql << storage_parameters
         sql << using_tablespace
@@ -601,9 +597,9 @@ module ActiveRecord
           end
 
           sql << "#{constraint_name}FOREIGN KEY ("
-          sql << Array(columns).collect { |c| base.quote_column_name(c) }.join(', ')
+          sql << Array.wrap(columns).collect { |c| base.quote_column_name(c) }.join(', ')
           sql << ") REFERENCES #{base.quote_table_name(table)}"
-          sql << ' (%s)' % Array(ref_columns).collect { |c| base.quote_column_name(c) }.join(', ') if ref_columns
+          sql << ' (%s)' % Array.wrap(ref_columns).collect { |c| base.quote_column_name(c) }.join(', ') if ref_columns
           sql << " MATCH #{options[:match].to_s.upcase}" if options[:match]
           sql << " ON DELETE #{options[:on_delete].to_s.gsub(/_/, ' ').upcase}" if options[:on_delete]
           sql << " ON UPDATE #{options[:on_update].to_s.gsub(/_/, ' ').upcase}" if options[:on_update]
@@ -691,8 +687,8 @@ module ActiveRecord
     #   default which is <tt>:btree</tt>. See the PostgreSQL docs for details.
     # * <tt>:storage_parameters</tt> - PostgreSQL allows you to add a
     #   couple of additional parameters to indexes to govern disk usage and
-    #   such. This option is a simple String that lets you insert these
-    #   options as necessary. See the PostgreSQL documentation on index
+    #   such. This option is a simple String or a Hash that lets you insert
+    #   these options as necessary. See the PostgreSQL documentation on index
     #   storage parameters for details. <tt>:index_parameters</tt> can also
     #   be used.
     # * <tt>:tablespace</tt> - allows you to specify a tablespace for the
@@ -830,8 +826,8 @@ module ActiveRecord
     # * <tt>:name</tt> - specifies a name for the constraint.
     # * <tt>:storage_parameters</tt> - PostgreSQL allows you to add a
     #   couple of additional parameters to indexes to govern disk usage and
-    #   such. This option is a simple String that lets you insert these
-    #   options as necessary. See the PostgreSQL documentation on index
+    #   such. This option is a simple String or a Hash that lets you insert
+    #   these options as necessary. See the PostgreSQL documentation on index
     #   storage parameters for details. <tt>:index_parameters</tt> can also
     #   be used.
     # * <tt>:tablespace</tt> - allows you to specify a tablespace for the
@@ -855,7 +851,7 @@ module ActiveRecord
       def to_sql #:nodoc:
         sql = String.new
         sql << "#{constraint_name}PRIMARY KEY "
-        sql << "(" << Array(columns).collect { |column|
+        sql << "(" << Array.wrap(columns).collect { |column|
           base.quote_column_name(column)
         }.join(', ')
         sql << ")"