quadtree 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 93b38a02013f5c97126e742d2262be25f388e4c1
-  data.tar.gz: 82bb915f6bddf1f6c1f187cbaf5a3a6eb3a47b0d
+SHA256:
+  metadata.gz: 3196d863c8fc7af5fe94d18fe481408c3ec38e008bdc5f778c8d1ea5125d8486
+  data.tar.gz: 971b02c0527fc9023d1fb04a50aaf4091129c933c4b937f8095c6624fc251424
 SHA512:
-  metadata.gz: f18c67ee620d739ddda87a0550f06eb770bb512a7781a0f1d534bdb3cbc51ee1d39fab47e96af94b2d7e75ad298d3b85bdc98ddb48d102efc53fe62be6233397
-  data.tar.gz: 3265235a06f9b067928906086849cca271a78eba0eec2efa48b6e4b6a1e065f006fa8d9274501724101c84e1ba0b69c7687eeac317312bd367f12bf4e7772381
+  metadata.gz: 2140f02c514b1fc60fc9c2202065bdf6e9a9811efafd632a0b1b58e93eabdcc622f6d548e377c2a3b524a02dcca53a330100ab10c3c0fe9a38822ce405cfb7b0
+  data.tar.gz: ddc469e27f0f8c156687ad99810a73edbf54ceb15eaa7cd1f260073c7a9d308d1add9047cec4c0547c5c59d7319920d994b34cdb91f7da69d9f1b06bbb408661

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Jan Lindblom
+Copyright (c) 2022 Jan Lindblom (janlindblom@fastmail.fm)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,5 @@
 # Quadtree
 
-![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoidk1aMm1Ya212SjRsU1pVdWNVZ2FRTDVPUXlVM2NsY0dWU2UxL1dEUlh2VTdxdURhcmxRK1JDTGg5OXJxeURKeFRiZXV5VEtTbmRBZCt6bTdDTms1Rm5ZPSIsIml2UGFyYW1ldGVyU3BlYyI6ImlUamttMGtUckZRT0tvM0EiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
-[![Bitbucket Pipelines](https://img.shields.io/bitbucket/pipelines/janlindblom/ruby-quadtree.png)](https://bitbucket.org/janlindblom/ruby-quadtree)
 [![Gem](https://img.shields.io/gem/v/quadtree.png)](https://rubygems.org/gems/quadtree)
 [![Documentation](https://img.shields.io/badge/docs-rdoc.info-yellow.png)](http://www.rubydoc.info/gems/quadtree/frames)
 
@@ -17,11 +15,15 @@ gem 'quadtree'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install quadtree
+```bash
+gem install quadtree
+```
 
 ## Usage
 
@@ -56,12 +58,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/janlindblom/ruby-quadtree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on Github at <https://github.com/janlindblom/ruby-quadtree>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://github.com/janlindblom/ruby-quadtree/blob/master/LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Quadtree project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/quadtree/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Quadtree project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/janlindblom/ruby-quadtree/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -18,14 +18,21 @@ spec = Gem::Specification.new do |s|
   s.email         = ["janlindblom@fastmail.fm"]
 
   s.summary       = %q{Quadtrees in Ruby.}
-  s.homepage      = "https://bitbucket.org/janlindblom/ruby-quadtree"
+  s.homepage      = "https://github.com/janlindblom/ruby-quadtree"
   s.license       = "MIT"
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(bin|test|spec|features)/}) ||
+    f.match(%r{^(bin|test|spec|features|.github)/}) ||
     f == ".travis.yml" ||
+    f == ".gitignore" ||
+    f == ".editorconfig" ||
+    f == ".rspec" ||
     f == "bitbucket-pipelines.yml" ||
-    f == "buildspec.yml"
+    f == "buildspec.yml" ||
+    f == ".gitlab-ci.yml" ||
+    f == ".rubocop.yml" ||
+    f == ".rubocop_todo.yml" ||
+    f == "Jenkinsfile"
   end
   s.bindir        = "exe"
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -33,14 +40,15 @@ spec = Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_development_dependency "bundler", "~> 1.14"
-  s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "pry", "~> 0.11"
+  s.add_development_dependency "bundler", "~> 2"
+  s.add_development_dependency "rake", "~> 13"
+  s.add_development_dependency "rspec", "~> 3"
+  s.add_development_dependency "pry", "~> 0.14"
   s.add_development_dependency "yard", "~> 0.9"
-  s.add_development_dependency "simplecov", "~> 0.16"
-  s.add_development_dependency "rubocop", "~> 0.54"
-  s.add_runtime_dependency "version", "~> 1.1"
+  s.add_development_dependency "simplecov", "~> 0.21"
+  s.add_development_dependency "rspec_junit_formatter", "~> 0.6"
+  s.add_development_dependency "rubocop", "~> 1"
+  s.add_runtime_dependency "version", "~> 1"
 end
 
 Rake::VersionTask.new do |task|

data/VERSION

@@ -1 +1 @@
-1.0.7
+1.0.9

data/lib/quadtree/axis_aligned_bounding_box.rb

@@ -1,108 +1,155 @@
-module Quadtree
-  # Axis-aligned bounding box with half dimension and center.
-  class AxisAlignedBoundingBox
-
-    # Center {Point} of this instance.
-    #
-    # @return [Point] the {Point} marking the center of this instance.
-    attr_accessor :center
-
-    # Half dimension of this instance (distance from the center {Point} to the
-    # edge).
-    #
-    # @return [Float] distance from the center {Point} to the edge.
-    attr_accessor :half_dimension
-
-    # @param center [Point]
-    # @param half_dimension [Float]
-    def initialize(center, half_dimension)
-      @center = center
-      @half_dimension = half_dimension.to_f
-    end
-
-    # Check if this instance contains a given {Point}.
-    #
-    # @param point [Point] the {Point} to check for.
-    # @return [Boolean] +true+ if given {Point} is contained, +false+
-    #   otherwise.
-    def contains_point?(point)
-      if point.x >= self.center.x - self.half_dimension &&
-          point.x <= self.center.x + self.half_dimension
-        if point.y >= self.center.y - self.half_dimension &&
-          point.y <= self.center.y + self.half_dimension
-          return true
-        end
-      end
-      false
-    end
-
-    # Check if this instance intersects with another instance.
-    #
-    # @param other [AxisAlignedBoundingBox] the other instance to check for.
-    # @return [Boolean] +true+ if these intersects, +false+ otherwise.
-    def intersects?(other)
-      other_lt_corner = Point.new(other.left, other.top)
-      other_rt_corner = Point.new(other.right, other.top)
-      other_lb_corner = Point.new(other.left, other.bottom)
-      other_rb_corner = Point.new(other.right, other.bottom)
-
-      [
-        other_lt_corner,
-        other_rt_corner,
-        other_lb_corner,
-        other_rb_corner
-      ].each do |corner|
-        return true if self.contains_point?(corner)
-      end
-      false
-    end
-
-    # Get the X coordinate of the left edge of this instance.
-    #
-    # @return [Float] the X coordinate of the left edge of this instance.
-    def left
-      @center.x - @half_dimension
-    end
-
-    # Get the X coordinate of the right edge of this instance.
-    #
-    # @return [Float] the X coordinate of the right edge of this instance.
-    def right
-      @center.x + @half_dimension
-    end
-
-    # Get the Y coordinate of the top edge of this instance.
-    #
-    # @return [Float] the Y coordinate of the top edge of this instance.
-    def top
-      @center.y + @half_dimension
-    end
-
-    # Get the Y coordinate of the bottom edge of this instance.
-    #
-    # @return [Float] the Y coordinate of the bottom edge of this instance.
-    def bottom
-      @center.y - @half_dimension
-    end
-
-    # Get the width of this instance.
-    #
-    # @return [Float]
-    def width
-      span
-    end
-
-    # Get the height of this instance.
-    #
-    # @return [Float]
-    def height
-      span
-    end
-
-    private
-
-    def span
-      @half_dimension * 2
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Quadtree
+  # Axis-aligned bounding box with half dimension and center.
+  class AxisAlignedBoundingBox
+    # Center {Point} of this instance.
+    #
+    # @return [Point] the {Point} marking the center of this instance.
+    attr_accessor :center
+
+    # Half dimension of this instance (distance from the center {Point} to the
+    # edge).
+    #
+    # @return [Float] distance from the center {Point} to the edge.
+    attr_accessor :half_dimension
+
+    # @param center [Point]
+    # @param half_dimension [Float]
+    def initialize(center, half_dimension)
+      @center = center
+      @half_dimension = half_dimension.to_f
+    end
+
+    #
+    # Create a Hash for this {AxisAlignedBoundingBox}.
+    #
+    # @return [Hash] Hash representation of this {AxisAlignedBoundingBox}.
+    #
+    def to_h
+      {
+        'center': center.to_h,
+        'half_dimension': half_dimension
+      }
+    end
+
+    #
+    # Create a Hash for this {AxisAlignedBoundingBox}.
+    #
+    # @return [Hash] Hash representation of this {AxisAlignedBoundingBox}.
+    #
+    def to_hash
+      to_h
+    end
+
+    #
+    # Create a JSON String representation of this {AxisAlignedBoundingBox}.
+    #
+    # @return [String] JSON String of this {AxisAlignedBoundingBox}.
+    #
+    def to_json(*_args)
+      require 'json'
+      to_h.to_json
+    end
+
+    #
+    # Create a String for this {AxisAlignedBoundingBox}.
+    #
+    # @return [String] String representation of this {AxisAlignedBoundingBox}.
+    #
+    def to_s
+      to_h.to_s
+    end
+
+    #
+    # Construct a {AxisAlignedBoundingBox} from a JSON String.
+    #
+    # @param [String] json_data input JSON String.
+    #
+    # @return [AxisAlignedBoundingBox] the {AxisAlignedBoundingBox} contained in the JSON String.
+    #
+    def self.from_json(json_data)
+      new(Point.from_json(json_data['center']), json_data['half_dimension'])
+    end
+
+    # Check if this instance contains a given {Point}.
+    #
+    # @param point [Point] the {Point} to check for.
+    # @return [Boolean] +true+ if given {Point} is contained, +false+
+    #   otherwise.
+    def contains_point?(point)
+      if point.x >= center.x - half_dimension &&
+         point.x <= center.x + half_dimension
+        if point.y >= center.y - half_dimension &&
+           point.y <= center.y + half_dimension
+          return true
+        end
+      end
+      false
+    end
+
+    # Check if this instance intersects with another instance.
+    #
+    # @param other [AxisAlignedBoundingBox] the other instance to check for.
+    # @return [Boolean] +true+ if these intersects, +false+ otherwise.
+    def intersects?(other)
+      other_lt_corner = Point.new(other.left, other.top)
+      other_rt_corner = Point.new(other.right, other.top)
+      other_lb_corner = Point.new(other.left, other.bottom)
+      other_rb_corner = Point.new(other.right, other.bottom)
+
+      [other_lt_corner, other_rt_corner, other_lb_corner, other_rb_corner].each do |corner|
+        return true if contains_point?(corner)
+      end
+      false
+    end
+
+    # Get the X coordinate of the left edge of this instance.
+    #
+    # @return [Float] the X coordinate of the left edge of this instance.
+    def left
+      @center.x - @half_dimension
+    end
+
+    # Get the X coordinate of the right edge of this instance.
+    #
+    # @return [Float] the X coordinate of the right edge of this instance.
+    def right
+      @center.x + @half_dimension
+    end
+
+    # Get the Y coordinate of the top edge of this instance.
+    #
+    # @return [Float] the Y coordinate of the top edge of this instance.
+    def top
+      @center.y + @half_dimension
+    end
+
+    # Get the Y coordinate of the bottom edge of this instance.
+    #
+    # @return [Float] the Y coordinate of the bottom edge of this instance.
+    def bottom
+      @center.y - @half_dimension
+    end
+
+    # Get the width of this instance.
+    #
+    # @return [Float]
+    def width
+      span
+    end
+
+    # Get the height of this instance.
+    #
+    # @return [Float]
+    def height
+      span
+    end
+
+    private
+
+    def span
+      @half_dimension * 2
+    end
+  end
+end

data/lib/quadtree/point.rb

@@ -1,107 +1,161 @@
-module Quadtree
-    # Simple coordinate object to represent points in some space.
-    class Point
-
-      # The X coordinate of this instance.
-      # @return [Float, Integer] X coordinate.
-      attr_accessor :x
-
-      # The Y coordinate of this instance.
-      # @return [Float, Integer] Y coordinate.
-      attr_accessor :y
-
-      # Optional payload attached to this instance.
-      # @return [Object] payload attached to this instance.
-      attr_accessor :data
-
-      # @param x [Float, Integer] X coordinate.
-      # @param y [Float, Integer] Y coordinate.
-      # @param data [Object] payload payload attached to this instance
-      #   (optional).
-      # @raise [UnknownTypeError] if one or more input parameters (+x+ and +y+)
-      #   has the wrong type.
-      def initialize(x, y, data=nil)
-
-        self.x = get_typed_numeric(x)
-        self.y = get_typed_numeric(y)
-
-        self.data = data unless data.nil?
-      end
-
-      # This will calculate distance to another {Point}, given that they are
-      # both in the same 2D space.
-      #
-      # @param other [Point] the other {Point}.
-      # @return [Float] the distance to the other {Point}.
-      def distance_to(other)
-        Math.sqrt((other.x - self.x) ** 2 + (other.y - self.y) ** 2)
-      end
-
-      # This will calculate distance to another {Point} using the Haversine
-      # formula. This means that it will treat {#x} as longitude and {#y} as
-      # latitude!
-      #
-      # a = sin²(Δφ/2) + cos φ_1 ⋅ cos φ_2 ⋅ sin²(Δλ/2)
-      #
-      # c = 2 ⋅ atan2( √a, √(1−a) )
-      #
-      # d = R ⋅ c
-      #
-      # where φ is latitude, λ is longitude, R is earth’s radius (mean
-      # radius = 6 371 km);
-      # note that angles need to be in radians to pass to trig functions!
-      #
-      # @param other [Point] the other {Point}.
-      # @return [Float] the distance, in meters, to the other {Point}.
-      def haversine_distance_to(other)
-        # earth's radius
-        r = 6371 * 1000.0
-        # coverting degrees to radians
-        lat1 = self.y * (Math::PI / 180.0)
-        lat2 = other.y * (Math::PI / 180.0)
-        dlat = (other.y - self.y) * (Math::PI / 180.0)
-        dlon = (other.x - self.x) * (Math::PI / 180.0)
-
-        # a = sin²(Δφ/2) + cos φ_1 ⋅ cos φ_2 ⋅ sin²(Δλ/2)
-        a = Math.sin(dlat / 2.0) * Math.sin(dlat / 2.0) +
-            Math.cos(lat1) * Math.cos(lat2) *
-            Math.sin(dlon / 2.0) * Math.sin(dlon / 2.0)
-        # c = 2 ⋅ atan2( √a, √(1−a) )
-        c = 2.0 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
-        # d = R ⋅ c
-        return r * c
-      end
-
-      private
-
-      def get_typed_numeric(any_input)
-        typed_output = nil
-        # Try integer first since float will parse integers too
-        return get_integer(any_input) unless get_integer(any_input).nil?
-        # Try Float next
-        return get_float(any_input) unless get_float(any_input).nil?
-
-        raise UnknownTypeError.new "Unknown type for parameter: #{any_input.class}"
-
-        #typed_output
-      end
-
-      def get_integer(any_input)
-        return Integer(any_input) if any_input.is_a? String
-        return any_input if any_input.is_a? Integer
-
-        nil
-      rescue
-        nil
-      end
-
-      def get_float(any_input)
-        return Float(any_input) if any_input.is_a? String
-        return any_input if any_input.is_a? Float
-
-        nil
-      rescue
-        nil
-      end
-    end
-end
+# frozen_string_literal: true
+
+module Quadtree
+  # Simple coordinate object to represent points in some space.
+  class Point
+    # The X coordinate of this instance.
+    # @return [Float, Integer] X coordinate.
+    attr_accessor :x
+
+    # The Y coordinate of this instance.
+    # @return [Float, Integer] Y coordinate.
+    attr_accessor :y
+
+    # Optional payload attached to this instance.
+    # @return [Object] payload attached to this instance.
+    attr_accessor :data
+
+    # @param x [Float, Integer] X coordinate.
+    # @param y [Float, Integer] Y coordinate.
+    # @param data [Object] payload payload attached to this instance
+    #   (optional).
+    # @raise [UnknownTypeError] if one or more input parameters (+x+ and +y+)
+    #   has the wrong type.
+    def initialize(x, y, data = nil)
+      self.x = get_typed_numeric(x)
+      self.y = get_typed_numeric(y)
+
+      self.data = data unless data.nil?
+    end
+
+    #
+    # Create a Hash for this {Point}.
+    #
+    # @return [Hash] Hash representation of this {Point}.
+    #
+    def to_h
+      {
+        'x': x,
+        'y': y,
+        'data': process_data(data)
+      }
+    end
+
+    #
+    # Create a Hash for this {Point}.
+    #
+    # @return [Hash] Hash representation of this {Point}.
+    #
+    def to_hash
+      to_h
+    end
+
+    #
+    # Create a JSON String representation of this {Point}.
+    #
+    # @return [String] JSON String of this {Point}.
+    #
+    def to_json(*_args)
+      require 'json'
+      to_h.to_json
+    end
+
+    #
+    # Create a String for this {Point}.
+    #
+    # @return [String] String representation of this {Point}.
+    #
+    def to_s
+      to_h.to_s
+    end
+
+    #
+    # Construct a {Quadtree::Point} from a JSON String.
+    #
+    # @param [String] json_data input JSON String.
+    #
+    # @return [Quadtree::Point] the {Quadtree::Point} contained in the JSON String.
+    #
+    def self.from_json(json_data)
+      new(json_data['x'], json_data['y'], json_data['data'])
+    end
+
+    # This will calculate distance to another {Point}, given that they are
+    # both in the same 2D space.
+    #
+    # @param other [Point] the other {Point}.
+    # @return [Float] the distance to the other {Point}.
+    def distance_to(other)
+      Math.sqrt((other.x - x)**2 + (other.y - y)**2)
+    end
+
+    # This will calculate distance to another {Point} using the Haversine
+    # formula. This means that it will treat {#x} as longitude and {#y} as
+    # latitude!
+    #
+    # a = sin²(Δφ/2) + cos φ_1 ⋅ cos φ_2 ⋅ sin²(Δλ/2)
+    #
+    # c = 2 ⋅ atan2( √a, √(1−a) )
+    #
+    # d = R ⋅ c
+    #
+    # where φ is latitude, λ is longitude, R is earth’s radius (mean
+    # radius = 6 371 km);
+    # note that angles need to be in radians to pass to trig functions!
+    #
+    # @param other [Point] the other {Point}.
+    # @return [Float] the distance, in meters, to the other {Point}.
+    def haversine_distance_to(other)
+      lat1 = y * (Math::PI / 180.0)
+      lat2 = other.y * (Math::PI / 180.0)
+      dlat = (other.y - y) * (Math::PI / 180.0)
+      dlon = (other.x - x) * (Math::PI / 180.0)
+
+      # a = sin²(Δφ/2) + cos φ_1 ⋅ cos φ_2 ⋅ sin²(Δλ/2)
+      a = calculate_haversine_a(lat1, lat2, dlat, dlon)
+      # c = 2 ⋅ atan2( √a, √(1−a) )
+      c = 2.0 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a))
+      # d = R ⋅ c
+      6371 * 1000.0 * c
+    end
+
+    private
+
+    def calculate_haversine_a(lat1, lat2, dlat, dlon)
+      Math.sin(dlat / 2.0) * Math.sin(dlat / 2.0) +
+        Math.cos(lat1) * Math.cos(lat2) *
+        Math.sin(dlon / 2.0) * Math.sin(dlon / 2.0)
+    end
+
+    def process_data(data)
+      data.nil? || data.is_a?(Array) || data.is_a?(String) || data.is_a?(Numeric) ? data : data.to_h
+    end
+
+    def get_typed_numeric(any_input)
+      # Try integer first since float will parse integers too
+      return get_integer(any_input) unless get_integer(any_input).nil?
+      # Try Float next
+      return get_float(any_input) unless get_float(any_input).nil?
+
+      raise UnknownTypeError, "Unknown type for parameter: #{any_input.class}"
+    end
+
+    def get_integer(any_input)
+      return Integer(any_input) if any_input.is_a? String
+      return any_input if any_input.is_a? Integer
+
+      nil
+    rescue StandardError
+      nil
+    end
+
+    def get_float(any_input)
+      return Float(any_input) if any_input.is_a? String
+      return any_input if any_input.is_a? Float
+
+      nil
+    rescue StandardError
+      nil
+    end
+  end
+end