rgeo 2.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8472a195fa15704c94ed5074f539d815477b9d05e1354e4a47dcf7110235f5e
-  data.tar.gz: 81914f85026703454776fd5816c25869a35ba00f77f6509dc815205d2f35b604
+  metadata.gz: 1e86885f1c2a19a3b89ea73784add4644f6cbfa6afb1cf73dc0f1dda22151923
+  data.tar.gz: 83690993b988a200dc689750e31f8aabdb78fc7aade2af339a068f5adb41b9a1
 SHA512:
-  metadata.gz: 6a6e0a821118e84e0052585431df5af8956a9f89882ce3314eeca72ff386617859bbe52a857b7761b8f8d8bc644a60734b5197fe209b20dd0d9fc294121735af
-  data.tar.gz: 2f68c55105f188e1f8c1b9c4bc1a5ae32e20b4dd630a3ade0038169a9d62fb3409cc85bad3c08bfb60bf0c73331f7c33192fb5c94622073974021e5b6447e9ae
+  metadata.gz: 733c109fc5858536ca56a18bac9d9ab78204365a1ea5cd2e4eb7f9d06eaf833cafb28907a547698954c5b5963be921b415b9e5cc881f7235d644be2619de482f
+  data.tar.gz: 7ab29b70bcfb8f7a58832271245a6a125861c5298db870a3ecad3ff2869aa56045fb42213b44609b44edcf7531349a205ef0e688773bab1f652508c66925730d

data/README.md

