activerecord-postgis-adapter 0.4.1 → 0.4.2

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 0.4.2 / 2012-04-12
+
+* Support the db:structure:load rake task in recent versions of Rails.
+* Support installing PostGIS via the PostgreSQL extension mechanism (requires at least PostGIS 2.0 and PostgreSQL 9.1).
+* Support bounding boxes in queries (useful for "window" queries such as finding objects to display in a map region).
+* Fix some issues determine the correct default value for spatial columns.
+
 === 0.4.1 / 2012-02-22
 
 * Some compatibility fixes for Rails 3.2. (Reported by Ryan Williams with implementation help from Radek Paviensky.)

data/README.rdoc

@@ -98,11 +98,23 @@ You can also use WKT:
 
   rec = MySpatialTable.where(:latlon => 'POINT(-122 47)').first
 
-The adapter also provides experimental support for more complex queries
-such as radius searches. However, these extensions require Arel 2.1
-(which is scheduled for release with Rails 3.1). We do not have these
-documented yet, and the syntax is subject to change. For now, you should
-write more complex queries in SQL.
+Most more complex spatial queries require the use of SQL functions. You
+can write such queries in raw SQL, but you may find the "squeel" gem
+very helpful in this regard. Using squeel, you can write queries like
+the following:
+
+  my_polygon = get_my_polygon()
+  MySpatialTable.where{st_intersects(latlon, my_polygon)}.first
+
+One common query is to find all objects displaying in a window. This can
+be done using the overlap (&&) operator with a bounding box, as follows:
+
+  sw = get_sw_corner()
+  ne = get_ne_corner()
+  window = RGeo::Cartesian::BoundingBox.create_from_points(sw, ne)
+  MySpatialTable.where{latlon.op('&&', window)}.all
+
+Note that using squeel to create SQL functions requires Rails 3.1 or later.
 
 == Installation And Configuration
 
@@ -116,8 +128,8 @@ This adapter has the following requirements:
 * pg gem 0.11 or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
   Should be compatible with Rails versions through 3.2.x.
-* rgeo gem 0.3.4 or later.
-* rgeo-activerecord gem 0.4.3 or later.
+* rgeo gem 0.3.10 or later.
+* rgeo-activerecord gem 0.4.4 or later.
 
 Install this adapter as a gem:
 
@@ -153,15 +165,27 @@ Besides the adapter name "postgis", most of the other database connection
 configuration parameters are the same as for the stock postgresql adapter.
 However, there are several important differences:
 
+The <i>postgis_extension</i> parameter is specific to the PostGIS adapter,
+and directs the adapter to use PostgreSQL's CREATE EXTENSION mechanism to
+install the PostGIS types, functions, and tables to a newly created
+database. Generally, the value should be set to true, although you can
+also set it to a comma-delimited list of extension names (which should
+include the base "postgis" extension) if you want to customize which
+extensions are installed. This is the easiest and cleanest way to create
+a PostGIS-enabled database, but it requires PostgreSQL 9.1 or later and
+PostGIS 2.0 or later.
+
 The <i>script_dir</i> parameter is specific to the PostGIS adapter, and
-provides the path to the directory containing the SQL scripts for PostGIS
-installation. This directory should contain the files <tt>postgis.sql</tt>
-and <tt>spatial_ref_sys.sql</tt>. (A common setting for this directory
-might be <tt>/usr/local/share/contrib/postgis-1.5</tt>.) It is used by
-<tt>rake db:create</tt> to add the PostGIS types, functions, and tables to
-a newly created database. If you do not provide this parameter, you will
-need to add these objects to the database manually.
-Generally, therefore, this parameter is required at least for the test
+provides an alternative mechanism for installing the PostGIS definitions
+into a new database if either PostgreSQL 9.1 or PostGIS 2.0 is not
+available. Its value should be set to the path to the directory containing
+the SQL scripts for PostGIS installation. This is the directory containing
+the files <tt>postgis.sql</tt> and <tt>spatial_ref_sys.sql</tt>. (A common
+setting might be <tt>/usr/local/share/contrib/postgis-1.5</tt>.)
+
+If you do not provide <i>postgis_extension</i> or <i>script_dir</i>, you
+will need to add the PostGIS definitions to the database manually.
+Generally, therefore, one of them is required at least for the test
 database, which is usually automatically created by the rake tasks.
 
 The <i>su_username</i> and <i>su_password</i> parameters are provided as
@@ -200,10 +224,10 @@ are managing a database using Rails and \ActiveRecord. For example:
 
 To deal with these issues, we recommend the following technique:
 
