librtree 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4cc8665ba0560f3258c4857556efa67195cc699915adc9d2297a78d0f41c3cc
-  data.tar.gz: 1b20b6f067a37c4f3265c9f9d7084d4736a8367aa05613e075a4589ba1dc0259
+  metadata.gz: c35526142564e94d93f091e405467f2ee2df3d294b1a4b8e3a87db66f1229043
+  data.tar.gz: dffb928767c821a14460f21d06fc1c90e41a7a17a94a8e700fac0c409d65ca59
 SHA512:
-  metadata.gz: c0ae30faf7cba617f9ab96be3d9ec5325505a9b97b9591fc64bcbd8e2de327def4bca47386992c80f6c1d6021211cdd660ca10cfa1ed8f75d82b67cc6a33f1a0
-  data.tar.gz: d561ecb375d69cb78a1f2681c43e430692c4f191bc9555cd317e8b0b76d726740154aa2befb6bdc9f35aa56adf0686c5030593ac81fff9fc3ce167ecdd9eeef4
+  metadata.gz: 0447a6e59546922ed8d227e0f3589aae7771243c4e16c24ae46cde5075dae4b1f7be2b1a8526d58adc6c3db379719201fcf370f1251e82773f488046ab66caff
+  data.tar.gz: 8ed4fd4e3982a4bfbffac9a53f92ae6dfd497ac4e684110d72591e7ec500a4ee2629a5b3a17dad5cc404383eb7aaccf333d7d15a8aeaa943d858a3e973a35d13

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 Changelog
 ---------
 
+### 1.0.2, pending
+
+- The `#serialise` method raises if the read from pipe returns
+  nil (which it might), so the method (and other methods which
+  call it to serialise) now return `String` or raise
+- Added RBS static type signatures and infrastructure for static
+  type checking with **steep**
+
+### 1.0.1, 16-03-2023
+
+- Update to 1.1.4 of embedded `librtree`
+- The `#empty?` method uses faster `rtree_empty` of the latest
+  version of the embedded library
+- Added the `simplecov` gem and configured (Ruby) coverage in
+  CI runs
+
 ### 1.0.0, 24-02-2023
 
 - The `librtree` library is no longer a requirement: the code

data/README.md

@@ -1,8 +1,8 @@
 librtree-ruby
 -------------
 
-A Ruby native extension for [librtree][3] implementing the R-tree
-spatial index of Guttman-Green.
+A Ruby native extension implementing the R-tree spatial index of
+Guttman-Green.  The code is an embedded version of [librtree][3].
 
 
 ### Installing dependencies
@@ -47,12 +47,12 @@ will import the **RTree** class, its usage is described [here][5].
 This is only needed if you want work on the extension, not for
 a Gem install.
 
-First install the dependencies and [librtree][3] as above.  Then
-clone the repository and install the extension's Ruby dependencies,
-there are several ways to do this.
+First install the dependencies as above.  Then clone the repository and
+install the extension's Ruby dependencies, there are several ways to do
+this.
 
-If using [rbenv][4], then first set a local version of Ruby to
-use, then install the gems into your local cache
+If using [rbenv][4], then first set a local version of Ruby to use,
+then install the gems into your local cache
 
     rbenv local 2.7.0
     bundle install
@@ -79,6 +79,8 @@ run the tests:
 
     bundle exec rake compile
     bundle exec rake spec
+    bundle exec steep check
+
 
 [1]: http://www.digip.org/jansson/
 [3]: http://soliton.vm.bytemark.co.uk/pub/jjg/en/code/librtree/

data/ext/rtree/lib/README.md

@@ -0,0 +1,9 @@
+Embedded librtree
+-----------------
+
+The code in this directory is largely generated by the script
+`bin/librtee-update`, one should not edit it directly, instead
+make a clone of the [librtree][1] project, modify that and use
+the update-script to copy the results here.
+
+[1]: https://gitlab.com/jjg/librtree

data/ext/rtree/lib/node.c

@@ -700,6 +700,34 @@ bool node_identical(const state_t *state, const node_t *a, const node_t *b)
   return ! (a || b);
 }
 
+/*
+  find whether the node or its descendants have a leaf,  so we're
+  looking for a level-zero node with a non-zero count, of course
+  we short circuit as soon as we find one.
+*/
+
+bool node_nonempty(const state_t *state, const node_t *node)
+{
+  node_count_t count;
+
+  if ((count = node_count(node)) == 0)
+    return false;
+
+  if (node_level(node) == 0)
+    return true;
+
+  for (size_t i = 0 ; i < count ; i++)
+    {
+      const branch_t *branch = node_get_branch(state, node, i);
+      const node_t *child = branch_get_child(branch);
+
+      if (node_nonempty(state, child))
+        return true;
+    }
+
+  return false;
+}
+
 extern node_count_t node_count(const node_t*);
 extern void node_count_increment(node_t*);
 extern void node_count_decrement(node_t*);

data/ext/rtree/lib/package.c

@@ -5,7 +5,7 @@
 
 #include "rtree/package.h"
 
-const char *rtree_package_version = "1.1.3";
-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";
+const char rtree_package_version[] = "1.1.4";
+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/rtree/node.h

@@ -8,6 +8,9 @@
 
 #ifdef __cplusplus
 extern "C" {
+#if 0
+}
+#endif
 #endif
 
 #include <stdint.h>
@@ -54,6 +57,7 @@ int node_update(const state_t*, const node_t*, rtree_update_t*, void*);
 bool node_identical(const state_t*, const node_t*, const node_t*);
 node_height_t node_height(const state_t*, const node_t*);
 size_t node_bytes(const state_t*, const node_t*);
+bool node_nonempty(const state_t*, const node_t*);
 
 inline node_count_t node_count(const node_t *node)
 {

data/ext/rtree/lib/rtree/package.h

@@ -6,9 +6,9 @@
 #ifndef RTREE_PACKAGE_H
 #define RTREE_PACKAGE_H
 
-extern const char *rtree_package_version;
-extern const char *rtree_package_name;
-extern const char *rtree_package_url;
-extern const char *rtree_package_bugreport;
+extern const char rtree_package_version[];
+extern const char rtree_package_name[];
+extern const char rtree_package_url[];
+extern const char rtree_package_bugreport[];
 
 #endif

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

@@ -188,3 +188,10 @@ size_t rtree_bytes(const rtree_t *rtree)
       state_bytes(rtree->state) +
       node_bytes(rtree->state, rtree->root);
 }
+
+bool rtree_empty(const rtree_t *rtree)
+{
+  return
+    (rtree == NULL) ||
+    (! node_nonempty(rtree->state, rtree->root));
+}

data/ext/rtree/lib/rtree.h

@@ -53,6 +53,7 @@ rtree_t* rtree_bsrt_read(FILE*);
 int rtree_postscript(const rtree_t*, const rtree_postscript_t*, FILE*);
 const char* rtree_strerror(int);
 size_t rtree_bytes(const rtree_t*);
+bool rtree_empty(const rtree_t*);
 
 #ifdef __cplusplus
 }

data/ext/rtree/rtree.c

@@ -55,6 +55,16 @@ static VALUE rt_release(VALUE self)
   return self;
 }
 
+static VALUE rt_empty(VALUE self)
+{
+  rtree_t *rtree;
+  TypedData_Get_Struct(self, rtree_t, &rtree_type, rtree);
+  if (rtree_empty(rtree))
+    return Qtrue;
+  else
+    return Qfalse;
+}
+
 static VALUE rt_height(VALUE self)
 {
   rtree_t *rtree;
@@ -505,6 +515,7 @@ void Init_rtree(void)
   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, "empty?", rt_empty, 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);

data/lib/rtree.rb

@@ -14,9 +14,9 @@ require 'fcntl'
 
 # @author RTree J. J. Green
 #
-# A Ruby wrapper around
-# {http://soliton.vm.bytemark.co.uk/pub/jjg/en/code/librtree librtree}
-# implementing the R-tree spatial index of Guttman-Green.
+# A Ruby native extension implementing the R-tree spatial index of
+# Guttman-Green.  The code is an emebded version of
+# {http://soliton.vm.bytemark.co.uk/pub/jjg/en/code/librtree librtree}.
 #
 # Use
 #
