librtree 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b253861945be28133a07d5041b080939164dc3725a4b5b458319899d1ad9b66
-  data.tar.gz: 56704611278f67678693ce56e4cec85ae436ba41d534803e0fb8694c39d5b45b
+  metadata.gz: b945bd1abd981557382119ef56ebde1c6bd1f3e75dfa0ca4656b43a59c99d833
+  data.tar.gz: 9af9d2d1317582970d0b27fd43c2947472d66be2383f29bdb7f3d8d19743a897
 SHA512:
-  metadata.gz: 904eacdcbbe518f91ccc41d2c03da9191591a0af6e17be87874be1d74525707a10815e68ed0c9c3dacf91afe70384f982723487f3b6434241ec51097745f0f3e
-  data.tar.gz: 8be9c36a56b92d1bea25a2ef352cb1e3062b1d197983c92cd11d0f753451573b454b3af22327c05fa300d52f3036561555bd1464faa79ea304d87811ddd4acd2
+  metadata.gz: 752765087a236c6ae456475af539ffafb72f02ba13521ff75c094e997c367b717f6d3166e97146a9bc45f2b58581ec6b292aea1faaababf18e6f57d2b8cbc705
+  data.tar.gz: 6aa633e4d38ca15f6a4dc6392870cb0ec8d3713bb15b53a9142b06a00a8e7d295eb5a5f57494eb72cdfdf2b9f8098b86e4703f310a9b3382b39d47df971f29d0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 ---------
 
+### 1.0.5, 16-01-2024
+
+- All methods which take a `File` object (i.e., a stream), now
+  also accept a `String` or `Pathname` to the file instead.
+
 ### 1.0.4, 30-10-2023
 
 - Check for `__builtin_ctzl` (and use if found)

data/ext/rtree/lib/bindex.c

@@ -20,6 +20,22 @@
 #define UL_BYTES sizeof(unsigned long)
 #define UL_BITS (UL_BYTES << 3)
 
+/*
+  config.h may contain HAVE___BUILTIN_CTZL defined from an autoconf
+  check (for the standalone C library, there will be such a check),
+  but in the embedded case, performing that check may be tricky, so
+  in that case we fall-back onto the __has_builtin macro which has
+  been present in clang for many years, and in gcc since version 10.
+*/
+
+#ifndef HAVE___BUILTIN_CTZL
+#ifdef __has_builtin
+#if __has_builtin(__builtin_ctzl)
+#define HAVE___BUILTIN_CTZL 1
+#endif
+#endif
+#endif
+
 /* see note on branch_sizeof in branch.c */
 
 static size_t bindex_sizeof(size_t n)

data/ext/rtree/lib/error.c

@@ -23,7 +23,7 @@ const char* strerror_rtree(int err)
         { RTREE_ERR_NOCSV, "Compiled without CSV support" },
         { RTREE_ERR_JANSSON, "Error from the Jansson library" },
         { RTREE_ERR_NOJSON, "Compiled without JSON support" },
-        { RTREE_ERR_NOJSON, "Compiled without BSRT support" },
+        { RTREE_ERR_NOBSRT, "Compiled without BSRT support" },
         { RTREE_ERR_GETBRANCH, "Error getting branch" },
         { RTREE_ERR_GETCHILD, "Error getting child node" },
         { RTREE_ERR_NODECLONE, "Error cloning node" },

data/ext/rtree/lib/mk/Hdr.mk

@@ -1,3 +1,9 @@
-HDR := rtree/branch.h rtree/error.h rtree/extent.h rtree/node.h \
-	rtree/package.h rtree/postscript.h rtree/rectf.h rtree/search.h \
-	rtree/state.h rtree/types.h rtree.h
+HDR := rtree.h \
+	rtree/error.h \
+	rtree/extent.h \
+	rtree/node.h \
+	rtree/package.h \
+	rtree/postscript.h \
+	rtree/search.h \
+	rtree/state.h \
+	rtree/types.h

data/ext/rtree/lib/package.c

@@ -5,7 +5,7 @@
 
 #include "rtree/package.h"
 
-const char rtree_package_version[] = "1.3.0";
+const char rtree_package_version[] = "1.3.1";
 const char rtree_package_name[] = "librtree";
 const char rtree_package_url[] = "https://gitlab.com/jjg/librtree";
 const char rtree_package_bugreport[] = "j.j.green@gmx.co.uk";

data/ext/rtree/lib/postscript.c

@@ -13,6 +13,7 @@
 #include <time.h>
 #include <errno.h>
 #include <stdbool.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.4
+  version: 1.0.5
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler