border_patrol 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+#*
+*.sw*
+.bundle

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem "nokogiri", "= 1.4.3.1"
+
+group :development do
+  gem "rake",          "= 0.8.7"
+  gem "rspec",         "= 1.3.0"
+  gem "progressbar"
+end
+

data/Gemfile.lock

@@ -0,0 +1,31 @@
+--- 
+dependencies: 
+  rake: 
+    group: 
+    - :development
+    version: = 0.8.7
+  rspec: 
+    group: 
+    - :development
+    version: = 1.3.0
+  progressbar: 
+    group: 
+    - :development
+    version: ">= 0"
+  nokogiri: 
+    group: 
+    - :default
+    version: = 1.4.3.1
+specs: 
+- rake: 
+    version: 0.8.7
+- nokogiri: 
+    version: 1.4.3.1
+- progressbar: 
+    version: 0.9.0
+- rspec: 
+    version: 1.3.0
+hash: cbbadd85a1348941a32f127e7ae81222e0cfb8bc
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/README.markdown

@@ -0,0 +1,40 @@
+# BorderPatrol
+
+BorderPatrol lets you import a KML file and then check if points are inside or outside the polygons the file defines.
+
+The KML file may have multiple polygons defined, google maps is a good source.
+
+## Examples
+
+An example KML file can be found here:
+http://maps.google.com/maps/ms?ie=UTF8&hl=en&msa=0&ll=38.814031,-103.743896&spn=9.600749,16.248779&z=7&msid=110523771099674876521.00049301d20252132a92c&output=kml
+
+To test if a point is in the region you can either pass a class that responds to `x` and `y` (like the provided BorderPatrol::Point class) or just pass a longitude latitude pair.
+
+    region = BorderPatrol.parse_kml(File.read('spec/support/colorado-test.kml'))
+    denver = BorderPatrol::Point.new(-105, 39.75)
+    region.contains_point?(denver) # true
+    region.contains_point?(-105, 39.75) # also true!
+    san_francisco = BorderPatrol::Point.new(-122.5, 37.75)
+    region.contains_point?(san_francisco) # false
+    region.contains_point?(-122.5, 37.75) # also false!
+
+If you want to use your own point class, just define `x` and `y` as methods that correspond to `longitude` and `latitude`.
+
+## 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
+
+## Dependencies
+
+* Nokogiri
+
+## Known Issues
+
+Polygons across the international date line don't work.
+
+## Acknowledgements
+
+http://jakescruggs.blogspot.com/2009/07/point-inside-polygon-in-ruby.html for evaluating the algorithm.
+
+http://github.com/nofxx/georuby/ for providing the bounding box code.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rake'
+require 'spec/rake/spectask'
+
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.libs << 'spec'
+  spec.spec_opts = ["--options", "spec/spec.opts"]
+end
+
+task :default => :spec

data/border_patrol.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'bundler'
+
+Gem::Specification.new do |s|
+  s.name = "border_patrol"
+  s.version = File.read("lib/VERSION").strip
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = "1.3.7"
+
+  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.summary = "Import and query KML regions"
+  s.homepage = "http://github.com/square/border_patrol"
+
+  s.rdoc_options = ["--charset=UTF-8"]
+
+  s.require_paths = ["lib"]
+  root_files = %w(border_patrol.gemspec Rakefile README.markdown .gitignore Gemfile Gemfile.lock)
+  s.files = Dir['{lib,spec}/**/*'] + root_files
+  s.test_files = Dir['spec/**/*']
+
+  s.add_bundler_dependencies
+end

data/lib/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/border_patrol.rb

@@ -0,0 +1,28 @@
+module BorderPatrol
+  class InsufficientPointsToActuallyFormAPolygonError < ArgumentError; end
+  class Point < Struct.new(:x, :y); end
+
+  def self.parse_kml(string)
+    doc = Nokogiri::XML(string)
+    polygons = doc.xpath('//kml:Polygon', 'kml' => 'http://earth.google.com/kml/2.2').map do |polygon_kml|
+      parse_kml_polygon_data(polygon_kml.to_s)
+    end
+    BorderPatrol::Region.new(polygons)
+  end
+
+  private
+  def self.parse_kml_polygon_data(string)
+    doc = Nokogiri::XML(string)
+    coordinates = doc.xpath("//coordinates").text.strip.split("\n")
+    points = coordinates.map do |coord|
+      x, y, z = coord.strip.split(',')
+      BorderPatrol::Point.new(x.to_f, y.to_f)
+    end
+    BorderPatrol::Polygon.new(points)
+  end
+end
+
+require 'set'
+require 'nokogiri'
+require 'border_patrol/polygon.rb'
+require 'border_patrol/region.rb'

