kmlbo 0.0.1 → 0.0.2

data/bin/kmlbo

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require 'kmlbo/kml'
-require 'kmlbo/pointlist'
+require 'kmlbo'
 
 options = {}
 option_parser = OptionParser.new do |opts|
@@ -16,6 +15,9 @@ option_parser = OptionParser.new do |opts|
   opts.on("-k", "--kml", "Emit kml instead of ruby") do |kml|
     options[:kml] = true
   end
+  opts.on("-e", "--encoded", "Output an encoded path suitable for use in Google Maps v3 API") do |encoded|
+    options[:encoded] = true
+  end
 end
 
 option_parser.parse!
@@ -39,6 +41,10 @@ if options[:kml]
   File.open(output_file, "w+") do |file|
     file.write(coordinates.to_kml)
   end
+elsif options[:encoded]
+  File.open(output_file, "w+") do |file|
+    file.write(coordinates.to_encoded.inspect)
+  end
 else
   File.open(output_file, "w+") do |file|
     file.write("PATH_COORDINATES = #{coordinates.to_a.to_s}")

data/lib/kmlbo/g_polyline.rb

@@ -0,0 +1,78 @@
+# GPolyline is a module that implements the Google Polyline Algorithm Format.
+# https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+#
+# Author:: Josh Cronemeyer
+# Copyright:: Copyright (c) 2008-2011
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+#
+# Include this module into a class that has an instance variable called
+# @tuple_array, where @tuple_array contains a list of geocoordinates of the
+# form [[lng, lat, elev], ..., [lng, lat, elev]].  It will override to_s
+# and output an encoded path suitable for use in Google Maps v3 API
+#
+#   require "kmlbo/g_polyline"
+#   class Polyline
+#     include GPolyline
+#     ...
+#   end
+#
+#   path = Polyline.new
+#   path.to_s
+#   # => "svzmFdgi_QdA?nCA"
+#
+# Ideas for this implementation of the google polyline algorithm format
+# come from the following sources:
+# * http://facstaff.unca.edu/mcmcclur/GoogleMaps/
+# * https://github.com/joshuaclayton/polylines/
+#
+# This implementation is tested against results from the Google API to
+# ensure compatability.  See unit tests for more information.
+
+module GPolyline
+  # Output an encoded path String suitable for use in Google Maps v3 API
+  def to_s
+    encode_polyline_algorithm
+  end
+  
+  private
+  def encode_polyline_algorithm
+    deltas.map {|point| encode_signed_decimal(point) }.join
+  end
+  
+  def round_decimal(decimal)
+    (decimal * 1e5).round
+  end
+  
+  def encode_signed_decimal(num)
+    sgn_num = num << 1
+    sgn_num = ~sgn_num if num < 0 
+    return encode_number(sgn_num)
+  end
+
+  def to_e5
+    @tuple_array.map do |tuple|
+      tuple.map{|coordinate| round_decimal(coordinate)}
+    end
+  end
+  
+  def deltas
+    delta_latitude, delta_longitude = 0, 0
+
+    return to_e5.inject([]) do |polyline, (longitude, latitude)|
+      polyline << latitude - delta_latitude
+      polyline << longitude - delta_longitude
+      delta_latitude, delta_longitude = latitude, longitude
+      polyline
+    end
+  end
+  
+  def encode_number(num)
+    encoded = ""
+    while (num >= 0x20) do
+        encoded << ((0x20 | (num & 0x1f)) + 63).chr
+        num = num >> 5
+    end
+    encoded << (num + 63).chr
+    return encoded
+  end
+end

data/lib/kmlbo/kml.rb

@@ -2,8 +2,8 @@ require 'erb'
 
 class KML
   def initialize(kml_file)
-    @coordinates = []
     @file_data = ""
+    @point_list = PointList.new([])
     File.open(kml_file, "r") do |file|
       @file_data = file.read
       parse_coordinates
@@ -11,13 +11,17 @@ class KML
   end
   
   def to_a
-    @coordinates
+    @point_list.tuple_array
+  end
+  
+  def to_encoded
+    @point_list.to_s
   end
   
   def simplify!(epsilon=nil, passes=nil)
