rgeo 2.3.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93de3431a81612631cfa612d589bc0e1026f16276d3c1e848b71f1a3e682731
-  data.tar.gz: 992a46705454a1fe1c77405e9b6f753739af0c80b9e6f58d8e60da07b75eea93
+  metadata.gz: 792e1494e9ef340bb740e8675b2ce67e4d02fa6c4333ad93c523e348e5153812
+  data.tar.gz: a4051c1728401caca45807c9e786a5e5130761c95a95ff6bdb60265130aa2049
 SHA512:
-  metadata.gz: aca5ecae4e1c3ee2d022591ccf612aae3e4f8539543cc740ba3875b15ae156da6e1e13180a305e0c2a41a9bcf3a60e3eafb5c87eb737f95ef194e08fe66c39f9
-  data.tar.gz: 94ae519f52c0a6deada3e560722256e99fc482528be8ceea67496cf0dbc7488da9bf643ab2905a28294aaa68ac3f532e913c3afb7fea2877b438ecf282911153
+  metadata.gz: 3a6ee8000fd92f7bef89915d9d7e11aea0fb413248778d0f5e5218516d98cc6d16afba66d92c670c9f0539d37a6c7e934a5fcc3ad839626d7299b7c5ae8ffc57
+  data.tar.gz: 580f0a56261c8ab5698e14a78e7f61bcdb8fa362160db4ed1662dbb792d1d8ec7272a1e3387568b00c6b8403547aae128363ad230cf622ec5b5908a0e17b8d6f

data/.yardopts

@@ -0,0 +1,6 @@
+--markup rdoc
+--output-dir ./yardoc
+lib/**/*.rb
+ext/**/*.{c,h}
+-
+doc/*.md

data/README.md

@@ -1,15 +1,14 @@
 ## RGeo
 
 [![Gem Version](https://badge.fury.io/rb/rgeo.svg)](http://badge.fury.io/rb/rgeo)
-[![CI](https://github.com/rgeo/rgeo/workflows/CI/badge.svg)](https://github.com/rgeo/rgeo/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush)
+[![CI](https://github.com/rgeo/rgeo/workflows/CI/badge.svg)](https://github.com/rgeo/rgeo/actions?query=workflow%3ACI+branch%3Amain+event%3Apush)
 
 RGeo is a geospatial data library for Ruby.
 
-:warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning:
+***Contributors Wanted!***
 
-This organization is looking for maintainers, see [this issue](https://github.com/rgeo/rgeo/issues/216) for more information.
+If you use RGeo and are interested in contributing, please check out our [open issues](https://github.com/rgeo/rgeo/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22%2C%22help+wanted%22) to see if there's anything you're able to help with.
 
-:warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning::warning:
 
 ### Summary
 
@@ -37,7 +36,7 @@ Use the core **rgeo** gem to:
 
 RGeo works with the following Ruby implementations:
 
-*   MRI Ruby 2.3.0 or later.
+*   MRI Ruby 2.6.0 or later.
 *   Partial support for JRuby 9.0 or later. The FFI implementation of GEOS
     is available (ffi-geos gem required) but CAPI is not.
 *   See earlier versions for support for older ruby versions.
@@ -74,6 +73,14 @@ If you are using proj.4 extensions, include
 gem "rgeo-proj4"
 ```
 
+### Upgrading to Version 3.0
+
+See [doc/Upgrading-to-v3.md](doc/Upgrading-to-v3.md) for a checklist of changes to make before upgrading to RGeo 3.0.
+
+For a brief overview of the changes, see [NEWS.md](NEWS.md).
+
+For a comprehensive list of all changes, see [History.md](History.md).
+
 
 ### Extensions
 
@@ -109,7 +116,7 @@ ActiveRecord connection adapter for SpatiaLite, based on sqlite3 (*not maintaine
 RDoc Documentation is available at https://www.rubydoc.info/gems/rgeo
 
 Contributions are welcome. Please read the
-[Contributing guidelines](https://github.com/rgeo/rgeo/blob/master/CONTRIBUTING.md).
+[Contributing guidelines](https://github.com/rgeo/rgeo/blob/main/CONTRIBUTING.md).
 
 Support may be available on the
 [rgeo-users google group](https://groups.google.com/forum/#!forum/rgeo-users)
@@ -124,13 +131,15 @@ generate documentation locally if you're working on RGeo: `yardoc server`.
 
 Here's the current list of available topics:
 
-- [An introduction to Spatial Programming With RGeo](https://github.com/rgeo/rgeo/blob/master/doc/An-Introduction-to-Spatial-Programming-With-RGeo.md)
-- [Enable GEOS and Proj4 on Heroku](https://github.com/rgeo/rgeo/blob/master/doc/Enable-GEOS-and-Proj4-on-Heroku.md)
-- [Installing GEOS](https://github.com/rgeo/rgeo/blob/master/doc/Installing-GEOS.md)
-- [Factory Compatibility](https://github.com/rgeo/rgeo/blob/master/doc/Factory-Compatibility.md)
-- [Which factory should I use?](https://github.com/rgeo/rgeo/blob/master/doc/Which-factory-should-I-use.md)
-- [Examples](https://github.com/rgeo/rgeo/blob/master/doc/Examples.md)
-- [Who uses `rgeo`?](https://github.com/rgeo/rgeo/blob/master/doc/Gallery.md)
+- [An introduction to Spatial Programming With RGeo](https://github.com/rgeo/rgeo/blob/main/doc/An-Introduction-to-Spatial-Programming-With-RGeo.md)
+- [Enable GEOS and Proj4 on Heroku](https://github.com/rgeo/rgeo/blob/main/doc/Enable-GEOS-and-Proj4-on-Heroku.md)
+- [Installing GEOS](https://github.com/rgeo/rgeo/blob/main/doc/Installing-GEOS.md)
+- [Factory Compatibility](https://github.com/rgeo/rgeo/blob/main/doc/Factory-Compatibility.md)
+- [Which factory should I use?](https://github.com/rgeo/rgeo/blob/main/doc/Which-factory-should-I-use.md)
+- [Geometry validity handling](https://github.com/rgeo/rgeo/blob/main/doc/Geometry-Validity.md)
+- [Upgrading to Version 3](https://github.com/rgeo/rgeo/blob/main/doc/Upgrading-to-v3.md)
+- [Examples](https://github.com/rgeo/rgeo/blob/main/doc/Examples.md)
+- [Who uses `rgeo`?](https://github.com/rgeo/rgeo/blob/main/doc/Gallery.md)
 
 You can see an exhaustive and up to date list at https://rubydoc.info/gems/rgeo/index.
 ### Acknowledgments
@@ -157,4 +166,4 @@ by [J Smith](https://github.com/dark-panda).
 
 Copyright (c) Daniel Azuma, Tee Parham
 
-[License](https://github.com/rgeo/rgeo/blob/master/LICENSE.txt)
+[License](https://github.com/rgeo/rgeo/blob/main/LICENSE.txt)

data/ext/geos_c_impl/analysis.c

@@ -6,12 +6,13 @@
 
 #ifdef RGEO_GEOS_SUPPORTED
 
-#include <ruby.h>
 #include <geos_c.h>
+#include <ruby.h>
 
 #include "analysis.h"
-#include "factory.h"
 #include "errors.h"
+#include "factory.h"
+#include "globals.h"
 
 RGEO_BEGIN_C
 
@@ -23,9 +24,9 @@ RGEO_BEGIN_C
  * otherwise.
  */
 #ifdef RGEO_GEOS_SUPPORTS_ISCCW
-VALUE rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring)
+VALUE
+rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring)
 {
-
   const RGeo_GeometryData* ring_data;
   const GEOSCoordSequence* coord_seq;
   char is_ccw;
@@ -34,43 +35,47 @@ VALUE rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring)
 
   ring_data = RGEO_GEOMETRY_DATA_PTR(ring);
 