data/lib/border_patrol/polygon.rb

@@ -0,0 +1,73 @@
+module BorderPatrol
+  class Polygon < Array
+    def initialize(* args)
+      args.flatten!
+      args.uniq!
+      raise InsufficientPointsToActuallyFormAPolygonError unless args.size > 2
+      super(args)
+    end
+
+    def ==(other)
+      # Do we have the right number of points?
+      return false unless other.size == size
+
+      # Are the points in the right order?
+      first, second = self.first(2)
+      index = other.index(first)
+      return false unless index
+      direction = (other[index-1] == second) ? -1 : 1
+      # Check if the two polygons have the same edges and the same points
+      # i.e. [point1, point2, point3] is the same as [point2, point3, point1] is the same as [point3, point2, point1]
+      each do |i|
+        return false unless i == other[index]
+        index = index + direction
+        index = 0 if index == size
+      end
+      true
+    end
+
+    # Quick and dirty hash function
+    def hash
+      inject(0) { |sum, point| sum += point.x + point.y }
+    end
+
+    def contains_point?(point)
+      return false unless inside_bounding_box?(point)
+      c = false
+      i = -1
+      j = self.size - 1
+      while (i += 1) < self.size
+        if ((self[i].y <= point.y && point.y < self[j].y) ||
+          (self[j].y <= point.y && point.y < self[i].y))
+          if (point.x < (self[j].x - self[i].x) * (point.y - self[i].y) /
+            (self[j].y - self[i].y) + self[i].x)
+            c = !c
+          end
+        end
+        j = i
+      end
+      return c
+    end
+
+    def inside_bounding_box?(point)
+      bb_point_1, bb_point_2 = bounding_box
+      max_x = [bb_point_1.x, bb_point_2.x].max
+      max_y = [bb_point_1.y, bb_point_2.y].max
+      min_x = [bb_point_1.x, bb_point_2.x].min
+      min_y = [bb_point_1.y, bb_point_2.y].min
+
+      !(point.x < min_x || point.x > max_x || point.y < min_y || point.y > max_y)
+    end
+
+    def bounding_box
+      max_x, min_x, max_y, min_y = -Float::MAX, Float::MAX, -Float::MAX, Float::MAX
+      each do |point|
+        max_y = point.y if point.y > max_y
+        min_y = point.y if point.y < min_y
+        max_x = point.x if point.x > max_x
+        min_x = point.x if point.x < min_x
+      end
+      [Point.new(min_x, max_y), Point.new(max_x, min_y)]
+    end
+  end
+end

data/lib/border_patrol/region.rb

@@ -0,0 +1,12 @@
+module BorderPatrol
+  class Region < Set
+    def contains_point?(*point)
+      point = case point.length
+        when 1 then point.first
+        when 2 then BorderPatrol::Point.new(point[0],point[1])
+        else raise ArgumentError, "#{point} is invalid.  Arguments can either be an object, or a longitude,lattitude pair."
+      end
+      any? { |polygon| polygon.contains_point?(point) }
+    end
+  end
+end

data/spec/lib/border_patrol/polygon_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+ describe BorderPatrol::Polygon do
+  describe "==" do
+    it "is true if polygons are congruent" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0)]
+      poly1 = BorderPatrol::Polygon.new(points)
+      poly2 = BorderPatrol::Polygon.new(points.unshift(points.pop))
+
+      poly1.should == poly2
+      poly2.should == poly1
+      poly3 = BorderPatrol::Polygon.new(points.reverse)
+      poly1.should == poly3
+      poly3.should == poly1
+
+    end
+
+    it "cares about order of points" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(5,5), BorderPatrol::Point.new(0, 0)]
+      poly1 = BorderPatrol::Polygon.new(points)
+      points = [BorderPatrol::Point.new(5,5), BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(0, 0), BorderPatrol::Point.new(3, 4)]
+      poly2 = BorderPatrol::Polygon.new(points)
+
+      poly1.should_not == poly2
+      poly2.should_not == poly1
+
+    end
+
+    it "is false if one polygon is a subset" do
+      poly1 = BorderPatrol::Polygon.new(BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0))
+      poly2 = BorderPatrol::Polygon.new(BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0), BorderPatrol::Point.new(4, 4))
+      poly2.should_not == poly1
+      poly1.should_not == poly2
+    end
+
+    it "is false if the polygons are not congruent" do
+      poly1 = BorderPatrol::Polygon.new(BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0))
+      poly2 = BorderPatrol::Polygon.new(BorderPatrol::Point.new(2, 1), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0))
+      poly2.should_not == poly1
+      poly1.should_not == poly2
+    end
+  end
+
+  describe "#initialize" do
+    it "stores a list of points" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0)]
+      polygon = BorderPatrol::Polygon.new(points)
+      points.each do |point|
+        polygon.should include point
+      end
+    end
+
+    it "can be instantiated with a arbitrary argument list" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0)]
+      poly1 = BorderPatrol::Polygon.new(*points)
+      poly2 = BorderPatrol::Polygon.new(points)
+      poly1.should == poly2
+    end
+
+    it "raises if less than 3 points are given" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(2, 3)]
+      expect { BorderPatrol::Polygon.new(points) }.to raise_exception(BorderPatrol::InsufficientPointsToActuallyFormAPolygonError)
+      points = [BorderPatrol::Point.new(1, 2)]
+      expect { BorderPatrol::Polygon.new(points) }.to raise_exception(BorderPatrol::InsufficientPointsToActuallyFormAPolygonError)
+      points = []
+      expect { BorderPatrol::Polygon.new(points) }.to raise_exception(BorderPatrol::InsufficientPointsToActuallyFormAPolygonError)
+    end
+
+    it "doesn't store duplicated points" do
+      points = [BorderPatrol::Point.new(1, 2), BorderPatrol::Point.new(3, 4), BorderPatrol::Point.new(0, 0)]
+      duplicate_point = [BorderPatrol::Point.new(1, 2)]
+      polygon = BorderPatrol::Polygon.new(points + duplicate_point)
+      polygon.size.should == 3
+      points.each do |point|
+        polygon.should include point
+      end
+    end
+  end
+
+  describe "#bounding_box" do
+    it "returns the (max top, max left), (max bottom, max right) as points" do
+      points = [BorderPatrol::Point.new(-1, 3), BorderPatrol::Point.new(4, -3), BorderPatrol::Point.new(10, 4), BorderPatrol::Point.new(0, 12)]
+      polygon = BorderPatrol::Polygon.new(points)
+      polygon.bounding_box.should == [BorderPatrol::Point.new(-1, 12), BorderPatrol::Point.new(10, -3)]
+    end
+  end
+
+  describe "#contains_point?" do
+    before do
+      points = [BorderPatrol::Point.new(-10, 0), BorderPatrol::Point.new(10, 0), BorderPatrol::Point.new(0, 10)]
+      @polygon = BorderPatrol::Polygon.new(points)
+    end
+
+    it "is true if the point is in the polygon" do
+      @polygon.contains_point?(BorderPatrol::Point.new(0.5, 0.5)).should be_true
+      @polygon.contains_point?(BorderPatrol::Point.new(0, 5)).should be_true
+      @polygon.contains_point?(BorderPatrol::Point.new(-1, 3)).should be_true
+    end
+
+    it "does not include points on the lines with slopes between vertices" do
+      @polygon.contains_point?(BorderPatrol::Point.new(5.0, 5.0)).should be_false
+      @polygon.contains_point?(BorderPatrol::Point.new(4.999999, 4.9999999)).should be_true
+      @polygon.contains_point?(BorderPatrol::Point.new(0, 0)).should be_true
+      @polygon.contains_point?(BorderPatrol::Point.new(0.000001, 0.000001)).should be_true
+    end
+
+    it "includes points at the vertices" do
+      @polygon.contains_point?(BorderPatrol::Point.new(-10, 0)).should be_true
+    end
+
+    it "is false if the point is outside of the polygon" do
+      @polygon.contains_point?(BorderPatrol::Point.new(9, 5)).should be_false
+      @polygon.contains_point?(BorderPatrol::Point.new(-5, 8)).should be_false
+      @polygon.contains_point?(BorderPatrol::Point.new(-10, -1)).should be_false
+      @polygon.contains_point?(BorderPatrol::Point.new(-20, -20)).should be_false
+    end
+  end
+
+  describe "#inside_bounding_box?" do
+    before do
+      points = [BorderPatrol::Point.new(-10, 0), BorderPatrol::Point.new(10, 0), BorderPatrol::Point.new(0, 10)]
+      @polygon = BorderPatrol::Polygon.new(points)
+    end
+
+    it "is false if it is outside the bounding box" do
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(-10, -1)).should be_false
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(-20, -20)).should be_false
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(1, 20)).should be_false
+    end
+
+    it "returns true if it is inside the bounding box" do
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(9, 5)).should be_true
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(-5, 8)).should be_true
+      @polygon.inside_bounding_box?(BorderPatrol::Point.new(1, 1)).should be_true
+    end
+
+  end
+end
+

data/spec/lib/border_patrol/region_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe BorderPatrol::Region do
+  it "is a Set" do
+    BorderPatrol::Region.new.should be_a Set
+  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)]
+
+      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)]
+
+      subject.contains_point?(point).should be_false
+    end
+
+    it "transforms (x,y) coordinates passed in into a point" do
+      @polygons = [polygon, polygon(30)]
+
+      subject.contains_point?(1,2).should be_true
+    end
+  end
+end

data/spec/lib/border_patrol_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe BorderPatrol do
+  describe ".parse_kml" do
+    it "returns a BorderPatrol::Region containing a BorderPatrol::Polygon for each polygon in the KML file" do
+      kml_data = File.read("#{File.dirname(__FILE__)}/../support/multi-polygon-test.kml")
+      region = BorderPatrol.parse_kml(kml_data)
+      region.length.should == 3
+      region.each {|p| p.should be_a BorderPatrol::Polygon}
+    end
+
+    context "when there is only one polygon" do
+      it "returns a region containing a single polygon" do
+        kml_data = File.read("#{File.dirname(__FILE__)}/../support/colorado-test.kml")
+        region = BorderPatrol.parse_kml(kml_data)
+        region.length.should == 1
+        region.each {|p| p.should be_a BorderPatrol::Polygon}
+      end
+    end
+  end
+
+  describe ".parse_kml_polygon_data" do
+    it "returns a BorderPatrol::Polygon with the points from the kml data in the correct order" do
+      kml = <<-EOM
+        <Polygon>
+          <outerBoundaryIs>
+           <LinearRing>
+             <tessellate>1</tessellate>
+             <coordinates>
+               -10,25,0.000000
+               -1,30,0.000000
+               10,1,0.000000
+               0, -5,000000
+               -10,25,0.000000
+              </coordinates>
+            </LinearRing>
+          </outerBoundaryIs>
+        </Polygon>
+      EOM
+      polygon = BorderPatrol.parse_kml_polygon_data(kml)
+      polygon.should == BorderPatrol::Polygon.new(BorderPatrol::Point.new(-10, 25), BorderPatrol::Point.new(-1, 30), BorderPatrol::Point.new(10, 1), BorderPatrol::Point.new(0, -5))
+    end
+  end
+
+  describe BorderPatrol::Point do
+    describe "==" do
+      it "is true if both points contain the same values" do
+        BorderPatrol::Point.new(1,2).should == BorderPatrol::Point.new(1,2)
+      end
+
+      it "is true if one point contains floats and one contains integers" do
+        BorderPatrol::Point.new(1,2.0).should == BorderPatrol::Point.new(1.0,2)
+      end
+
+      it "is false if the points contain different values" do
+        BorderPatrol::Point.new(1,3).should_not == BorderPatrol::Point.new(1.0,2)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format Spec::Runner::Formatter::CompactProgressBarFormatter
+--loadby mtime
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'nokogiri'
+
+base_dir = File.expand_path("#{File.dirname(__FILE__)}/..")
+app_dirs = ['lib', 'lib/kaml_pen']
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+app_dirs.each do |app_dir|
+  Dir["#{base_dir}/spec/#{app_dir}/*.rb"].each do |f|
+    f.sub!('/spec','')
+    f.sub!('_spec','')
+    require f
+  end
+end
+
+Spec::Runner.configure do |config|
+end

data/spec/support/colorado-test.kml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.2">
+<Document>
+  <name>Colorado</name>
+  <description><![CDATA[]]></description>
+  <Style id="style1">
+    <LineStyle>
+      <color>40000000</color>
+      <width>3</width>
+    </LineStyle>
+    <PolyStyle>
+      <color>73FF0000</color>
+      <fill>1</fill>
+      <outline>1</outline>
+    </PolyStyle>
+  </Style>
+  <Placemark>
+    <name>Shape 1</name>
+    <description><![CDATA[]]></description>
+    <styleUrl>#style1</styleUrl>
+    <Polygon>
+      <outerBoundaryIs>
+        <LinearRing>
+          <tessellate>1</tessellate>
+          <coordinates>
+            -109.050293,41.008923,0.000000
+            -102.057495,41.004776,0.000000
+            -102.046509,36.993778,0.000000
+            -109.044800,36.998165,0.000000
+            -109.050293,41.008923,0.000000
+          </coordinates>
+        </LinearRing>
+      </outerBoundaryIs>
+    </Polygon>
+  </Placemark>
+</Document>
+</kml>

data/spec/support/formatters/compact_progress_bar_formatter.rb

@@ -0,0 +1,133 @@
+# Originally by Nicholas A. Evans. See LICENSE.txt at
+# http://gist.github.com/275257
+#
+# Note: includes modifications from the original to use '=' for the progress
+# bar mark and keep the cursor from hopping all around during the animation.
+#
+# This version is compatible with RSpec 1.2.9 and ProgressBar 0.9.0.
+
+require 'spec/runner/formatter/base_text_formatter'
+require 'progressbar'
+
+module Spec
+  module Runner
+    module Formatter
+      class CompactProgressBarFormatter < BaseTextFormatter
+        # Threshold for slow specs, in seconds.
+        # Anything that takes longer than this will be printed out
+        THRESHOLD = 1.0 unless defined?(THRESHOLD)
+
+        attr_reader :total, :current
+
+        def start(example_count)
+          @current     = 0
+          @total       = example_count
+          @error_state = :all_passing
+          @pbar        = ProgressBar.new("#{example_count} examples", example_count, output)
+          @pbar.instance_variable_set("@bar_mark", "=")
+        end
+
+        def example_started(example)
+          super
+          @start_time = Time.now
+        end
+
+        def example_passed(example)
+          print_warning_if_slow(example_group.description,
+                                example.description,
+                                Time.now - @start_time)
+          increment
+        end
+
+        def example_pending(example, message, deprecated_pending_location=nil)
+          immediately_dump_pending(example.description, message, pending_caller)
+          mark_error_state_pending
+          increment
+        end
+
+        def example_failed(example, counter, failure)
+          immediately_dump_failure(counter, failure)
+          mark_error_state_failed
+          increment
+        end
+
+        def start_dump
+          with_color do
+            @pbar.finish
+          end
+          output.flush
+        end
+
+        def dump_failure(*args)
+          # no-op; we summarized failures as we were running
+        end
+
+        def method_missing(sym, *args)
+          # ignore
+        end
+
+        # Adapted from BaseTextFormatter#dump_failure
+        def immediately_dump_failure(counter, failure)
+          erase_current_line
+          output.print "#{counter.to_s}) "
+          output.puts colorize_failure("#{failure.header}\n#{failure.exception.message}", failure)
+          output.puts format_backtrace(failure.exception.backtrace)
+          output.puts
+        end
+
+        # Adapted from BaseTextFormatter#dump_pending
+        def immediately_dump_pending(desc, msg, called_from)
+          erase_current_line
+          output.puts yellow("PENDING SPEC:") + " #{desc} (#{msg})"
+          output.puts "  Called from #{called_from}" if called_from
+        end
+
+        def increment
+          with_color do
+            @current += 1
+            # Since we're constantly erasing the line, make sure the progress is
+            # printed even when the bar hasn't changed
+            @pbar.instance_variable_set("@previous", 0)
+            @pbar.instance_variable_set("@title", "  #{current}/#{total}")
+            @pbar.inc
+          end
+          output.flush
+        end
+
+        ERROR_STATE_COLORS = {
+          :all_passing  => "\e[32m", # green
+          :some_pending => "\e[33m", # yellow
+          :some_failed  => "\e[31m", # red
+        } unless defined?(ERROR_STATE_COLORS)
+
+        def with_color
+          output.print "\e[?25l" + ERROR_STATE_COLORS[@error_state] if colour?
+          yield
+          output.print "\e[0m\e[?25h" if colour?
+        end
+
+        def mark_error_state_failed
+          @error_state = :some_failed
+        end
+
+        def mark_error_state_pending
+          @error_state = :some_pending unless @error_state == :some_failed
+        end
+
+        def erase_current_line
+          output.print "\e[K"
+        end
+
+        def print_warning_if_slow(group, example, elapsed)
+          if elapsed > THRESHOLD
+            erase_current_line
+            output.print yellow("SLOW SPEC: #{sprintf("%.4f", elapsed)} ")
+            output.print " #{group} #{example}"
+            output.puts
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/support/multi-polygon-test.kml