@@ -71,6 +71,10 @@ class RTree < RTreeBase
 
     # @!visibility private
     #
+    # The call to exit! here has a true argument, indicationg success,
+    # but the value is ignored, so could be omitted; but the sigature
+    # for exit! is incorrect: https://github.com/ruby/rbs/issues/1298
+    #
     def deserialise(string, encoding)
       raise TypeError unless string.is_a? String
       rd, wr = IO.pipe(encoding)
@@ -89,7 +93,7 @@ class RTree < RTreeBase
           wr.write(string)
         ensure
           wr.close
-          exit!
+          exit! true
         end
       end
       result
@@ -97,13 +101,15 @@ class RTree < RTreeBase
 
     # @!visibility private
     #
+    # See note above on argument to exit!
+    #
     def serialise(encoding)
       rd, wr = IO.pipe(encoding)
       if fork then
         wr.close
         unset_nonblock(rd)
         begin
-          result = rd.read
+          result = rd.read || raise(IOError, 'reading from pipe')
         ensure
           rd.close
           Process.wait
@@ -114,7 +120,7 @@ class RTree < RTreeBase
           yield(wr)
         ensure
           wr.close
-          exit!
+          exit! true
         end
       end
       result
@@ -233,19 +239,12 @@ class RTree < RTreeBase
     # 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
+    # the expected behaviour.  Note that self.const_get(:FOO) is
+    # the same as self::FOO, but the latter gives a spurious
+    # type-warning from steep
     #
     def split_flag(split)
-      case split
-      when :quadratic
-        self::SPLIT_QUADRATIC
-      when :linear
-        self::SPLIT_LINEAR
-      when :greene
-        self::SPLIT_GREENE
-      else
-        raise ArgumentError, "bad split value: #{split}"
-      end
+      self.const_get(split_symbol(split))
     end
 
     # @!visibility private
@@ -256,10 +255,22 @@ class RTree < RTreeBase
 
     private
 
-    def deserialise(*args, &block)
-      RTree::IOUtil.deserialise(*args, &block)
+    def deserialise(string, encoding, &block)
+      RTree::IOUtil.deserialise(string, encoding, &block)
     end
 
+    def split_symbol(split)
+      case split
+      when :quadratic
+        :SPLIT_QUADRATIC
+      when :linear
+        :SPLIT_LINEAR
+      when :greene
+        :SPLIT_GREENE
+      else
+        raise ArgumentError, "bad split value: #{split}"
+      end
+    end
   end
 
   # Initialize a new (empty) RTree
@@ -355,7 +366,7 @@ class RTree < RTreeBase
   # @return [Boolean] true if the RTree is empty
   #
   def empty?
-    height.zero?
+    super
   end
 
   # Serialise to JSON stream
@@ -512,8 +523,8 @@ class RTree < RTreeBase
     node_page_flag | split_flag
   end
 
-  def serialise(*args, &block)
-    RTree::IOUtil.serialise(*args, &block)
+  def serialise(encoding, &block)
+    RTree::IOUtil.serialise(encoding, &block)
   end
 
 end
@@ -576,8 +587,8 @@ class RTree::Style < RTreeStyleBase
 
     private
 
-    def deserialise(*args, &block)
-      RTree::IOUtil.deserialise(*args, &block)
+    def deserialise(string, encoding, &block)
+      RTree::IOUtil.deserialise(string, encoding, &block)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librtree
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: |
   A Ruby extension implementing the R-tree spatial-index of
   Guttman-Green.
@@ -107,6 +135,7 @@ files:
 - COPYING
 - README.md
 - ext/rtree/extconf.rb
+- ext/rtree/lib/README.md
 - ext/rtree/lib/bindex.c
 - ext/rtree/lib/bindex.h
 - ext/rtree/lib/bounds.h
@@ -173,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- The Jannson library
+- The Jansson library
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4