Created simple shared interface for traits.

 - Updated local var names in BingTrait to be more consistent
 - Updated test suite to use new interface on two test-suites
 - Update phar to error two "undefined" if git descrive fails

Author: emcconville

build/phar.php

@@ -27,7 +27,7 @@
 define('SRC_DIR',ROOT_DIR.'src'.DIRECTORY_SEPARATOR);
 define('EXT','.phar');
 define('PACKAGE_NAME','polyline-encoder');
-define('PACKAGE_VERSION',trim(`git describe`));
+define('PACKAGE_VERSION',trim(`git describe 2>/dev/null || echo "undefined"`));
 define('PACKAGE',PACKAGE_NAME.'-'.PACKAGE_VERSION);
 define('PACKAGE_PHAR',PACKAGE.EXT);
 
@@ -50,6 +50,7 @@
 // traits for immediate use.
 $main=<<<END_OF_MAIN
 <?php
+require_once('phar://polyline-encoder.phar/PolylineEncoderInterface.php');
 require_once('phar://polyline-encoder.phar/BingTrait.php');
 require_once('phar://polyline-encoder.phar/GoogleTrait.php');
 __HALT_COMPILER();

src/emcconville/Polyline/BingTrait.php

@@ -92,13 +92,13 @@ public function encodePoints($points)
          * Convert ANSI string into array of points
          *
          * @link http://msdn.microsoft.com/en-us/library/dn306801.aspx
-         * @param string $encoded
+         * @param string $string
          * @return array or FALSE on failure
          */
-        public function decodeString($str)
+        public function decodeString($string)
         {
-            assert(is_string($str));
-            $length   = strlen($str);
+            assert(is_string($string));
+            $length   = strlen($string);
             $cursor   = 0;
             $previous = array(0,0);
             $points   = array();
@@ -109,7 +109,7 @@ public function decodeString($str)
                 while(true)
                 {
                     // Read input
-                    $remainder = strpos(BING_SAFE_CHARACTERS,$str[$cursor++]);
+                    $remainder = strpos(BING_SAFE_CHARACTERS,$string[$cursor++]);
                     if( $remainder === FALSE )
                         return FALSE;
                     // Mask top bit and shift by bytes read
@@ -139,4 +139,4 @@ public function decodeString($str)
             return $points;
         }
     }
-}
+}

src/emcconville/Polyline/PolylineEncoderInterface.php

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * Google Maps - Encoded Polyline Algorithm
+ * 
+ * This library is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package PolylineEncoderInterface
+ * @author  E. McConville <[email protected]>
+ * @version 1.1
+ * @license GNU Lesser General Public License <http://www.gnu.org/licenses/lgpl.html>
+ * @link    https://github.com/emcconville/polyline-encoder
+ */   
+namespace emcconville\Polyline
+{
+    /**
+     * Inform a delegate that a given class uses polyline encoding
+     */
+    interface PolylineEncoderInterface
+    {
+        /**
+         * Convert array of points into compressed ANSI string
+         *
+         * Points should be given to this method in lists of two.
+         * array(
+         *   array({latitude1},{longitude1}),
+         *   array({latitude2},{longitude2}),
+         *   ...
+         *   array({latitudeN},{longitudeN}),
+         * )
+         *
+         * @param array $points
+         * @return string
+         */
+        public function encodePoints($points);
+
+        /**
+         * Convert ANSI string into array of points
+         *
+         * @param string $string
+         * @return array or FALSE on error
+         */
+        public function decodeString($string);
+    }
+}

test/GoogleTraitBadInputTest.php

@@ -1,6 +1,6 @@
 <?php
 
-class GooglePolylineBadInput
+class GooglePolylineBadInput implements emcconville\Polyline\PolylineEncoderInterface
 {
     use emcconville\Polyline\GoogleTrait;
 }
@@ -30,4 +30,4 @@ public function testBadInputDecode()
     {
         $fail = $this->object->decodeString(0xFF6633);
     }
-}
+}

test/GoogleTraitHackingTest.php

@@ -1,6 +1,6 @@
 <?php
 
-class GooglePolylineHacking
+class GooglePolylineHacking implements emcconville\Polyline\PolylineEncoderInterface
 {
     use emcconville\Polyline\GoogleTrait;
     private function polylinePrecision()

test/bootstrap.php

@@ -1,3 +1,4 @@
 <?php
+require_once 'src/emcconville/Polyline/PolylineEncoderInterface.php';
 require_once 'src/emcconville/Polyline/BingTrait.php';
 require_once 'src/emcconville/Polyline/GoogleTrait.php';