encoded_polyline 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Brandon Liu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -2,22 +2,33 @@
 
 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.
+This coordinate encoding scheme is also compatible with [MapQuest Platform Services](http://open.mapquestapi.com/common/encodedecode.html), which supports variable decimal precision. The default precision of 5 is appropriate for compatibility with the Google Maps API.
+
+## Installation
+
+    gem install encoded_polyline
 
 ## 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 with default decimal precision of 5:
+
+    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]]
 
-Using the library:
+Using the library with explicit decimal precisions:
 
-    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]]
+    EncodedPolyline.encode(-179.9832104, 7)               # "na`|gjB"
+    EncodedPolyline.decode("na`|gjB", 7)                  # -179.9832104
+    EncodedPolyline.encode_points([[37.782,-122.406]], 2) # "ckF`|V"
+    EncodedPolyline.decode_points("ckF`|V", 2)            # [[37.78, -122.41]]
+
+It is important to specify the same precision when encoding and decoding. Otherwise, decoded coordinates may be wrong by orders of magnitude.
 
 ## 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).
+Included is a benchmark that creates a 100-point random walk, gives you a URL, and encodes/decodes it 10,000 times (1 million points total).
 
     Raw length(JSON):     3682 characters
     Encoded length:       495 characters
@@ -27,7 +38,12 @@ Some of the steps outlined in the algorithm spec are composed together, for spee
     encoding              9.090000   0.000000   9.090000 (  9.092519)
     decoding             16.470000   0.010000  16.480000 ( 16.473547)
 
-## Known Issues
+## Contributors
+
+[bdon](https://github.com/bdon) - author
+
+[anoved](https://github.com/anoved) - explicit precision, MapQuest support
 
-Haven't tested with Ruby 1.9; probably doesn't work.
+## Copyright
 
+Copyright (c) 2013 Brandon Liu. See LICENSE for details.

data/encoded_polyline.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   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.date = "2013-02-20"
+  s.description = "Encode an array of coordinates for the Google Static Maps and MapQuest APIs."
   s.summary = "Encode an array of coordinates"
   s.homepage = "http://github.com/bdon/encoded_polyline"
 

data/lib/encoded_polyline/core.rb

@@ -1,6 +1,6 @@
 class EncodedPolyline
-  def self.encode(number)
-    number = (number * 1e5).round
+  def self.encode(number, precision=5)
+    number = (number * (10 ** precision)).round
     n = number << 1
     n = ~n if number < 0
     str = ""
@@ -11,44 +11,44 @@ class EncodedPolyline
     return str << (n + 63).chr
   end
 
-  def self.decode_arr(arr)
+  def self.decode_arr(arr, precision=5)
     num = 0
     arr[0..-2].each_with_index do |elem, i|
-      num = (num | (((elem[0] - 63) ^ 0x20) << (i * 5)))
+      num = (num | (((elem[0].ord - 63) ^ 0x20) << (i * 5)))
     end
-    num = (num | ((arr.last[0] - 63) << ((arr.size-1) * 5)))
+    num = (num | ((arr.last[0].ord - 63) << ((arr.size-1) * 5)))
     num = ~num if ((num & 0x1) == 1)
     num = num >> 1
-    num = num.to_f / 1e5
+    num = num.to_f * (10 ** -precision)
     return num
   end
 
-  def self.decode(str)
-    self.decode_arr(str.split(//))
+  def self.decode(str, precision=5)
+    self.decode_arr(str.split(//), precision)
   end
 
-  def self.encode_points(coordinates)
+  def self.encode_points(coordinates, precision=5)
     output = ""
-    output << encode(coordinates.first[0])
-    output << encode(coordinates.first[1])
+    output << encode(coordinates.first[0], precision)
+    output << encode(coordinates.first[1], precision)
 
     (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])
+      output << encode(current[0] - previous[0], precision)
+      output << encode(current[1] - previous[1], precision)
     end
     return output
   end
 
-  def self.decode_points(str)
+  def self.decode_points(str, precision=5)
     decoded_points = []
     point_chars = []
 
     str.each_char do |char|
       point_chars << char
-      if ((char[0] - 63) & 0x20).zero?
-        decoded_points << decode_arr(point_chars)
+      if ((char[0].ord - 63) & 0x20).zero?
+        decoded_points << decode_arr(point_chars, precision)
         point_chars = []
       end
     end
@@ -62,4 +62,4 @@ class EncodedPolyline
      end
     return coordinates
   end
-end
+end

data/lib/encoded_polyline/version.rb

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

data/spec/encoded_polyline/encoded_polyline_spec.rb

@@ -5,6 +5,10 @@ describe EncodedPolyline, ".encode" do
     EncodedPolyline.encode(-179.9832104).should == "`~oia@"
   end
 
+  it "encodes a single point with explicit precision" do
+    EncodedPolyline.encode(-179.9832104, 7).should == "na`|gjB"
+  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 == "?"
@@ -13,14 +17,18 @@ end
 
 describe EncodedPolyline, ".decode" do
   it "decodes a single point" do
-    EncodedPolyline.decode('`~oia@').should be_close(-179.9832104, 0.0001)
+    EncodedPolyline.decode('`~oia@').should be_within(0.00001).of(-179.9832104)
+  end
+
+  it "decodes a single point with explicit precision" do
+    EncodedPolyline.decode("na`|gjB", 7).should be_within(0.0000001).of(-179.9832104)
   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)
+    x.should be_within(0.0001).of(arr2[i][0])
+    y.should be_within(0.0001).of(arr2[i][1])
   end
 end
 
@@ -33,10 +41,18 @@ describe EncodedPolyline, ".decode_points" do
     EncodedPolyline.encode_points([[37.782,-122.406]]).should == "ohreFnlbjV"
   end
 
+  it "encodes a a pair of points with explicit precision" do
+    EncodedPolyline.encode_points([[37.782,-122.406]], 2).should == "ckF`|V"
+  end
+
   it "should decode" do
     should_be_similar_points(EncodedPolyline.decode_points(ring_text), ring_points)
   end
 
+  it "decodes points with explicit precision" do
+    should_be_similar_points(EncodedPolyline.decode_points("ckF`|V", 2),[[37.78, -122.41]])
+  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)

metadata

@@ -1,62 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: encoded_polyline
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Brandon Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-02 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 1
-        - 3
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.3.1
   type: :development
-  version_requirements: *id002
-description: Encode an array of coordinates for the Google Static Maps API.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: Encode an array of coordinates for the Google Static Maps and MapQuest
+  APIs.
 email: bdon@bdon.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- LICENSE
 - README.markdown
 - Rakefile
 - encoded_polyline.gemspec
@@ -66,40 +60,31 @@ files:
 - 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: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Encode an array of coordinates
-test_files: 
+test_files:
 - spec/encoded_polyline/encoded_polyline_spec.rb
 - spec/spec_helper.rb
+has_rdoc: