encoded_polyline 0.0.1

data/README.markdown

@@ -0,0 +1,33 @@
+# EncodedPolyline
+
+EncodedPolyline implements [Google's algorithm](http://code.google.com/apis/maps/documentation/utilities/polylinealgorithm.html) for compressing arrays of geographic points. The compressed string can then be passed to the Google Maps API.
+The Maps API limits URL requests to 2048 characters. This library does not enforce this limit on the encoding length.
+
+## Examples
+
+An [example map](http://maps.googleapis.com/maps/api/staticmap?size=400x400&sensor=false&path=weight:3|color:blue|enc:~fzz\]_uvsOdX`a@jR~Boe@_XfPZoe@N{N}p@jTqIxCpYvi@?yApz@{r@}HkQ|l@xi@pa@vB{IiHg`@ao@jWxA_Bi_@gN_S|\[zN}s@vy@mQ|c@bd@TyHti@x\]ca@vZ~Di}@mb@`\hPxe@hRky@~Rk`@nq@_p@t_@mUdw@oHaWc@dNus@kVz\[gu@oi@ne@}Yxg@mu@iCo}@mm@gQhMgWtc@}Kxv@x_@gSlWq|@vT{v@q{@_m@jL_Td\]
+) from a 50-point random walk, encoded using the library.
+
+Using the library:
+
+    EncodedPolyline.encode(-179.9832104)               # "`~oia@"
+    EncodedPolyline.decode("`~oia@")                   # -179.98321
+    EncodedPolyline.encode_points([[37.782,-122.406]]) # "ohreFnlbjV"
+    EncodedPolyline.decode_points("ohreFnlbjV")        # [[37.782,-122.406]]
+
+## Performance
+
+Some of the steps outlined in the algorithm spec are composed together, for speediness. Included is a benchmark that creates a 100-point random walk and encodes/decodes it 10,000 times (1 million points total).
+
+    Raw length(JSON):     3682 characters
+    Encoded length:       495 characters
+    Compression ratio:    0.134437805540467
+
+                              user     system      total        real
+    encoding              9.090000   0.000000   9.090000 (  9.092519)
+    decoding             16.470000   0.010000  16.480000 ( 16.473547)
+
+## Known Issues
+
+Haven't tested with Ruby 1.9; probably doesn't work.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "spec/rake/spectask"
+
+task :default => :spec
+
+# RSpec 1.3
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.spec_files = FileList['spec/encoded_polyline/*_spec.rb']
+end

data/encoded_polyline.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'encoded_polyline/version'
+
+Gem::Specification.new do |s|
+  s.name = "encoded_polyline"
+  s.version = EncodedPolyline::VERSION
+  s.authors = ["Brandon Liu"]
+  s.email = "bdon@bdon.org"
+  s.date = "2011-09-02"
+  s.description = "Encode an array of coordinates for the Google Static Maps API."
+  s.summary = "Encode an array of coordinates"
+  s.homepage = "http://github.com/bdon/encoded_polyline"
+
+  s.require_paths = ["lib"]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec", "~> 1.3.1")
+end

data/lib/encoded_polyline.rb

@@ -0,0 +1,2 @@
+require 'encoded_polyline/core'
+require 'encoded_polyline/version'

data/lib/encoded_polyline/core.rb

@@ -0,0 +1,65 @@
+class EncodedPolyline
+  def self.encode(number)
+    number = (number * 1e5).round
+    n = number << 1
+    n = ~n if number < 0
+    str = ""
+    while n >= 0x20 do
+        str << ((0x20 | (n & 0x1f)) + 63).chr
+        n = n >> 5
+    end
+    return str << (n + 63).chr
+  end
+
+  def self.decode_arr(arr)
+    num = 0
+    arr[0..-2].each_with_index do |elem, i|
+      num = (num | (((elem[0] - 63) ^ 0x20) << (i * 5)))
+    end
+    num = (num | ((arr.last[0] - 63) << ((arr.size-1) * 5)))
+    num = ~num if ((num & 0x1) == 1)
+    num = num >> 1
+    num = num.to_f / 1e5
+    return num
+  end
+
+  def self.decode(str)
+    self.decode_arr(str.split(//))
+  end
+
+  def self.encode_points(coordinates)
+    output = ""
+    output << encode(coordinates.first[0])
+    output << encode(coordinates.first[1])
+
+    (1..coordinates.size-1).each do |i|
+      previous = coordinates[i-1]
+      current = coordinates[i]
+      output << encode(current[0] - previous[0])
+      output << encode(current[1] - previous[1])
+    end
+    return output
+  end
+
+  def self.decode_points(str)
+    decoded_points = []
+    point_chars = []
+
+    str.each_char do |char|
+      point_chars << char
+      if ((char[0] - 63) & 0x20).zero?
+        decoded_points << decode_arr(point_chars)
+        point_chars = []
+      end
+    end
+
+    coordinates = [[decoded_points.shift, decoded_points.shift]]
+     while decoded_points.any?
+       coordinates << [
+         coordinates.last[0] + decoded_points.shift,
+         coordinates.last[1] + decoded_points.shift
+       ]
+     end
+    return coordinates
+  end
+end

data/lib/encoded_polyline/version.rb

@@ -0,0 +1,3 @@
+class EncodedPolyline
+  VERSION = "0.0.1".freeze
+end

data/script/benchmark.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby -w
+require "lib/encoded_polyline/core"
+require 'benchmark'
+
+def rsign
+  (rand(2) == 1) ? -1 : 1
+end
+
+random_walk = [[rand * 180 * rsign, rand * 180 * rsign]]
+99.times do
+  lat = random_walk.last[0] + rand * 0.01 * rsign
+  long =random_walk.last[1] + rand * 0.01 * rsign
+  random_walk << [lat, long]
+end
+
+random_walk_text = EncodedPolyline.encode_points(random_walk)
+
+points_length = random_walk.inspect.gsub(' ','').to_s.length
+compressed_length = random_walk_text.length
+
+puts "Raw length(JSON):\t#{points_length} characters"
+puts "Encoded length:\t\t#{compressed_length} characters"
+
+puts "Compression ratio:\t#{compressed_length.to_f / points_length}"
+
+puts "Static map:\t\thttp://maps.googleapis.com/maps/api/staticmap?size=400x400&sensor=false&path=weight:3%7Ccolor:blue%7Cenc:#{random_walk_text}"
+puts "\n"
+
+Benchmark.bm(20) do |x|
+  x.report("encoding") do
+    10000.times do |i|
+      EncodedPolyline.encode_points(random_walk)
+    end
+  end
+
+  x.report("decoding") do
+    10000.times do |i|
+      EncodedPolyline.decode_points(random_walk_text)
+    end
+  end
+end

data/spec/encoded_polyline/encoded_polyline_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe EncodedPolyline, ".encode" do
+  it "encodes a single point" do
+    EncodedPolyline.encode(-179.9832104).should == "`~oia@"
+  end
+
+  it "encodes a very slightly negative point" do
+    # Due to precision errors, verify that a negative value that rounds to 0 works.
+    EncodedPolyline.encode(-3e-6).should == "?"
+  end
+end
+
+describe EncodedPolyline, ".decode" do
+  it "decodes a single point" do
+    EncodedPolyline.decode('`~oia@').should be_close(-179.9832104, 0.0001)
+  end
+end
+
+def should_be_similar_points(arr1, arr2)
+  arr1.each_with_index do |(x,y),i|
+    x.should be_close(arr2[i][0], 0.0001)
+    y.should be_close(arr2[i][1], 0.0001)
+  end
+end
+
+describe EncodedPolyline, ".decode_points" do
+  let(:ring_points) { [[37.79297, -122.39676], [37.78987, -122.40075], [37.7894, -122.401], [37.78573, -122.40512], [37.78553, -122.40598], [37.78417, -122.40744], [37.78153, -122.41122], [37.77895, -122.41474], [37.77501, -122.41894], [37.77447, -122.41851], [37.77332, -122.41688], [37.77081, -122.41345], [37.77013, -122.40959], [37.77291, -122.40332], [37.77379, -122.40186], [37.77515, -122.40075], [37.77691, -122.39766], [37.77997, -122.39525], [37.78417, -122.39242], [37.78729, -122.38959], [37.78906, -122.38959], [37.79068, -122.39131], [37.79258, -122.39431], [37.79258, -122.39431], [37.79297, -122.39676], [37.78987, -122.40075], [37.7894, -122.401], [37.78573, -122.40512], [37.78553, -122.40598], [37.78417, -122.40744], [37.78153, -122.41122], [37.77895, -122.41474], [37.77501, -122.41894], [37.77447, -122.41851], [37.77332, -122.41688], [37.77081, -122.41345], [37.77013, -122.40959], [37.77291, -122.40332], [37.77379, -122.40186], [37.77515, -122.40075], [37.77691, -122.39766], [37.77997, -122.39525], [37.78417, -122.39242], [37.78729, -122.38959], [37.78906, -122.38959], [37.79068, -122.39131], [37.79258, -122.39431], [37.79258, -122.39431]] }
+
+  let(:ring_text) { "amteFvr`jVjR|W|Ap@|UvXf@jDnGbHnOrVbO~TrWfYjBuAdFeItNmTfCcWkPef@oDcHoG}E_JiRcRaNgYuPoRuPaJ?cIvI{JvQ??mAhNjR|W|Ap@|UvXf@jDnGbHnOrVbO~TrWfYjBuAdFeItNmTfCcWkPef@oDcHoG}E_JiRcRaNgYuPoRuPaJ?cIvI{JvQ??" }
+
+  it "encodes a pair of points" do
+    EncodedPolyline.encode_points([[37.782,-122.406]]).should == "ohreFnlbjV"
+  end
+
+  it "should decode" do
+    should_be_similar_points(EncodedPolyline.decode_points(ring_text), ring_points)
+  end
+
+  it "encodes points with little variation" do
+    points = [[37.79297, -122.39676],[37.79297, -122.39676],[37.79297, -122.39676]]
+    should_be_similar_points(EncodedPolyline.decode_points(EncodedPolyline.encode_points(points)), points)
+  end
+
+  it "truncates to 5 digits of accuracy" do
+    points = [[37.79297111, -122.39676222],[37.79297333, -122.39676444],[37.79297555, -122.39676666]]
+    points_2 = [[37.79297, -122.39676],[37.79297, -122.39676],[37.79297, -122.39676]]
+    should_be_similar_points(EncodedPolyline.decode_points(EncodedPolyline.encode_points(points)), points_2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'encoded_polyline'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: encoded_polyline
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brandon Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+description: Encode an array of coordinates for the Google Static Maps API.
+email: bdon@bdon.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- encoded_polyline.gemspec
+- lib/encoded_polyline.rb
+- lib/encoded_polyline/core.rb
+- lib/encoded_polyline/version.rb
+- script/benchmark.rb
+- spec/encoded_polyline/encoded_polyline_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bdon/encoded_polyline
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Encode an array of coordinates
+test_files: 
+- spec/encoded_polyline/encoded_polyline_spec.rb
+- spec/spec_helper.rb