rgeo 0.2.6 → 0.2.7

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 0.2.7 / 2011-04-09
+
+* POSSIBLE INCOMPATIBLE CHANGE: GeometryCollection#geometry_n, Polygon#interior_ring_n, and LineString#point_n, in some implementations, allowed negative indexes (which counted backwards from the end of the collection as per Ruby arrays.) This was against the SFS interface, and so the behavior has been removed. However, GeometryCollection#[], because it is supposed to model Ruby arrays, now explicitly DOES allow negative indexes. This means GeometryCollection#[] is no longer exactly the same as GeometryCollection#geometry_n. These clarifications have also been made in the RDoc.
+* The GEOS implementations of GeometryCollection#geometry_n and Polygon#interior_ring_n segfaulted when given an index out of bounds. Bounds Check Fail fixed. (Reported by sharpone74.)
+
 === 0.2.6 / 2011-03-31
 
 * Ring direction analysis crashed if any of the line segments were zero length. Fixed. (Reported by spara.)

data/README.rdoc

@@ -70,17 +70,20 @@ Install RGeo as a gem:
  gem install rgeo
 
 Note: By default, the gem installation looks for the GEOS library in the
-following locations: <tt>/usr/local</tt>, <tt>/usr/local/geos</tt>, <tt>/opt/local</tt>, <tt>/opt/geos</tt>, <tt>/opt</tt>, <tt>/usr</tt>.
+following locations: <tt>/usr/local</tt>, <tt>/usr/local/geos</tt>,
+<tt>/opt/local</tt>, <tt>/opt/geos</tt>, <tt>/opt</tt>, <tt>/usr</tt>.
 
 If GEOS has been installed in a different location, you must provide its
 installation prefix directory using the "--with-geos-dir" option. This
-option must be preceded by "--" to separate it, as a build switch, from
-the switches interpreted by the gem command. For example:
+option must be preceded by "<tt>--</tt>" to separate it, as a build
+switch, from the switches interpreted by the gem command. For example:
 
  gem install rgeo -- --with-geos-dir=/path/to/my/geos/installation
 
 Similarly, the gem installation looks for the Proj4 library in the
-following locations by default: <tt>/usr/local</tt>, <tt>/usr/local/proj</tt>, <tt>/usr/local/proj4</tt>, <tt>/opt/local</tt>, <tt>/opt/proj</tt>, <tt>/opt/proj4</tt>, <tt>/opt</tt>, <tt>/usr</tt>.
+following locations by default: <tt>/usr/local</tt>,
+<tt>/usr/local/proj</tt>, <tt>/usr/local/proj4</tt>, <tt>/opt/local</tt>,
+<tt>/opt/proj</tt>, <tt>/opt/proj4</tt>, <tt>/opt</tt>, <tt>/usr</tt>.
 
 If Proj4 is installed in a different location, you must provide its
 installation prefix directory using the "--with-proj-dir" option.

data/Version

@@ -1 +1 @@
-0.2.6
+0.2.7

data/ext/geos_c_impl/geometry_collection.c

@@ -183,7 +183,7 @@ static VALUE method_geometry_collection_num_geometries(VALUE self)
 }
 
 
-static VALUE method_geometry_collection_geometry_n(VALUE self, VALUE n)
+static VALUE impl_geometry_n(VALUE self, VALUE n, char allow_negatives)
 {
   VALUE result = Qnil;
   RGeo_GeometryData* self_data = RGEO_GEOMETRY_DATA_PTR(self);
@@ -191,13 +191,35 @@ static VALUE method_geometry_collection_geometry_n(VALUE self, VALUE n)
   if (self_geom) {
     VALUE klasses = self_data->klasses;
     int i = NUM2INT(n);
-    const GEOSGeometry* elem_geom = GEOSGetGeometryN_r(self_data->geos_context, self_geom, i);
-    result = rgeo_wrap_geos_geometry_clone(self_data->factory, elem_geom, NIL_P(klasses) ? Qnil : rb_ary_entry(klasses, i));
+    if (allow_negatives || i >= 0) {
+      GEOSContextHandle_t self_context = self_data->geos_context;
+      int len = GEOSGetNumGeometries_r(self_context, self_geom);
+      if (i < 0) {
+        i += len;
+      }
+      if (i >= 0 && i < len) {
+        result = rgeo_wrap_geos_geometry_clone(self_data->factory,
+          GEOSGetGeometryN_r(self_context, self_geom, i),
+          NIL_P(klasses) ? Qnil : rb_ary_entry(klasses, i));
+      }
+    }
   }
   return result;
 }
 
 
