kluster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc71f6255d1a306aa34cf392605aba5109363b05
+  data.tar.gz: 914b64508886a5851bec305a491c23df284bb747
+SHA512:
+  metadata.gz: f67a84ec09ee90a0565611b1d3f29a5b803fc8d4cd99e1c8c567cf2c725e44824bdaf36fdb6520a29a8e259ff7e84ac0ab3ef18d12fd3eac4f2f2747f9c26e09
+  data.tar.gz: 88f01c7e5d82b2a6cce2f85184dfdab36a0371fdf395422e27facdded00f00f089def0c5fc0dbce4a2e9829f657d0db5f40a0f9c45a0cea6b547ad1b33f4c0f5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris O'Sullivan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Kluster
+
+Ever try to display annotations on a map, but find you have too many?
+
+Kluster can help!
+
+It'll take a bunch of pins that have a latitude and longitude, and decide whether they're too close together or not. If so, it'll create a cluster of em.
+
+Sweet
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kluster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kluster
+
+## Usage
+
+Give kluster an array of objects that have a coordinate field and it'll spit back the array with some clusters.
+
+The only parameter it takes is the radius of how big you want the cluster to look in KMs.
+
+e.g.
+  clusterer = Clusterer.new(@pins)
+  @clustered_pins = clusterer.clusterize(params[:cluster_radius].to_f)
+
+## Dependencies
+Kluster uses handy distance methods from the geocoder gem
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/kluster.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kluster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kluster"
+  spec.version       = Kluster::VERSION
+  spec.authors       = ["Chris O'Sullivan"]
+  spec.email         = ["thechrisoshow@gmail.com"]
+  spec.description   = %q{Create geographic clusters}
+  spec.summary       = %q{Take a collection of geographic objects and figures out any clusters of them}
+  spec.homepage      = "http://github.com/thechrisoshow/kluster"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "geocoder", "~> 1.1"
+end

data/lib/kluster.rb

@@ -0,0 +1,4 @@
+require "kluster/version"
+require "geocoder"
+require "kluster/cluster"
+require "kluster/clusterer"

data/lib/kluster/cluster.rb

@@ -0,0 +1,36 @@
+module Kluster
+  class Cluster
+    include Geocoder::Calculations
+    attr_accessor :latitude, :longitude, :pins
+
+    def initialize(initial_pin=nil)
+      @pins = [initial_pin]
+      @number_of_pins = 1
+    end
+
+    def coordinate
+      [latitude, longitude]
+    end
+
+    def ll
+      "#{latitude},#{longitude}"
+    end
+
+    def latitude
+      center[0]
+    end
+
+    def longitude
+      center[1]
+    end
+
+    def number_of_pins
+      @pins.count
+    end
+
+    private
+    def center
+      @center ||= geographic_center(@pins.collect(&:coordinate))
+    end
+  end
+end

data/lib/kluster/clusterer.rb

@@ -0,0 +1,62 @@
+# rewritten from OCMapView bubble clustering
+
+module Kluster
+  class Clusterer
+
+    include Geocoder::Calculations
+
+    def initialize(pins)
+      @pins = pins
+    end
+
+    def clusterize(radius)
+      clustered_annotations = []
+      @pins.each do |pin|
+        is_containing = false
+        if clustered_annotations.empty?
+          new_cluster = Cluster.new(pin)
+          clustered_annotations << new_cluster
+        else
+          clustered_annotations.each do |cluster|
+            if location_near_to_other_location(pin.coordinate, cluster.coordinate, radius)
+              is_containing = true
+              cluster.pins << pin
+              break
+            end
+          end
+
+          if !is_containing
+            new_cluster = Cluster.new(pin)
+            clustered_annotations << new_cluster
+          end
+        end
+      end
+
+      return_array = []
+      clustered_annotations.each do |cluster|
+        if cluster.pins.length <= 1
+           return_array << cluster.pins.last
+        else
+          return_array << cluster
+        end
+      end
+      return_array
+    end
+
+    private
+
+    def get_distance(first_location, second_location)
+      deltaLat = first_location.latitude - second_location.latitude;
+      deltaLon = first_location.longitude - second_location.longitude;
+      distance = Math.sqrt(deltaLat*deltaLat + deltaLon*deltaLon);
+
+      return distance;
+    end
+
+    def location_near_to_other_location(first_coordinate, second_coordinate, radius)
+      distance = distance_between(first_coordinate, second_coordinate, {units: :km})
+      (distance <= radius)
+    end
+
+  end
+end

data/lib/kluster/version.rb

@@ -0,0 +1,3 @@
+module Kluster
+  VERSION = "0.0.1"
+end

data/spec/clusterer_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+class Pin
+
+  def initialize(attrs={})
+    @lat = attrs[:lat]
+    @lng = attrs[:lng]
+  end
+
+  def coordinate
+    [@lat, @lng]
+  end
+end
+
+describe Kluster::Clusterer do
+
+  it "returns nothing if there's nothing" do
+    clusterer = Kluster::Clusterer.new([])
+    clusterer.clusterize(20).should == []
+  end
+
+  it "returns one object if there's only one" do
+    pin = Pin.new
+    clusterer = Kluster::Clusterer.new([pin])
+    clusterer.clusterize(20).should == [pin]
+  end
+
+  it "returns a cluster of two if the pins are in the same place" do
+    pin = Pin.new(lat: 0.1, lng: 0.1)
+    other_pin = Pin.new(lat: 0.1, lng: 0.1)
+    clusterer = Kluster::Clusterer.new([pin, other_pin])
+    result = clusterer.clusterize(10)
+    result.length.should == 1
+    result[0].latitude.should == 0.1
+    result[0].longitude.should == 0.1
+    result[0].number_of_pins.should == 2
+  end
+
+  it "clusters two very close pins" do
+    pin = Pin.new(lng: -0.07949243, lat: 51.52628)
+    other_pin = Pin.new(lng: -0.0794824, lat: 51.52628)
+
+    clusterer = Kluster::Clusterer.new([pin, other_pin])
+    clusterer.clusterize(10).length.should == 1
+  end
+
+  it "clusters at right zoom level" do
+    lads_pin = Pin.new(lng: -0.0848282966763571, lat: 51.5262816148359)
+    vicks_pin = Pin.new(lng: -0.08467794, lat: 51.52645)
+    quick_pin = Pin.new(lng: -0.0832336395979703, lat: 51.5265399870011)
+
+    clusterer = Kluster::Clusterer.new([lads_pin, vicks_pin, quick_pin])
+    clusterer.clusterize(0.05).length.should == 2
+    clusterer.clusterize(1).length.should == 1
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'kluster'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: kluster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris O'Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Create geographic clusters
+email:
+- thechrisoshow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kluster.gemspec
+- lib/kluster.rb
+- lib/kluster/cluster.rb
+- lib/kluster/clusterer.rb
+- lib/kluster/version.rb
+- spec/clusterer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thechrisoshow/kluster
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Take a collection of geographic objects and figures out any clusters of them
+test_files:
+- spec/clusterer_spec.rb
+- spec/spec_helper.rb