librtree 0.8.5 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9abe4061328dd6a2b8b9f1c00a38f76332a0f0a188af7a5d3e6f1125eab346e
-  data.tar.gz: 4029ed06803576cc76ec7bd8d3d1eb9a2d628da9fd982d04e80b643177fce244
+  metadata.gz: d796bcdad6e023f99009363c9c11a10d8c6dfc7b9c797b487925fa319ace78b9
+  data.tar.gz: 83d563781db1c1e1b6bd8b8790cbb68fbbd9a7f997dd49840ff8cba7bfcac3e8
 SHA512:
-  metadata.gz: f6b7005f8ec37a45ff8ee894de5642eb969a26af72ad9fa330aeeae1c746447d786b309301e84116de595bed40f70bef8683fbd9a969b2b9c2cabb32e5c4d374
-  data.tar.gz: c4c6641e2cdfd9f14f21b50047fe2f304ab1446eb643a0f6cd3acd594fbc37469cf71c78434daa82b759bdb2741a1f887add7809d72c7bbc3f39886aee3ecc9b
+  metadata.gz: e1a6c56ad9c14ae15c8ed047e980262477f36b672bb08c5cc584eff7b2fba3b20845e8671ee166f8929abbb5a7d11e596cca36da6d89a67cef167773ada20577
+  data.tar.gz: b699d85386e8ea991eb2d4e4816635b6a0d550e2dbeb36b670526186d0b72f72f8cf763d22ba6339fe595dc3f70c7d6f9e9bfa5714216ec125e0b1748c146d97

data/ext/rtree/rtree.c

@@ -4,48 +4,33 @@
 
 #include <rtree.h>
 #include <rtree/package.h>
+#include <rtree/postscript.h>
 
 #include <errno.h>
 #include <stdint.h>
 
+static rb_data_type_t style_type;
+static rb_data_type_t rtree_type;
 
-static void lrt_dfree(void *p)
+static void rt_dfree(void *p)
 {
   rtree_destroy((rtree_t*)p);
 }
 
-static size_t lrt_dsize(const void *p)
+static size_t rt_dsize(const void *p)
 {
   return rtree_bytes((const rtree_t*)p);
 }
 
-static rb_data_type_t type = {
-  .wrap_struct_name = "rtree-wrap",
-  .function = {
-    .dmark = NULL,
-    .dfree = lrt_dfree,
-    .dsize = lrt_dsize,
-#if RUBY_API_VERSION_CODE < 20700
-    .reserved = { NULL, NULL }
-#else
-    .dcompact = NULL,
-    .reserved = { NULL }
-#endif
-  },
-  .parent = NULL,
-  .data = NULL,
-  .flags = RUBY_TYPED_FREE_IMMEDIATELY
-};
-
-static VALUE lrt_alloc(VALUE cls)
+static VALUE rt_alloc(VALUE cls)
 {
   rtree_t *rtree;;
   if ((rtree = rtree_alloc()) == NULL)
     rb_raise(rb_eNoMemError, "failed to alloc rtree");
-  return TypedData_Wrap_Struct(cls, &type, rtree);
+  return TypedData_Wrap_Struct(cls, &rtree_type, rtree);
 }
 
-static VALUE lrt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
+static VALUE rt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
 {
   Check_Type(dim_obj, T_FIXNUM);
   size_t dim = FIX2ULONG(dim_obj);
@@ -54,7 +39,7 @@ static VALUE lrt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
   state_flags_t flags = FIX2UINT(flags_obj);
 
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   if ((rtree_init(rtree, dim, flags)) != 0)
     rb_raise(rb_eNoMemError, "failed to init rtree");
@@ -62,28 +47,28 @@ static VALUE lrt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
   return self;
 }
 
-static VALUE lrt_release(VALUE self)
+static VALUE rt_release(VALUE self)
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
   rtree_destroy(rtree);
   return self;
 }
 
-static VALUE lrt_height(VALUE self)
+static VALUE rt_height(VALUE self)
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
   return INT2NUM(rtree_height(rtree));
 }
 
-static VALUE lrt_add_rect(VALUE self, VALUE id_obj, VALUE coord_obj)
+static VALUE rt_add_rect(VALUE self, VALUE id_obj, VALUE coord_obj)
 {
   Check_Type(coord_obj, T_ARRAY);
   Check_Type(id_obj, T_FIXNUM);
 
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   rtree_id_t
     id = FIX2ULONG(id_obj);
@@ -135,13 +120,13 @@ static int update_cb(rtree_id_t id, rtree_coord_t *coord, void *context)
   return 0;
 }
 
-static VALUE lrt_update(VALUE self)
+static VALUE rt_update(VALUE self)
 {
   if (!rb_block_given_p())
     rb_raise(rb_eArgError, "Expected block");
 
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   size_t len = 2 * state_dims(rtree->state);
   int err = rtree_update(rtree, update_cb, &len);
@@ -154,10 +139,10 @@ static VALUE lrt_update(VALUE self)
 
 /*
   The librtree API expects the search callback to return zero to
-  continue the search, non-zero to terminate. I was expecting to
+  continue the search, non-zero to terminate.  I was expecting to
   need to wrap the 'yield' in 'rescue's and 'ensure's to handle
   exceptions and breaks, but find that doing nothing actually does
-  the right thing (see specs).  The search implemetation is just
+  the right thing (see specs).  The search implementation is just
   a recursive search through the tree (as you would expect) so
   there is no end-of-search cleanup to do, so I think this is all
   just fine ... wild
@@ -169,7 +154,7 @@ static int search_cb(rtree_id_t id, void *context)
   return 0;
 }
 
-static VALUE lrt_search(VALUE self, VALUE coord_obj)
+static VALUE rt_search(VALUE self, VALUE coord_obj)
 {
   if (!rb_block_given_p())
     rb_raise(rb_eArgError, "Expected block");
@@ -177,7 +162,7 @@ static VALUE lrt_search(VALUE self, VALUE coord_obj)
   Check_Type(coord_obj, T_ARRAY);
 
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   size_t
     len = RARRAY_LEN(coord_obj),
@@ -220,21 +205,21 @@ static VALUE deserialise(VALUE cls, VALUE io_obj, deserialise_t *f)
         rb_raise(rb_eRuntimeError, "Failed read from stream");
     }
 
-  return TypedData_Wrap_Struct(cls, &type, rtree);
+  return TypedData_Wrap_Struct(cls, &rtree_type, rtree);
 }
 
-static VALUE lrt_json_read(VALUE cls, VALUE io_obj)
+static VALUE rt_json_read(VALUE cls, VALUE io_obj)
 {
   return deserialise(cls, io_obj, rtree_json_read);
 }
 
-static VALUE lrt_bsrt_read(VALUE cls, VALUE io_obj)
+static VALUE rt_bsrt_read(VALUE cls, VALUE io_obj)
 {
   return deserialise(cls, io_obj, rtree_bsrt_read);
 }
 
-static VALUE lrt_csv_read(VALUE cls,
-                          VALUE io_obj, VALUE dim_obj, VALUE flags_obj)
+static VALUE rt_csv_read(VALUE cls,
+                         VALUE io_obj, VALUE dim_obj, VALUE flags_obj)
 {
   Check_Type(io_obj, T_FILE);
   rb_io_t *io;
@@ -259,7 +244,7 @@ static VALUE lrt_csv_read(VALUE cls,
         rb_raise(rb_eRuntimeError, "Failed read from stream");
     }
 
-  return TypedData_Wrap_Struct(cls, &type, rtree);
+  return TypedData_Wrap_Struct(cls, &rtree_type, rtree);
 }
 
 /* serialisation */
@@ -277,7 +262,7 @@ static VALUE serialise(VALUE self, VALUE io_obj, serialise_t *f)
   FILE *fp = rb_io_stdio_file(io);
 
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   int err = f(rtree, fp);
   if (err != 0)
@@ -286,22 +271,22 @@ static VALUE serialise(VALUE self, VALUE io_obj, serialise_t *f)
   return self;
 }
 
-static VALUE lrt_json_write(VALUE self, VALUE io_obj)
+static VALUE rt_json_write(VALUE self, VALUE io_obj)
 {
   return serialise(self, io_obj, rtree_json_write);
 }
 
-static VALUE lrt_bsrt_write(VALUE self, VALUE io_obj)
+static VALUE rt_bsrt_write(VALUE self, VALUE io_obj)
 {
   return serialise(self, io_obj, rtree_bsrt_write);
 }
 
-static VALUE lrt_identical(VALUE self, VALUE other)
+static VALUE rt_identical(VALUE self, VALUE other)
 {
   rtree_t *rtree_self, *rtree_other;
 
-  TypedData_Get_Struct(self, rtree_t, &type, rtree_self);
-  TypedData_Get_Struct(other, rtree_t, &type, rtree_other);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree_self);
+  TypedData_Get_Struct(other, rtree_t, &rtree_type, rtree_other);
 
   if (rtree_identical(rtree_self, rtree_other))
     return Qtrue;
@@ -309,10 +294,10 @@ static VALUE lrt_identical(VALUE self, VALUE other)
     return Qfalse;
 }
 
-static VALUE lrt_clone(VALUE self)
+static VALUE rt_clone(VALUE self)
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
 
   rtree_t *clone;
   errno = 0;
@@ -324,102 +309,231 @@ static VALUE lrt_clone(VALUE self)
         rb_raise(rb_eRuntimeError, "Failed clone");
     }
 
-  return TypedData_Wrap_Struct(CLASS_OF(self), &type, clone);
+  return TypedData_Wrap_Struct(CLASS_OF(self), &rtree_type, clone);
 }
 
 static VALUE state_size_access(VALUE self, size_t (*f)(const state_t*))
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
   return INT2NUM(f(rtree->state));
 }
 
-static VALUE lrt_dim(VALUE self)
+static VALUE rt_dim(VALUE self)
 {
   return state_size_access(self, state_dims);
 }
 
-static VALUE lrt_page_size(VALUE self)
+static VALUE rt_page_size(VALUE self)
 {
   return state_size_access(self, state_page_size);
 }
 
-static VALUE lrt_node_size(VALUE self)
+static VALUE rt_node_size(VALUE self)
 {
   return state_size_access(self, state_node_size);
 }
 
-static VALUE lrt_rect_size(VALUE self)
+static VALUE rt_rect_size(VALUE self)
 {
   return state_size_access(self, state_rect_size);
 }
 
-static VALUE lrt_branch_size(VALUE self)
+static VALUE rt_branch_size(VALUE self)
 {
   return state_size_access(self, state_branch_size);
 }
 
-static VALUE lrt_branching_factor(VALUE self)
+static VALUE rt_branching_factor(VALUE self)
 {
   return state_size_access(self, state_branching_factor);
 }
 
-static VALUE lrt_unit_sphere_volume(VALUE self)
+static VALUE rt_unit_sphere_volume(VALUE self)
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
   return DBL2NUM(state_unit_sphere_volume(rtree->state));
 }
 
-static VALUE lrt_size(VALUE self)
+static VALUE rt_size(VALUE self)
 {
   rtree_t *rtree;
-  TypedData_Get_Struct(self, rtree_t, &type, rtree);
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
   return INT2NUM(rtree_bytes(rtree));
 }
 
-static VALUE lrt_version(VALUE self)
+static VALUE rt_version(VALUE self)
 {
   return rb_str_new_cstr(rtree_package_version);
 }
 
-static VALUE lrt_bugreport(VALUE self)
+static VALUE rt_bugreport(VALUE self)
 {
   return rb_str_new_cstr(rtree_package_bugreport);
 }
 
-static VALUE lrt_url(VALUE self)
+static VALUE rt_url(VALUE self)
 {
   return rb_str_new_cstr(rtree_package_url);
 }
 
+static VALUE rt_postscript(VALUE self,
+                           VALUE style_obj,
+                           VALUE axis_obj,
+                           VALUE extent_obj,
+                           VALUE margin_obj,
+                           VALUE io_obj)
+{
+  rtree_t *rtree;
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
+
+  style_t *style;
+  TypedData_Get_Struct(style_obj, style_t, &style_type, style);
+
+  Check_Type(io_obj, T_FILE);
+  rb_io_t *io;
+  GetOpenFile(io_obj, io);
+  rb_io_check_initialized(io);
+  rb_io_check_writable(io);
+  FILE *fp = rb_io_stdio_file(io);
+
+  float
+    extent = NUM2DBL(extent_obj),
+    margin = NUM2DBL(margin_obj);
+
+  Check_Type(axis_obj, T_FIXNUM);
+  extent_axis_t axis = FIX2UINT(axis_obj);
+
+  rtree_postscript_t opt =
+    {
+     .style = style,
+     .axis = axis,
+     .extent = extent,
+     .margin = margin,
+     .title = "librtree-ruby output"
+    };
+
+  int err;
+  if ((err = rtree_postscript(rtree, &opt, fp)) != 0)
+    rb_raise(rb_eRuntimeError, "librtree: %s", rtree_strerror(err));
+
+  return Qnil;
+}
+
+static rb_data_type_t rtree_type = {
+  .wrap_struct_name = "rtree-wrap",
+  .function = {
+    .dmark = NULL,
+    .dfree = rt_dfree,
+    .dsize = rt_dsize,
+#if RUBY_API_VERSION_CODE < 20700
+    .reserved = { NULL, NULL }
+#else
+    .dcompact = NULL,
+    .reserved = { NULL }
+#endif
+  },
+  .parent = NULL,
+  .data = NULL,
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+/* RTree::Style */
+
+static void st_dfree(void *p)
+{
+  postscript_style_destroy((style_t*)p);
+}
+
+static VALUE st_release(VALUE self)
+{
+  style_t *style;
+  TypedData_Get_Struct(self, style_t, &style_type, style);
+  postscript_style_destroy(style);
+  return self;
+}
+
+static VALUE st_json_read(VALUE cls, VALUE io_obj)
+{
+  Check_Type(io_obj, T_FILE);
+
+  rb_io_t *io;
+  GetOpenFile(io_obj, io);
+  rb_io_check_initialized(io);
+  rb_io_check_readable(io);
+  FILE *fp = rb_io_stdio_file(io);
+
+  style_t *style;
+  errno = 0;
+
+  if ((style = postscript_style_read(fp)) == NULL)
+    {
+      if (errno)
+        rb_sys_fail(__func__);
+      else
+        rb_raise(rb_eRuntimeError, "Failed read from stream");
+    }
+
+  return TypedData_Wrap_Struct(cls, &style_type, style);
+}
+
+static rb_data_type_t style_type = {
+  .wrap_struct_name = "style-wrap",
+  .function = {
+    .dmark = NULL,
+    .dfree = st_dfree,
+    .dsize = NULL,
+#if RUBY_API_VERSION_CODE < 20700
+    .reserved = { NULL, NULL }
+#else
+    .dcompact = NULL,
+    .reserved = { NULL }
+#endif
+  },
+  .parent = NULL,
+  .data = NULL,
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
 void Init_rtree(void)
 {
-  VALUE cls = rb_const_get(rb_cObject, rb_intern("RTreeC"));
-
-  rb_define_alloc_func(cls, lrt_alloc);
-  rb_define_method(cls, "initialize", lrt_init, 2);
-  rb_define_method(cls, "free", lrt_release, 0);
-  rb_define_method(cls, "clone", lrt_clone, 0);
-  rb_define_method(cls, "update!", lrt_update, 0);
-  rb_define_method(cls, "height", lrt_height, 0);
-  rb_define_method(cls, "add_rect", lrt_add_rect, 2);
-  rb_define_method(cls, "search", lrt_search, 1);
-  rb_define_method(cls, "json_write", lrt_json_write, 1);
-  rb_define_method(cls, "bsrt_write", lrt_bsrt_write, 1);
-  rb_define_method(cls, "eq?", lrt_identical, 1);
-  rb_define_method(cls, "dim", lrt_dim, 0);
-  rb_define_method(cls, "size", lrt_size, 0);
-  rb_define_method(cls, "page_size", lrt_page_size, 0);
-  rb_define_method(cls, "node_size", lrt_node_size, 0);
-  rb_define_method(cls, "rect_size", lrt_rect_size, 0);
-  rb_define_method(cls, "branch_size", lrt_branch_size, 0);
-  rb_define_method(cls, "branching_factor", lrt_branching_factor, 0);
-  rb_define_method(cls, "unit_sphere_volume", lrt_unit_sphere_volume, 0);
-  rb_define_singleton_method(cls, "version", lrt_version, 0);
-  rb_define_singleton_method(cls, "bugreport", lrt_bugreport, 0);
-  rb_define_singleton_method(cls, "url", lrt_url, 0);
-  rb_define_singleton_method(cls, "json_read", lrt_json_read, 1);
-  rb_define_singleton_method(cls, "bsrt_read", lrt_bsrt_read, 1);
-  rb_define_singleton_method(cls, "csv_read", lrt_csv_read, 3);
+  VALUE cRTreeBase = rb_const_get(rb_cObject, rb_intern("RTreeBase"));
+
+  rb_define_alloc_func(cRTreeBase, rt_alloc);
+  rb_define_method(cRTreeBase, "initialize", rt_init, 2);
+  rb_define_method(cRTreeBase, "free", rt_release, 0);
+  rb_define_method(cRTreeBase, "clone", rt_clone, 0);
+  rb_define_method(cRTreeBase, "update!", rt_update, 0);
+  rb_define_method(cRTreeBase, "height", rt_height, 0);
+  rb_define_method(cRTreeBase, "add_rect", rt_add_rect, 2);
+  rb_define_method(cRTreeBase, "search", rt_search, 1);
+  rb_define_method(cRTreeBase, "json_write", rt_json_write, 1);
+  rb_define_method(cRTreeBase, "bsrt_write", rt_bsrt_write, 1);
+  rb_define_method(cRTreeBase, "eq?", rt_identical, 1);
+  rb_define_method(cRTreeBase, "dim", rt_dim, 0);
+  rb_define_method(cRTreeBase, "size", rt_size, 0);
+  rb_define_method(cRTreeBase, "page_size", rt_page_size, 0);
+  rb_define_method(cRTreeBase, "node_size", rt_node_size, 0);
+  rb_define_method(cRTreeBase, "rect_size", rt_rect_size, 0);
+  rb_define_method(cRTreeBase, "branch_size", rt_branch_size, 0);
+  rb_define_method(cRTreeBase, "branching_factor", rt_branching_factor, 0);
+  rb_define_method(cRTreeBase, "unit_sphere_volume", rt_unit_sphere_volume, 0);
+  rb_define_method(cRTreeBase, "postscript", rt_postscript, 5);
+  rb_define_singleton_method(cRTreeBase, "version", rt_version, 0);
+  rb_define_singleton_method(cRTreeBase, "bugreport", rt_bugreport, 0);
+  rb_define_singleton_method(cRTreeBase, "url", rt_url, 0);
+  rb_define_singleton_method(cRTreeBase, "json_read", rt_json_read, 1);
+  rb_define_singleton_method(cRTreeBase, "bsrt_read", rt_bsrt_read, 1);
+  rb_define_singleton_method(cRTreeBase, "csv_read", rt_csv_read, 3);
+  rb_define_const(cRTreeBase, "SPLIT_QUADRATIC", INT2NUM(RTREE_SPLIT_QUADRATIC));
+  rb_define_const(cRTreeBase, "SPLIT_LINEAR", INT2NUM(RTREE_SPLIT_LINEAR));
+  rb_define_const(cRTreeBase, "SPLIT_GREENE", INT2NUM(RTREE_SPLIT_GREENE));
+  rb_define_const(cRTreeBase, "AXIS_HEIGHT", INT2NUM(axis_height));
+  rb_define_const(cRTreeBase, "AXIS_WIDTH", INT2NUM(axis_width));
+
+  VALUE cRTreeStyleBase = rb_const_get(rb_cObject, rb_intern("RTreeStyleBase"));
+
+  rb_define_method(cRTreeStyleBase, "free", st_release, 0);
+  rb_define_singleton_method(cRTreeStyleBase, "json_read", st_json_read, 1);
 }

data/lib/rtree.rb

@@ -1,5 +1,14 @@
-# The Ruby/C interface, which is not documented in YARD.
-class RTreeC ; end
+# The internal Ruby/C interface for RTree, not documented in YARD.
+#
+class RTreeBase ; end
+
+# The internal Ruby/C interface for RTree::Style, not documented in YARD.
+#
+class RTreeStyleBase ; end
+
+require 'rtree/rtree'
+require 'json'
+require 'fcntl'
 
 # @author RTree J. J. Green
 #
@@ -51,7 +60,26 @@ class RTreeC ; end
 # determined at compile-time (with the RTREE_ID_TYPE variable) and by
 # default this is a 64-bit unsigned integer.
 #
-class RTree < RTreeC
+class RTree < RTreeBase
+
+  module IOUtil
+
+    private
+
+    # In Ruby 3, the Fibres facility exploits non-blocking IO and so pipes
+    # are non-blocking by default, this buggers-up the deserialise method
+    # since there is short delay forking here -- so we reinstate blocking
+    # with some fairly low-level fcntl)2) magick.
+
+    def unset_nonblock(fd)
+      flags0 = fd.fcntl(Fcntl::F_GETFL, 0)
+      flags1 = flags0 & ~Fcntl::O_NONBLOCK
+      fd.fcntl(Fcntl::F_SETFL, flags1)
+    end
+
+  end
+
+  extend IOUtil
 
   class << self
 
@@ -61,6 +89,7 @@ class RTree < RTreeC
     # @see #json_write
     # @example Read from file
     #   rtree = File.open('rtree.json', 'r') { |io| RTree.json_read(io) }
+    #
     def json_read(io)
       super
     end
@@ -69,6 +98,7 @@ class RTree < RTreeC
     # @param json [String] a JSON string
     # @return [RTree] the newly instantiated RTree
     # @see #to_json
+    #
     def from_json(json)
       deserialise(json, Encoding::UTF_8) { |io| json_read(io) }
     end
@@ -80,6 +110,7 @@ class RTree < RTreeC
     # @see #bsrt_write
     # @example Read from file
     #   rtree = File.open('rtree.bsrt', 'r') { |io| RTree.bsrt_read(io) }
+    #
     def bsrt_read(io)
       super
     end
@@ -89,6 +120,7 @@ class RTree < RTreeC
     # @param bsrt [String] a binary encoded string
     # @return [RTree] the newly instantiated RTree
     # @see #to_bsrt
+    #
     def from_bsrt(bsrt)
       deserialise(bsrt, Encoding::BINARY) { |io| bsrt_read(io) }
     end
@@ -96,7 +128,7 @@ class RTree < RTreeC
     # Build a new RTree instance from CSV stream
     # @param io [IO] a readable stream object
     # @param dim [Integer] the dimension of the tree
-    # @param split [:linear, :quadratic] See {#initialize}
+    # @param split [:linear, :quadratic, :greene] See {#initialize}
     # @param node_page [Integer] See {#initialize}
     # @return [RTree] the newly built RTree
     # @note The CSV file (without header) should have the id in the
@@ -104,6 +136,7 @@ class RTree < RTreeC
     #   Extra columns may be present and will be ignored (this
     #   useful feature is the reason that the dimension is a required
     #   argument).
+    #
     def csv_read(io, dim, split: :quadratic, node_page: 0)
       flags = split_flag(split) | node_page_flag(node_page)
       super(io, dim, flags)
@@ -114,6 +147,7 @@ class RTree < RTreeC
     # @param dim [Integer] the dimension of the tree
     # @param kwarg [Hash] As for {.csv_read}
     # @return [RTree] the newly built RTree
+    #
     def from_csv(csv, dim, **kwarg)
       deserialise(csv, Encoding::UTF_8) do |io|
         csv_read(io, dim, **kwarg)
@@ -121,33 +155,46 @@ class RTree < RTreeC
     end
 
     # @return [Array<Integer>] version of librtree
+    #
     def version
       @version ||= super.split('.').map(&:to_i)
     end
 
     # @return [String] email address for librtree bug reports
+    #
     def bugreport
       super
     end
 
     # @return [String] librtree homepage
+    #
     def url
       super
     end
 
     # @!visibility private
+    # This seems to need the self qualification on the constants,
+    # without them we get a NameError, not sure why so asked on SO
+    # https://stackoverflow.com/questions/68122256/ It's still not
+    # clear to me why this qualification is needed, but that's a
+    # problem with my understanding of the Ruby Eigenclass, it is
+    # the expected behaviour
+    #
     def split_flag(split)
       case split
       when :quadratic
-        0
+        self::SPLIT_QUADRATIC
       when :linear
-        1
+        self::SPLIT_LINEAR
+      when :greene
+        self::SPLIT_GREENE
       else
         raise ArgumentError, "bad split value: #{split}"
       end
     end
 
     # @!visibility private
+    #
     def node_page_flag(node_page)
       node_page << 2
     end
@@ -157,6 +204,7 @@ class RTree < RTreeC
     def deserialise(string, encoding)
       raise TypeError unless string.is_a? String
       rd, wr = IO.pipe(encoding)
+      unset_nonblock(rd)
       if fork then
         wr.close
         begin
@@ -180,9 +228,10 @@ class RTree < RTreeC
 
   # Initialize a new (empty) RTree
   # @param dim [Integer] the dimension of the tree
-  # @param split [:linear, :quadratic] determines the splitting strategy,
-  #   the linear strategy is faster to build, the quadratic produces a
-  #   better-quality R-tree which is faster to query.
+  # @param split [:linear, :quadratic, :greene] determines the splitting
+  #   strategy, the linear strategy is faster to build, the quadratic
+  #   and greene strategies produce better-quality R-trees which are
+  #   faster to query.
   # @param node_page [Integer] the nodes-per-page value. This value can
   #   affect performance quite dramatically, particularly build time. A
   #   value which is too large would result in an infeasible branching
@@ -192,6 +241,7 @@ class RTree < RTreeC
   #   You may get better performance for your use-case by manual
   #   experimentation, but zero is a good place to start.
   # @return [RTree] the newly instantiated RTree
+  #
   def initialize(dim, split: :quadratic, node_page: 0)
     @split = split
     @node_page = node_page
@@ -200,6 +250,7 @@ class RTree < RTreeC
 
   # Create a deep copy
   # @return [RTree] a deep copy of the RTree
+  #
   def clone
     super
   end
@@ -216,6 +267,7 @@ class RTree < RTreeC
   # @example Add a rectangle to a dimension two RTree
   #   rtree = RTree.new(2)
   #   rtree.add_rect(7, [0, 0, 1, 1])
+  #
   def add_rect(id, coords)
     super
   end
@@ -225,6 +277,7 @@ class RTree < RTreeC
   # @return [Array<Integer>] the ids of all rectangles which intersect
   #   the search rectangle. If a block is given then these values will
   #   be yielded to the block (one at a time).
+  #
   def search(coords)
     if block_given? then
       super
@@ -250,18 +303,21 @@ class RTree < RTreeC
   #   block and then convert the returned Ruby Floats to C; so we would
   #   expect that it loses much of its competitive advantage when
   #   compared to an R-tree rebuild.
+  #
   def update!
     super
   end
 
   # The height to the tree in the usual mathematical sense
   # @return [Integer] the tree height
+  #
   def height
     super
   end
 
   # Whether the RTree has any rectangles or not
   # @return [Boolean] true if the RTree is empty
+  #
   def empty?
     height == 0
   end
@@ -272,6 +328,7 @@ class RTree < RTreeC
   # @see .json_read
   # @example Write to file
   #   File.open('rtree.json', 'w') { |io| rtree.json_write(io) }
+  #
   def json_write(io)
     super
   end
@@ -282,6 +339,7 @@ class RTree < RTreeC
   # @see .bsrt_read
   # @example Write to file
   #   File.open('rtree.bsrt', 'w') { |io| rtree.bsrt_write(io) }
+  #
   def bsrt_write(io)
     super
   end
@@ -289,6 +347,7 @@ class RTree < RTreeC
   # Serialise to JSON string
   # @return [String] the UTF-8 encoded JSON
   # @see .from_json
+  #
   def to_json
     serialise(Encoding::UTF_8) { |io| json_write(io) }
   end
@@ -296,12 +355,14 @@ class RTree < RTreeC
   # Serialise to BSRT string
   # @return [String] the binary encoded BSRT
   # @see .from_bsrt
+  #
   def to_bsrt
     serialise(Encoding::BINARY) { |io| bsrt_write(io) }
   end
 
   # The RTree structure in hash form
   # @return [Hash]
+  #
   def to_h
     JSON.parse(to_json, symbolize_names: true)
   end
@@ -311,6 +372,7 @@ class RTree < RTreeC
   # must be in the same order. Certainly {#clone} will produce
   # an instance which is equal in this sense.
   # @return [Boolean] true if the instances are identical
+  #
   def eq?(other)
     super
   end
@@ -318,6 +380,7 @@ class RTree < RTreeC
   alias_method(:==, :eq?)
 
   # @return [Integer] the dimension of the R-tree
+  #
   def dim
     super
   end
@@ -328,41 +391,74 @@ class RTree < RTreeC
   #   running count).  Performance-minded users may wish to
   #   cache this value (invalidating the cache when calling
   #   {#add_rect} of course).
+  #
   def size
     super
   end
 
   # @return [Integer] the bytes in a page of memory
+  #
   def page_size
     super
   end
 
   # @return [Integer] the size in bytes of a node
+  #
   def node_size
     super
   end
 
   # @return [Integer] the size in bytes of a rectangle
+  #
   def rect_size
     super
   end
 
   # @return [Integer] the size in bytes of a branch
+  #
   def branch_size
     super
   end
 
   # @return [Integer] the number of branches from each node
+  #
   def branching_factor
     super
   end
 
   # @return [Float] the volume of the unit sphere in the R-tree's
   #   dimension
+  #
   def unit_sphere_volume
     super
   end
 
+  # Create a PostScript plot of the RTree
+  # @param io [IO] a writeable stream object
+  # @param style [RTree::Style] a style object describing the fill
+  #   colour and stroke width and colour for each level of the tree.
+  # @param height [Float] the height of the plot in units of PostScript
+  #   point (1/72 inch)
+  # @param width [Float] the width of the plot in units of PostScript
+  #   point (1/72 inch), if neither height nor width is given then a
+  #   width of 216 (3 inches) will be taken as default
+  # @param margin [Float] extra space around the plot in units of
+  #   PostScript point (1/72 inch), default zero
+  #
+  def postscript(io, style, height: nil, width: nil, margin: 0)
+    if height && width then
+      raise ArgumentError, 'cannot specify both height and width'
+    end
+    if height then
+      axis = AXIS_HEIGHT
+      extent = height
+    else
+      axis = AXIS_WIDTH
+      extent = width || 216
+    end
+    super(style, axis, extent, margin, io)
+  end
+
   private
 
   attr_reader :split, :node_page
@@ -394,8 +490,85 @@ class RTree < RTreeC
     end
     result
   end
+end
+
+# @author RTree::Style J. J. Green
+#
+# A Ruby wrapper around RTree styles, used in PostScript plotting.
+# in particular by {RTree#postscript}.
+#
+class RTree::Style < RTreeStyleBase
 
+  extend RTree::IOUtil
 
-end
+  class << self
 
-require 'rtree/rtree'
+    # Create a new Style instance from JSON stream
+    # @param io [IO] a readable stream object
+    # @return [RTree::Style] the newly instantiated Style
+    # @example Read from file
+    #   style = File.open('some.style', 'r') do |io|
+    #     RTree::Style.json_read(io)
+    #   end
+    #
+    def json_read(io)
+      super
+    end
+
+    # Create a new Style instance from JSON string
+    # @param json [String] a JSON string
+    # @return [RTree::Style] the newly instantiated Style
+    # @see .json_read
+    #
+    def from_json(json)
+      raise TypeError unless json.is_a? String
+      rd, wr = IO.pipe(Encoding::UTF_8)
+      unset_nonblock(rd)
+      if fork then
+        wr.close
+        begin
+          result = json_read(rd)
+        ensure
+          rd.close
+          Process.wait
+        end
+      else
+        rd.close
+        begin
+          wr.write(json)
+        ensure
+          wr.close
+          exit!
+        end
+      end
+      result
+    end
+
+    # Create a new Style instance from array of Hash
+    # @param array [Array] an array of hash, this will be converted
+    #   to JSON and read by .from_json
+    # @return [RTree::Style] the newly instantiated Style
+    # @see .from_json
+    # @example Create a simple one-level style:
+    #   style = RTree::Style.from_a(
+    #     [
+    #       {
+    #         fill: {
+    #           rgb: [0.5, 0.5, 0.5]
+    #         },
+    #         stroke: {
+    #           rgb: [0, 0, 1],
+    #           width: 3
+    #         }
+    #       }
+    #     ]
+    #   )
+    #
+    def from_a(array)
+      from_json(array.to_json)
+    end
+
+    alias_method :from_array, :from_a
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librtree
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.9
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- The librtree library (1.0.5 or later)
-rubygems_version: 3.1.2
+- The librtree library (1.0.6 or later)
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: R-tree spatial index