-  coord_seq = GEOSGeom_getCoordSeq_r(ring_data->geos_context, ring_data->geom);
-  if (!coord_seq) { rb_raise(geos_error, "Could not retrieve CoordSeq from given ring."); }
-  if (!GEOSCoordSeq_isCCW_r(ring_data->geos_context, coord_seq, &is_ccw)) {
-    rb_raise(geos_error, "Could not determine if the CoordSeq is CCW.");
+  coord_seq = GEOSGeom_getCoordSeq(ring_data->geom);
+  if (!coord_seq) {
+    rb_raise(rb_eGeosError, "Could not retrieve CoordSeq from given ring.");
+  }
+  if (!GEOSCoordSeq_isCCW(coord_seq, &is_ccw)) {
+    rb_raise(rb_eGeosError, "Could not determine if the CoordSeq is CCW.");
   }
 
   return is_ccw ? Qtrue : Qfalse;
-};
+}
 #endif // RGEO_GEOS_SUPPORTS_ISCCW
 
-
 /**
  * call-seq:
- *   RGeo::Geos::Analysis.ccw_supported? -> true or false 
- * 
+ *   RGeo::Geos::Analysis.ccw_supported? -> true or false
+ *
  * Checks if the RGEO_GEOS_SUPPORTS_ISCCW macro is defined, returns +true+
  * if it is, +false+ otherwise
  */
-VALUE rgeo_geos_analysis_supports_ccw(VALUE self)
+VALUE
+rgeo_geos_analysis_supports_ccw(VALUE self)
 {
-  #ifdef RGEO_GEOS_SUPPORTS_ISCCW
-    return Qtrue;
-  #else
-    return Qfalse;
-  #endif
+#ifdef RGEO_GEOS_SUPPORTS_ISCCW
+  return Qtrue;
+#else
+  return Qfalse;
+#endif
 }
 
-
-void rgeo_init_geos_analysis(RGeo_Globals* globals)
+void
+rgeo_init_geos_analysis()
 {
   VALUE geos_analysis_module;
 
-  geos_analysis_module = rb_define_module_under(globals->geos_module, "Analysis");
-  rb_define_singleton_method(geos_analysis_module, "ccw_supported?", rgeo_geos_analysis_supports_ccw, 0);
-  #ifdef RGEO_GEOS_SUPPORTS_ISCCW
-  rb_define_singleton_method(geos_analysis_module, "ccw?", rgeo_geos_analysis_ccw_p, 1);
-  #endif // RGEO_GEOS_SUPPORTS_ISCCW
+  geos_analysis_module = rb_define_module_under(rgeo_geos_module, "Analysis");
+  rb_define_singleton_method(
+    geos_analysis_module, "ccw_supported?", rgeo_geos_analysis_supports_ccw, 0);
+#ifdef RGEO_GEOS_SUPPORTS_ISCCW
+  rb_define_singleton_method(
+    geos_analysis_module, "ccw?", rgeo_geos_analysis_ccw_p, 1);
+#endif // RGEO_GEOS_SUPPORTS_ISCCW
 }
 
 RGEO_END_C

data/ext/geos_c_impl/analysis.h

@@ -9,8 +9,6 @@
 
 #ifdef RGEO_GEOS_SUPPORTED
 
-#include "factory.h"
-
 RGEO_BEGIN_C
 
 /*
@@ -21,19 +19,22 @@ RGEO_BEGIN_C
  * otherwise.
  */
 #ifdef RGEO_GEOS_SUPPORTS_CCW
-VALUE rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring);
+VALUE
+rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring);
 #endif // RGEO_GEOS_SUPPORTS_CCW
 
 /**
  * call-seq:
- *   RGeo::Geos::Analysis.ccw_supported? -> true or false 
- * 
+ *   RGeo::Geos::Analysis.ccw_supported? -> true or false
+ *
  * Checks if the RGEO_GEOS_SUPPORTS_ISCCW macro is defined, returns +true+
  * if it is, +false+ otherwise
  */
