cacheable_kdtree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0df08204eb2b5ccf4cb9495a44a329573ca4af04
+  data.tar.gz: 90c8dd11173baa5aa4ec78808d42b461da2bd04d
+SHA512:
+  metadata.gz: 34040472bdfe529124bb27e14ac6da865c3ee79335787d02b973fcd79c546fe4d34ed66035ec1da40f73ee168c38a9a8e2bc821ea8faae345407e700fb53d685
+  data.tar.gz: 80a110414a30f66a8ad4ad7ea162d832c99fdc1896346a482222629068627fcb4801ce607a24da151f86cd4082d2d904d0820ff6d6162554f292020fd5630b8b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,491 @@
+# Common configuration.
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'features/**/*'
+    - 'Gemfile'
+    - 'bin/**'
+    - 'tmp/**/*'
+    - 'db/**/*.rb'
+  # By default, the rails cops are not run. Override in project or home
+  # directory .rubocop.yml files, or by giving the -R/--rails option.
+
+# Indent private/protected/public as deep as method definitions
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
+
+# Align the elements of a hash literal if they span more than one line.
+Style/AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: key
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: key
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ignore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ignore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: always_inspect
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+Style/AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same column
+  # as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_first_parameter
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+
+Metrics/BlockNesting:
+  Max: 3
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+  SupportedStyles:
+    - braces
+    - no_braces
+
+# Indentation of `when`.
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+Style/ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  Enabled: false
+  EnforcedStyle: compact
+  SupportedStyles:
+    - nested
+    - compact
+
+Style/ClassCheck:
+  EnforcedStyle: is_a?
+  SupportedStyles:
+    - is_a?
+    - kind_of?
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+# Align with the style guide.
+Style/CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+# Checks formatting of special comments
+Style/CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Multi-line method chaining should be done with leading dots.
+Style/DotPosition:
+  EnforcedStyle: leading
+  SupportedStyles:
+    - leading
+    - trailing
+
+# Use empty lines between defs.
+Style/EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+# Checks whether the source file has a utf-8 encoding comment or not
+Style/Encoding:
+  EnforcedStyle: always
+  SupportedStyles:
+    - when_needed
+    - always
+
+Style/FileName:
+  Exclude:
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - '**/Capfile'
+
+# Checks use of for or each in multiline loops.
+Style/For:
+  EnforcedStyle: each
+  SupportedStyles:
+    - for
+    - each
+
+# Enforce the method used for string formatting.
+Style/FormatString:
+  EnforcedStyle: format
+  SupportedStyles:
+    - format
+    - sprintf
+    - percent
+
+# Built-in global variables are allowed by default.
+Style/GlobalVars:
+  AllowedVariables: []
+
+# `MinBodyLength` defines the number of lines of the a body of an if / unless
+# needs to have to trigger this cop
+Style/GuardClause:
+  MinBodyLength: 1
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+  SupportedStyles:
+    - ruby19
+    - hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 80
+
+# Checks the indentation of the first key in a hash literal.
+Style/IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
+Style/LambdaCall:
+  EnforcedStyle: call
+  SupportedStyles:
+    - call
+    - braces
+
+Metrics/LineLength:
+  Max: 80
+  AllowURI: true
+
+Style/Next:
+  # With `always` all conditions at the end of an iteration needs to be
+  # replace by next - with `skip_modifier_ifs` the modifier if like this one
+  # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
+  EnforcedStyle: skip_modifier_ifs
+  SupportedStyles:
+    - skip_modifier_ifs
+    - always
+
+Style/NonNilCheck:
+  # With `IncludeSemanticChanges` set to `true`, this cop reports offenses for
+  # `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which is
+  # **usually** OK, but might change behavior.
+  #
+  # With `IncludeSemanticChanges` set to `false`, this cop does not report
+  # offenses for `!x.nil?` and does no changes that might change behavior.
+  IncludeSemanticChanges: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - require_no_parentheses
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10
+  Exclude:
+    - 'db/migrate/*.rb'
+
+Style/MethodName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+Style/NumericLiterals:
+  MinDigits: 5
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+# Allow safe assignment in conditions.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+    - has_
+    - have_
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+  SupportedStyles:
+    - compact # raise Exception.new(msg)
+    - exploded # raise Exception, msg
+
+
+Style/RedundantReturn:
+  # When true allows code like `return x, y`.
+  AllowMultipleReturnValues: false
+
+Style/Semicolon:
+  # Allow ; to separate several expressions on the same line.
+  AllowAsExpressionSeparator: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+
+Style/SingleLineBlockParams:
+  Methods:
+    - reduce:
+        - a
+        - e
+    - inject:
+        - a
+        - e
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: true
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/TrailingBlankLines:
+  EnforcedStyle: final_newline
+  SupportedStyles:
+    - final_newline
+    - final_blank_line
+
+# TrivialAccessors doesn't require exact name matches and doesn't allow
+# predicated methods by default.
+Style/TrivialAccessors:
+  ExactNameMatch: false
+  AllowPredicates: false
+  # Allows trivial writers that don't end in an equal sign. e.g.
+  #
+  # def on_exception(action)
+  #   @on_exception=action
+  # end
+  # on_exception :restart
+  #
+  # Commonly used in DSLs
+  AllowDSLWriters: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+
+Style/VariableName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+Style/WhileUntilModifier:
+  MaxLineLength: 80
+
+Style/WordArray:
+  MinSize: 0
+
+##################### Lint ##################################
+
+# Allow safe assignment in conditions.
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+# Align ends correctly.
+Lint/EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: keyword
+  SupportedStyles:
+    - keyword
+    - variable
+
+Lint/DefEndAlignment:
+  # The value `def` means that `end` should be aligned with the def keyword.
+  # The value `start_of_line` means that `end` should be aligned with method
+  # calls like `private`, `public`, etc, if present in front of the `def`
+  # keyword on the same line.
+  AlignWith: start_of_line
+  SupportedStyles:
+    - start_of_line
+    - def
+
+LineLength:
+  Max: 150
+
+Documentation:
+  Enabled: false
+
+EndOfLine:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.2.2
+script:
+- bundle exec rubocop -Dc .rubocop.yml
+- bundle exec rake test
+deploy:
+  provider: rubygems
+  api_key:
+    secure: TfNKvb7Qzqch5zzbaXv3Qv0m4amPSMQI8rlucf5nW2YxdNBIxGAx9sFeD495V592bzgcnYoeew5OFPOSxVd5YeT+VVu43cJv5gvI+Eouro7r4AKTuJjLcMRvmZvhy5RZrPhph1QwbDHbEcGTpqKcbXka8aURKgsnZzdsf66/iezp30/+q3gkWvUz94b4bBkcHMELsnwvlUX5XukVPP8Zh73YYzUy1Dh6UZiV/Reio2fQb+giSd1FafyptI5LXgmnNhnuLGwOajFgbEYr4ZFg8SfvlQ1SKZzHvH3tsFNUrCcsklowcbks/G/Hb/lOjZpqQH9M4BFrVwYNDEGN8pkmB6mBO56nK6JW4qJwh38MpAhhrLScy8IJw+D9tajkGMyjezb2svqWvMWQ6bdyBeeEsVF51oBqIXD/tadIAVY41ngCvcFw+zzi9568W27CL/9idFHi7rSB1Q/RLNIF2/uT0lt4eOk8Gr8Zyh/YImb3ktXSu4JwWQEfj4m+xugFXL1F/XkkOi/cSNq1tBf2J2LUCe+DxCogGWz5LbiY/aU1sfM4TJmp6awPP6JBv+qujJvVCJblKX/HIhIkfW0o1q1e639JYMTq/6DlIJQk+D9hXzY4X/lrsLlH7zYRie+HCxgxSg1tKTiZkfmohY3GOLLy8W/LfaR/ma622MLWjIIyUVM=
+  gem: kdtree
+  on:
+    tags: true
+    repo: aaronFranssell/kdtree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kdtree.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+[![Build Status](https://travis-ci.org/aaronFranssell/kdtree.svg?branch=master)](https://travis-ci.org/aaronFranssell/kdtree)
+[![Code Climate](https://codeclimate.com/github/aaronFranssell/kdtree/badges/gpa.svg)](https://codeclimate.com/github/aaronFranssell/kdtree)
+[![Test Coverage](https://codeclimate.com/github/aaronFranssell/kdtree/badges/coverage.svg)](https://codeclimate.com/github/aaronFranssell/kdtree/coverage)
+
+# Kd-tree
+
+My Ruby implementation of a [Kd-tree](https://en.wikipedia.org/wiki/K-d_tree). Kd-trees allow for fast nearest-neighbor searches. This implementation will also allow the Kd-tree to be cached using ```Rails.cache``` methods. For now, this only supports 2d latitude/longitude searches.
+
+## Getting Started
+
+Add the gem:
+
+```ruby
+gem 'cacheable_kdtree'
+```
+
+## Usage
+
+A Kd-tree is made up of multiple nodes. A single node contains the data associated with the latitude/longitude:
+
+```ruby
+Kdtree::LatitudeLongitudeNode.new(your_data_here, latitude_of_your_data, longitude_of_your_data)
+```
+
+Once you have an array of nodes, you can create a Kd-tree:
+```ruby
+nodes = [Kdtree::LatitudeLongitudeNode.new(...), Kdtree::LatitudeLongitudeNode.new(...)]
+my_tree = Kdtree::LatitudeLongitudeTree.new(nodes)
+```
+
+You can query your tree and return the closest nodes:
+```ruby
+# The 4th parameter may be :miles or :kilometers
+all_my_nodes = my_tree.closest(my_lat, my_long, distance, :kilometers)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aaronFranssell/kdtree.
+
+Please make sure all tests pass and that [Rubocop](https://github.com/bbatsov/rubocop) is happy:
+```ruby
+rake test
+rubocop -Dac .rubocop.yml
+```
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'kdtree'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kdtree.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kdtree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cacheable_kdtree'
+  spec.version       = Kdtree::VERSION
+  spec.authors       = ['Aaron Franssell']
+  spec.email         = ['aaron.franssell@gmail.com']
+
+  spec.summary       = 'My implementation of a 2d k-d tree'
+  spec.homepage      = 'https://github.com/aaronFranssell/kdtree'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)/) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe/) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rubocop', '0.38.0'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2.3'
+  spec.add_development_dependency 'mocha', '~> 1.1.0'
+end

data/lib/kdtree/latitude_longitude_node.rb

@@ -0,0 +1,33 @@
+class Kdtree::LatitudeLongitudeNode
+  attr_accessor :left, :right, :data, :latitude, :longitude, :region
+
+  def initialize(node_data, node_lat, node_long)
+    @data = node_data
+    @latitude = node_lat
+    @longitude = node_long
+  end
+
+  def to_s
+    "region: #{region ? region.to_s : region}"
+  end
+
+  def self.create_or_merge_regions(n1, n2)
+    return Kdtree::LatitudeLongitudeRegion.new(n1.latitude, n1.longitude, n2.latitude, n2.longitude) if n1.region.nil? && n2.region.nil?
+    return n1.region.merge_point(n2.latitude, n2.longitude) if n1.region && n2.region.nil?
+    return n2.region.merge_point(n1.latitude, n1.longitude) if n2.region && n1.region.nil?
+    n1.region.merge_region(n2.region)
+  end
+
+  def self.sort_node_list(node_list, depth)
+    use_latitude?(depth) ? node_list.sort_by(&:latitude) : node_list.sort_by(&:longitude)
+  end
+
+  def self.partition_node_list(node_list)
+    midpoint = node_list.length / 2
+    [node_list.slice(0, node_list.length / 2), node_list[midpoint], node_list.slice(midpoint + 1..-1)]
+  end
+
+  def self.use_latitude?(depth)
+    depth.even?
+  end
+end

data/lib/kdtree/latitude_longitude_region.rb

@@ -0,0 +1,32 @@
+class Kdtree::LatitudeLongitudeRegion
+  attr_accessor :max_latitude, :max_longitude, :min_latitude, :min_longitude
+  def initialize(lat1, long1, lat2, long2)
+    @min_latitude, @max_latitude = [lat1, lat2].minmax
+    @min_longitude, @max_longitude = [long1, long2].minmax
+  end
+
+  def merge_point(lat, long)
+    new_min_lat, new_max_lat = [lat, @min_latitude, @max_latitude].minmax
+    new_min_long, new_max_long = [long, @min_longitude, @max_longitude].minmax
+    self.class.new(new_min_lat, new_min_long, new_max_lat, new_max_long)
+  end
+
+  def merge_region(region)
+    new_min_lat, new_max_lat = [region.min_latitude, region.max_latitude, @min_latitude, @max_latitude].minmax
+    new_min_long, new_max_long = [region.min_longitude, region.max_longitude, @min_longitude, @max_longitude].minmax
+    self.class.new(new_min_lat, new_min_long, new_max_lat, new_max_long)
+  end
+
+  def point_in_region?(latitude, longitude)
+    latitude.between?(min_latitude, max_latitude) && longitude.between?(min_longitude, max_longitude)
+  end
+
+  def to_s
+    "min lat/long: (#{min_latitude}, #{min_longitude}) max lat/long (#{max_latitude}, #{max_longitude})"
+  end
+
+  def self.regions_intersect?(region1, region2)
+    region1.min_latitude <= region2.max_latitude && region1.max_latitude >= region2.min_latitude &&
+      region1.min_longitude <= region2.max_longitude && region1.max_longitude >= region2.min_longitude
+  end
+end

data/lib/kdtree/latitude_longitude_tree.rb

@@ -0,0 +1,57 @@
+class Kdtree::LatitudeLongitudeTree
+  attr_accessor :root
+
+  def initialize(node_list)
+    @root = create_tree(node_list)
+    find_regions(@root)
+  end
+
+  def closest(lat, long, distance, units = :miles)
+    fail 'Input must be numeric.' unless lat.is_a?(Numeric) && long.is_a?(Numeric) && distance.is_a?(Numeric)
+    fail 'Units must be either :kilometers or :miles.' unless %i(miles kilometers).include?(units)
+    bounding_box = units == :miles ? Kdtree::Util.bounding_box_miles(lat, long, distance) : Kdtree::Util.bounding_box_kilometers(lat, long, distance)
+    nearest_nodes(bounding_box)
+  end
+
+  private
+
+  def nearest_nodes(bounding_box, node = @root, result = [])
+    return result if node.nil?
+    result << node.data if bounding_box.point_in_region?(node.latitude, node.longitude)
+    nearest_nodes(bounding_box, node.left, result) if search_child?(node.left, bounding_box)
+    nearest_nodes(bounding_box, node.right, result) if search_child?(node.right, bounding_box)
+    result
+  end
+
+  def search_child?(child, bounding_box)
+    child &&
+      (bounding_box.point_in_region?(child.latitude, child.longitude) ||
+      (child.region && Kdtree::LatitudeLongitudeRegion.regions_intersect?(child.region, bounding_box)))
+  end
+
+  def find_regions(node)
+    return unless node
+    left_region = find_regions(node.left)
+    left_region = Kdtree::LatitudeLongitudeNode.create_or_merge_regions(node, node.left) if node.left
+    right_region = find_regions(node.right)
+    right_region = Kdtree::LatitudeLongitudeNode.create_or_merge_regions(node, node.right) if node.right
+    node.region = merge_regions(left_region, right_region)
+    node.region
+  end
+
+  def merge_regions(region1, region2)
+    return region1 unless region2
+    return region2 unless region1
+    region1.merge_region(region2)
+  end
+
+  def create_tree(node_list, depth = 0)
+    return if node_list.empty?
+    return node_list.first if node_list.length == 1
+    sorted_list = Kdtree::LatitudeLongitudeNode.sort_node_list(node_list, depth)
+    lower_half, midpoint, greater_half = Kdtree::LatitudeLongitudeNode.partition_node_list(sorted_list)
+    midpoint.left = create_tree(lower_half, depth + 1)
+    midpoint.right = create_tree(greater_half, depth + 1)
+    midpoint
+  end
+end

data/lib/kdtree/util.rb

@@ -0,0 +1,33 @@
+class Kdtree::Util
+  EARTH_MILES = 3959.0
+  EARTH_KILOMETERS = 6371.0
+
+  # I pulled the algorithm for the bounding_box calculation from here:
+  # http://stackoverflow.com/questions/1689096/calculating-bounding-box-a-certain-distance-away-from-a-lat-long-coordinate-in-j
+
+  def self.bounding_box_miles(lat, long, distance_in_miles)
+    bounding_box(lat, long, distance_in_miles, EARTH_MILES)
+  end
+
+  def self.bounding_box_kilometers(lat, long, distance_in_miles)
+    bounding_box(lat, long, distance_in_miles, EARTH_MILES)
+  end
+
+  def self.bounding_box(lat, long, radius_distance, sphere_radius)
+    lat_amount = radians_to_degrees(radius_distance / sphere_radius)
+    lat1 = lat + lat_amount
+    lat2 = lat - lat_amount
+    long_amount = radians_to_degrees(radius_distance / sphere_radius / Math.cos(degrees_to_radians(lat)))
+    long1 = long - long_amount
+    long2 = long + long_amount
+    Kdtree::LatitudeLongitudeRegion.new(lat1, long1, lat2, long2)
+  end
+
+  def self.degrees_to_radians(degrees)
+    degrees * 3.1416 / 180
+  end
+
+  def self.radians_to_degrees(radians)
+    radians * 180 / 3.1416
+  end
+end

data/lib/kdtree/version.rb

@@ -0,0 +1,3 @@
+module Kdtree
+  VERSION = '1.0.0'.freeze
+end

data/lib/kdtree.rb

@@ -0,0 +1,7 @@
+%w(
+  version
+  latitude_longitude_node
+  latitude_longitude_region
+  latitude_longitude_tree
+  util
+).each { |name| require "kdtree/#{name}" }

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: cacheable_kdtree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Franssell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: 
+email:
+- aaron.franssell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kdtree.gemspec
+- lib/kdtree.rb
+- lib/kdtree/latitude_longitude_node.rb
+- lib/kdtree/latitude_longitude_region.rb
+- lib/kdtree/latitude_longitude_tree.rb
+- lib/kdtree/util.rb
+- lib/kdtree/version.rb
+homepage: https://github.com/aaronFranssell/kdtree
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: My implementation of a 2d k-d tree
+test_files: []