clumpy 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a098909784fa383eb4f35a22ca1047c8420b7f24
+  data.tar.gz: 20f94e3674bcde0a04a14690ca9e9fdaeef8a002
+SHA512:
+  metadata.gz: 804979e09ec478f0db7c983bfb2734552abaf908bf1949378210d10b87f9a424916cd5c0b44d18a862c7e0a7656584181547876e4f8fb5068b08f6ad4badc0c5
+  data.tar.gz: 3173e9fd9ade10ce884149c502ab69a2e0bf033c9eae019f5cb52b8a832df3d784d3f008475b27e5902122ed2974ce7ae4b02cf9264caa79bf6ef82cd33d659e

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/Rakefile

@@ -9,25 +9,22 @@ task :console do
   sh 'irb -rubygems -I lib -r clumpy.rb'
 end
 
-desc 'Run a simple benchmarking'
+desc 'Run a simple benchmarking (cluster 100_000 random points)'
 task :benchmark do
   require 'benchmark'
-  require 'ostruct'
   require 'clumpy'
 
-  number = 20_000
+  number = 100_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)) }
+  number.times do
+    points << OpenStruct.new(
+      latitude: rand(Clumpy::Builder::MAX_LATITUDE_DISTANCE),
+      longitude: rand(Clumpy::Builder::MAX_LONGITUDE_DISTANCE)
+    )
+  end
 
   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
+    x.report("normal precision") { Clumpy::Builder.new(points).cluster }
+    x.report("  high precision") { Clumpy::Builder.new(points, precision: :high).cluster }
   end
 end

data/lib/clumpy.rb

@@ -1,7 +1,9 @@
+require "ostruct"
 require "clumpy/version"
+require "clumpy/cluster_behavior"
 require "clumpy/cluster"
 require "clumpy/builder"
+require "clumpy/extensions/sunspot_hit"
 
 module Clumpy
-  # Your code goes here...
 end

data/lib/clumpy/builder.rb

@@ -24,15 +24,20 @@ module Clumpy
     end
 
     def add_to_cluster(point)
+      useable_point?(point) or return
       parent_cluster = find_parent_cluster(point)
 
       if parent_cluster
         parent_cluster.points << point
       else
-        clusters << Cluster.new(point, cluster_distance)
+        clusters << cluster_class.new(point, cluster_distance, cluster_options)
       end
     end
 
+    def useable_point?(point)
+      point.respond_to?(:latitude) && point.respond_to?(:longitude)
+    end
+
     def find_parent_cluster(point)
       clusters.find { |c| c.contains?(point) }
     end
@@ -41,6 +46,14 @@ module Clumpy
       latitude_distance / DISTANCE_MODIFIER
     end
 
+    def cluster_options
+      { values_threshold: options[:values_threshold] }
+    end
+
+    def cluster_class
+      @cluster_class ||= (options[:cluster_class] || Clumpy::Cluster)
+    end
+
     def latitude_distance
       if options[:nelat] && options[:swlat]
         (options[:nelat] - options[:swlat]).abs

data/lib/clumpy/cluster.rb

@@ -1,40 +1,9 @@
 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
+    include ClusterBehavior
 
     def to_s
-      "Clumpy::Cluster(latitude: #{latitude}, longitude: #{longitude}, # points: #{points.length})"
+      "Clumpy::Cluster(latitude: #{latitude}, longitude: #{longitude}, # size: #{points.size})"
     end
   end
 end

data/lib/clumpy/cluster_behavior.rb

@@ -0,0 +1,54 @@
+module Clumpy
+  module ClusterBehavior
+    attr_accessor :latitude, :longitude, :points, :bounds
+
+    def initialize(point, distance, options = {})
+      @latitude  = point.latitude
+      @longitude = point.longitude
+      @points    = [point]
+      @options   = options
+      @bounds    = OpenStruct.new(
+        latitude: (latitude - distance)..(latitude + distance),
+        longitude: (longitude - distance)..(longitude + distance)
+      )
+    end
+
+    def contains?(point)
+      bounds.latitude.include?(point.latitude) &&
+      bounds.longitude.include?(point.longitude)
+    end
+
+    def reposition
+      @latitude  = points.inject(0.0) { |m, p| m + p.latitude } / points.size
+      @longitude = points.inject(0.0) { |m, p| m + p.longitude } / points.size
+    end
+
+    def as_json(*)
+      {
+        latitude: latitude,
+        longitude: longitude,
+        size: points.size,
+        bounds: bounds_as_json,
+        values: value_list
+      }
+    end
+
+    def value_list
+      values_threshold = @options[:values_threshold] || 10
+      (points.size < values_threshold) ? points : []
+    end
+
+    def bounds_as_json
+      {
+        northeast: {
+          latitude: bounds.latitude.max,
+          longitude: bounds.longitude.max
+        },
+        southwest: {
+          latitude: bounds.latitude.min,
+          longitude: bounds.longitude.max
+        }
+      }
+    end
+  end
+end

data/lib/clumpy/extensions/sunspot_hit.rb

@@ -0,0 +1,20 @@
+module Clumpy
+  module Extensions
+    module SunspotHit
+      def latitude
+        stored(:lat)
+      end
+
+      def longitude
+        stored(:lng)
+      end
+
+      def as_json(*)
+        {
+          id: primary_key,
+          type: class_name
+        }
+      end
+    end
+  end
+end

data/lib/clumpy/version.rb

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

data/spec/builder_spec.rb

@@ -1,9 +1,9 @@
 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(:point1) { OpenStruct.new(latitude: 15,   longitude: 20) }
+  let(:point2) { OpenStruct.new(latitude: 15.5, longitude: 20.5) }
+  let(:point3) { OpenStruct.new(latitude: 50,   longitude: 50) }
 
   let(:points)  { [point1, point2, point3] }
   let(:builder) { Clumpy::Builder.new(points) }
@@ -23,6 +23,13 @@ describe Clumpy::Builder do
     end
   end
 
+  it "passes the values threshold through to the cluster" do
+    builder = Clumpy::Builder.new([point1], values_threshold: 100)
+    builder.cluster_options.should eq({ values_threshold: 100 })
+    clusters = builder.cluster
+    clusters.first.instance_variable_get(:@options).should eq builder.cluster_options
+  end
+
   context "#add_to_cluster" do
     it "creates a new cluster if there is no matching" do
       builder.clusters.should be_empty
@@ -30,6 +37,12 @@ describe Clumpy::Builder do
       builder.clusters.size.should eq 1
     end
 
+    it "will not create a cluster if the given value is not a true point" do
+      builder.clusters.should be_empty
+      builder.add_to_cluster(:foo)
+      builder.clusters.should be_empty
+    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
@@ -40,12 +53,6 @@ describe Clumpy::Builder do
     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 }

data/spec/cluster_behavior_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Clumpy::ClusterBehavior do
+  let(:point)       { OpenStruct.new(latitude: 15, longitude: 20) }
+  let(:other_point) { OpenStruct.new(latitude: 40, longitude: 40) }
+  let(:cluster)     { Clumpy::Cluster.new(point, 10) }
+
+  it "has a nicish to_s representation" do
+    cluster.to_s.should include '# size: 1'
+  end
+
+  it "has a json represtation as well" do
+    cluster.as_json.should have_key :size
+    cluster.as_json.should have_key :latitude
+    cluster.as_json.should have_key :longitude
+    cluster.as_json.should have_key :bounds
+  end
+
+  context "#reposition" do
+    it "calculates new latitude and longitude values" do
+      cluster.points << other_point
+      cluster.reposition
+      cluster.latitude.should eq (15.0+40.0)/2.0
+      cluster.longitude.should eq (20.0+40.0)/2.0
+    end
+  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 a points that isn't contained" do
+      cluster.contains?(other_point).should be_false
+    end
+  end
+end

data/spec/extensions/sunspot_hit_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class Hit
+  def primary_key
+    :foo
+  end
+
+  def class_name
+    'Foo'
+  end
+
+  def stored(key)
+    key
+  end
+end
+
+describe Clumpy::Extensions::SunspotHit do
+  let(:hit)          { Hit.new }
+  let(:extended_hit) { Hit.new.extend(Clumpy::Extensions::SunspotHit) }
+
+  it "adds #latitude method" do
+    hit.should_not      respond_to :latitude
+    extended_hit.should respond_to :latitude
+    extended_hit.latitude.should eq :lat
+  end
+
+  it "adds #longitude method" do
+    hit.should_not      respond_to :longitude
+    extended_hit.should respond_to :longitude
+    extended_hit.longitude.should eq :lng
+  end
+
+  it "overrides as_json to return minimal representation" do
+    extended_hit.as_json.should eq({ id: :foo, type: 'Foo' })
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: clumpy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-03-30 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
@@ -91,42 +82,39 @@ files:
 - lib/clumpy.rb
 - lib/clumpy/builder.rb
 - lib/clumpy/cluster.rb
+- lib/clumpy/cluster_behavior.rb
+- lib/clumpy/extensions/sunspot_hit.rb
 - lib/clumpy/version.rb
 - spec/builder_spec.rb
-- spec/cluster_spec.rb
+- spec/cluster_behavior_spec.rb
+- spec/extensions/sunspot_hit_spec.rb
 - spec/spec_helper.rb
 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: -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
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cluster a bunch of points
 test_files:
 - spec/builder_spec.rb
-- spec/cluster_spec.rb
+- spec/cluster_behavior_spec.rb
+- spec/extensions/sunspot_hit_spec.rb
 - spec/spec_helper.rb

data/spec/cluster_spec.rb

@@ -1,34 +0,0 @@
-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