added hash without zip

Author: Zack Teska

src/Address.php

@@ -20,6 +20,7 @@ class Address
     protected $suffix2;
     protected $street2;
 
+    protected $hash;
     protected $fullHash;
     protected $streetHash;
 
@@ -138,7 +139,7 @@ public function getStreetHash(string $algo = 'sha1'): string
     }
 
     /**
-     * Gets the full hash (of all address components)
+     * Gets the full hash (of all address components, including zip code)
      *
      * @param string $algo
      *
@@ -153,16 +154,43 @@ public function getFullHash(string $algo = 'sha1'): string
         return $this->fullHash;
     }
 
+    /**
+     * Gets the address hash (of all components MINUS the zip code)
+     *
+     * NOTE: zip codes have the potential to change, and something like 4% of
+     * ZIP codes change every month, so this hash is likely the better comparison
+     *
+     * @param string $algo
+     *
+     * @return string
+     */
+    public function getHash(string $algo = 'sha1'): string
+    {
+        if ($this->hash) {
+            return $this->hash;
+        }
+        $line1 = $this->getLineOne();
+        $line2 = $this->getLineTwo(false);
+        $this->hash = hash($algo, strtolower(
+            ($line1 && $line2) ? $line1 . ', ' . $line2 : $line1
+        ));
+        return $this->hash;
+    }
+
     /**
      * Is this address is the same as another address?
      *
      * @param Address $address
+     * @param bool $fullHash uses the full hash comparison (with zip) vs without zip
      *
      * @return bool
      */
-    public function is(Address $address): bool
+    public function is(Address $address, bool $fullHash = false): bool
     {
-        return $this->getFullHash() === $address->getFullHash();
+        if ($fullHash) {
+            return $this->getFullHash() === $address->getFullHash();
+        }
+        return $this->getHash() === $address->getHash();
     }
 
     /**
@@ -201,14 +229,18 @@ private function getLineOne(): string
     /**
      * Gets the second line of a formatted address
      *
+     * @param bool $withZip include/exclude zip code
+     *
      * @return string
      */
-    private function getLineTwo(): string
+    private function getLineTwo(bool $withZip = true): string
     {
         $line = (string) $this->city;
         $line .= $this->state ? ", " . $this->state : "";
-        $line .= $this->postalCode ? " " . $this->postalCode : "";
-        $line .= $this->postalCodeExt ? "-" . $this->postalCodeExt : "";
+        if ($withZip) {
+            $line .= $this->postalCode ? " " . $this->postalCode : "";
+            $line .= $this->postalCodeExt ? "-" . $this->postalCodeExt : "";
+        }
         return $line;
     }
 

tests/AddressTest.php

@@ -13,16 +13,24 @@ public function testHashesAddress()
     {
         $normalizer = new Normalizer();
         $address = $normalizer->parse("1234 Main St. NE, Minneapolis, MN 55401");
+        $sameAddressDiffZip = $normalizer->parse("1234 Main St. NE, Minneapolis, MN 55402");
         $sameAddress = $normalizer->parse("1234 Main Street Northeast, Minneapolis, Minnesota 55401");
         $differentNumberAddress = $normalizer->parse("5678 Main Street Northeast, Minneapolis, Minnesota 55401");
 
+        $this->assertEquals('9bdbf17a475a0129c0546fc210ef46cb914338d0', $address->getHash());
         $this->assertEquals('c4ced80b9489911b4a66712470833242597aa032', $address->getFullHash());
         $this->assertEquals('f7f77f11493cccb50c5827dff7cb8b26d31f8442', $address->getStreetHash());
 
+        $this->assertEquals($address->getHash(), $sameAddressDiffZip->getHash());
+        $this->assertNotEquals($address->getFullHash(), $sameAddressDiffZip->getFullHash());
+
+        $this->assertEquals($address->getHash(), $sameAddress->getHash());
         $this->assertEquals($address->getFullHash(), $sameAddress->getFullHash());
         $this->assertEquals($address->getStreetHash(), $sameAddress->getStreetHash());
         $this->assertTrue($address->is($sameAddress));
         $this->assertTrue($sameAddress->is($address));
+        $this->assertTrue($address->is($sameAddress, true));
+        $this->assertTrue($sameAddress->is($address, true));
 
         $this->assertEquals($address->getStreetHash(), $differentNumberAddress->getStreetHash());
         $this->assertNotEquals($address->getFullHash(), $differentNumberAddress->getFullHash());