dr-postgis_adapter 0.8.1

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in postgis_adapter.gemspec
+gemspec
+
+platforms :jruby do
+  gem 'activerecord-jdbcpostgresql-adapter', :git => 'git://github.com/dryade/activerecord-jdbc-adapter.git'
+  gem 'jruby-openssl'
+end
+
+platforms :ruby do    
+  gem 'pg', '~> 0.11.0' 
+end
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "rcov", ">= 0"
+  gem "autotest"
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GIT
+  remote: git://github.com/dryade/activerecord-jdbc-adapter.git
+  revision: 0bf424bc3bcaf9f44646976cc4c1a8e9e57f11b4
+  specs:
+    activerecord-jdbc-adapter (1.2.2)
+    activerecord-jdbcpostgresql-adapter (1.2.2)
+      activerecord-jdbc-adapter (~> 1.2.2)
+      jdbc-postgres (>= 9.0, < 9.2)
+
+PATH
+  remote: .
+  specs:
+    dr-postgis_adapter (0.8.1)
+      nofxx-georuby
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    bouncy-castle-java (1.5.0146.1)
+    diff-lcs (1.1.2)
+    jdbc-postgres (9.0.801)
+    jruby-openssl (0.7.7)
+      bouncy-castle-java (>= 1.5.0146.1)
+    nofxx-georuby (1.9.2)
+    pg (0.11.0)
+    rake (10.0.4)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activerecord-jdbcpostgresql-adapter!
+  autotest
+  dr-postgis_adapter!
+  jruby-openssl
+  pg (~> 0.11.0)
+  rcov
+  rspec (~> 2.3.0)

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-12-10
+
+* 1 major enhancement
+
+  * Birthday!
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Spatial Adapter Copyright (c) 2006 Guilhem Vellut <guilhem.vellut+georuby@gmail.com>
+PostGis Adapter Functions (c) 2008 Marcos Piccinini <nofxx>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,380 @@
+= PostgisAdapter
+
+A plugin for ActiveRecord which manages the PostGIS geometric columns
+in a transparent way (that is like the other base data type columns).
+It also provides a way to manage these columns in migrations.
+
+This fork adds handy methods to make geometrical calculations on postgis.
+Based on http://georuby.rubyforge.org Spatial Adapter
+
+RDocs - http://docs.github.com/nofxx/postgis_adapter
+Postgis Online reference - http://postgis.refractions.net
+Postgis Manual - http://postgis.refractions.net/documentation/manual-svn
+
+
+== Install
+
+If you are using Spatial Adapter, *remove it first*.
+
+    gem install postgis_adapter
+
+
+=== Dependencies
+
+- georuby gem
+- postgres 8.3+
+- postgis  1.3+
+
+
+=== Rails 3+
+
+Add dependency to Gemfile:
+
+    gem "postgis_adapter"
+
+
+Or, to use latest from repository:
+
+    gem "postgis_adapter", :git => 'git://github.com/nofxx/postgis_adapter.git'
+
+
+=== Rails 2
+
+    gem install postgis_adapter -v 0.7.8
+
+
+== How to Use
+
+Geometric columns in your ActiveRecord models now appear just like
+any other column of other basic data types. They can also be dumped
+in ruby schema mode and loaded in migrations the same way as columns
+of basic types.
+
+
+=== Example App
+
+Simple rails app to demonstrate, check it out:
+
+http://github.com/nofxx/postgis_example
+
+
+=== Model
+
+    class TablePoint < ActiveRecord::Base
+    end
+
+That was easy! As you see, there is no need to declare a column as geometric.
+The plugin will get this information by itself.
+
+Here is an example of PostGIS row creation and access, using the
+model and the table defined above :
+
+        pt = TablePoint.new(:data => "Hello!",:geom => Point.from_x_y(1,2))
+        pt.save
+        pt = TablePoint.first
+        puts pt.geom.x
+        => 1
+
+
+== PostGIS Functions
+
+Here are this fork additions. To use it:
+
+    acts_as_geom [column_name] => [geom_type]
+
+
+Examples:
+
+    class POI < ActiveRecord::Base
+      acts_as_geom :geom => :point
+    end
+
+    class Street < ActiveRecord::Base
+      acts_as_geom :line => :line_string
+    end
+
+    ...
+
+
+
+== Play!
+
+    @place  =   Poi.new(    :geom  =>  Point.from_x_y(10,20)    )
+    @park   =   Park.new(   :area  =>  **Polygon**     )
+    @street =   Street.new( :line  => **LineString**   )
+
+    @place.inside?(@park)
+    => true
+
+    @place.in_bounds?(@park, 0.5) # margin
+    => false
+
+    @place.outside?(@park)
+    @street.crosses?(@park)
+    @area.contains?(@place)
+    ...
+
+
+=== Polygons:
+
+    @park.area
+    => 1345
+
+    @park.contains?(@point)
+    => true
+
+    @park.overlaps?(@other_park)
+    => false
+
+Supports transform (useful to transform SRID to UTM for area in Km^2)
+
+    @park.area(SRID)
+    => Area with new SRID
+
+
+=== LineStrings:
+
+    @street_east.intersects?(@street_west)
+    => false
+
+    @street_central.length
+    => 4508.53636
+
+    @street.length_spheroid
+    => 4.40853636
+
+
+=== Class Methods
+
+    City.close_to(@point)
+    => [Array of cities in order by distance...
+
+    Street.close_to(@point)
+    => [Array streets in order by distance...
+
+    Country.contain(@point)
+    => The Conutry that contains the point
+
+    Area.contains(@point)
+    => [Array of areas contains the point...
+
+
+=== BBox Support
+
+    @area.strictly_left_of? @point
+
+    @area.overlaps_or_above? @street
+
+    ...
+
+    completely_contained_by?
+    completely_contains?
+    overlaps_or_above?
+    overlaps_or_below?
+    overlaps_or_left_of?
+    overlaps_or_right_of?
+    strictly_above?
+    strictly_below?
+    strictly_left_of?
+    strictly_right_of?
+    interacts_with?
+    binary_equal?
+    same_as?
+
+
+Or use a (almost) PostGIS like notation:
+
+    @area.bbox "<<", @point
+
+    @area.bbox "|>>", @point
+
+    @area.bbox "@",  @park
+
+
+=== Warning
+
+*To be fixed:*
+
+This only supports one geom column per model. Still looking for the best way to
+implement a multi geom.
+
+http://nofxx.lighthouseapp.com/projects/20712/tickets/3-multiple-geoms-in-model
+
+
+=== Find_by
+
+find_by_*column* has been redefined when column is of a geometric type.
+Instead of using the Rails default '=' operator, for which I can't see
+a definition for MySql spatial datatypes and which performs a bounding
+box equality test in PostGIS, it uses a bounding box intersection:
+&& in PostGIS and MBRIntersects in MySQL, which can both make use
+of a spatial index if one is present to speed up the queries.
+You could use this query, for example, if you need to display data
+from the database: You would want only the geometries which are in
+the screen rectangle and you could use a bounding box query for that.
+Since this is a common case, it is the default. You have 2 ways to use
+the find_by_*geom_column*: Either by passing a geometric object directly,
+or passing an array with the 2 opposite corners of a bounding box
+(with 2 or 3 coordinates depending of the dimension of the data).
+
+        Park.find_by_geom(LineString.from_coordinates([[1.4,5.6],[2.7,8.9],[1.6,5.6]]))
+
+  or
+
+        Park.find_by_geom([[3,5.6],[19.98,5.9]])
+
+In PostGIS, since you can only use operations with geometries with the same SRID, you can add a third element representing the SRID of the bounding box to the array. It is by default set to -1:
+
+        Park.find_by_geom([[3,5.6],[19.98,5.9],123])
+
+
+
+== Database Tools
+
+=== Migrations
+
+Here is an example of code for the creation of a table with a
+geometric column in PostGIS, along with the addition of a spatial
+index on the column :
+
+    ActiveRecord::Schema.define do
+      create_table :places do |t|
+        t.string   :name
+        t.point    :geom, :srid => 4326, :with_z => true, :null => false
+
+        t.timestamps
+      end
+
+      add_index :places, :geom, :spatial => true
+    end
+
+
+Types:
+
+    point
+    polygon
+    line_string
+    multi_point
+    multi_polygon
+    multi_line_string
+    geometry
+    geometry_collection
+
+
+=== PostGIS Helper Scripts
+
+Optional, this will create postgis enabled database automatically for you.
+
+Helpers to create postgis template database. At time of writing,
+postgis.sql and spatial_ref_sys.sql are used.
+
+
+==== System wide
+
+
+Find where your OS put those sql files and:
+
+    rake postgis:template path/to/sqls/folder
+
+
+==== Vendorize
+
+Place the following scripts in a folder named 'spatial' under the 'db' folder; For example:
+
+  RAILS_ROOT/db/spatial/lwpostgis.sql
+  RAILS_ROOT/db/spatial/spatial_ref_sys
+
+These will be used when creating the Test database when running the Rake Test tasks.
+These scripts should have been installed when the PostGIS libraries were installed.
+Online reference: http://postgis.refractions.net/
+
+
+=== Fixtures
+
+If you use fixtures for your unit tests, at some point,
+you will want to input a geometry. You could transform your
+geometries to a form suitable for YAML yourself everytime but
+the spatial adapter provides a method to do it for you: +to_yaml+.
+It works for both MySQL and PostGIS (although the string returned
+is different for each database). You would use it like this, if
+the geometric column is a point:
+
+    fixture:
+          id: 1
+          data: HELLO
+          geom: <%= Point.from_x_y(123.5,321.9).to_yaml %>
+
+
+=== Annotate
+
+If you are using annotate_models, check out this fork which adds geometrical annotations for PostgisAdapter and SpatialAdapter:
+
+http://github.com/nofxx/annotate_models
+
+
+== Geometric data types
+
+Ruby geometric datatypes are currently made available only through
+the GeoRuby library (http://georuby.rubyforge.org): This is where the
+*Point.from_x_y* in the example above comes from. It is a goal
+of a future release of the Spatial Adapter to support additional
+geometric datatype libraries, such as Ruby/GEOS, as long as they
+can support reading and writing of EWKB.
+
+
+
+=== Warning
+
+- Since ActiveRecord seems to keep only the string values directly
+returned from the database, it translates from these to the correct
+types everytime an attribute is read, which is probably ok for simple
+types, but might be less than efficient for geometries, since the EWKB
+string has to be parsed everytime. Also it means you cannot modify the
+geometry object returned from an attribute directly :
+
+       place = Place.first
+       place.the_geom.y=123456.7
+
+- Since the translation to a geometry is performed everytime the_geom
+is read, the change to y will not be saved! You would have to do
+something like this :
+
+       place = Place.first
+       the_geom = place.the_geom
+       the_geom.y=123456.7
+       place.the_geom = the_geom
+
+
+== Postgis Adapter
+
+Marcos Piccinini (nofxx)
+Ying Tsen Hong (tsenying)
+Simon Tokumine (tokumine)
+Fernando Blat (ferblape)
+Shoaib Burq (sabman)
+
+(in order of appearance)
+
+
+== License
+
+Spatial Adapter for Rails is released under the MIT license.
+Postgis Adapter is released under the MIT license.
+
+
+== Support
+
+Tested using activerecord 3+ / postgresql 8.5+ / postgis 1.5+ / linux / osx
+
+Any questions, enhancement proposals, bug notifications or corrections:
+
+
+=== PostgisAdapter
+
+http://github.com/nofxx/postgis_adapter/issues
+
+
+=== SpatialAdapter
+
+http://georuby.rubyforge.org
+guilhem.vellut+georuby@gmail.com.

data/Rakefile

@@ -0,0 +1,81 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+end
+
+# require 'rubygems'
+# require 'rake'
+# require 'rake/clean'
+# require 'rake/rdoctask'
+# #require 'spec/rake/spectask'
+
+# CLEAN.include('**/*.gem')
+
+# namespace :gem do
+#   desc "Create the postgis_adapter gem"
+#   task :create => [:clean] do
+#     spec = eval(IO.read('postgis_adapter.gemspec'))
+#     Gem::Builder.new(spec).build
+#   end
+
+#   desc "Install the postgis_adapter gem"
+#   task :install => [:create] do
+#     file = Dir['*.gem'].first
+#     sh "gem install #{file}"
+#   end
+# end
+
+# # Spec::Rake::SpecTask.new(:spec) do |spec|
+# #   spec.libs << 'lib' << 'spec'
+# #   spec.spec_files = FileList['spec/**/*_spec.rb']
+# # end
+
+# # Spec::Rake::SpecTask.new(:rcov) do |spec|
+# #   spec.libs << 'lib' << 'spec'
+# #   spec.pattern = 'spec/**/*_spec.rb'
+# #   spec.rcov = true
+# # end
+
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION').chomp : ""
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "postgis_adapter #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+# task :default => :spec
+
+# #
+# # Reek & Roodi
+# #
+# begin
+#   require 'reek/rake_task'
+#   Reek::RakeTask.new do |t|
+#     t.fail_on_error = true
+#     t.verbose = false
+#     t.source_files = 'lib/**/*.rb'
+#   end
+# rescue LoadError
+#   task :reek do
+#     abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+#   end
+# end
+
+# begin
+#   require 'roodi'
+#   require 'roodi_task'
+#   RoodiTask.new do |t|
+#     t.verbose = false
+#   end
+# rescue LoadError
+#   task :roodi do
+#     abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+#   end
+# end

data/lib/postgis_adapter/acts_as_geom.rb

@@ -0,0 +1,49 @@
+#
+# PostGIS Adapter
+#
+# http://github.com/nofxx/postgis_adapter
+#
+module PostgisAdapter
+module Functions
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+
+    # has_geom :db_field => :geom_type
+    # Examples:
+    #
+    # has_geom :data => :point
+    # has_geom :geom => :line_string
+    # has_geom :geom => :polygon
+    #
+    def has_geom(*geom)
+      cattr_accessor :postgis_geoms
+      self.postgis_geoms = geom[0].keys.first # {:columns => column }
+      send :include, case geom[0].values[0]
+        when :point       then  PointFunctions
+        when :polygon     then PolygonFunctions
+        when :line_string, :multi_line_string then  LineStringFunctions
+        when :multi_polygon then MultiPolygonFunctions
+        when :geometry    then GeometryFunctions
+      end unless geom[0].kind_of? Symbol
+    end
+    alias :acts_as_geom :has_geom
+
+    def get_geom_type(column)
+      self.postgis_geoms.values[0] rescue nil
+    #   self.columns.select { |c| c.name == column.to_s }[0].geometry_type
+    # rescue ActiveRecord::StatementInvalid => e
+    #   nil
+    end
+
+    def default_geometry
+      postgis_geoms
+    end
+
+  end
+end
+end
+
+ActiveRecord::Base.send :include, PostgisAdapter::Functions