nofxx-postgis_adapter 0.1.7 → 0.1.8

data/README.rdoc

@@ -1,5 +1,4 @@
-== Postgis Adapter
-
+= PostgisAdapter
 
 A plugin for ActiveRecord which manages the PostGIS geometric columns
 in a transparent way (that is like the other base data type columns).
@@ -16,18 +15,21 @@ Postgis Manual - http://postgis.refractions.net/documentation/manual-svn
 
 If you are using Spatial Adapter, *remove it first*.
 
+
 ==== Dependencies
 
 - georuby
 - postgres 8.3+
 - postgis  1.3+
 
+
 ==== As gem:
 
     sudo gem sources --add http://gems.github.com
     sudo gem install nofxx-postgis_adapter
   
     config.gem "nofxx-postgis_adapter", :lib => "postgis_adapter", :source => "http://gems.github.com"
+    
   
 ==== As plugin:
 
@@ -36,7 +38,6 @@ If you are using Spatial Adapter, *remove it first*.
 
 === 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
@@ -90,6 +91,7 @@ Here are this fork additions. To use it:
     @street.crosses?(@park)
 
     @area.contains?(@place)
+    
 
 Polygons:
 
@@ -101,6 +103,7 @@ Polygons:
 
     @park.overlaps?(@other_park)
     => false
+    
 
 Line Strings:
 
@@ -164,6 +167,7 @@ Or use a (almost) postgis like notation:
     @area.bbox "@",  @park
 
 
+
 === Warning
 
 *To be fixed:*
@@ -173,6 +177,7 @@ implement a multi geom.
 
 http://nofxx.lighthouseapp.com/projects/20712/tickets/3-multiple-geoms-in-model
 
+
 === Wiki
 
 Check out the wiki pages (http://github.com/nofxx/postgis_adapter/wikis).
@@ -206,8 +211,8 @@ In PostGIS, since you can only use operations with geometries with the same SRID
   	Park.find_by_geom([[3,5.6],[19.98,5.9],123])
 
 
-== Database Tools
 
+== Database Tools
 
 === Migrations
 
@@ -244,7 +249,6 @@ the geometric column is a point:
 
 == 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
@@ -252,6 +256,12 @@ 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.
 
+== 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
+
 
 === Warning
 
@@ -277,22 +287,23 @@ something like this :
 
 == License
 
-
 Spatial Adapter for Rails is released under the MIT license.
-PostGis Adapter is released under the MIT license.
+Postgis Adapter is released under the MIT license.
 
 
 == Support
 
-
 Tested using rails 2.2.2 / postgresql 8.3.5 / postgis 1.3.3 / linux / osx
 
 Any questions, enhancement proposals, bug notifications or corrections:
 
-=== PostGis Adapter
+
+=== PostgisAdapter
 
 Project Tracker http://nofxx.lighthouseapp.com/projects/20712-postgis_adapter
 
+
 === SpatialAdapter
 
+
 guilhem.vellut+georuby@gmail.com.

data/lib/postgis_adapter.rb

@@ -20,7 +20,7 @@ include GeoRuby::SimpleFeatures
 include SpatialAdapter
 
 module PostgisAdapter
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end
 
 #tables to ignore in migration : relative to PostGIS management of geometric columns

data/lib/postgis_functions/class.rb

@@ -10,6 +10,9 @@ module PostgisFunctions
     #
     module ClassMethods
 
+      #
+      # Returns the closest record 
+      #
       def closest_to(p, srid=4326)
         find(:first, :order => "ST_Distance(geom, GeomFromText('POINT(#{p.x} #{p.y})', #{srid}))" )
       end
@@ -18,7 +21,10 @@ module PostgisFunctions
         find(:all, :order => "ST_Distance(geom, GeomFromText('POINT(#{p.x} #{p.y})', #{srid}))" )
       end
 
-      def by_size sort='asc'
+      #
+      #
+      #
+      def by_length sort='asc'
         find(:all, :order => "ST_length(geom) #{sort}" )
       end
 

data/lib/postgis_functions/common.rb

@@ -98,7 +98,7 @@ module PostgisFunctions
   # Returns Float ST_Distance(geometry g1, geometry g2);
   #
   def distance_to(other)
-    postgis_calculate(:distance, [self, other])
+    postgis_calculate(:distance, [self, other]).to_f
   end
   
   #
@@ -124,6 +124,19 @@ module PostgisFunctions
     postgis_calculate(:within, [self, other])
   end
 
+  #
+  # True if the geometries are within the specified distance of one another.
+  # The distance is specified in units defined by the spatial reference system
+  # of the geometries. For this function to make sense, the source geometries
+  # must both be of the same coorindate projection, having the same SRID.
+  #
+  # Returns boolean ST_DWithin(geometry g1, geometry g2, double precision distance);
+  #
+  def d_within?(other, margin=0.1)
+    postgis_calculate(:dwithin, [self, other], margin)
+  end
+  alias_method "in_bounds?", "d_within?"
+  
   #
   # True if geometry B is completely inside geometry A. 
   #
@@ -217,7 +230,12 @@ module PostgisFunctions
   def simplify(tolerance=0.1)
     postgis_calculate(:simplify, self, tolerance)
   end
-  #TODO:  #def simplify!
+  
+  
+  def simplify!(tolerance=0.1)
+    #FIXME: not good..
+    self.geom = simplify
+  end
 
   #
   # Returns a "simplified" version of the given geometry using the Douglas-Peuker
@@ -364,20 +382,57 @@ module PostgisFunctions
     postgis_calculate(:polygonize, self)
   end
   
-  # NEW
-  #ST_OrderingEquals — Returns true if the given geometries represent the same geometry and points are in the same directional order.
-  #boolean ST_OrderingEquals(g
-  #  ST_PointOnSurface — Returns a POINT guaranteed to lie on the surface.
-  #geometry ST_PointOnSurface(geometry g1);eometry A, geometry B);
+  #
+  # Returns true if this Geometry is spatially related to anotherGeometry, 
+  # by testing for intersections between the Interior, Boundary and Exterior 
+  # of the two geometries as specified by the values in the 
+  # intersectionPatternMatrix. If no intersectionPatternMatrix is passed in, 
+  # then returns the maximum intersectionPatternMatrix that relates the 2 geometries.
+  # 
+  # 
+  # Version 1: Takes geomA, geomB, intersectionMatrix and Returns 1 (TRUE) if 
+  # this Geometry is spatially related to anotherGeometry, by testing for 
+  # intersections between the Interior, Boundary and Exterior of the two 
+  # geometries as specified by the values in the intersectionPatternMatrix.
+  # 
+  # This is especially useful for testing compound checks of intersection, 
+  # crosses, etc in one step.
+  # 
+  # Do not call with a GeometryCollection as an argument
+  # 
+  # This is the "allowable" version that returns a boolean, not an integer. 
+  # This is defined in OGC spec.
+  # This DOES NOT automagically include an index call. The reason for that 
+  # is some relationships are anti e.g. Disjoint. If you are using a relationship 
+  # pattern that requires intersection, then include the && index call.
+  # 
+  # Version 2: Takes geomA and geomB and returns the DE-9IM 
+  # (dimensionally extended nine-intersection matrix)
+  # 
+  # Do not call with a GeometryCollection as an argument
+  # Not in OGC spec, but implied. see s2.1.13.2
+  # 
+  #  Both Performed by the GEOS module
+  # 
+  #  Returns:
+  #
+  #  text ST_Relate(geometry geomA, geometry geomB);
+  #  boolean ST_Relate(geometry geomA, geometry geomB, text intersectionPatternMatrix);
+  #
+  def relate?(other, m = nil)
+    # Relate is case sentitive.......
+    m = "'#{m}'" if m
+    postgis_calculate("Relate", [self, other], m)
+  end  
+  
+end
 
+# NEW
+#ST_OrderingEquals — Returns true if the given geometries represent the same geometry and points are in the same directional order.
+#boolean ST_OrderingEquals(g
+#  ST_PointOnSurface — Returns a POINT guaranteed to lie on the surface.
+#geometry ST_PointOnSurface(geometry g1);eometry A, geometry B);
 
-  #x ST_SnapToGrid(geometry, geometry, sizeX, sizeY, sizeZ, sizeM)
-  # ST_X , ST_Y, SE_M, SE_Z, SE_IsMeasured has_m?
 
-  #x ST_Relate(geometry, geometry, intersectionPatternMatrix)
-  
-  
-  
-  
-  
-end
+#x ST_SnapToGrid(geometry, geometry, sizeX, sizeY, sizeZ, sizeM)
+# ST_X , ST_Y, SE_M, SE_Z, SE_IsMeasured has_m?

data/lib/postgis_functions/linestring.rb

@@ -17,7 +17,7 @@ module PostgisFunctions
     # Returns Float
     #
     def length
-      dis = postgis_calculate(:length, self)
+      dis = postgis_calculate(:length, self).to_f
     end
 
     #
@@ -28,7 +28,7 @@ module PostgisFunctions
     # Returns Float
     #
     def length_3d
-      dis = postgis_calculate(:length3d, self)
+      dis = postgis_calculate(:length3d, self).to_f
     end
 
     #
@@ -49,7 +49,7 @@ module PostgisFunctions
     # Returns Float length_spheroid(geometry linestring, spheroid);
     #
     def length_spheroid(spheroid = EARTH_SPHEROID)
-      dis = postgis_calculate(:length_spheroid, self, spheroid)
+      dis = postgis_calculate(:length_spheroid, self, spheroid).to_f
     end
 
     #
@@ -104,7 +104,7 @@ module PostgisFunctions
     # Returns float (0 to 1) ST_Line_Locate_Point(geometry a_linestring, geometry a_point);
     #
     def locate_point point
-      postgis_calculate(:line_locate_point, [self, point])
+      postgis_calculate(:line_locate_point, [self, point]).to_f
     end
     
     #

data/lib/postgis_functions/point.rb

@@ -8,19 +8,6 @@ module PostgisFunctions
   #
   module PointFunctions
 
-    #
-    # True if the geometries are within the specified distance of one another.
-    # The distance is specified in units defined by the spatial reference system
-    # of the geometries. For this function to make sense, the source geometries
-    # must both be of the same coorindate projection, having the same SRID.
-    #
-    # Returns boolean ST_DWithin(geometry g1, geometry g2, double precision distance);
-    #
-    def d_within?(other, margin=0.1)
-      postgis_calculate(:dwithin, [self, other], margin)
-    end
-    alias_method "in_bounds?", "d_within?"
-
     #
     # Returns a float between 0 and 1 representing the location of the closest point
     # on LineString to the given Point, as a fraction of total 2d line length.
@@ -33,7 +20,7 @@ module PostgisFunctions
     # Returns float (0 to 1) ST_Line_Locate_Point(geometry a_linestring, geometry a_point);
     #
     def where_on_line line
-      postgis_calculate(:line_locate_point, [line, self])
+      postgis_calculate(:line_locate_point, [line, self]).to_f
     end
 
     #
@@ -46,7 +33,7 @@ module PostgisFunctions
     # Returns Float ST_Distance_Sphere(geometry pointlonlatA, geometry pointlonlatB);
     #
     def distance_sphere_to(other)
-      dis = postgis_calculate(:distance_sphere, [self, other])
+      dis = postgis_calculate(:distance_sphere, [self, other]).to_f
     end
 
     #
@@ -69,7 +56,7 @@ module PostgisFunctions
     # Returns ST_Distance_Spheroid(geometry geomA, geometry geomB, spheroid);
     #
     def distance_spheroid_to(other, spheroid = EARTH_SPHEROID)
-      postgis_calculate(:distance_spheroid, [self, other], spheroid)
+      postgis_calculate(:distance_spheroid, [self, other], spheroid).to_f
     end
 
     #
@@ -83,7 +70,7 @@ module PostgisFunctions
     #
     def azimuth other
       #TODO: return if not point/point
-      postgis_calculate(:azimuth, [self, other])
+      postgis_calculate(:azimuth, [self, other]).to_f
       rescue
         ActiveRecord::StatementInvalid
     end

data/lib/postgis_functions/polygon.rb

@@ -15,7 +15,7 @@ module PostgisFunctions
     # Returns Float ST_Area(geometry g1);
     #
     def area
-      postgis_calculate(:area, self)
+      postgis_calculate(:area, self).to_f
     end
 
     #
@@ -27,7 +27,7 @@ module PostgisFunctions
     # Returns Float ST_Perimeter(geometry g1);
     #
     def perimeter
-      postgis_calculate(:perimeter, self)
+      postgis_calculate(:perimeter, self).to_f
     end
 
     #
@@ -37,7 +37,7 @@ module PostgisFunctions
     # Returns Float ST_Perimeter3D(geometry geomA);
     #
     def perimeter3d
-      postgis_calculate(:perimeter3d, self)
+      postgis_calculate(:perimeter3d, self).to_f
     end
 
     #

data/lib/postgis_functions.rb

@@ -56,7 +56,7 @@ module PostgisFunctions
     #
     # Data =>  SELECT Func(A,B)
     # BBox =>  SELECT (A <=> B)
-    #
+    # 
     if type == :bbox
       opcode = nil
       s_join = " #{options} "
@@ -73,20 +73,22 @@ module PostgisFunctions
     #p sql; sql
   end
 
+  #
   # Execute the query and parse the return.
   # We may receive:
   #
   # "t" or "f" for boolean queries
   # BIGHASH    for geometries
+  # HASH       for ST_Relate
   # Rescue     a float
   #
   def execute_geometrical_calculation(operation, subject, options) #:nodoc:
     value = connection.select_value(construct_geometric_sql(operation, subject, options))
     return nil unless value
-    if value =~ /^\D/
+    if value =~ /t|f/
       {"f" => false, "t" => true}[value] 
     else
-      GeoRuby::SimpleFeatures::Geometry.from_hex_ewkb(value) rescue value.to_f
+      GeoRuby::SimpleFeatures::Geometry.from_hex_ewkb(value) rescue value
     end
   end
 

data/postgis_adapter.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = "postgis_adapter"
-  s.version = "0.1.7"
+  s.version = "0.1.8"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcos Piccinini"]
-  s.date = "2008-12-10"
+  s.date = "2008-12-16"
   s.description = "Postgis Adapter for Activer Record"
   s.email = ["x@nofxx.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]

data/spec/postgis_functions/linestring_spec.rb

@@ -16,8 +16,8 @@ describe "LineString" do
   end
    
   it "should sort by size" do
-    Street.by_size.first.data.should == "Street1"
-    Street.by_size.last.data.should == "Street3"
+    Street.by_length.first.data.should == "Street1"
+    Street.by_length.last.data.should == "Street3"
   end
 
   it "largest" do

data/spec/postgis_functions/point_spec.rb

@@ -14,6 +14,7 @@ describe "Point" do
      @p1 ||= Position.create!(:data => "Point1", :geom => Point.from_x_y(1,1,123))
      @p2 ||= Position.create!(:data => "Point2", :geom => Point.from_x_y(5,5,123))
      @p3 ||= Position.create!(:data => "Point3", :geom => Point.from_x_y(8,8,123))
+     @p4 ||= Position.create!(:data => "Point5", :geom => Point.from_x_y(18.1,18,123))
    end
    
    
@@ -82,13 +83,6 @@ describe "Point" do
      @p1.should be_outside(@c1)
    end
 
-   it do
-     @p1.should be_in_bounds(@s1)
-   end
-
-   it "in bounds of a geometry? with option" do
-     @p3.should_not be_in_bounds(@s1, 1)
-   end
 
    it do
      @p1.azimuth(@p2).should be_close(0.785398163397448,0.000001)
@@ -117,6 +111,26 @@ describe "Point" do
    it do
      @p3.polygonize.geometries.should be_empty
    end
+   
+   it do
+     @p1.should be_in_bounds(@s1)
+   end
 
+   it "in bounds of a geometry? with option" do
+     @p3.should_not be_in_bounds(@s1, 1)
+   end
+   
+   it { @p4.in_bounds?(@s3, 0.01).should be_false } 
+   
+   it { @p4.where_on_line(@s3).should be_close(0.335, 0.0001) }   
+   
+   it { @s3.locate_point(@p4).should be_close(0.335, 0.1)}
+   
+   it { @s3.interpolate_point(0.335).x.should be_close(18.05, 0.01) }
+  
+   it { @p1.relate?(@s3, "T*T***FF*").should be_false }
+   
+   it { @p1.relate?(@s3).should eql("FF0FFF102") }
+   
 end
 

data/spec/postgis_functions/polygon_spec.rb

@@ -24,7 +24,7 @@ describe "Point" do
    describe "Polygon" do
 
      it "sort by area size" do
-       City.by_size.first.data.should == "City1" #[@c1, @c2, @c3]
+       City.by_area.first.data.should == "City1" #[@c1, @c2, @c3]
      end
 
      it do

data/spec/spec.opts

@@ -1,6 +1,6 @@
 --colour
 --format
-profile
+spinner
 --timeout
 20
---diff
+--diff

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nofxx-postgis_adapter
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Marcos Piccinini
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-10 00:00:00 -08:00
+date: 2008-12-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency