librtree 1.0.3 → 1.0.5

data/ext/rtree/lib/private/split.h

@@ -0,0 +1,15 @@
+/*
+  private/split.h
+  Copyright (c) J.J. Green 2020
+*/
+
+#ifndef PRIVATE_SPLIT_H
+#define PRIVATE_SPLIT_H
+
+#include <private/branch.h>
+#include <private/node.h>
+#include <private/state.h>
+
+node_t* split_node(const state_t*, node_t*, branch_t*);
+
+#endif

data/ext/rtree/lib/{spvol.h → private/spvol.h}

@@ -1,10 +1,10 @@
 /*
-  spvol.h
+  private/spvol.h
   Copyright (c) J.J. Green 2020
 */
 
-#ifndef SPVOL_H
-#define SPVOL_H
+#ifndef PRIVATE_SPVOL_H
+#define PRIVATE_SPVOL_H
 
 #include <stddef.h>
 

data/ext/rtree/lib/{state.h → private/state.h}

@@ -1,19 +1,20 @@
 /*
-  state.h
+  private/state.h
   Copyright (c) J.J. Green 2023
 */
 
-#ifndef STATE_H
-#define STATE_H
+#ifndef PRIVATE_STATE_H
+#define PRIVATE_STATE_H
 
-#include <stdlib.h>
-#include <stdbool.h>
+#include <private/rectf.h>
+
+#include <rtree/state.h>
+#include <rtree/types.h>
 
-#include "rtree/state.h"
-#include "rtree/types.h"
-#include "rtree/rectf.h"
+#include <stddef.h>
+#include <stdbool.h>
 
-struct state_t
+typedef struct
 {
   size_t dims, factor;
   rtree_coord_t volume;
@@ -25,7 +26,7 @@ struct state_t
     rectf_rc_t *combine;
   } rectf;
   state_flags_t flags;
-};
+} state_t;
 
 state_t* state_new(size_t, state_flags_t);
 state_t* state_clone(const state_t*);

data/ext/rtree/lib/rect.c

@@ -2,8 +2,8 @@
 #include "config.h"
 #endif
 
-#include "rect.h"
-#include "state.h"
+#include "private/rect.h"
+#include "private/state.h"
 
 #include "rtree/error.h"
 
@@ -19,6 +19,7 @@
 
 #include <string.h>
 #include <errno.h>
