activerecord-postgresql-extensions 0.0.12 → 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.kpf
+*.komodoproject
+*~
+.DS_Store
+*tmp*
+pkg/
+doc/
+*.orig
+*.patch
+.vimrc_local
+debug.log
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+test/local_database.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 2167961 Ontario Inc., Zoocasa <code@zoocasa.com>
+Copyright (c) 2012 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

@@ -12,7 +12,7 @@ PostgreSQL adapter including:
   functions, sequences, views, schemas and triggers.
 
 * better support for creating indexes with expressions so you can use functions
-  and GIST and GIN indexes.
+  and GiST and GIN indexes.
 
 * support for manipulating role privileges.
 
@@ -20,10 +20,15 @@ PostgreSQL adapter including:
   creating tables.
 
 * support for automatically detecting foreign key relationships and building
-  ActiveRecord associations accordingly. This associations can be overriden
+  ActiveRecord associations accordingly. This associations can be overridden
   as necessary and are sane enough that they won't try to overwrite existing
   associations.
 
+* 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 .
+
 == First Public Release Notice!
 
 This is the first public release of this gem, so while it has been kind to us

data/Rakefile

@@ -8,6 +8,7 @@ gem 'rdoc', '~> 3.12'
 require 'rubygems/package_task'
 require 'rake/testtask'
 require 'rdoc/task'
+require 'bundler/gem_tasks'
 
 if RUBY_VERSION >= '1.9'
   begin
@@ -19,27 +20,13 @@ end
 
 $:.push 'lib'
 
-version = File.read('VERSION') rescue ''
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "activerecord-postgresql-extensions"
-    gem.summary = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
-    gem.description = gem.summary
-    gem.email = "code@zoocasa.com"
-    gem.homepage = "http://github.com/zoocasa/activerecord-postgresql-extensions"
-    gem.authors =    [ "J Smith" ]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+version = ActiveRecord::PostgreSQLExtensions::VERSION
 
 desc 'Test PostgreSQL extensions'
 Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_tests.rb']
-  t.verbose = false
+  t.verbose = !!ENV['VERBOSE_TESTS']
+  t.warning = !!ENV['WARNINGS']
 end
 
 desc 'Build docs'

data/activerecord-postgresql-extensions.gemspec

@@ -1,76 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
+require File.expand_path('../lib/active_record/postgresql_extensions/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name = "activerecord-postgresql-extensions"
-  s.version = "0.0.12"
+  s.version = ActiveRecord::PostgreSQLExtensions::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["J Smith"]
-  s.date = "2012-03-22"
   s.description = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
+  s.summary = s.description
   s.email = "code@zoocasa.com"
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
-  s.files = [
-    "MIT-LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "activerecord-postgresql-extensions.gemspec",
-    "lib/activerecord-postgresql-extensions.rb",
-    "lib/postgresql_extensions/foreign_key_associations.rb",
-    "lib/postgresql_extensions/postgresql_adapter_extensions.rb",
-    "lib/postgresql_extensions/postgresql_constraints.rb",
-    "lib/postgresql_extensions/postgresql_extensions.rb",
-    "lib/postgresql_extensions/postgresql_functions.rb",
-    "lib/postgresql_extensions/postgresql_geometry.rb",
-    "lib/postgresql_extensions/postgresql_indexes.rb",
-    "lib/postgresql_extensions/postgresql_languages.rb",
-    "lib/postgresql_extensions/postgresql_permissions.rb",
-    "lib/postgresql_extensions/postgresql_roles.rb",
-    "lib/postgresql_extensions/postgresql_rules.rb",
-    "lib/postgresql_extensions/postgresql_schemas.rb",
-    "lib/postgresql_extensions/postgresql_sequences.rb",
-    "lib/postgresql_extensions/postgresql_tables.rb",
-    "lib/postgresql_extensions/postgresql_tablespaces.rb",
-    "lib/postgresql_extensions/postgresql_text_search.rb",
-    "lib/postgresql_extensions/postgresql_triggers.rb",
-    "lib/postgresql_extensions/postgresql_types.rb",
-    "lib/postgresql_extensions/postgresql_views.rb",
-    "test/adapter_tests.rb",
-    "test/constraints_tests.rb",
-    "test/extensions_tests.rb",
-    "test/functions_tests.rb",
-    "test/geometry_tests.rb",
-    "test/index_tests.rb",
-    "test/languages_tests.rb",
-    "test/permissions_tests.rb",
-    "test/roles_tests.rb",
-    "test/rules_tests.rb",
-    "test/schemas_tests.rb",
-    "test/sequences_tests.rb",
-    "test/tables_tests.rb",
-    "test/tablespace_tests.rb",
-    "test/test_helper.rb",
-    "test/text_search_tests.rb",
-    "test/trigger_tests.rb"
-  ]
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
   s.homepage = "http://github.com/zoocasa/activerecord-postgresql-extensions"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
-  s.summary = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
+  s.add_dependency("activerecord", [">= 2.3"])
+  if RUBY_PLATFORM == "java"
+    s.add_dependency("activerecord-jdbcpostgresql-adapter")
   else
+    s.add_dependency("pg")
   end
+  s.add_dependency("rdoc")
+  s.add_dependency("rake", ["~> 0.9"])
 end
 

data/lib/{postgresql_extensions/postgresql_adapter_extensions.rb → active_record/postgresql_extensions/adapter_extensions.rb}

@@ -1,12 +1,13 @@
 
 module ActiveRecord
   module ConnectionAdapters
-    class PostgreSQLAdapter < AbstractAdapter
+    class PostgreSQLAdapter
       if defined?(Rails)
         LOGGER_REGEXP = /^#{Rails.root}(?!\/vendor\/rails)/
 
-        def query_with_extra_logging(sql, name = nil) #:nodoc:
+        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|
@@ -14,12 +15,13 @@ module ActiveRecord
               }.join("\n"))
             end
           end
-          query_without_extra_logging(sql, name)
+          query_without_extra_logging(*args)
         end
         alias_method_chain :query, :extra_logging
 
-        def execute_with_extra_logging(sql, name = nil) #:nodoc:
+        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|
@@ -27,29 +29,11 @@ module ActiveRecord
               }.join("\n"))
             end
           end
-          execute_without_extra_logging(sql, name)
+          execute_without_extra_logging(*args)
         end
         alias_method_chain :execute, :extra_logging
       end
 
-      # There seems to be a bug in ActiveRecord where it isn't setting
-      # the schema search path properly because it's using ',' as a
-      # separator rather than /,\s+/.
-      def schema_search_path_with_fix_csv=(schema_csv)
-        if schema_csv
-          csv = schema_csv.gsub(/,\s+/, ',')
-          execute "SET search_path TO #{csv}"
-          @schema_search_path = csv
-        end
-      end
-      alias_method_chain :schema_search_path=, :fix_csv
-
-      # Fix ActiveRecord bug when grabbing the current search_path.
-      def schema_search_path_with_fix_csv
-        @schema_search_path ||= query('SHOW search_path')[0][0].gsub(/,\s+/, ',')
-      end
-      alias_method_chain :schema_search_path, :fix_csv
-
       # 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
@@ -82,7 +66,7 @@ module ActiveRecord
       #
       #   with_schema :geospatial do
       #     create_table(:test) do |t|
-      #       ignore_schema do
+      #       ignore_scoped_schema do
       #         t.integer(
       #           :ref_id,
       #           :references => {
@@ -106,11 +90,11 @@ module ActiveRecord
       # Here we see that we used the geospatial schema when naming the
       # test table and dropped back to not specifying a schema when
       # setting up the foreign key to the refs table. If we had not
-      # used ignore_schema, the foreign key would have been defined
+      # used ignore_scoped_schema, the foreign key would have been defined
       # thusly:
       #
       #   FOREIGN KEY ("ref_id") REFERENCES "geospatial"."refs" ("id")
-      def ignore_schema
+      def ignore_scoped_schema
         with_schema nil do
           yield
         end
@@ -124,18 +108,24 @@ module ActiveRecord
       end
 
       # Get the current scoped schema.
-      def current_schema
+      def current_scoped_schema
         scoped_schemas.last
       end
 
       # A generic quoting method for PostgreSQL.
-      def quote_generic(g)
-        PGconn.quote_ident(g.to_s)
+      if RUBY_PLATFORM == 'java'
+        def quote_generic(g)
+          quote_column_name(g)
+        end
+      else
+        def quote_generic(g)
+          PGconn.quote_ident(g.to_s)
+        end
       end
 
       # A generic quoting method for PostgreSQL that specifically ignores
       # any and all schemas.
-      def quote_generic_ignore_schema(g)
+      def quote_generic_ignore_scoped_schema(g)
         if g.is_a?(Hash)
           quote_generic g.values.first
         else
@@ -149,8 +139,8 @@ module ActiveRecord
         if g.is_a?(Hash)
           "#{quote_schema(g.keys.first)}.#{quote_generic(g.values.first)}"
         else
-          if current_schema
-            quote_schema(current_schema) << '.'
+          if current_scoped_schema
+            quote_schema(current_scoped_schema) << '.'
           end.to_s << quote_generic(g)
         end
       end
@@ -215,13 +205,13 @@ module ActiveRecord
       #   # => "geospatial"."epois"
       #
       #   with_schema(:geospatial) do
-      #     ignore_schema do
+      #     ignore_scoped_schema do
       #       quote_table_name(:epois)
       #     end
       #   end
       #   # => "epois"
       def quote_table_name_with_schemas(name)
-        if current_schema || name.is_a?(Hash)
+        if current_scoped_schema || name.is_a?(Hash)
           quote_generic_with_schema(name)
         else
           quote_table_name_without_schemas(name)
@@ -472,15 +462,21 @@ module ActiveRecord
       end
       alias_method_chain :tables, :views
 
-      def schema_search_path_with_csv_fix=(schema_csv) #:nodoc:
-        self.schema_search_path_without_csv_fix = schema_csv.gsub(/, /, ',') if schema_csv
-      end
-      alias_method_chain :schema_search_path=, :csv_fix
+      unless RUBY_PLATFORM == "java"
+        # There seems to be a bug in ActiveRecord where it isn't setting
+        # the schema search path properly because it's using ',' as a
+        # separator rather than /,\s+/.
+        def schema_search_path_with_csv_fix=(schema_csv) #:nodoc:
+          self.schema_search_path_without_csv_fix = schema_csv.gsub(/,\s+/, ',') if schema_csv
+        end
+        alias_method_chain :schema_search_path=, :csv_fix
 
-      def schema_search_path_with_csv_fix #:nodoc:
-        @schema_search_path ||= query('SHOW search_path;')[0][0].gsub(/, /, ',')
+        # Fix ActiveRecord bug when grabbing the current search_path.
+        def schema_search_path_with_csv_fix
+          @schema_search_path ||= query('SHOW search_path;')[0][0].gsub(/,\s+/, ',')
+        end
+        alias_method_chain :schema_search_path, :csv_fix
       end
-      alias_method_chain :schema_search_path, :csv_fix
 
       def disable_referential_integrity_with_views #:nodoc:
         if supports_disable_referential_integrity? then
@@ -682,11 +678,13 @@ module ActiveRecord
       alias_method_chain :change_column_default, :expression
     end
 
-    class PostgreSQLColumn < Column
+    class PostgreSQLColumn
       def simplified_type_with_additional_types(field_type)
         case field_type
           when 'geometry'
             :geometry
+          when 'geography'
+            :geography
           when 'tsvector'
             :tsvector
           else
@@ -707,8 +705,8 @@ module ActiveRecord
         }
       end
 
-      def ignore_schema
-        self.connection.ignore_schema { |*block_args|
+      def ignore_scoped_schema
+        self.connection.ignore_scoped_schema { |*block_args|
           yield(*block_args)
         }
       end
@@ -717,8 +715,8 @@ module ActiveRecord
         self.connection.scope_schemas
       end
 
-      def current_schema
-        self.connection.current_schema
+      def current_scoped_schema
+        self.connection.current_scoped_schema
       end
 
       def sequence_exists?

data/lib/{postgresql_extensions/postgresql_constraints.rb → active_record/postgresql_extensions/constraints.rb}

@@ -1,4 +1,7 @@
 
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'active_record/postgresql_extensions/utils'
+
 module ActiveRecord
   class InvalidForeignKeyAction < ActiveRecordError #:nodoc:
     def initialize(action)
@@ -25,7 +28,7 @@ module ActiveRecord
   end
 
   module ConnectionAdapters
-    class PostgreSQLAdapter < AbstractAdapter
+    class PostgreSQLAdapter
       # Adds a CHECK constraint to the table. See
       # PostgreSQLCheckConstraint for usage.
       def add_check_constraint(table, expression, options = {})
@@ -50,8 +53,16 @@ module ActiveRecord
         execute("#{sql};")
       end
 
+      # Adds an EXCLUDE constraint to the table. See
+      # PostgreSQLExcludeConstraint for details.
+      def add_exclude_constraint(table, excludes, options = {})
+        sql = "ALTER TABLE #{quote_table_name(table)} ADD "
+        sql << PostgreSQLExcludeConstraint.new(self, table, excludes, options).to_s
+        execute("#{sql};")
+      end
+
       # Drops a constraint from the table. Use this to drop CHECK,
-      # UNIQUE and FOREIGN KEY constraints from a table.
+      # UNIQUE, EXCLUDE and FOREIGN KEY constraints from a table.
       #
       # Options:
       #
@@ -304,7 +315,7 @@ module ActiveRecord
     # PostgreSQLAdapter#create_index method similarly. The create_index
     # method adds a couple of PostgreSQL-specific options if you need them.
     #
-    # ==== Examples:
+    # ==== Examples
     #
     #   # using the constraint method:
     #   add_unique_constraint(:foo, [ :fancy_id, :another_fancy_id ])
@@ -335,7 +346,8 @@ module ActiveRecord
     #   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
-    #   storage parameters for details.
+    #   storage parameters for details. <tt>:index_parameters</tt> can also
+    #   be used.
     # * <tt>:tablespace</tt> - allows you to specify a tablespace for the
     #   unique index being created. See the PostgreSQL documentation on
     #   tablespaces for details.
@@ -363,7 +375,7 @@ module ActiveRecord
         sql = "#{constraint_name}UNIQUE ("
         sql << Array(columns).collect { |c| base.quote_column_name(c) }.join(', ')
         sql << ")"
-        sql << " WITH (#{options[:storage_parameters]})" if options[:storage_parameters]
+        sql << " WITH (#{options[:storage_parameters] || options[:index_parameters]})" if options[:storage_parameters] || options[:index_parameters]
         sql << " USING INDEX TABLESPACE #{base.quote_tablespace(options[:tablespace])}" if options[:tablespace]
         sql
       end
@@ -470,13 +482,13 @@ module ActiveRecord
     # You can also create new FOREIGN KEY constraints outside of a table
     # definition using PostgreSQLAdapter#add_foreign_key.
     #
-    # ==== Examples:
+    # ==== Examples
     #
     #   add_foreign_key(:foo, :bar_id, :bar)
-    #   # => ALTER TABLE "funk" ADD FOREIGN KEY ("bar_id") REFERENCES "bar";
+    #   # => ALTER TABLE "foo" ADD FOREIGN KEY ("bar_id") REFERENCES "bar";
     #
     #   add_foreign_key(:foo, :bar_id, :bar, :id)
-    #   # => ALTER TABLE "funk" ADD FOREIGN KEY ("bar_id") REFERENCES "bar"("id");
+    #   # => ALTER TABLE "foo" ADD FOREIGN KEY ("bar_id") REFERENCES "bar"("id");
     #
     #   add_foreign_key(:foo, [ :bar_id, :blort_id ], :bar, [ :id, :blort_id ],
     #     :name => 'my_fk', :match => :simple
@@ -505,7 +517,7 @@ module ActiveRecord
     # the <tt>:deferrable</tt>, <tt>:match</tt>, <tt>:on_delete</tt>
     # and <tt>:on_update</tt> options.
     #
-    # === Dropping CHECK Constraints
+    # === Dropping FOREIGN KEY Constraints
     #
     # Like all PostgreSQL constraints, you can use
     # PostgreSQLAdapter#drop_constraint to remove a constraint from a
@@ -522,7 +534,7 @@ module ActiveRecord
         assert_valid_action(options[:on_update]) if options[:on_update]
         assert_valid_deferrable_option(options[:deferrable])
         @columns, @ref_table, @ref_columns = columns, ref_table, ref_columns
-        @schema = base.current_schema
+        @schema = base.current_scoped_schema
         super(base, options)
       end
 
@@ -564,5 +576,104 @@ module ActiveRecord
           end
         end
     end
+
+    # Creates EXCLUDE constraints for PostgreSQL tables and columns.
+    #
+    # This class is meant to be used by PostgreSQL column and table
+    # definition and manipulation methods. There are two ways to create
+    # a EXCLUDE constraint:
+    #
+    # * on a table definition
+    # * when altering a table
+    #
+    # In both cases, a Hash or an Array of Hashes should be used to set the
+    # EXCLUDE constraint checks. The Hash(es) should be in the format
+    # <tt>{ :element => ..., :with => ... }</tt>, where <tt>:element</tt> is
+    # a column name or expression and <tt>:with</tt> is the operator to
+    # compare against. The key <tt>:operator</tt> is an alias for <tt>:where</tt>.
+    #
+    # === Table Definition
+    #
+    # EXCLUDE constraints can also be applied to the table directly
+    # rather than on a column definition.
+    #
+    # ==== Example:
+    #
+    # The following example produces the same result as above:
+    #
+    #   create_table('foo') do |t|
+    #     t.integer :blort
+    #     t.exclude({
+    #       :element => 'length(blort)',
+    #       :with => '='
+    #     }, {
+    #       :name => 'exclude_blort_length'
+    #     })
+    #   end
+    #
+    #   # Produces:
+    #   #
+    #   # CREATE TABLE "foo" (
+    #   #   "id" serial primary key,
+    #   #   "blort" text,
+    #   #   CONSTRAINT "exclude_blort_length" EXCLUDE (length(blort) WITH =)
+    #   # );
+    #
+    # === Table Manipulation
+    #
+    # You can also create new EXCLUDE constraints outside of a table
+    # definition using PostgreSQLAdapter#add_exclude_constraint.
+    #
+    # ==== Examples
+    #
+    #   add_exclude_constraint(:foo, { :element => :bar_id, :with => '=' })
+    #   # => ALTER TABLE "foo" ADD EXCLUDE ("bar_id" WITH =);
+    #
+    # === Options for EXCLUDE Constraints
+    #
+    # * <tt>:using</tt> - sets the index type to be used. Usually this will
+    #   <tt>:gist</tt>, but the default is left blank to allow for the PostgreSQL
+    #   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
+    #   storage parameters for details. <tt>:index_parameters</tt> can also
+    #   be used.
+    # * <tt>:tablespace</tt> - allows you to specify a tablespace for the
+    #   index being created. See the PostgreSQL documentation on
+    #   tablespaces for details.
+    # * <tt>:conditions</tt> - sets the WHERE conditions for the EXCLUDE
+    #   constraint. You can also use the <tt>:where</tt> option.
+    #
+    # === Dropping EXCLUDE Constraints
+    #
+    # Like all PostgreSQL constraints, you can use
+    # PostgreSQLAdapter#drop_constraint to remove a constraint from a
+    # table.
+    class PostgreSQLExcludeConstraint < PostgreSQLConstraint
+      attr_accessor :excludes
+
+      def initialize(base, table, excludes, options = {}) #:nodoc:
+        @excludes = ActiveRecord::PostgreSQLExtensions::Utils.hash_or_array_of_hashes(excludes)
+
+        super(base, options)
+      end
+
+      def to_sql #:nodoc:
+        sql = String.new
+        sql << "#{constraint_name}EXCLUDE "
+        sql << "USING #{base.quote_column_name(options[:using])} " if options[:using]
+        sql << "(" << excludes.collect { |e|
+          "#{e[:element]} WITH #{e[:with] || e[:operator]}"
+        }.join(', ')
+        sql << ")"
+        sql << " WITH (#{options[:index_parameters] || options[:storage_parameters]})" if options[:index_parameters] || options[:storage_parameters]
+        sql << " USING INDEX TABLESPACE #{base.quote_tablespace(options[:tablespace])}" if options[:tablespace]
+        sql << " WHERE (#{options[:conditions] || options[:where]})" if options[:conditions] || options[:where]
+        sql
+      end
+      alias :to_s :to_sql
+    end
   end
 end