@@ -0,0 +1,160 @@
+## 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)
+
+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:
+
+This organization is looking for maintainers, see [this issue](https://github.com/rgeo/rgeo/issues/216) for more information.
+
+: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
+
+RGeo is a key component for writing location-aware applications in the Ruby
+programming language. At its core is an implementation of the industry
+standard OGC Simple Features Specification, which provides data
+representations of geometric objects such as points, lines, and polygons,
+along with a set of geometric analysis operations. This makes it ideal for
+modeling geolocation data. It also supports a suite of optional add-on modules
+that provide various geolocation-related services.
+
+Use the core **rgeo** gem to:
+
+*   Represent spatial and geolocation data objects such as points, lines, and
+    polygons in your Ruby application.
+*   Perform standard spatial analysis operations such as finding
+    intersections, creating buffers, and computing lengths and areas.
+*   Correctly handle spherical geometry, and compute geographic projections
+    for map display and data analysis.
+*   Read and write location data in the WKT and WKB representations used by
+    spatial databases.
+
+
+### Dependencies
+
+RGeo works with the following Ruby implementations:
+
+*   MRI Ruby 2.3.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.
+
+Some features also require the following:
+
+*   GEOS 3.2 or later is highly recommended. (3.3.3 or later preferred.) Some
+    functions will not be available without it. This C/C++ library may be
+    available via your operating system's package manager (`sudo aptitude
+    install libgeos-dev` for debian based Linux distributions, `yum install geos geos-devel` for redhat based Linux distributions), or you can
+    download it from http://trac.osgeo.org/geos
+*   On some platforms, you should install the ffi-geos gem (version 1.2.0 or
+    later recommended.) JRuby requires this gem to link properly with Geos,
+    and Windows builds probably do as well.
+
+### Installation
+
+Install the RGeo gem:
+
+```sh
+gem install rgeo
+```
+
+or include it in your Gemfile:
+
+```ruby
+gem "rgeo"
+```
+
+If you are using proj.4 extensions, include
+[`rgeo-proj4`](https://github.com/rgeo/rgeo-proj4):
+
+```ruby
+gem "rgeo-proj4"
+```
+
+
+### Extensions
+
+The [RGeo organization](https://github.com/rgeo) provides several gems that extend RGeo:
+
+#### [`rgeo-proj4`](https://github.com/rgeo/rgeo-proj4)
+
+Proj4 extensions
+
+#### [`rgeo-geojson`](https://github.com/rgeo/rgeo-geojson)
+
+Read and write GeoJSON
+
+#### [`rgeo-shapefile`](https://github.com/rgeo/rgeo-shapefile)
+
+Read ESRI shapefiles
+
+#### [`activerecord-postgis-adapter`](https://github.com/rgeo/activerecord-postgis-adapter)
+
+ActiveRecord connection adapter for PostGIS, based on postgresql (pg gem)
+
+#### [`activerecord-mysql2spatial-adapter`](https://github.com/rgeo/activerecord-mysql2spatial-adapter)
+
+ActiveRecord connection adapter for MySQL Spatial Extensions, based on mysql2
+
+#### [`activerecord-spatialite-adapter`](https://github.com/rgeo/activerecord-spatialite-adapter)
+
+ActiveRecord connection adapter for SpatiaLite, based on sqlite3 (*not maintained)
+
+
+### Development and support
+
+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).
+
+Support may be available on the
+[rgeo-users google group](https://groups.google.com/forum/#!forum/rgeo-users)
+or on [Stack Overflow](https://stackoverflow.com/questions/tagged/rgeo).
+
+### Documentation
+
+You can see more in-depth documentation in the `doc` folder. Factories and
+methods are documented inline, you should consider checking
+https://rubydoc.info/gems/rgeo with the version you are currently using. Or
+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)
+
+You can see an exhaustive and up to date list at https://rubydoc.info/gems/rgeo/index.
+### Acknowledgments
+
+[Daniel Azuma](http://www.daniel-azuma.com) created RGeo.
+[Tee Parham](http://twitter.com/teeparham) is a former maintainer.
+[Keith Doggett](http://www.github.com/keithdoggett), [Ulysse Buonomo](http://www.github.com/BuonOmo) are current maintainers.
+
+Development is supported by:
+
+- [Klaxit](https://www.github.com/klaxit)
+- Goldfish Ads
+
+RGeo calls the GEOS library to handle most Cartesian geometric calculations,
+and the Proj4 library to handle projections and coordinate transformations.
+These libraries are maintained by the Open Source Geospatial Foundation; more
+information is available on [OSGeo's web site](http://www.osgeo.org).
+
+JRuby support is made possible by the ffi-geos (and upcoming ffi-proj4) gems,
+by [J Smith](https://github.com/dark-panda).
+
+
+### License
+
+Copyright (c) Daniel Azuma, Tee Parham
+
+[License](https://github.com/rgeo/rgeo/blob/master/LICENSE.txt)

data/ext/geos_c_impl/analysis.c

@@ -0,0 +1,78 @@
+/*
+  Analysis methos for GEOS wrapper
+*/
+
+#include "preface.h"
+
+#ifdef RGEO_GEOS_SUPPORTED
+
+#include <ruby.h>
+#include <geos_c.h>
+
+#include "analysis.h"
+#include "factory.h"
+#include "errors.h"
+
+RGEO_BEGIN_C
+
+/*
+ * call-seq:
+ *   RGeo::Geos::Analysis.ccw? -> true or false
+ *
+ * Checks direction for a ring, returns +true+ if counter-clockwise, +false+
+ * otherwise.
+ */
+#ifdef RGEO_GEOS_SUPPORTS_ISCCW
+VALUE rgeo_geos_analysis_ccw_p(VALUE self, VALUE ring)
+{
+
+  const RGeo_GeometryData* ring_data;
+  const GEOSCoordSequence* coord_seq;
+  char is_ccw;
+
+  rgeo_check_geos_object(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.");
+  }
+
+  return is_ccw ? Qtrue : Qfalse;
+};
+#endif // RGEO_GEOS_SUPPORTS_ISCCW
+
+
+/**
+ * call-seq:
+ *   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)
+{
+  #ifdef RGEO_GEOS_SUPPORTS_ISCCW
+    return Qtrue;
+  #else
+    return Qfalse;
+  #endif
+}
+
+
+void rgeo_init_geos_analysis(RGeo_Globals* globals)
+{
+  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
+}
+
+RGEO_END_C
+
+#endif

data/ext/geos_c_impl/analysis.h

@@ -0,0 +1,42 @@
+/*
+  Analysis methos for GEOS wrapper
+*/
+
+#ifndef RGEO_GEOS_ANALYSIS_INCLUDED
+#define RGEO_GEOS_ANALYSIS_INCLUDED
+
+#include <ruby.h>
+
+#ifdef RGEO_GEOS_SUPPORTED
+
+#include "factory.h"
+
+RGEO_BEGIN_C
+
+/*
+ * call-seq:
+ *   RGeo::Geos::Analysis.ccw? -> true or false
+ *
+ * Checks direction for a ring, returns +true+ if counter-clockwise, +false+
+ * otherwise.
+ */
+#ifdef RGEO_GEOS_SUPPORTS_CCW
+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 
+ * 
+ * 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);
+
+void rgeo_init_geos_analysis(RGeo_Globals* globals);
+
+RGEO_END_C
+
+#endif // RGEO_GEOS_SUPPORTED
+
+#endif // RGEO_GEOS_ANALYSIS_INCLUDED

data/ext/geos_c_impl/errors.c

@@ -0,0 +1,35 @@
+
+#ifndef RGEO_GEOS_ERROS_INCLUDED
+#define RGEO_GEOS_ERROS_INCLUDED
+
+#include <ruby.h>
+
+#include "preface.h"
+
+#ifdef RGEO_GEOS_SUPPORTED
+
+#include "errors.h"
+
+RGEO_BEGIN_C
+
+// Any error relative to RGeo.
+VALUE rgeo_error;
+// RGeo error specific to the GEOS implementation.
+VALUE geos_error;
+
+
+void rgeo_init_geos_errors() {
+  VALUE rgeo_module;
+  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);
+}
+
+RGEO_END_C
+
+#endif // RGEO_GEOS_SUPPORTED
+
+#endif // RGEO_GEOS_ERROS_INCLUDED

data/ext/geos_c_impl/errors.h

@@ -0,0 +1,22 @@
+
+#ifndef RGEO_GEOS_ERROS_INCLUDED
+#define RGEO_GEOS_ERROS_INCLUDED
+
+#include <ruby.h>
+
+#ifdef RGEO_GEOS_SUPPORTED
+
+RGEO_BEGIN_C
+
+// Any error relative to RGeo.
+extern VALUE rgeo_error;
+// RGeo error specific to the GEOS implementation.
+extern VALUE geos_error;
+
+void rgeo_init_geos_errors();
+
+RGEO_END_C
+
+#endif // RGEO_GEOS_SUPPORTED
+
+#endif // RGEO_GEOS_ERROS_INCLUDED

data/ext/geos_c_impl/extconf.rb

@@ -31,6 +31,7 @@ else
     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
 

data/ext/geos_c_impl/factory.c

@@ -16,6 +16,7 @@
 #include "line_string.h"
 #include "polygon.h"
 #include "geometry_collection.h"
+#include "errors.h"
 
 RGEO_BEGIN_C
 
@@ -576,10 +577,11 @@ RGeo_Globals* rgeo_init_geos_factory()
   VALUE wrapped_globals;
   VALUE feature_module;
 
+  rgeo_module = rb_define_module("RGeo");
+
   globals = ALLOC(RGeo_Globals);
 
   // Cache some modules so we don't have to look them up by name every time
-  rgeo_module = rb_define_module("RGeo");
   feature_module = rb_define_module_under(rgeo_module, "Feature");
   globals->feature_module = feature_module;
   globals->geos_module = rb_define_module_under(rgeo_module, "Geos");
@@ -831,6 +833,13 @@ char rgeo_is_geos_object(VALUE obj)
   return (TYPE(obj) == T_DATA && RDATA(obj)->dfree == (RUBY_DATA_FUNC)destroy_geometry_func) ? 1 : 0;
 }
 
+void rgeo_check_geos_object(VALUE obj)
+{
+  if (!rgeo_is_geos_object(obj)) {
+    rb_raise(rgeo_error, "Not a GEOS Geometry object.");
+  }
+}
+
 
 const GEOSGeometry* rgeo_get_geos_geometry_safe(VALUE obj)
 {

data/ext/geos_c_impl/factory.h

@@ -10,7 +10,6 @@
 
 RGEO_BEGIN_C
 
-
 /*
   Per-interpreter globals.
   Most of these are cached references to commonly used classes, modules,
@@ -187,6 +186,11 @@ GEOSGeometry* rgeo_convert_to_detached_geos_geometry(VALUE obj, VALUE factory, V
 */
 char rgeo_is_geos_object(VALUE obj);
 
+/*
+  Raises a rgeo error if the object is not a GEOS Geometry implementation.
+*/
+void rgeo_check_geos_object(VALUE obj);
+
 /*
   Gets the underlying GEOS geometry for a given ruby object. Returns NULL
   if the given ruby object is not a GEOS geometry wrapper.

data/ext/geos_c_impl/geometry.c

@@ -756,7 +756,9 @@ static VALUE method_geometry_buffer_with_style(VALUE self, VALUE distance, VALUE
                                      GEOSBufferWithStyle_r(self_data->geos_context, self_geom,
                                                            rb_num2dbl(distance),
                                                            RGEO_FACTORY_DATA_PTR(factory)->buffer_resolution,
-                                                           endCapStyle, joinStyle, mitreLimit),
+                                                           rb_num2int(endCapStyle),
+                                                           rb_num2int(joinStyle),
+                                                           rb_num2dbl(mitreLimit)),
                                      Qnil);
   }
   return result;
@@ -1043,12 +1045,28 @@ static VALUE method_geometry_invalid_reason(VALUE self)
   self_geom = self_data->geom;
   if (self_geom) {
     str = GEOSisValidReason_r(self_data->geos_context, self_geom);
-    if (str) {
-      result = rb_str_new2(str);
-    }
-    else {
-      result = rb_str_new2("Exception");
-    }
+    // Per documentation, a valid geometry should give an empty string.
+    // However it seems not to be the case. Hence the comparison against
+    // the string that is really given: `"Valid Geometry"`.
+    // See https://github.com/libgeos/geos/issues/431.
+    if (str) result = (str[0] == '\0' || !strcmp(str, "Valid Geometry")) ? Qnil : rb_str_new2(str);
+    else result = rb_str_new2("Exception");
+    GEOSFree_r(self_data->geos_context, str);
+  }
+  return result;
+}
+
+static VALUE method_geometry_point_on_surface(VALUE self)
+{
+  VALUE result;
+  RGeo_GeometryData* self_data;
+  const GEOSGeometry* self_geom;
+
+  result = Qnil;
+  self_data = RGEO_GEOMETRY_DATA_PTR(self);
+  self_geom = self_data->geom;
+  if (self_geom) {
+    result = rgeo_wrap_geos_geometry(self_data->factory, GEOSPointOnSurface_r(self_data->geos_context, self_geom), Qnil);
   }
   return result;
 }
@@ -1107,6 +1125,7 @@ void rgeo_init_geos_geometry(RGeo_Globals* globals)
   rb_define_method(geos_geometry_methods, "sym_difference", method_geometry_sym_difference, 1);
   rb_define_method(geos_geometry_methods, "valid?", method_geometry_is_valid, 0);
   rb_define_method(geos_geometry_methods, "invalid_reason", method_geometry_invalid_reason, 0);
+  rb_define_method(geos_geometry_methods, "point_on_surface", method_geometry_point_on_surface, 0);
 }