+#include <stdlib.h>
 
 int rect_init(const state_t *state, rtree_coord_t *rect)
 {

data/ext/rtree/lib/rectf.c

@@ -2,7 +2,7 @@
 #include "config.h"
 #endif
 
-#include "rtree/rectf.h"
+#include "private/rectf.h"
 
 #ifdef HAVE_TGMATH_H
 #include <tgmath.h>

data/ext/rtree/lib/rtree/node.h

@@ -12,7 +12,6 @@ extern "C" {
 
 #include <rtree/types.h>
 
-typedef struct node_t node_t;
 typedef int (rtree_update_t)(rtree_id_t, rtree_coord_t*, void*);
 
 #ifdef __cplusplus

data/ext/rtree/lib/rtree/postscript.h

@@ -10,16 +10,16 @@
 extern "C" {
 #endif
 
-typedef struct rtree_postscript_t rtree_postscript_t;
+#include <rtree/extent.h>
 
 #include <stdio.h>
-#include <rtree/node.h>
-#include <rtree/state.h>
-#include <rtree/extent.h>
 
-typedef enum
-  { model_none, model_grey, model_rgb, model_cmyk }
-  postscript_colour_model_t;
+typedef enum {
+  model_none,
+  model_grey,
+  model_rgb,
+  model_cmyk
+} postscript_colour_model_t;
 
 typedef struct {
   postscript_colour_model_t model;
@@ -48,17 +48,14 @@ typedef struct {
 postscript_style_t* postscript_style_read(FILE*);
 void postscript_style_destroy(postscript_style_t*);
 
-struct rtree_postscript_t
+typedef struct rtree_postscript_t
 {
   const postscript_style_t *style;
   extent_axis_t axis;
   float extent;
   float margin;
   const char *title;
-};
-
-int postscript_write(const state_t*, const node_t*,
-                     const rtree_postscript_t*, FILE*);
+} rtree_postscript_t;
 
 #ifdef __cplusplus
 }

data/ext/rtree/lib/rtree/state.h

@@ -18,7 +18,6 @@ extern "C" {
 #include <stdint.h>
 
 typedef uint32_t state_flags_t;
-typedef struct state_t state_t;
 
 #define RTREE_DEFAULT 0
 

data/ext/rtree/lib/rtree-base.c

@@ -2,15 +2,15 @@
 #include "config.h"
 #endif
 
-#include "rtree.h"
-
-#include "csv.h"
-#include "json.h"
-#include "bsrt.h"
-#include "node.h"
-#include "search.h"
-#include "state.h"
+#include "private/bsrt.h"
+#include "private/csv.h"
+#include "private/json.h"
+#include "private/node.h"
+#include "private/postscript.h"
+#include "private/search.h"
+#include "private/state.h"
 
+#include "rtree.h"
 #include "rtree/error.h"
 
 #include <errno.h>

data/ext/rtree/lib/rtree.h

@@ -24,12 +24,6 @@ typedef uint16_t rtree_height_t;
 #include <rtree/search.h>
 #include <rtree/error.h>
 
-struct rtree_t
-{
-  state_t *state;
-  node_t *root;
-};
-
 rtree_t* rtree_alloc(void);
 int rtree_init(rtree_t*, size_t, state_flags_t);
 rtree_t* rtree_new(size_t, state_flags_t);

data/ext/rtree/lib/search.c

@@ -2,14 +2,13 @@
 #include "config.h"
 #endif
 
-#include "search.h"
-#include "node.h"
-#include "branch.h"
-#include "rect.h"
+#include "private/search.h"
+#include "private/node.h"
+#include "private/branch.h"
+#include "private/rect.h"
 
 #include "rtree/error.h"
 
-
 typedef struct
 {
   rtree_search_t *callback;

data/ext/rtree/lib/split.c

@@ -2,8 +2,17 @@
 #include "config.h"
 #endif
 
+#include "private/bindex.h"
+#include "private/branch.h"
+#include "private/branches.h"
+#include "private/node.h"
+#include "private/split.h"
+
+#include "rtree/error.h"
+
 #include <float.h>
 #include <errno.h>
+#include <stdlib.h>
 
 #ifdef HAVE_TGMATH_H
 #include <tgmath.h>
@@ -11,14 +20,6 @@
 #include <math.h>
 #endif
 
-#include "rtree/error.h"
-
-#include "branches.h"
-#include "branch.h"
-#include "split.h"
-#include "bindex.h"
-#include "node.h"
-
 typedef struct
 {
   bindex_t *choice, *taken;

data/ext/rtree/lib/spvol.c

@@ -1,6 +1,6 @@
 /* Autogenerated by spvol.py, do not edit */
 
-#include "spvol.h"
+#include "private/spvol.h"
 
 int spvol(size_t dim, double *val)
 {

data/ext/rtree/lib/state.c

@@ -2,16 +2,16 @@
 #include "config.h"
 #endif
 
-#include "state.h"
-
-#include "branch.h"
-#include "page.h"
-#include "constants.h"
-#include "spvol.h"
-#include "node.h"
+#include "private/branch.h"
+#include "private/constants.h"
+#include "private/node.h"
+#include "private/page.h"
+#include "private/spvol.h"
+#include "private/state.h"
 
 #include <errno.h>
 #include <string.h>
+#include <stdlib.h>
 
 #ifdef HAVE_TGMATH_H
 #include <tgmath.h>

data/ext/rtree/rtree.c

@@ -35,7 +35,7 @@ static VALUE rt_init(VALUE self, VALUE dim_obj, VALUE flags_obj)
   Check_Type(dim_obj, T_FIXNUM);
   size_t dim = FIX2ULONG(dim_obj);
 
-  Check_Type(dim_obj, T_FIXNUM);
+  Check_Type(flags_obj, T_FIXNUM);
   state_flags_t flags = FIX2UINT(flags_obj);
 
   rtree_t *rtree;
@@ -241,7 +241,7 @@ static VALUE rt_csv_read(VALUE cls,
   Check_Type(dim_obj, T_FIXNUM);
   size_t dim = FIX2ULONG(dim_obj);
 
-  Check_Type(dim_obj, T_FIXNUM);
+  Check_Type(flags_obj, T_FIXNUM);
   state_flags_t flags = FIX2UINT(flags_obj);
 
   rtree_t *rtree;
@@ -415,14 +415,13 @@ static VALUE rt_postscript(VALUE self,
   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"
-    };
+  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)

data/lib/rtree.rb

@@ -15,7 +15,7 @@ require 'fcntl'
 # @author RTree J. J. Green
 #
 # A Ruby native extension implementing the R-tree spatial index of
-# Guttman-Green.  The code is an emebded version of
+# Guttman-Green.  The code is an embedded version of
 # {http://soliton.vm.bytemark.co.uk/pub/jjg/en/code/librtree librtree}.
 #
 # Use
@@ -69,6 +69,21 @@ class RTree < RTreeBase
   module IOUtil
     extend self
 
+    # @!visibility private
+    #
+    def io_with_mode(arg, mode)
+      case arg
+      when String, Pathname
+        File.open(arg, mode) do |io|
+          yield io
+        end
+      when File, IO
+        yield arg
+      else
+        raise TypeError, arg
+      end
+    end
+
     # @!visibility private
     #
     def deserialise(string, encoding)
@@ -138,15 +153,19 @@ class RTree < RTreeBase
 
   class << self
 
-    # Create a new RTree instance from JSON stream
-    # @param io [IO] a readable stream object
+    # Create a new RTree instance from JSON path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @return [RTree] the newly instantiated RTree
     # @see #json_write
-    # @example Read from file
+    # @example Using a path
+    #   rtree = RTree.json_read('rtree.json')
+    # @example Using a stream
     #   rtree = File.open('rtree.json', 'r') { |io| RTree.json_read(io) }
     #
-    def json_read(io)
-      super
+    def json_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'r') do |io|
+        super(io)
+      end
     end
 
     # Create a new RTree instance from JSON string
@@ -159,15 +178,17 @@ class RTree < RTreeBase
     end
 
     # Create a new RTree instance from BSRT (binary serialised R-tree)
-    # stream
-    # @param io [IO] a readable stream object
+    # path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @return [RTree] the newly instantiated RTree
     # @see #bsrt_write
-    # @example Read from file
-    #   rtree = File.open('rtree.bsrt', 'r') { |io| RTree.bsrt_read(io) }
+    # @example Read from path
+    #   rtree = RTree.bsrt_read('rtree.bsrt')
     #
-    def bsrt_read(io)
-      super
+    def bsrt_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'rb') do |io|
+        super(io)
+      end
     end
 
     # Create a new RTree instance from BSRT (binary serialised R-tree)
@@ -180,8 +201,8 @@ class RTree < RTreeBase
       deserialise(bsrt, Encoding::BINARY) { |io| bsrt_read(io) }
     end
 
-    # Build a new RTree instance from CSV stream
-    # @param io [IO] a readable stream object
+    # Build a new RTree instance from CSV path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @param dim [Integer] the dimension of the tree
     # @param split [:linear, :quadratic, :greene] See {#initialize}
     # @param node_page [Integer] See {#initialize}
@@ -192,9 +213,11 @@ class RTree < RTreeBase
     #   useful feature is the reason that the dimension is a required
     #   argument).
     #
-    def csv_read(io, dim, split: :quadratic, node_page: 0)
+    def csv_read(io_arg, dim, split: :quadratic, node_page: 0)
       flags = split_flag(split) | node_page_flag(node_page)
-      super(io, dim, flags)
+       RTree::IOUtil.io_with_mode(io_arg, 'r') do |io|
+         super(io, dim, flags)
+      end
     end
 
     # Build a new RTree instance from CSV string
@@ -363,26 +386,28 @@ class RTree < RTreeBase
     super
   end
 
-  # Serialise to JSON stream
-  # @param io [IO] a writable stream
+  # Serialise to JSON
+  # @param io_arg [String|IO] a path or writable stream
   # @return [self]
   # @see .json_read
   # @example Write to file
-  #   File.open('rtree.json', 'w') { |io| rtree.json_write(io) }
+  #   rtree.json_write('rtree.json')
   #
-  def json_write(io)
-    super
+  def json_write(io_arg)
+    RTree::IOUtil.io_with_mode(io_arg, 'w') { |io| super(io) }
+    self
   end
 
-  # Serialise to BSRT (binary serialised R-tree) stream
-  # @param io [IO] a writable stream
+  # Serialise to BSRT (binary serialised R-tree)
+  # @param io_arg [String|IO] a path or writable stream
   # @return [self]
   # @see .bsrt_read
   # @example Write to file
-  #   File.open('rtree.bsrt', 'w') { |io| rtree.bsrt_write(io) }
+  #   rtree.bsrt_write('rtree.bsrt')
   #
-  def bsrt_write(io)
-    super
+  def bsrt_write(io_arg)
+    RTree::IOUtil.io_with_mode(io_arg, 'wb') { |io| super(io) }
+    self
   end
 
   # Serialise to JSON string
@@ -476,7 +501,7 @@ class RTree < RTreeBase
 
   # Create a PostScript plot of the RTree
   #
-  # @param io [IO] a writeable stream object
+  # @param io_arg [String|IO] a path or writeable stream
   # @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
@@ -487,7 +512,7 @@ class RTree < RTreeBase
   # @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)
+  def postscript(io_arg, style, height: nil, width: nil, margin: 0)
     if height && width then
       raise ArgumentError, 'cannot specify both height and width'
     end
@@ -498,7 +523,9 @@ class RTree < RTreeBase
       axis = AXIS_WIDTH
       extent = width || 216
     end
-    super(style, axis, extent, margin, io)
+    RTree::IOUtil.io_with_mode(io_arg, 'w') do |io|
+      super(style, axis, extent, margin, io)
+    end
   end
 
   private
@@ -523,7 +550,7 @@ class RTree < RTreeBase
 
 end
 
-# @author RTree::Style J. J. Green
+# @author RTree::Style J.J. Green
 #
 # A Ruby wrapper around RTree styles, used in PostScript plotting.
 # in particular by {RTree#postscript}.
@@ -532,16 +559,14 @@ class RTree::Style < RTreeStyleBase
 
   class << self
 
-    # Create a new Style instance from JSON stream
-    # @param io [IO] a readable stream object
+    # Create a new Style instance from JSON path or stream
+    # @param io_arg [String|IO] a path or readable stream
     # @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
+    #   style = RTree::Style.json_read('some.style')
     #
-    def json_read(io)
-      super
+    def json_read(io_arg)
+      RTree::IOUtil.io_with_mode(io_arg, 'r') { |io| super(io) }
     end
 
     # Create a new Style instance from JSON string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librtree
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,53 +151,54 @@ files:
 - ext/rtree/extconf.rb
 - ext/rtree/lib/README.md
 - ext/rtree/lib/bindex.c
-- ext/rtree/lib/bindex.h
-- ext/rtree/lib/bounds.h
 - ext/rtree/lib/branch.c
-- ext/rtree/lib/branch.h
 - ext/rtree/lib/branches.c
-- ext/rtree/lib/branches.h
 - ext/rtree/lib/bsrt.c
-- ext/rtree/lib/bsrt.h
-- ext/rtree/lib/constants.h
 - ext/rtree/lib/csv.c
-- ext/rtree/lib/csv.h
-- ext/rtree/lib/endianness.h
 - ext/rtree/lib/error.c
 - ext/rtree/lib/json.c
-- ext/rtree/lib/json.h
 - ext/rtree/lib/mk/Hdr.mk
 - ext/rtree/lib/mk/MakeDepend
 - ext/rtree/lib/mk/Obj.mk
 - ext/rtree/lib/node.c
-- ext/rtree/lib/node.h
 - ext/rtree/lib/package.c
 - ext/rtree/lib/page.c
-- ext/rtree/lib/page.h
 - ext/rtree/lib/postscript.c
+- ext/rtree/lib/private/bindex.h
+- ext/rtree/lib/private/bounds.h
+- ext/rtree/lib/private/branch.h
+- ext/rtree/lib/private/branches.h
+- ext/rtree/lib/private/bsrt.h
+- ext/rtree/lib/private/constants.h
+- ext/rtree/lib/private/csv.h
+- ext/rtree/lib/private/endianness.h
+- ext/rtree/lib/private/json.h
+- ext/rtree/lib/private/node.h
+- ext/rtree/lib/private/page.h
+- ext/rtree/lib/private/postscript.h
+- ext/rtree/lib/private/rect.h
+- ext/rtree/lib/private/rectf.h
+- ext/rtree/lib/private/rtree.h
+- ext/rtree/lib/private/search.h
+- ext/rtree/lib/private/split.h
+- ext/rtree/lib/private/spvol.h
+- ext/rtree/lib/private/state.h
 - ext/rtree/lib/rect.c
-- ext/rtree/lib/rect.h
 - ext/rtree/lib/rectf.c
 - ext/rtree/lib/rtree-base.c
 - ext/rtree/lib/rtree.h
-- ext/rtree/lib/rtree/branch.h
 - ext/rtree/lib/rtree/error.h
 - ext/rtree/lib/rtree/extent.h
 - ext/rtree/lib/rtree/node.h
 - ext/rtree/lib/rtree/package.h
 - ext/rtree/lib/rtree/postscript.h
-- ext/rtree/lib/rtree/rectf.h
 - ext/rtree/lib/rtree/search.h
 - ext/rtree/lib/rtree/state.h
 - ext/rtree/lib/rtree/types.h
 - ext/rtree/lib/search.c
-- ext/rtree/lib/search.h
 - ext/rtree/lib/split.c
-- ext/rtree/lib/split.h
 - ext/rtree/lib/spvol.c
-- ext/rtree/lib/spvol.h
 - ext/rtree/lib/state.c
-- ext/rtree/lib/state.h
 - ext/rtree/rtree.c
 - lib/rtree.rb
 homepage: https://gitlab.com/jjg/librtree-ruby

data/ext/rtree/lib/page.h

@@ -1,13 +0,0 @@
-/*
-  page.h
-  Copyright (c) J.J. Green 2019
-*/
-
-#ifndef PAGE_H
-#define PAGE_H
-
-#include <stdlib.h>
-
-int page_size(size_t*);
-
-#endif

data/ext/rtree/lib/rtree/branch.h

@@ -1,19 +0,0 @@
-/*
-  rtree/branch.h
-  Copyright (c) J.J. Green 2019
-*/
-
-#ifndef RTREE_BRANCH_H
-#define RTREE_BRANCH_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-typedef struct branch_t branch_t;
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

data/ext/rtree/lib/split.h

@@ -1,15 +0,0 @@
-/*
-  split.h
-  Copyright (c) J.J. Green 2020
-*/
-
-#ifndef SPLIT_H
-#define SPLIT_H
-
-#include "rtree/state.h"
-#include "rtree/branch.h"
-#include "rtree/node.h"
-
-node_t* split_node(const state_t*, node_t*, branch_t*);
-
-#endif