librtree 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dbcdf3078b84e506da1a5afb4e0f31db7490ef8b57860c3d670dae5422bb283
-  data.tar.gz: 9c63a1227bbf656f12360acda82a0f7a7c369d27a25ae1352c906af769f5c2d3
+  metadata.gz: c35526142564e94d93f091e405467f2ee2df3d294b1a4b8e3a87db66f1229043
+  data.tar.gz: dffb928767c821a14460f21d06fc1c90e41a7a17a94a8e700fac0c409d65ca59
 SHA512:
-  metadata.gz: 6c54dae2e5b2e4601c6730fd7e3d50e7f87c5af3a067b7b9c2167c8f43c8c43d52429f7db18db17116cfc958f54587b7009ee92a69d59843048ca53b6b422878
-  data.tar.gz: 1c9aa746ba96bd5413add8a1629a2c84da513e0ed5467d553a10dcfe6f2c776b15d9dd45afac3ff2a33b6cef40633bc7937bffceb0f877c7c03f30ac34bdd8eb
+  metadata.gz: 0447a6e59546922ed8d227e0f3589aae7771243c4e16c24ae46cde5075dae4b1f7be2b1a8526d58adc6c3db379719201fcf370f1251e82773f488046ab66caff
+  data.tar.gz: 8ed4fd4e3982a4bfbffac9a53f92ae6dfd497ac4e684110d72591e7ec500a4ee2629a5b3a17dad5cc404383eb7aaccf333d7d15a8aeaa943d858a3e973a35d13

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 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`

data/README.md

@@ -79,6 +79,7 @@ run the tests:
 
     bundle exec rake compile
     bundle exec rake spec
+    bundle exec steep check
 
 
 [1]: http://www.digip.org/jansson/

data/lib/rtree.rb

@@ -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
@@ -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.1
+  version: 1.0.2
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,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.