-    original_number_of_coords = @coordinates.size
-    @coordinates = PointList.new(@coordinates, epsilon, passes).simplify.tuple_array
-    puts "Simplified path from #{original_number_of_coords} to #{@coordinates.size} points"
+    original_number_of_coords = @point_list.size
+    @point_list = PointList.new(@point_list.tuple_array, epsilon, passes).simplify
+    puts "Simplified path from #{original_number_of_coords} to #{@point_list.size} points"
     self
   end
   
@@ -34,7 +38,10 @@ class KML
   private
   def parse_coordinates
     coordinate_string = get_data_between_coordinates_markup
-    @coordinates = convert_string_data_to_array_data(coordinate_string) if coordinate_string != ""
+    if coordinate_string != ""
+      array_data = convert_string_data_to_array_data(coordinate_string) 
+      @point_list = PointList.new(array_data)
+    end
   end
   
   def get_data_between_coordinates_markup

data/lib/kmlbo/pointlist.rb

@@ -1,5 +1,5 @@
 class PointList
-  
+  include GPolyline
   attr_accessor :tuple_array
   attr_accessor :epsilon
   attr_accessor :passes
@@ -20,6 +20,9 @@ class PointList
     @tuple_array == other.tuple_array
   end
   
+  def size
+    @tuple_array.size
+  end
   private
   def douglas_peucker(point_list, epsilon)
     #http://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm

data/lib/kmlbo.rb

@@ -0,0 +1,9 @@
+# kmlbo is a library and utility for working with KML, Ruby and the Google Maps API
+# See https://github.com/joshuacronemeyer/kmlbo for info.
+#
+# Author:: Josh Cronemeyer
+# Copyright:: Copyright (c) 2008-2011
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+require 'kmlbo/g_polyline.rb'
+require 'kmlbo/pointlist'
+require 'kmlbo/kml'

data/test/g_polyline_test.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+# all expected values for these tests were computed using google's API
+# https://developers.google.com/maps/documentation/utilities/polylineutility
+class GPolylineTest < MiniTest::Unit::TestCase
+ describe "polyline module" do
+   it "must correctly convert a one element polyline" do
+     pointlist = PointList.new([[-122.674693498207,45.5474112205939,0]])
+     pointlist.to_s.must_equal "i~~tGx{vkV"
+   end
+
+   it "must convert a multipart line" do
+     path = [ [-94.42434787909789,39.13594499803094,0], [-94.42434713169446,39.1355875721549,0], [-94.424343522331,39.13486866498771,0] ]
+     expected = "svzmFdgi_QdA?nCA"
+     pointlist = PointList.new(path)
+     pointlist.to_s.must_equal expected
+   end
+  end
+end

data/test/pointlist_test.rb

@@ -1,6 +1,5 @@
-require 'minitest/autorun'
-require_relative '../lib/kmlbo/pointlist.rb'
-require_relative 'data.rb'
+require File.join(File.dirname(__FILE__), 'test_helper')
+
 class PointlistTest < MiniTest::Unit::TestCase
   describe "simplify module" do
     it "must do nothing when asked to simplify a one point path" do

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'kmlbo'
+require File.join(File.dirname(__FILE__), 'data')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kmlbo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70268437580240 !ruby/object:Gem::Requirement
+  requirement: &70183536448300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70268437580240
+  version_requirements: *70183536448300
 description: A Gem for converting kml path data to ruby arrays, and applying douglas
   peucker path simplification.
 email: joshuacronemeyer@gmail.com
@@ -33,12 +33,16 @@ files:
 - Rakefile
 - README.md
 - bin/kmlbo
+- lib/kmlbo.rb
 - lib/kmlbo/kml.rb
-- lib/kmlbo/output.kml.erb
+- lib/kmlbo/g_polyline.rb
 - lib/kmlbo/pointlist.rb
+- lib/kmlbo/output.kml.erb
 - test/data.rb
 - test/pointlist_test.rb
+- test/g_polyline_test.rb
 - test/sample.kml
+- test/test_helper.rb
 homepage: https://github.com/joshuacronemeyer/kmlbo
 licenses: []
 post_install_message: 
@@ -62,9 +66,10 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A Gem for converting kml path data to ruby arrays, and applying douglas peucker
-  path simplification.
+summary: A library and utility for working with KML, Ruby and the Google Maps API.
 test_files:
 - test/data.rb
 - test/pointlist_test.rb
+- test/g_polyline_test.rb
 - test/sample.kml
+- test/test_helper.rb