border_patrol 0.1.1 → 0.1.2

data/README.markdown

@@ -21,6 +21,15 @@ To test if a point is in the region you can either pass a class that responds to
 
 If you want to use your own point class, just define `x` and `y` as methods that correspond to `longitude` and `latitude`.
 
+## Performance
+It's definitely not going to beat a specialized system like PostGIS or SOLR, but it also doesn't have to go across the network to get results.
+We've been using it successfully in critical paths in production with zero impact.  Here's a benchmark checking 10,000 random points against the sample files included in the specs.
+
+                              user     system      total        real
+    colorado region       0.240000   0.010000   0.250000 (  0.249663)
+    multi polygon region  0.610000   0.020000   0.630000 (  0.631532)
+
+
 ## Pro Tip
 
 You can make KML files easily on Google Maps by clicking "My Maps", drawing shapes and saving the map.  Just copy the share link and add "&output=kml" to download the file.g

data/border_patrol.gemspec

@@ -1,12 +1,15 @@
 # encoding: utf-8
 
+$:.push File.expand_path("../lib", __FILE__)
+require 'border_patrol/version'
+
 Gem::Specification.new do |s|
   s.name = "border_patrol"
-  s.version = File.read("lib/VERSION").strip
+  s.version = BorderPatrol::VERSION
   s.authors = ["Zach Brock", "Matt Wilson"]
   s.email = "eng@squareup.com"
-  s.date = "2010-10-20"
-  s.description = "Lets you import a KML file and then check if points are inside or outside the polygons the file defines."
+  s.date = "2011-07-06"
+  s.description = "Lets you import a KML file and then check if points are inside or outside region polygons defined by the file."
   s.summary = "Import and query KML regions"
   s.homepage = "http://github.com/square/border_patrol"
 

data/lib/border_patrol.rb

@@ -24,5 +24,6 @@ end
 
 require 'set'
 require 'nokogiri'
-require 'border_patrol/polygon.rb'
-require 'border_patrol/region.rb'
+require 'border_patrol/version'
+require 'border_patrol/polygon'
+require 'border_patrol/region'

data/lib/border_patrol/version.rb

@@ -0,0 +1,3 @@
+module BorderPatrol
+  VERSION = "0.1.2".freeze
+end

data/script/benchmark.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby -w
+require "spec/spec_helper"
+require 'benchmark'
+
+colorado_region = BorderPatrol.parse_kml(File.read('spec/support/colorado-test.kml'))
+multi_polygon_region = BorderPatrol.parse_kml(File.read('spec/support/multi-polygon-test.kml'))
+Benchmark.bm(20) do |x|
+  x.report("colorado region") do
+    10000.times do |i|
+      multiple = (rand(2) == 1) ? -1 : 1
+      colorado_region.contains_point?(rand * 180 * multiple, rand * 180 * multiple)
+    end
+   end
+   
+  x.report("multi polygon region") do 
+    10000.times do |i|
+      multiple = (rand(2) == 1) ? -1 : 1
+      multi_polygon_region.contains_point?(rand * 180 * multiple, rand * 180 * multiple)
+    end
+  end
+end

data/spec/lib/border_patrol/region_spec.rb

@@ -5,42 +5,46 @@ describe BorderPatrol::Region do
     BorderPatrol::Region.new.should be_a Set
   end
 
+  it "stores the polygons provided at initialization" do
+    region = BorderPatrol::Region.new([create_polygon, create_polygon(1), create_polygon(2)])
+    region.length.should == 3
+  end
+
   describe "#contains_point?" do
-    def point
-      
-    end
-    def polygon(start=0)
-      BorderPatrol::Polygon.new(
-        BorderPatrol::Point.new(start,start), 
-        BorderPatrol::Point.new(start + 10, start), 
-        BorderPatrol::Point.new(start + 10, start + 10), 
-        BorderPatrol::Point.new(start, start + 10))
-    end
     subject { BorderPatrol::Region.new(@polygons) }
 
     it "raises an argument error if contains_point? takes more than 3 arguments" do
       expect { subject.contains_point? }.to raise_exception ArgumentError
       expect { subject.contains_point?(1,2,3) }.to raise_exception ArgumentError
     end
-    
+
     it "returns true if any polygon contains the point" do
       point = BorderPatrol::Point.new(1,2)
-      @polygons = [polygon, polygon(30)]
+      @polygons = [create_polygon, create_polygon(30)]
 
       subject.contains_point?(point).should be_true
     end
 
     it "returns false if no polygons contain the point" do
       point = BorderPatrol::Point.new(-1,-2)
-      @polygons = [polygon, polygon(30)]
+      @polygons = [create_polygon, create_polygon(30)]
 
       subject.contains_point?(point).should be_false
     end
 
     it "transforms (x,y) coordinates passed in into a point" do
-      @polygons = [polygon, polygon(30)]
+      @polygons = [create_polygon, create_polygon(30)]
 
       subject.contains_point?(1,2).should be_true
     end
   end
+
+  def create_polygon(start=0)
+    BorderPatrol::Polygon.new(
+      BorderPatrol::Point.new(start,start),
+      BorderPatrol::Point.new(start + 10, start),
+      BorderPatrol::Point.new(start + 10, start + 10),
+      BorderPatrol::Point.new(start, start + 10))
+  end
+
 end

data/spec/spec_helper.rb

@@ -3,6 +3,3 @@ require 'bundler'
 Bundler.setup
 
 require 'border_patrol'
-
-RSpec.configure do |config|
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: border_patrol
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Zach Brock
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 -07:00
+date: 2011-07-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,7 @@ dependencies:
         version: 2.6.0
   type: :development
   version_requirements: *id003
-description: Lets you import a KML file and then check if points are inside or outside the polygons the file defines.
+description: Lets you import a KML file and then check if points are inside or outside region polygons defined by the file.
 email: eng@squareup.com
 executables: []
 
@@ -82,10 +82,11 @@ files:
 - README.markdown
 - Rakefile
 - border_patrol.gemspec
-- lib/VERSION
 - lib/border_patrol.rb
 - lib/border_patrol/polygon.rb
 - lib/border_patrol/region.rb
+- lib/border_patrol/version.rb
+- script/benchmark.rb
 - script/ci
 - spec/lib/border_patrol/polygon_spec.rb
 - spec/lib/border_patrol/region_spec.rb

data/lib/VERSION

@@ -1 +0,0 @@
-0.1.1