-* Set <i>script_dir</i> in both your development and test database
-  configurations. This will cause the PostGIS Adapter to automatically
-  add the PostGIS definitions and spatial references to your databases
-  when rake db:create is run.
+* Set either <i>postgis_extension</i> or <i>script_dir</i> in both your
+  development and test database configurations. This will cause the
+  PostGIS Adapter to automatically add the PostGIS definitions and
+  spatial references to your databases when rake db:create is run.
 * Include "postgis" in your <i>schema_search_path</i> for both your
   development and test databases. It is recommended that you include it
   as the <i>last</i> element, so that your application's tables don't get
@@ -226,7 +250,7 @@ Finally, you generally should _not_ set the \ActiveRecord schema format
 to <tt>:sql</tt>. You should leave it set to <tt>:ruby</tt>. The reason
 is that SQL structure dumps do not currently properly emit the correct
 <tt>AddGeometryColumn</tt> calls to create geometry columns. As a result,
-the <tt>geometry_columns</tt> table will not be properly populated, among
+the <tt>geometry_columns</tt> table will not be populated properly, among
 other issues. Instead, the schema.rb output by the Ruby schema format
 should properly replicate the schema. This is a known issue that we are
 investigating.
@@ -251,6 +275,9 @@ current known issues.
   on a SQL dump to be an accurate representation of the schema. (That is,
   you should not set <tt>config.active_record.schema_format</tt> to
   <tt>:sql</tt>.)
+* Other rake tasks may not be supported. Unfortunately, Rails makes it
+  difficult for custom \ActiveRecord adapters to support the standard
+  rake tasks.
 
 === Development and support
 
@@ -280,7 +307,7 @@ source gave us a head start on the implementation.
 
 === License
 
-Copyright 2010-2011 Daniel Azuma
+Copyright 2010-2012 Daniel Azuma
 
 All rights reserved.
 

data/Version

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/active_record/connection_adapters/postgis_adapter/databases.rake

@@ -71,7 +71,7 @@ def create_database(config_)
         conn_.execute("CREATE SCHEMA #{schema_}#{auth_}") unless schema_.downcase == 'public'
       end
 
-      # Define the postgis stuff, if the script_dir is provided.
+      # Install postgis definitions into the database.
       # Note: a superuser is required to run the postgis definitions.
       # If a separate superuser is provided, we need to grant privileges on
       # the postgis definitions over to the regular user afterwards.
@@ -79,11 +79,23 @@ def create_database(config_)
       # If "postgis" is present in the search path, use it.
       # Otherwise, use the last schema in the search path.
       # If no search path is given, use "public".
-      if (script_dir_ = config_['script_dir'])
+      script_dir_ = config_['script_dir']
+      postgis_extension_ = config_['postgis_extension']
+      if script_dir_ || postgis_extension_
         postgis_schema_ = search_path_.include?('postgis') ? 'postgis' : (search_path_.last || 'public')
-        conn_.execute("SET search_path TO #{postgis_schema_}")
-        conn_.execute(::File.read(::File.expand_path('postgis.sql', script_dir_)))
-        conn_.execute(::File.read(::File.expand_path('spatial_ref_sys.sql', script_dir_)))
+        if script_dir_
+          # Use script_dir (for postgresql < 9.1 or postgis < 2.0)
+          conn_.execute("SET search_path TO #{postgis_schema_}")
+          conn_.execute(::File.read(::File.expand_path('postgis.sql', script_dir_)))
+          conn_.execute(::File.read(::File.expand_path('spatial_ref_sys.sql', script_dir_)))
+        elsif postgis_extension_
+          # Use postgis_extension (for postgresql >= 9.1 and postgis >= 2.0)
+          postgis_extension_ = 'postgis' if postgis_extension_ == true
+          postgis_extension_ = postgis_extension_.to_s.split(',') unless postgis_extension_.is_a?(::Array)
+          postgis_extension_.each do |extname_|
+            conn_.execute("CREATE EXTENSION #{extname_} SCHEMA #{postgis_schema_}")
+          end
+        end
         if has_su_
           conn_.execute("GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{postgis_schema_} TO #{username_}")
           conn_.execute("GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA #{postgis_schema_} TO #{username_}")
@@ -122,16 +134,26 @@ end
   ::ENV['PGHOST'] = config_["host"] if config_["host"]
   ::ENV['PGPORT'] = config_["port"].to_s if config_["port"]
   ::ENV['PGPASSWORD'] = config_["password"].to_s if config_["password"]
+  filename_ = ::File.join(::Rails.root, "db/#{::Rails.env}_structure.sql")
   search_path_ = config_["schema_search_path"].to_s.strip
   search_path_ = search_path_.split(",").map{ |sp_| sp_.strip }
   search_path_.delete('postgis')
   search_path_ = ['public'] if search_path_.length == 0
   search_path_ = search_path_.map{ |sp_| "--schema=#{sp_}" }.join(" ")
-  `pg_dump -i -U "#{config_["username"]}" -s -x -O -f db/#{::Rails.env}_structure.sql #{search_path_} #{config_["database"]}`
+  `pg_dump -i -U "#{config_["username"]}" -s -x -O -f #{filename_} #{search_path_} #{config_["database"]}`
   raise "Error dumping database" if $?.exitstatus == 1
 end
 
 
+::RGeo::ActiveRecord::TaskHacker.modify('db:structure:load', nil, 'postgis') do |config_|
+  ::ENV['PGHOST'] = config_["host"] if config_["host"]
+  ::ENV['PGPORT'] = config_["port"].to_s if config_["port"]
+  ::ENV['PGPASSWORD'] = config_["password"].to_s if config_["password"]
+  filename_ = ::File.join(::Rails.root, "db/#{::Rails.env}_structure.sql")
+  `psql -f #{filename_} #{config_["database"]}`
+end
+
+
 ::RGeo::ActiveRecord::TaskHacker.modify('db:test:clone_structure', 'test', 'postgis') do |config_|
   ::ENV['PGHOST'] = config_["host"] if config_["host"]
   ::ENV['PGPORT'] = config_["port"].to_s if config_["port"]

data/lib/active_record/connection_adapters/postgis_adapter/main_adapter.rb

@@ -98,6 +98,8 @@ module ActiveRecord
         def quote(value_, column_=nil)
           if ::RGeo::Feature::Geometry.check_type(value_)
             "'#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true, :type_format => :ewkb, :emit_ewkb_srid => true).generate(value_)}'"
+          elsif value_.is_a?(::RGeo::Cartesian::BoundingBox)
+            "'#{value_.min_x},#{value_.min_y},#{value_.max_x},#{value_.max_y}'::box"
           else
             super
           end
@@ -118,9 +120,9 @@ module ActiveRecord
           # We needed to return a spatial column subclass.
           table_name_ = table_name_.to_s
           spatial_info_ = spatial_column_info(table_name_)
-          column_definitions(table_name_).collect do |name_, type_, default_, notnull_|
-            SpatialColumn.new(@rgeo_factory_settings, table_name_, name_, default_, type_,
-              notnull_ == 'f', type_ =~ /geometry/i ? spatial_info_[name_] : nil)
+          column_definitions(table_name_).collect do |col_name_, type_, default_, notnull_|
+            SpatialColumn.new(@rgeo_factory_settings, table_name_, col_name_, default_, type_,
+              notnull_ == 'f', type_ =~ /geometry/i ? spatial_info_[col_name_] : nil)
           end
         end
 

data/lib/active_record/connection_adapters/postgis_adapter/spatial_column.rb

@@ -52,7 +52,6 @@ module ActiveRecord
         def initialize(factory_settings_, table_name_, name_, default_, sql_type_=nil, null_=true, opts_=nil)
           @factory_settings = factory_settings_
           @table_name = table_name_
-          super(name_, default_, sql_type_, null_)
           @geographic = sql_type_ =~ /geography/i ? true : false
           if opts_
             # This case comes from an entry in the geometry_columns table
@@ -79,7 +78,7 @@ module ActiveRecord
                 end
               end
             end
-          elsif type == :spatial
+          elsif sql_type_ =~ /geography|geometry|point|linestring|polygon/i
             # Just in case there is a geometry column with no geometry_columns entry.
             @geometric_type = ::RGeo::Feature::Geometry
             @srid = @has_z = @has_m = nil
@@ -87,6 +86,7 @@ module ActiveRecord
             # Non-spatial column
             @geometric_type = @has_z = @has_m = @srid = nil
           end
+          super(name_, default_, sql_type_, null_)
           if type == :spatial
             if @srid
               @limit = {:srid => @srid, :type => @geometric_type.type_name.underscore}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgis-adapter
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-23 00:00:00.000000000 Z
+date: 2012-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo-activerecord
-  requirement: &2155891880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *2155891880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2155890820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: 0.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155890820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 description: This is an ActiveRecord connection adapter for PostGIS. It is based on
   the stock PostgreSQL adapter, but provides built-in support for the spatial extensions
   provided by PostGIS. It uses the RGeo library to represent spatial data in Ruby.
@@ -78,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: virtuoso
-rubygems_version: 1.8.17
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: An ActiveRecord adapter for PostGIS, based on RGeo.