clumpy 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,42 @@
+# Clumpy
+
+Little gem to cluster markers, points or anything that responds to `lat` and `lng`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clumpy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clumpy
+
+## Usage
+
+It's dead easy:
+
+```ruby
+builder  = Clumpy::Builder.new(points)
+clusters = builder.cluster
+```
+
+Optionally you could add a `precision: :high` option to the builder initialization to move the cluster a little bit after all points were assigned.
+
+## 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
+
+## License
+
+WTFPL - What The Fuck You Want To Public License
+
+Read more at [http://www.wtfpl.net](http://www.wtfpl.net)

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r clumpy.rb'
+end
+
+desc 'Run a simple benchmarking'
+task :benchmark do
+  require 'benchmark'
+  require 'ostruct'
+  require 'clumpy'
+
+  number = 20_000
+  points = []
+  max_lat_range = -85..85.05115
+  max_lng_range = -180..180
+  number.times { points << OpenStruct.new(lat: rand(max_lat_range), lng: rand(max_lng_range)) }
+
+  Benchmark.bm do |x|
+    x.report('low precision') do
+      clusters = Clumpy::Builder.new(points).cluster
+    end
+
+    x.report('high precision') do
+      clusters = Clumpy::Builder.new(points, precision: :high).cluster
+    end
+  end
+end

data/clumpy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clumpy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clumpy"
+  spec.version       = Clumpy::VERSION
+  spec.authors       = ["Johannes Opper"]
+  spec.email         = ["xijo@gmx.de"]
+  spec.description   = %q{Cluster points e.g. for a map}
+  spec.summary       = %q{Cluster a bunch of points}
+  spec.homepage      = "http://github.com/xijo/clumpy"
+  spec.license       = "WTFPL"
+
+  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_development_dependency 'simplecov'
+end

data/lib/clumpy.rb

@@ -0,0 +1,7 @@
+require "clumpy/version"
+require "clumpy/cluster"
+require "clumpy/builder"
+
+module Clumpy
+  # Your code goes here...
+end

data/lib/clumpy/builder.rb

@@ -0,0 +1,52 @@
+module Clumpy
+  class Builder
+    MAX_LATITUDE_DISTANCE  = 170.05115
+    MAX_LONGITUDE_DISTANCE = 360
+    DISTANCE_MODIFIER      = 5
+
+    attr_accessor :points, :options, :clusters
+
+    def initialize(points, options = {})
+      @points   = points
+      @options  = options || {}
+      @clusters = []
+    end
+
+    # Clusters the given points
+    #
+    # == Returns:
+    # An array of cluster objects.
+    #
+    def cluster
+      points.each { |point| add_to_cluster(point) }
+      options[:precision] == :high and clusters.each(&:reposition)
+      clusters
+    end
+
+    def add_to_cluster(point)
+      parent_cluster = find_parent_cluster(point)
+
+      if parent_cluster
+        parent_cluster.points << point
+      else
+        clusters << Cluster.new(point, cluster_distance)
+      end
+    end
+
+    def find_parent_cluster(point)
+      clusters.find { |c| c.contains?(point) }
+    end
+
+    def cluster_distance
+      latitude_distance / DISTANCE_MODIFIER
+    end
+
+    def latitude_distance
+      if options[:nelat] && options[:swlat]
+        (options[:nelat] - options[:swlat]).abs
+      else
+        MAX_LATITUDE_DISTANCE
+      end
+    end
+  end
+end

data/lib/clumpy/cluster.rb

@@ -0,0 +1,40 @@
+module Clumpy
+  class Cluster
+    attr_accessor :latitude, :longitude, :points
+
+    def initialize(point, distance)
+      @latitude, @longitude = point.lat, point.lng
+      @bb_latitudes  = (latitude - distance)..(latitude + distance)
+      @bb_longitudes = (longitude - distance)..(longitude + distance)
+      @points = [point]
+    end
+
+    def contains?(point)
+      point.respond_to?(:lat) &&
+        point.respond_to?(:lng) &&
+        @bb_latitudes.include?(point.lat) &&
+        @bb_longitudes.include?(point.lng)
+    end
+
+    def reposition
+      @latitude  = points.inject(0) { |m, p| m + p.lat } / points.size
+      @longitude = points.inject(0) { |m, p| m + p.lng } / points.size
+    end
+
+    def as_json(*)
+      {
+        swlat: @bb_latitudes.min,
+        swlng: @bb_longitudes.min,
+        nelat: @bb_latitudes.max,
+        nelng: @bb_longitudes.max,
+        lat: latitude,
+        lng: longitude,
+        points: points.length
+      }
+    end
+
+    def to_s
+      "Clumpy::Cluster(latitude: #{latitude}, longitude: #{longitude}, # points: #{points.length})"
+    end
+  end
+end

data/lib/clumpy/version.rb

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

data/spec/builder_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Clumpy::Builder do
+  let(:point1) { OpenStruct.new(lat: 15,   lng: 20) }
+  let(:point2) { OpenStruct.new(lat: 15.5, lng: 20.5) }
+  let(:point3) { OpenStruct.new(lat: 50,   lng: 50) }
+
+  let(:points)  { [point1, point2, point3] }
+  let(:builder) { Clumpy::Builder.new(points) }
+
+  it "takes points and options" do
+    builder = Clumpy::Builder.new(points, { foo: :bar })
+    builder.points.should eq points
+    builder.options.should eq({ foo: :bar })
+  end
+
+  context "#cluster" do
+    it "creates clusters from points" do
+      clusters = builder.cluster
+      clusters.size.should eq 2
+      clusters.first.points.should eq [point1, point2]
+      clusters.last.points.should eq [point3]
+    end
+  end
+
+  context "#add_to_cluster" do
+    it "creates a new cluster if there is no matching" do
+      builder.clusters.should be_empty
+      builder.add_to_cluster(point1)
+      builder.clusters.size.should eq 1
+    end
+
+    it "appends markers to a existing cluster if they match" do
+      builder.clusters << Clumpy::Cluster.new(point1, builder.cluster_distance)
+      builder.clusters.size.should eq 1
+      builder.clusters.first.points.size.should eq 1
+      builder.add_to_cluster(point2)
+      builder.clusters.size.should eq 1
+      builder.clusters.first.points.size.should eq 2
+    end
+  end
+
+  context "#find_parent_cluster" do
+    it "returns the surrounding cluster if there is one" do
+
+    end
+  end
+
+  it "calculates the latitude distance" do
+    builder.latitude_distance.should eq Clumpy::Builder::MAX_LATITUDE_DISTANCE
+    builder.options = { nelat: -30, swlat: 40 }
+    builder.latitude_distance.should eq 70
+    builder.options = { nelat: -30, swlat: -35 }
+    builder.latitude_distance.should eq 5
+    builder.options = { nelat: 20, swlat: 35 }
+    builder.latitude_distance.should eq 15
+  end
+end

data/spec/cluster_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Clumpy::Cluster do
+  let(:point)       { OpenStruct.new(lat: 15, lng: 20) }
+  let(:other_point) { OpenStruct.new(lat: 40, lng: 40) }
+  let(:cluster)     { Clumpy::Cluster.new(point, 10) }
+
+  it "has a nicish to_s representation" do
+    cluster.to_s.should include '# points: 1'
+  end
+
+  it "has a json represtation as well" do
+    cluster.as_json.should have_key :points
+    cluster.as_json.should have_key :lat
+    cluster.as_json.should have_key :lng
+  end
+
+  context "#contains" do
+    it "returns true if the given point is within the bounds" do
+      cluster.contains?(point).should be_true
+    end
+
+    it "returns false for strange values" do
+      cluster.contains?(nil).should be_false
+      cluster.contains?('').should be_false
+      cluster.contains?(42).should be_false
+      cluster.contains?([42, 42]).should be_false
+    end
+
+    it "returns false for a points that isn't contained" do
+      cluster.contains?(other_point).should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+
+SimpleCov.adapters.define 'gem' do
+  add_filter '/spec/'
+  add_filter '/autotest/'
+  add_group 'Libraries', '/lib/'
+end
+SimpleCov.start 'gem'
+
+require 'clumpy'
+require 'ostruct'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: clumpy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Johannes Opper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cluster points e.g. for a map
+email:
+- xijo@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clumpy.gemspec
+- lib/clumpy.rb
+- lib/clumpy/builder.rb
+- lib/clumpy/cluster.rb
+- lib/clumpy/version.rb
+- spec/builder_spec.rb
+- spec/cluster_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/xijo/clumpy
+licenses:
+- WTFPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2869748522569163282
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2869748522569163282
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Cluster a bunch of points
+test_files:
+- spec/builder_spec.rb
+- spec/cluster_spec.rb
+- spec/spec_helper.rb