rgeo-shapefile 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6e5256b3e85525a1eaf405a0d77df1e4f5e607a36164cad539b07f0f8008ad2
-  data.tar.gz: 69c7b87747813c5ae3bbb76a8dd9b635b8c3d6c96dcf86a3a6b50b311e126038
+  metadata.gz: e5e8a29dc9ce093542c32fb72317a7db94e5f48b6126b5df177a4d3add375d2b
+  data.tar.gz: b92fed106be710057adcd3ad0e0047b7341466c80ab3f3b66e920a180549c115
 SHA512:
-  metadata.gz: 302a221acc3cac6842143dedaff74380d5dce58959b8b7381c00cce52401fa0e4343b31a999340f40ba08947c4245b15f2f1962e66f2422bab937b71de5bdd3e
-  data.tar.gz: 56c09783ed155a8fcb95ad9596bae125a4b0a54cedd655fff07cfb4d1786c1011738c1a4768dff4e023b025ce75bee788c22f368a1b5c6ea4d5d3f1237fe1bd1
+  metadata.gz: e63fb61c0a948d75491810b6869f1955a1ef6bc6b66a71491dc0051b0ed2a558553b5eee072a9691aeba94a469b674e1a3ffa91eb8ef008498b92c8e78d26611
+  data.tar.gz: ccbec1961217d64f10931299f77a9aff64956ccc7d425dde97fd7b2a85fb34189fe873e2296c8966d1e2f534af3384934c1ead5ba68dc561983d18f524588b19

data/History.md

@@ -1,40 +1,50 @@
+### Current
+
+### 3.1.0 / 2023-09-30
+
+* Rubocop updates and execution ([#51](https://github.com/rgeo/rgeo-shapefile/pull/51), ObiWanKeoni)
+* Add option to allow unsafe parsing of shapefiles ([#50](https://github.com/rgeo/rgeo-shapefile/pull/50), ObiWanKeoni)
+* Fix issue reading polylines without m values ([#44](https://github.com/rgeo/rgeo-shapefile/pull/44), rywall)
+* Don't pass invalid encodings to DBF ([#43](https://github.com/rgeo/rgeo-shapefile/pull/43), rywall)
+* Add Enumerable to the Reader ([#40](https://github.com/rgeo/rgeo-shapefile/pull/40), x4d3)
+
 ### 3.0.0 / 2020-08-02
 
-* Handle invalid DBF file (#37, rywall)
-* Update DBF gem to version 4.x, bump minimum Ruby version to 2.4 (#38, alvir)
+* Handle invalid DBF file ([#37](https://github.com/rgeo/rgeo-shapefile/pull/37), rywall)
+* Update DBF gem to version 4.x, bump minimum Ruby version to 2.4 ([#38](https://github.com/rgeo/rgeo-shapefile/pull/38), alvir)
 
 ### 2.0.1 / 2019-04-01
 
-* Check dbf record attributes / allow DBF file to have fewer records than SHX (#34, womanonrails / #28, marcisv)
+* Check dbf record attributes / allow DBF file to have fewer records than SHX ([#34](https://github.com/rgeo/rgeo-shapefile/pull/34), womanonrails / [#28](https://github.com/rgeo/rgeo-shapefile/pull/28), marcisv)
 
 
 ### 2.0.0 / 2019-02-23
 
-* Use .cpg file to specify the DBF encoding (#32, rywall)
+* Use .cpg file to specify the DBF encoding ([#32](https://github.com/rgeo/rgeo-shapefile/pull/32), rywall)
 * Remove :dbf_encoding option introduced in 1.2.0
 
 
 ### 1.2.0 / 2019-02-21
 
-* Add ability to specify the DBF encoding (#30, rywall)
+* Add ability to specify the DBF encoding ([#30](https://github.com/rgeo/rgeo-shapefile/pull/30), rywall)
 
 
 ### 1.1.0 / 2018-11-30
 
-* Allow rgeo 2.0 (#29, sunpoet)
+* Allow rgeo 2.0 ([#29](https://github.com/rgeo/rgeo-shapefile/pull/29), sunpoet)
 * Require ruby 2.3+
 
 
 ### 1.0.0 / 2018-3-6
 
-* Require rgeo 1.0 (#27)
+* Require rgeo 1.0 ([#27](https://github.com/rgeo/rgeo-shapefile/pull/27))
 * Freeze strings
 
 
 ### 0.4.2 / 2017-1-31
 
 * Require ruby 2.1+
-* Handle non-string path objects in Reader (#20, msimonborg)
+* Handle non-string path objects in Reader ([#20](https://github.com/rgeo/rgeo-shapefile/pull/20), msimonborg)
 
 ### 0.4.1 / 2015-2-8
 

data/README.md

@@ -1,7 +1,7 @@
 # RGeo::Shapefile
 
 [![Gem Version](https://badge.fury.io/rb/rgeo-shapefile.svg)](http://badge.fury.io/rb/rgeo-shapefile)
-[![Build Status](https://travis-ci.org/rgeo/rgeo-shapefile.svg?branch=master)](https://travis-ci.org/rgeo/rgeo-shapefile)
+[![CI](https://github.com/rgeo/rgeo-shapefile/workflows/CI/badge.svg)](https://github.com/rgeo/rgeo-shapefile/actions?query=workflow%3ACI+branch%3Amain+event%3Apush)
 
 `RGeo::Shapefile` is an optional module for [RGeo](https://github.com/rgeo/rgeo)
 for reading geospatial data from ESRI shapefiles.
@@ -32,12 +32,21 @@ RGeo::Shapefile::Reader.open('myshpfil.shp') do |file|
     puts "  Geometry: #{record.geometry.as_text}"
     puts "  Attributes: #{record.attributes.inspect}"
   end
-  file.rewind
+  # If using version 3.0.0 or earlier, rewind is necessary to return to the beginning of the file.
+  # file.rewind
   record = file.next
   puts "First record geometry was: #{record.geometry.as_text}"
 end
 ```
+### Skipping validity checks
 
+If you have shapefiles that are failing [rgeo validity checks](https://github.com/rgeo/rgeo/blob/main/doc/Geometry-Validity.md) you can skip validity checks by passing `allow_unsafe: true` to the `RGeo::Shapefile::Reader#open` method:
+
+```ruby
+RGeo::Shapefile::Reader.open('myshpfil.shp', allow_unsafe: true) do |file|
+  # ...
+end
+```
 ## Install
 
 `RGeo::Shapefile` has the following requirements:
@@ -46,7 +55,7 @@ end
 * rgeo 1.0.0 or later.
 * dbf 4.0 or later.
 
-If you need support for older Rubies, please use 2.x version  
+If you need support for older Rubies, please use 2.x version
 
 Include in your bundle:
 
@@ -98,4 +107,4 @@ ESRI shapefiles, we did borrow a bunch of their test cases.
 
 Copyright Daniel Azuma, Tee Parham
 
-https://github.com/rgeo/rgeo-shapefile/blob/master/LICENSE.txt
+https://github.com/rgeo/rgeo-shapefile/blob/main/LICENSE.txt

data/lib/rgeo/shapefile/reader.rb

@@ -92,6 +92,7 @@ module RGeo
     #   a GeometryCollection instead of a MultiPolygon.
 
     class Reader
+      include Enumerable
       # Values less than this value are considered "no value" in the
       # shapefile format specification.
       NODATA_LIMIT = -1e38
@@ -175,18 +176,31 @@ module RGeo
       # block. You should use Reader::open instead.
 
       def initialize(path_, opts_ = {}) # :nodoc:
+        @allow_unsafe = false
+        if opts_[:allow_unsafe]
+          if Gem::Version.new(RGeo::VERSION) < Gem::Version.new("3.0.0")
+            warn "RGeo v#{RGeo::VERSION} does not support unsafe methods. Unsafe methods were added in RGeo v3.0.0."
+          else
+            @allow_unsafe = opts_[:allow_unsafe]
+          end
+        end
         path_ = path_.to_s.sub(/\.shp$/, "")
         @base_path = path_
         @opened = true
-        @main_file = ::File.open(path_ + ".shp", "rb:ascii-8bit")
-        @index_file = ::File.open(path_ + ".shx", "rb:ascii-8bit")
+        @main_file = ::File.open("#{path_}.shp", "rb:ascii-8bit")
+        @index_file = ::File.open("#{path_}.shx", "rb:ascii-8bit")
         @attr_dbf =
-          if ::File.file?(path_ + ".dbf") && ::File.readable?(path_ + ".dbf")
-            if ::File.file?(path_ + ".cpg") && ::File.readable?(path_ + ".cpg")
-              dbf_encoding_ = ::File.read(path_ + ".cpg")
+          if ::File.file?("#{path_}.dbf") && ::File.readable?("#{path_}.dbf")
+            if ::File.file?("#{path_}.cpg") && ::File.readable?("#{path_}.cpg")
+              dbf_encoding_ = ::File.read("#{path_}.cpg")
+              dbf_encoding_ = begin
+                Encoding.find(dbf_encoding_.to_s.strip)
+              rescue StandardError
+                nil
+              end
             end
 
-            ::DBF::Table.new(path_ + ".dbf", nil, dbf_encoding_)
+            ::DBF::Table.new("#{path_}.dbf", nil, dbf_encoding_)
           end
         @main_length, @shape_type_code, @xmin, @ymin, @xmax, @ymax, @zmin, @zmax, @mmin, @mmax = @main_file.read(100).unpack("x24Nx4VE8")
         @main_length *= 2
@@ -268,6 +282,7 @@ module RGeo
       def num_records
         @opened ? @num_records : nil
       end
+
       alias size num_records
 
       # Returns the shape type code.
@@ -342,8 +357,17 @@ module RGeo
       # and yield the Reader::Record for each one.
 
       def each
-        return unless @opened
-        yield _read_next_record while @cur_record_index < @num_records
+        return to_enum(:each) { @num_records } unless block_given?
+        raise IOError, "File was not open" unless @opened
+        # Each needs to be idempotent, therefore we reset all the internal indexes to their original value
+        current_record_index = @cur_record_index
+        begin
+          rewind
+          yield _read_next_record while @cur_record_index < @num_records
+        ensure
+          seek_index(current_record_index)
+        end
+        self
       end
 
       # Seek to the given record index.
@@ -485,7 +509,7 @@ module RGeo
           if opt_ == :z
             zs_ = ms_
             ms_ = values_.slice!(4, num_points_)
-            ms_.map! { |val_| val_ < NODATA_LIMIT ? 0 : val_ }
+            ms_.map! { |val_| val_ < NODATA_LIMIT ? 0 : val_ } if ms_
           end
         end
 
@@ -613,14 +637,16 @@ module RGeo
                 # The initial guess. It could be -1 if this inner ring
                 # appeared before any outer rings had appeared.
                 first_try_ = part_data_[3]
-                if first_try_ >= 0 && part_data_[2].within?(polygons_[first_try_].first[2])
+
+                within_method_ = @allow_unsafe ? :unsafe_within? : :within?
+                if first_try_ >= 0 && part_data_[2].public_send(within_method_, polygons_[first_try_].first[2])
                   parent_index_ = first_try_
                 end
                 # If the initial guess didn't work, go through the
                 # remaining polygons and check their outer rings.
                 unless parent_index_
                   polygons_.each_with_index do |poly_data_, index_|
-                    if index_ != first_try_ && part_data_[2].within?(poly_data_.first[2])
+                    if index_ != first_try_ && part_data_[2].public_send(within_method_, poly_data_.first[2])
                       parent_index_ = index_
                       break
                     end
@@ -639,7 +665,7 @@ module RGeo
         # Generate the actual polygons from the collected polygon data
         polygons_.map! do |poly_data_|
           outer_ = poly_data_[0][0]
-          inner_ = poly_data_[1..-1].map { |part_data_| part_data_[0] }
+          inner_ = poly_data_[1..].map { |part_data_| part_data_[0] }
           @factory.polygon(outer_, inner_)
         end
 
@@ -730,7 +756,7 @@ module RGeo
             else
               # End of an outer-led sequence.
               # Add the polygon and reset the state.
-              polygons_ << @factory.polygon(sequence_[0], sequence_[1..-1])
+              polygons_ << @factory.polygon(sequence_[0], sequence_[1..])
               state_ = :empty
               sequence_ = []
             end
@@ -750,9 +776,10 @@ module RGeo
                 geos_polygons_ = sequence_.map { |ring_| geos_factory_.polygon(ring_) }
                 outer_poly_ = nil
                 outer_index_ = 0
+                contains_method_ = @allow_unsafe ? :unsafe_contains? : :contains?
                 geos_polygons_.each_with_index do |poly_, idx_|
                   if outer_poly_
-                    if poly_.contains?(outer_poly_)
+                    if poly_.public_send(contains_method_, outer_poly_)
                       outer_poly_ = poly_
                       outer_index_ = idx_
                       break
@@ -764,7 +791,7 @@ module RGeo
                 sequence_.slice!(outer_index_)
                 sequence_.unshift(outer_poly_)
               end
-              polygons_ << @factory.polygon(sequence_[0], sequence_[1..-1])
+              polygons_ << @factory.polygon(sequence_[0], sequence_[1..])
               state_ = :empty
               sequence_ = []
             end

data/lib/rgeo/shapefile/version.rb

@@ -2,6 +2,6 @@
 
 module RGeo
   module Shapefile
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgeo-shapefile
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,8 +100,9 @@ files:
 - lib/rgeo/shapefile/version.rb
 homepage: http://github.com/rgeo/rgeo-shapefile
 licenses:
-- BSD
-metadata: {}
+- BSD-3-Clause
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: An RGeo module for reading ESRI shapefiles.