+static VALUE method_geometry_collection_geometry_n(VALUE self, VALUE n)
+{
+  impl_geometry_n(self, n, 0);
+}
+
+
+static VALUE method_geometry_collection_brackets(VALUE self, VALUE n)
+{
+  impl_geometry_n(self, n, 1);
+}
+
+
 static VALUE method_geometry_collection_each(VALUE self)
 {
   RGeo_GeometryData* self_data = RGEO_GEOMETRY_DATA_PTR(self);
@@ -386,7 +408,7 @@ void rgeo_init_geos_geometry_collection(RGeo_Globals* globals)
   rb_define_method(geos_geometry_collection_class, "num_geometries", method_geometry_collection_num_geometries, 0);
   rb_define_method(geos_geometry_collection_class, "size", method_geometry_collection_num_geometries, 0);
   rb_define_method(geos_geometry_collection_class, "geometry_n", method_geometry_collection_geometry_n, 1);
-  rb_define_method(geos_geometry_collection_class, "[]", method_geometry_collection_geometry_n, 1);
+  rb_define_method(geos_geometry_collection_class, "[]", method_geometry_collection_brackets, 1);
   rb_define_method(geos_geometry_collection_class, "each", method_geometry_collection_each, 0);
   
   // Methods for MultiPointImpl

data/ext/geos_c_impl/line_string.c

@@ -150,7 +150,6 @@ static VALUE method_line_string_point_n(VALUE self, VALUE n)
         unsigned int size;
         if (GEOSCoordSeq_getSize_r(self_context, coord_seq, &size)) {
           if (i < size) {
-            unsigned int dims;
             result = get_point_from_coordseq(self, coord_seq, i, has_z);
           }
         }

data/ext/geos_c_impl/polygon.c

@@ -144,7 +144,16 @@ static VALUE method_polygon_interior_ring_n(VALUE self, VALUE n)
   RGeo_GeometryData* self_data = RGEO_GEOMETRY_DATA_PTR(self);
   const GEOSGeometry* self_geom = self_data->geom;
   if (self_geom) {
-    result = rgeo_wrap_geos_geometry_clone(self_data->factory, GEOSGetInteriorRingN_r(self_data->geos_context, self_geom, NUM2INT(n)), RGEO_FACTORY_DATA_PTR(self_data->factory)->globals->geos_linear_ring);
+    int i = NUM2INT(n);
+    if (i >= 0) {
+      GEOSContextHandle_t self_context = self_data->geos_context;
+      int num = GEOSGetNumInteriorRings_r(self_context, self_geom);
+      if (i < num) {
+        result = rgeo_wrap_geos_geometry_clone(self_data->factory,
+          GEOSGetInteriorRingN_r(self_context, self_geom, i),
+          RGEO_FACTORY_DATA_PTR(self_data->factory)->globals->geos_linear_ring);
+      }
+    }
   }
   return result;
 }

data/lib/rgeo/feature/geometry_collection.rb

@@ -88,7 +88,9 @@ module RGeo
       # === Notes
       # 
       # Returns an object that supports the Geometry interface, or nil
-      # if the given n is out of range.
+      # if the given N is out of range. N is zero-based.
+      # Also note that this method is different from GeometryCollection#[]
+      # in that it does not support negative indexes.
       
       def geometry_n(n_)
         raise Error::UnsupportedOperation, "Method GeometryCollection#geometry_n not defined."
@@ -102,10 +104,18 @@ module RGeo
       end
       
       
-      # Alias of the geometry_n method.
+      # Returns the Nth geometry in this GeometryCollection, or nil if the
+      # given N is out of range. N is zero-based.
+      # 
+      # This behaves slightly different from GeometryCollection#geometry_n.
+      # GeometryCollection#geometry_n accepts only nonnegative indexes,
+      # as specified by the SFS. However, GeometryCollection#[] also accepts
+      # negative indexes counting backwards from the end of the collection,
+      # the same way Ruby's array indexing works. Hence, geometry_n(-1)
+      # returns nil, where [-1] returns the last element of the collection.
       
       def [](n_)
-        geometry_n(n_)
+        raise Error::UnsupportedOperation, "Method GeometryCollection#[] not defined."
       end
       
       

data/lib/rgeo/feature/line_string.rb

@@ -79,7 +79,8 @@ module RGeo
       # === Notes
       # 
       # Returns an object that supports the Point interface, or nil
-      # if the given n is out of range.
+      # if the given N is out of range. N is zero-based.
+      # Does not support negative indexes.
       
       def point_n(n_)
         raise Error::UnsupportedOperation, "Method LineString#point_n not defined."

data/lib/rgeo/feature/polygon.rb

@@ -118,7 +118,8 @@ module RGeo
       # === Notes
       # 
       # Returns an object that supports the LinearRing interface, or nil
-      # if the given n is out of range.
+      # if the given N is out of range. N is zero-based.
+      # Does not support negative indexes.
       
       def interior_ring_n(n_)
         raise Error::UnsupportedOperation, "Method Polygon#interior_ring_n not defined."

data/lib/rgeo/impl_helper/basic_geometry_collection_methods.rb

@@ -70,6 +70,11 @@ module RGeo
       
       
       def geometry_n(n_)
+        n_ < 0 ? nil : @elements[n_]
+      end
+      
+      
+      def [](n_)
         @elements[n_]
       end
       

data/lib/rgeo/impl_helper/basic_line_string_methods.rb

@@ -77,7 +77,7 @@ module RGeo
       
       
       def point_n(n_)
-        @points[n_]
+        n_ < 0 ? nil : @points[n_]
       end
       
       

data/lib/rgeo/impl_helper/basic_polygon_methods.rb

@@ -79,7 +79,7 @@ module RGeo
       
       
       def interior_ring_n(n_)
-        @interior_rings[n_]
+        n_ < 0 ? nil : @interior_rings[n_]
       end
       
       

data/test/common/geometry_collection_tests.rb

@@ -77,6 +77,14 @@ module RGeo
         end
         
         
+        def test_bounds_check
+          geom_ = @factory.collection([@point1, @line1])
+          assert_nil(geom_.geometry_n(200))
+          assert_nil(geom_.geometry_n(-1))
+          assert(@line1.eql?(geom_[-1]))
+        end
+        
+        
         def test_creation_save_klass
           geom_ = @factory.collection([@point1, @line3])
           assert_not_nil(geom_)

data/test/common/line_string_tests.rb

@@ -53,6 +53,8 @@ module RGeo
           assert_equal(2, line1_.num_points)
           assert_equal(point1_, line1_.point_n(0))
           assert_equal(point2_, line1_.point_n(1))
+          assert_nil(line1_.point_n(-1))
+          assert_nil(line1_.point_n(2))
           assert_equal(point1_, line1_.start_point)
           assert_equal(point2_, line1_.end_point)
         end

data/test/common/polygon_tests.rb

@@ -55,6 +55,8 @@ module RGeo
           assert_equal(::RGeo::Feature::Polygon, polygon_.geometry_type)
           assert(exterior_.eql?(polygon_.exterior_ring))
           assert_equal(0, polygon_.num_interior_rings)
+          assert_nil(polygon_.interior_ring_n(0))
+          assert_nil(polygon_.interior_ring_n(-1))
         end
         
         
@@ -75,6 +77,8 @@ module RGeo
           assert(exterior_.eql?(polygon_.exterior_ring))
           assert_equal(1, polygon_.num_interior_rings)
           assert(interior_.eql?(polygon_.interior_ring_n(0)))
+          assert_nil(polygon_.interior_ring_n(1))
+          assert_nil(polygon_.interior_ring_n(-1))
         end
         
         

metadata

@@ -2,7 +2,7 @@
 name: rgeo
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-31 00:00:00 -07:00
+date: 2011-04-09 00:00:00 -07:00
 default_executable: 
 dependencies: []