clumpy 0.2.3 → 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c9b3590d403a8d17022234a9c010d77afb868ba
+  data.tar.gz: 2c6c5d30ecaab4b5e7b9860da3503a26cd7e4376
+SHA512:
+  metadata.gz: aa62267024945a10872876e7051bc1c7d5323c7fcb0434cb05255366e59e8ba639e5a96845c090106475f90bd576c584728c5641c5d9a6cc479ff15cd13b6d51
+  data.tar.gz: 86aab5b639351c14244a2ec557e5f387efabbbefeff727131c615035e6290284ce9e9bcaf93c8cc9a7f1b6475807ff37bbcb4b0b1bdc317b29db19209d977de1

data/.ruby-gemset

@@ -0,0 +1 @@
+clumpy

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/README.md

@@ -1,30 +1,49 @@
 # Clumpy
 
-Little gem to cluster markers, points or anything that responds to `lat` and `lng`.
+Cluster markers, geocoordinates or anything that responds to `latitude` and `longitude`.
 
-## Installation
+## Why serverside clustering
 
-Add this line to your application's Gemfile:
+Of cause there are lots of libs to cluster large amounts of markers in the frontend, but the expensive part is to
+transfer all those markers to the client. In my case it was the difference between sending 10_000 markers - or 20.
 
-    gem 'clumpy'
+## Installation
 
-And then execute:
+As part of the Gemfile or by hand, nothing unusual here.
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Clumpy takes points, typically geocoordinates, and puts them together into clusters.
 
-    $ gem install clumpy
+It requires the given points to be ruby objects, responding to `latitude` and `longitude` methods.
 
-## Usage
+```ruby
+require 'ostruct'
+
+Point = Struct.new(:latitude, :longitude)
+points = [
+  Point.new(latitude: 101, longitude: 11),
+  Point.new(latitude: 102, longitude: 12),
+  Point.new(latitude: 201, longitude: 21)
+]
+```
 
-It's dead easy:
+Now those points may be clustered easily:
 
 ```ruby
 builder  = Clumpy::Builder.new(points)
 clusters = builder.cluster
+
+cluster = clusters.first
+cluster.size                 # => 2
+cluster.latitude             # => 101.5
+cluster.longitude            # => 11.5
+cluster.points               # => points 1 and 2 from above
+cluster.bounds               # => represents the area this cluster covers
+cluster.to_json              # => well, json representation of that.
 ```
 
+
 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

data/lib/clumpy/builder.rb

@@ -2,14 +2,14 @@ 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 = []
+      @points            = points
+      @options           = options || {}
+      @distance_modifier = options.fetch(:distance_modifier) { 5 }
+      @clusters          = []
     end
 
     # Clusters the given points
@@ -43,11 +43,11 @@ module Clumpy
     end
 
     def cluster_latitude_distance
-      latitude_distance / DISTANCE_MODIFIER
+      latitude_distance / @distance_modifier
     end
 
     def cluster_longitude_distance
-      longitude_distance / (DISTANCE_MODIFIER * 2)
+      longitude_distance / (@distance_modifier * 2)
     end
 
     def cluster_options

data/lib/clumpy/version.rb

@@ -1,3 +1,3 @@
 module Clumpy
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/builder_spec.rb

@@ -14,6 +14,16 @@ describe Clumpy::Builder do
     builder.options.should eq({ foo: :bar })
   end
 
+  it "initializes the distance_modifier is none was given" do
+    builder = Clumpy::Builder.new([])
+    builder.instance_variable_get(:@distance_modifier).should_not be_nil
+  end
+
+  it 'takes the given distance modifier' do
+    builder = Clumpy::Builder.new([], distance_modifier: 12)
+    builder.instance_variable_get(:@distance_modifier).should eq 12
+  end
+
   context "#cluster" do
     it "creates clusters from points" do
       clusters = builder.cluster

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: clumpy
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.2.4
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,49 +27,43 @@ dependencies:
 - !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
@@ -83,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,33 +94,26 @@ files:
 homepage: http://github.com/xijo/clumpy
 licenses:
 - WTFPL
+metadata: {}
 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: -2427505316629763450
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2427505316629763450
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cluster a bunch of points
 test_files:
 - spec/builder_spec.rb