rgeo-geojson 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea734285d614e1301d41808430a05d9dbb4e8552159b037ea653556e88fd79e3
-  data.tar.gz: 7561c7640b2a74b82bb4f20a1995f641071fd698eb2cee50e77395c3209b9bdf
+  metadata.gz: 448049463c510bdeb2fa366eaa3834566962116632675ccb509134cc54875fc0
+  data.tar.gz: 7a6c7b327824850c164d3fca314347256e9b8513574afae86687361e92b00c26
 SHA512:
-  metadata.gz: a67279b3edd9290fb455b8ffde0fa0b5f0207f938fc805c0d2caa53a71b895bb1fb09ef990a9b98786be9cc343a65c16107745193d7be934efe619341b4909c9
-  data.tar.gz: 4775eacc655a9cd60c927644c483e0ac522b5e94dcbb36ca2867168ba97bc1fa59a24c7fbcf364d5933b0105cbc4112982b7322da1160a6f67804755875eefd2
+  metadata.gz: d6009ac4f8cdd344ca8403235a20d40c71b9dcf891c17a3646650a8b307d863dd5bf2b63d1ce58bcd768f7d394a572f5f14f822ea294818a7c42e307839e0bb6
+  data.tar.gz: 8a53d85316ec32a69a36a287bc6a5f44702427f2b54b9720da82e91fa599aa33e6fd7ccf600f06a1c01442675cf8b267c749506c32151f798c310e4c6060286e

data/History.md

@@ -1,3 +1,9 @@
+### 2.2.0 / 2024-07-22
+
+* Delegation to inner geometry for a feature (#53)
+* MultiJson rather than JSON (#46)
+* Conversion methods for better integration with core (#56)
+
 ### 2.1.1 / 2018-11-27
 
 * Freeze strings

data/README.md

@@ -1,7 +1,7 @@
 # rgeo-geojson
 
 [![Gem Version](https://badge.fury.io/rb/rgeo-geojson.svg)](http://badge.fury.io/rb/rgeo-geojson)
-[![Build Status](https://travis-ci.org/rgeo/rgeo-geojson.svg?branch=master)](https://travis-ci.org/rgeo/rgeo-geojson)
+[![CI](https://github.com/rgeo/rgeo-geojson/workflows/CI/badge.svg)](https://github.com/rgeo/rgeo-geojson/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush)
 
 `rgeo-geojson` is an extension to [RGeo](https://github.com/rgeo/rgeo)
 that provides GeoJSON encoding and decoding.

data/lib/rgeo/geo_json/coder.rb

@@ -6,7 +6,6 @@ module RGeo
     # the RGeo::Feature::Factory and the RGeo::GeoJSON::EntityFactory to
     # be used) so that you can encode and decode without specifying those
     # settings every time.
-
     class Coder
       # Create a new coder settings object. The geo factory is passed as
       # a required argument.
@@ -41,7 +40,6 @@ module RGeo
       # appropriate JSON library installed.
       #
       # Returns nil if nil is passed in as the object.
-
       def encode(object)
         if @entity_factory.is_feature_collection?(object)
           {
@@ -60,13 +58,12 @@ module RGeo
       # Decode an object from GeoJSON. The input may be a JSON hash, a
       # String, or an IO object from which to read the JSON string.
       # If an error occurs, nil is returned.
-
       def decode(input)
         if input.is_a?(IO)
           input = input.read rescue nil
         end
         if input.is_a?(String)
-          input = JSON.parse(input)
+          input = MultiJson.load(input)
         end
         return unless input.is_a?(Hash)
 

data/lib/rgeo/geo_json/collection_methods.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RGeo
+  # This module is here to fill the gap between what is a GeometryCollection (GIS)
+  # and a FeatureCollection (GeoJSON).
+  #
+  # Note for contributors, you can rely on `@features` to be defined and
+  # you can consider working with an Enumerable wrapping `@features`. See
+  # GeoJSON::FeatureCollection.
+  module GeoJSON::CollectionMethods
+    # There is tight coupling between {FeatureCollection} and this, hence the
+    # guard.
+    private_class_method def self.included(base)
+      return if base.to_s == "RGeo::GeoJSON::FeatureCollection"
+
+      raise Error::RGeoError, "#{self.class} must only be used by FeatureCollection"
+    end
+
+    private def method_missing(symbol, *args)
+      return super unless any? { |feature| feature.respond_to?(symbol) }
+
+      raise Error::UnsupportedOperation, "Method FeatureCollection##{symbol} " \
+        "is not defined. You may consider filing an issue or opening a pull " \
+        "request at https://github.com/rgeo/rgeo-geojson"
+    end
+
+    def contains?(geometry)
+      any? { |feature| feature.contains?(geometry) }
+    end
+
+    def intersects?(geometry)
+      any? { |feature| feature.intersects?(geometry) }
+    end
+  end
+end

data/lib/rgeo/geo_json/conversion_methods.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RGeo
+  # This module serves to provide handy methods when using GeoJSON. The methods
+  # provided eases the passage between entities and GeoJSON String/Hash.
+  module GeoJSON::ConversionMethods
+    # Convert a geometry to a GeoJSON Hash
+    def as_geojson
+      GeoJSON.encode(self)
+    end
+    alias as_json as_geojson
+
+    # Convert a geometry to a GeoJSON String
+    def to_geojson
+      ::MultiJson.dump(as_geojson)
+    end
+    alias to_json to_geojson
+  end
+
+  # These convenience methods are added directly into the module rather than
+  # including the module above into the Feature::Instance module which is in
+  # every geometry implementation. This is due to a behavior in ruby versions
+  # <3.0.2 where dynamically included modules will not be included automatically
+  # in the ancestor tree.
+  # See https://bugs.ruby-lang.org/issues/9573 for more information.
+  module Feature
+    module Instance
+      # Convert a geometry to a GeoJSON Hash
+      def as_geojson
+        GeoJSON.encode(self)
+      end
+      alias as_json as_geojson
+
+      # Convert a geometry to a GeoJSON String
+      def to_geojson
+        ::MultiJson.dump(as_geojson)
+      end
+      alias to_json to_geojson
+    end
+
+    module Factory::Instance
+      # Parses a GeoJSON String/Hash, or an IO object from which
+      # the JSON string is read and returns the corresponding
+      # feature. Returns nil if unable to parse.
+      def parse_geojson(input)
+        GeoJSON.decode(input, geo_factory: self)
+      end
+    end
+  end
+end

data/lib/rgeo/geo_json/entities.rb

@@ -1,7 +1,40 @@
 # frozen_string_literal: true
 
+require_relative "collection_methods"
+require_relative "conversion_methods"
+
 module RGeo
+  module CastOverlay
+    def self.included(base)
+      # The original {RGeo::Feature.cast} would copy a GeoJSON::Feature, which
+      # fails most operations. When casting, we MUST get a geometry.
+      original_cast = base.method(:cast)
+      base.define_singleton_method(:cast) do |obj, *params|
+        if obj.class == GeoJSON::Feature
+          original_cast.call(obj.geometry, *params)
+        else
+          original_cast.call(obj, *params)
+        end
+      end
+    end
+  end
+  Feature.include(CastOverlay)
+
   module GeoJSON
+    # Simplify usage of inner geometries for Feature and FeatureCollection
+    # objets. Including class must contain a `#geometry` method.
+    module DelegateToGeometry
+      private def method_missing(symbol, *args)
+        return geometry.public_send(symbol, *args) if geometry
+
+        super
+      end
+
+      private def respond_to_missing?(symbol, *)
+        geometry&.respond_to?(symbol) || super
+      end
+    end
+
     # This is a GeoJSON wrapper entity that corresponds to the GeoJSON
     # "Feature" type. It is an immutable type.
     #
@@ -11,11 +44,12 @@ module RGeo
     # implementation need not subclass or even duck-type this class.
     # the entity factory mediates all interaction between the GeoJSON
     # engine and features.
-
     class Feature
+      include DelegateToGeometry
+      include ConversionMethods
+
       # Create a feature wrapping the given geometry, with the given ID
       # and properties.
-
       def initialize(geometry, id = nil, properties = {})
         @geometry = geometry
         @id = id
@@ -41,7 +75,6 @@ module RGeo
       # are all equal.
       # This method uses the eql? method to test geometry equality, which
       # may behave differently than the == operator.
-
       def eql?(other)
         other.is_a?(Feature) && @geometry.eql?(other.geometry) && @id.eql?(other.feature_id) && @properties.eql?(other.instance_variable_get(:@properties))
       end
@@ -50,37 +83,31 @@ module RGeo
       # are all equal.
       # This method uses the == operator to test geometry equality, which
       # may behave differently than the eql? method.
-
       def ==(other)
         other.is_a?(Feature) && @geometry == other.geometry && @id == other.feature_id && @properties == other.instance_variable_get(:@properties)
       end
 
       # Returns the geometry contained in this feature, which may be nil.
-
       attr_reader :geometry
 
       # Returns the ID for this feature, which may be nil.
-
       def feature_id
         @id
       end
 
       # Returns a copy of the properties for this feature.
-
       def properties
         @properties.dup
       end
 
       # Gets the value of the given named property.
       # Returns nil if the given property is not found.
-
       def property(key)
         @properties[key.to_s]
       end
       alias [] property
 
       # Gets an array of the known property keys in this feature.
-
       def keys
         @properties.keys
       end
@@ -95,16 +122,17 @@ module RGeo
     # FeatureCollection implementation need not subclass or even
     # duck-type this class. The entity factory mediates all interaction
     # between the GeoJSON engine and feature collections.
-
     class FeatureCollection
       include Enumerable
+      include CollectionMethods
+      include ConversionMethods
 
       # Create a new FeatureCollection with the given features, which must
       # be provided as an Enumerable.
-
       def initialize(features = [])
         @features = []
         features.each { |f| @features << f if f.is_a?(Feature) }
+        @features.freeze
       end
 
       def inspect
@@ -123,7 +151,6 @@ module RGeo
       # features in the same order.
       # This methods uses the eql? method to test geometry equality, which
       # may behave differently than the == operator.
-
       def eql?(other)
         other.is_a?(FeatureCollection) && @features.eql?(other.instance_variable_get(:@features))
       end
@@ -132,25 +159,21 @@ module RGeo
       # features in the same order.
       # This methods uses the == operator to test geometry equality, which
       # may behave differently than the eql? method.
-
       def ==(other)
         other.is_a?(FeatureCollection) && @features == other.instance_variable_get(:@features)
       end
 
       # Iterates or returns an iterator for the features.
-
       def each(&block)
         @features.each(&block)
       end
 
       # Returns the number of features contained in this collection.
-
       def size
         @features.size
       end
 
       # Access a feature by index.
-
       def [](index)
         @features[index]
       end
@@ -164,60 +187,51 @@ module RGeo
       # Create and return a new feature, given geometry, ID, and
       # properties hash. Note that, per the GeoJSON spec, geometry and/or
       # properties may be nil.
-
       def feature(geometry, id = nil, properties = nil)
         Feature.new(geometry, id, properties || {})
       end
 
       # Create and return a new feature collection, given an enumerable
       # of feature objects.
-
       def feature_collection(features = [])
         FeatureCollection.new(features)
       end
 
       # Returns true if the given object is a feature created by this
       # entity factory.
-
       def is_feature?(object)
         object.is_a?(Feature)
       end
 
       # Returns true if the given object is a feature collection created
       # by this entity factory.
-
       def is_feature_collection?(object)
         object.is_a?(FeatureCollection)
       end
 
       # Run Enumerable#map on the features contained in the given feature
       # collection.
-
       def map_feature_collection(object, &block)
         object.map(&block)
       end
 
       # Returns the geometry associated with the given feature.
-
       def get_feature_geometry(object)
         object.geometry
       end
 
       # Returns the ID of the given feature, or nil for no ID.
-
       def get_feature_id(object)
         object.feature_id
       end
 
       # Returns the properties of the given feature as a hash. Editing
       # this hash does not change the state of the feature.
-
       def get_feature_properties(object)
         object.properties
       end
 
       # Return the singleton instance of EntityFactory.
-
       def self.instance
         @instance ||= new
       end

data/lib/rgeo/geo_json/interface.rb

@@ -13,9 +13,8 @@ module RGeo
       # RGeo::GeoJSON::EntityFactory for more information. By default,
       # encode supports objects of type RGeo::GeoJSON::Feature and
       # RGeo::GeoJSON::FeatureCollection.
-
       def encode(object, opts = {})
-        Coder.new(opts).encode(object)
+        coder(opts).encode(object)
       end
 
       # High-level convenience routine for decoding an object from GeoJSON.
@@ -33,8 +32,8 @@ module RGeo
       #   RGeo::GeoJSON::EntityFactory, which generates objects of type
       #   RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection.
       #   See RGeo::GeoJSON::EntityFactory for more information.
-      def decode(input_, opts = {})
-        Coder.new(opts).decode(input_)
+      def decode(input, opts = {})
+        coder(opts).decode(input)
       end
 
       # Creates and returns a coder object of type RGeo::GeoJSON::Coder

data/lib/rgeo/geo_json/version.rb

@@ -2,6 +2,6 @@
 
 module RGeo
   module GeoJSON
-    VERSION = "2.1.1"
+    VERSION = "2.2.0"
   end
 end

data/lib/rgeo/geo_json.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require "rgeo"
-require "rgeo/geo_json/version"
-require "rgeo/geo_json/entities"
-require "rgeo/geo_json/coder"
-require "rgeo/geo_json/interface"
-require "json"
+require_relative "geo_json/version"
+require_relative "geo_json/conversion_methods"
+require_relative "geo_json/entities"
+require_relative "geo_json/coder"
+require_relative "geo_json/interface"
+require "multi_json"

data/lib/rgeo-geojson.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "rgeo/geo_json"
+require_relative "rgeo/geo_json"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgeo-geojson
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo
@@ -26,19 +26,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: '1.15'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,7 @@ description: Convert RGeo data to and from GeoJSON. rgeo-geojson is an extension
 email:
 - dazuma@gmail.com
 - parhameter@gmail.com
+- kfdoggett@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -82,12 +83,14 @@ files:
 - lib/rgeo-geojson.rb
 - lib/rgeo/geo_json.rb
 - lib/rgeo/geo_json/coder.rb
+- lib/rgeo/geo_json/collection_methods.rb
+- lib/rgeo/geo_json/conversion_methods.rb
 - lib/rgeo/geo_json/entities.rb
 - lib/rgeo/geo_json/interface.rb
 - lib/rgeo/geo_json/version.rb
 homepage: https://github.com/rgeo/rgeo-geojson
 licenses:
-- BSD
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -104,8 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.5.2
 signing_key: 
 specification_version: 4
 summary: Convert RGeo data to and from GeoJSON.