@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.2">
+<Document>
+  <name>Multi-Polygon</name>
+  <description><![CDATA[]]></description>
+  <Style id="style1">
+    <LineStyle>
+      <color>40000000</color>
+      <width>3</width>
+    </LineStyle>
+    <PolyStyle>
+      <color>73FF0000</color>
+      <fill>1</fill>
+      <outline>1</outline>
+    </PolyStyle>
+  </Style>
+  <Style id="style3">
+    <LineStyle>
+      <color>40000000</color>
+      <width>3</width>
+    </LineStyle>
+    <PolyStyle>
+      <color>73FF0000</color>
+      <fill>1</fill>
+      <outline>1</outline>
+    </PolyStyle>
+  </Style>
+  <Style id="style2">
+    <LineStyle>
+      <color>40000000</color>
+      <width>3</width>
+    </LineStyle>
+    <PolyStyle>
+      <color>73FF0000</color>
+      <fill>1</fill>
+      <outline>1</outline>
+    </PolyStyle>
+  </Style>
+  <Placemark>
+    <name>Colorado</name>
+    <description><![CDATA[]]></description>
+    <styleUrl>#style1</styleUrl>
+    <Polygon>
+      <outerBoundaryIs>
+        <LinearRing>
+          <tessellate>1</tessellate>
+          <coordinates>
+            -109.053040,41.002705,0.000000
+            -102.046509,41.006847,0.000000
+            -102.041016,36.991585,0.000000
+            -109.048920,36.997070,0.000000
+            -109.053040,41.002705,0.000000
+          </coordinates>
+        </LinearRing>
+      </outerBoundaryIs>
+    </Polygon>
+  </Placemark>
+  <Placemark>
+    <name>Paris</name>
+    <description><![CDATA[]]></description>
+    <styleUrl>#style3</styleUrl>
+    <Polygon>
+      <outerBoundaryIs>
+        <LinearRing>
+          <tessellate>1</tessellate>
+          <coordinates>
+            1.593018,49.109837,0.000000
+            1.571045,48.257599,0.000000
+            3.186035,48.275883,0.000000
+            3.186035,49.167339,0.000000
+            1.593018,49.109837,0.000000
+          </coordinates>
+        </LinearRing>
+      </outerBoundaryIs>
+    </Polygon>
+  </Placemark>
+  <Placemark>
+    <name>Australia</name>
+    <description><![CDATA[]]></description>
+    <styleUrl>#style2</styleUrl>
+    <Polygon>
+      <outerBoundaryIs>
+        <LinearRing>
+          <tessellate>1</tessellate>
+          <coordinates>
+            120.673828,-14.179186,0.000000
+            107.534180,-25.918526,0.000000
+            111.840820,-37.544579,0.000000
+            148.183594,-44.559162,0.000000
+            157.543945,-30.789038,0.000000
+            148.051758,-10.617418,0.000000
+            135.131836,-9.188870,0.000000
+            120.673828,-14.179186,0.000000
+          </coordinates>
+        </LinearRing>
+      </outerBoundaryIs>
+    </Polygon>
+  </Placemark>
+</Document>
+</kml>

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: border_patrol
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Zach Brock
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
+  prerelease: false
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  name: rspec
+  prerelease: false
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: progressbar
+  prerelease: false
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 113
+        segments: 
+        - 1
+        - 4
+        - 3
+        - 1
+        version: 1.4.3.1
+  name: nokogiri
+  prerelease: false
+  requirement: *id004
+  type: :runtime
+description: Lets you import a KML file and then check if points are inside or outside the polygons the file defines.
+email: eng@squareup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/border_patrol/polygon.rb
+- lib/border_patrol/region.rb
+- lib/border_patrol.rb
+- lib/VERSION
+- spec/lib/border_patrol/polygon_spec.rb
+- spec/lib/border_patrol/region_spec.rb
+- spec/lib/border_patrol_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/colorado-test.kml
+- spec/support/formatters/compact_progress_bar_formatter.rb
+- spec/support/multi-polygon-test.kml
+- border_patrol.gemspec
+- Rakefile
+- README.markdown
+- .gitignore
+- Gemfile
+- Gemfile.lock
+has_rdoc: true
+homepage: http://github.com/square/border_patrol
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Import and query KML regions
+test_files: 
+- spec/lib/border_patrol/polygon_spec.rb
+- spec/lib/border_patrol/region_spec.rb
+- spec/lib/border_patrol_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/colorado-test.kml
+- spec/support/formatters/compact_progress_bar_formatter.rb
+- spec/support/multi-polygon-test.kml