-VALUE rgeo_geos_analysis_supports_ccw(VALUE self);
+VALUE
+rgeo_geos_analysis_supports_ccw(VALUE self);
 
-void rgeo_init_geos_analysis(RGeo_Globals* globals);
+void
+rgeo_init_geos_analysis();
 
 RGEO_END_C
 

data/ext/geos_c_impl/coordinates.c

@@ -1,8 +1,9 @@
-#include <ruby.h>
 #include <geos_c.h>
+#include <ruby.h>
 
-
-VALUE extract_points_from_coordinate_sequence(GEOSContextHandle_t context, const GEOSCoordSequence* coord_sequence, int zCoordinate)
+VALUE
+extract_points_from_coordinate_sequence(const GEOSCoordSequence* coord_sequence,
+                                        int zCoordinate)
 {
   VALUE result = Qnil;
   VALUE point;
@@ -10,20 +11,20 @@ VALUE extract_points_from_coordinate_sequence(GEOSContextHandle_t context, const
   unsigned int i;
   double val;
 
-  if(GEOSCoordSeq_getSize_r(context, coord_sequence, &count)) {
+  if (GEOSCoordSeq_getSize(coord_sequence, &count)) {
     result = rb_ary_new2(count);
-    for(i = 0; i < count; ++i) {
-      if(zCoordinate) {
+    for (i = 0; i < count; ++i) {
+      if (zCoordinate) {
         point = rb_ary_new2(3);
       } else {
         point = rb_ary_new2(2);
       }
-      GEOSCoordSeq_getX_r(context, coord_sequence, i, &val);
+      GEOSCoordSeq_getX(coord_sequence, i, &val);
       rb_ary_push(point, rb_float_new(val));
-      GEOSCoordSeq_getY_r(context, coord_sequence, i, &val);
+      GEOSCoordSeq_getY(coord_sequence, i, &val);
       rb_ary_push(point, rb_float_new(val));
-      if(zCoordinate) {
-        GEOSCoordSeq_getZ_r(context, coord_sequence, i, &val);
+      if (zCoordinate) {
+        GEOSCoordSeq_getZ(coord_sequence, i, &val);
         rb_ary_push(point, rb_float_new(val));
       }
       rb_ary_push(result, point);
@@ -33,7 +34,8 @@ VALUE extract_points_from_coordinate_sequence(GEOSContextHandle_t context, const
   return result;
 }
 
-VALUE extract_points_from_polygon(GEOSContextHandle_t context, const GEOSGeometry* polygon, int zCoordinate)
+VALUE
+extract_points_from_polygon(const GEOSGeometry* polygon, int zCoordinate)
 {
   VALUE result = Qnil;
 
@@ -43,20 +45,24 @@ VALUE extract_points_from_polygon(GEOSContextHandle_t context, const GEOSGeometr
   unsigned int i;
 
   if (polygon) {
-    ring = GEOSGetExteriorRing_r(context, polygon);
-    coord_sequence = GEOSGeom_getCoordSeq_r(context, ring);
+    ring = GEOSGetExteriorRing(polygon);
+    coord_sequence = GEOSGeom_getCoordSeq(ring);
 
-    if(coord_sequence) {
-      interior_ring_count = GEOSGetNumInteriorRings_r(context, polygon);
+    if (coord_sequence) {
+      interior_ring_count = GEOSGetNumInteriorRings(polygon);
       result = rb_ary_new2(interior_ring_count + 1); // exterior + inner rings
 
-      rb_ary_push(result, extract_points_from_coordinate_sequence(context, coord_sequence, zCoordinate));
+      rb_ary_push(
+        result,
+        extract_points_from_coordinate_sequence(coord_sequence, zCoordinate));
 
-      for(i = 0; i < interior_ring_count; ++i) {
-        ring = GEOSGetInteriorRingN_r(context, polygon, i);
-        coord_sequence = GEOSGeom_getCoordSeq_r(context, ring);
-        if(coord_sequence) {
-          rb_ary_push(result, extract_points_from_coordinate_sequence(context, coord_sequence, zCoordinate));
+      for (i = 0; i < interior_ring_count; ++i) {
+        ring = GEOSGetInteriorRingN(polygon, i);
+        coord_sequence = GEOSGeom_getCoordSeq(ring);
+        if (coord_sequence) {
+          rb_ary_push(result,
+                      extract_points_from_coordinate_sequence(coord_sequence,
+                                                              zCoordinate));
         }
       }
     }

data/ext/geos_c_impl/coordinates.h

@@ -1,2 +1,5 @@
-VALUE extract_points_from_coordinate_sequence(GEOSContextHandle_t context, const GEOSCoordSequence* coord_sequence, int zCoordinate);
-VALUE extract_points_from_polygon(GEOSContextHandle_t context, const GEOSGeometry* polygon, int zCoordinate);
+VALUE
+extract_points_from_coordinate_sequence(const GEOSCoordSequence* coord_sequence,
+                                        int zCoordinate);
+VALUE
+extract_points_from_polygon(const GEOSGeometry* polygon, int zCoordinate);

data/ext/geos_c_impl/errors.c

@@ -9,23 +9,32 @@
 #ifdef RGEO_GEOS_SUPPORTED
 
 #include "errors.h"
+#include "globals.h"
 
 RGEO_BEGIN_C
 
-// Any error relative to RGeo.
-VALUE rgeo_error;
-// RGeo error specific to the GEOS implementation.
-VALUE geos_error;
+VALUE rb_eRGeoError;
+VALUE rb_eRGeoInvalidGeometry;
+VALUE rb_eRGeoParseError;
+VALUE rb_eRGeoUnsupportedOperation;
+VALUE rb_eGeosError;
 
-
-void rgeo_init_geos_errors() {
-  VALUE rgeo_module;
+void
+rgeo_init_geos_errors()
+{
   VALUE error_module;
 
-  rgeo_module = rb_define_module("RGeo");
   error_module = rb_define_module_under(rgeo_module, "Error");
-  rgeo_error = rb_define_class_under(error_module, "RGeoError", rb_eRuntimeError);
-  geos_error = rb_define_class_under(error_module, "GeosError", rgeo_error);
+  rb_eRGeoError =
+    rb_define_class_under(error_module, "RGeoError", rb_eRuntimeError);
+  rb_eRGeoInvalidGeometry =
+    rb_define_class_under(error_module, "InvalidGeometry", rb_eRGeoError);
+  rb_eRGeoUnsupportedOperation =
+    rb_define_class_under(error_module, "UnsupportedOperation", rb_eRGeoError);
+  rb_eRGeoParseError =
+    rb_define_class_under(error_module, "ParseError", rb_eRGeoError);
+  rb_eGeosError =
+    rb_define_class_under(error_module, "GeosError", rb_eRGeoError);
 }
 
 RGEO_END_C

data/ext/geos_c_impl/errors.h

@@ -8,12 +8,19 @@
 
 RGEO_BEGIN_C
 
-// Any error relative to RGeo.
-extern VALUE rgeo_error;
+// Main rgeo error type
+extern VALUE rb_eRGeoError;
+// RGeo::Error::InvalidGeometry
+extern VALUE rb_eRGeoInvalidGeometry;
+// RGeo::Error::ParseError
+extern VALUE rb_eRGeoParseError;
+// RGeo::Error::UnsupportedOperation
+extern VALUE rb_eRGeoUnsupportedOperation;
 // RGeo error specific to the GEOS implementation.
-extern VALUE geos_error;
+extern VALUE rb_eGeosError;
 
-void rgeo_init_geos_errors();
+void
+rgeo_init_geos_errors();
 
 RGEO_END_C
 

data/ext/geos_c_impl/extconf.rb

@@ -6,42 +6,56 @@
 #
 # -----------------------------------------------------------------------------
 def create_dummy_makefile
-  File.open("Makefile", "w") { |f_| f_.write(".PHONY: install\ninstall:\n") }
+  File.write("Makefile", ".PHONY: install\ninstall:\n")
 end
 
 if RUBY_DESCRIPTION =~ /^jruby\s/
   create_dummy_makefile
-else
-  require "mkmf"
+  exit
+end
 
-  geosconfig = with_config("geos-config") || find_executable("geos-config")
+require "mkmf"
 
-  if geosconfig
-    puts "Using GEOS compile configuration from #{geosconfig}"
-    $INCFLAGS << " " << `#{geosconfig} --cflags`.strip
-    geos_libs = `#{geosconfig} --clibs`.tr("\n", " ")
-    geos_libs.split(/\s+/).each do |flag|
-      $libs << " " + flag unless $libs.include?(flag)
-    end
-  end
+if ENV.key?("DEBUG") || ENV.key?("MAINTAINER_MODE")
+  $CFLAGS << " -DDEBUG" \
+             " -Wall" \
+             " -ggdb" \
+             " -pedantic" \
+             " -std=c17"
 
-  found_geos_ = false
-  if have_header("geos_c.h")
-    found_geos_ = true if have_func("GEOSSetSRID_r", "geos_c.h")
-    have_func("GEOSPreparedContains_r", "geos_c.h")
-    have_func("GEOSPreparedDisjoint_r", "geos_c.h")
-    have_func("GEOSUnaryUnion_r", "geos_c.h")
-    have_func("GEOSCoordSeq_isCCW_r", "geos_c.h")
-    have_func("rb_memhash", "ruby.h")
-  end
+  extra_flags = ENV.fetch("MAINTAINER_MODE", ENV.fetch("DEBUG", ""))
+  $CFLAGS << " " << extra_flags if extra_flags.strip.start_with?("-")
+end
 
-  if found_geos_
-    create_makefile("rgeo/geos/geos_c_impl")
-  else
-    puts "**** WARNING: Unable to find GEOS headers or libraries."
-    puts "**** Ensure that 'geos-config' is in your PATH or provide that full path via --with-geos-config"
-    puts "**** Compiling without GEOS support."
+geosconfig = with_config("geos-config") || find_executable("geos-config")
 
-    create_dummy_makefile
+if geosconfig
+  puts "Using GEOS compile configuration from #{geosconfig}"
+  $INCFLAGS << " " << IO.popen([geosconfig, "--cflags"], &:read).strip
+  geos_libs = IO.popen([geosconfig, "--clibs"], &:read)
+  geos_libs.split.each do |flag|
+    $libs << " " << flag unless $libs.include?(flag)
   end
 end
+
+found_geos = false
+if have_header("geos_c.h")
+  found_geos = true if have_func("GEOSSetSRID_r", "geos_c.h")
+  have_func("GEOSPreparedContains_r", "geos_c.h")
+  have_func("GEOSPreparedDisjoint_r", "geos_c.h")
+  have_func("GEOSUnaryUnion_r", "geos_c.h")
+  have_func("GEOSCoordSeq_isCCW_r", "geos_c.h")
+  have_func("GEOSDensify", "geos_c.h")
+  have_func("rb_memhash", "ruby.h")
+  have_func("rb_gc_mark_movable", "ruby.h")
+end
+
+if found_geos
+  create_makefile("rgeo/geos/geos_c_impl")
+else
+  puts "**** WARNING: Unable to find GEOS headers or libraries."
+  puts "**** Ensure that 'geos-config' is in your PATH or provide that full path via --with-geos-config"
+  puts "**** Compiling without GEOS support."
+
+  create_dummy_makefile
+end