« Changelog History


GeoCoder v3.0.0-alpha1 Release Notes

Release Date: 2014-12-18 // over 9 years ago

  • Hi!

    I am proud to announce that we are ready to ship the next major version of Geocoder: 3.0.0. This is a pre-release which will help us ensure everything works smoothly. We are currently working hard on making Geocoder related projects compatible with this new version, hence the need for a pre-release version.

    Basically, we changed almost everything in this library but its simplicity and its robustness have been kept. Since 2012, Geocoder provides a powerful API to perform geocoding actions in PHP. However, things in PHP evolved a lot, and we decided to refactor the lib to be more flexible , and even more powerful.

    🔧 For instance, providers are now highly configurable and Geocoder leverages a third-party library implementing PSR-7.

    ⚡️ Update: the main idea behind this was to introduce a dependency to PSR-7 interfaces, and to avoid the NIH syndrom. The http-adapter library is a great one, and Geocoder is not about dealing with HTTP, it is about geocoding stuff.

    Geocoder 3.0.0 contains less code than previously, 49 classes, 5 interfaces and less than 5300 lines of code for the code (tests are not included here). As a matter of fact, Geocoder 2.x has 56 classes and 6500 lines of code. Removing code was a challenge as we did not want to remove features from this library. We rather re-organized Geocoder to fit its initial goal: providing a simple yet powerful way to geocode street and IP addresses, with the ability to switch from one provider to another with ease. Geocoder Extra contains alternative providers that are not worldwide and therefore less used. Again, we did not remove anything.

    🆕 New features have been added, such as the TimedGeocoder implementation and a better model layer. You will find all details in the CHANGELOG below.

    📚 The documentation, which has been rewritten, also contains a description of Geocoder's versioning strategy, and we are proud to have a Contributor Code of Conduct, because the lack of diversity in Open Source is not acceptable.

    Help us making Geocoder 3.0.0 really stable by giving this very first pre-release a try!

    Last but not the least, THANK YOU to all contributors!!! 💛 💙 ❤️ 💚 🚢 ⭐️ 🌟💙 🌠 💝

    Let's celebrate now!

    Full Changelog

    • ➕ Added: using() method now throws an exception if provider not found
    • ➕ Added: new Result classes (Address, Bounds, Region, Country, County, Coordinates)
    • ➕ Added: new named exceptions
    • ➕ Added: better exception messages
    • ➕ Added: new HTTP layer thanks to egeloen/http-adapter library
    • ➕ Added: TimedGeocoder implementation (works with StopWatch Symfony component)
    • ➕ Added: AbstractHttpProvider (extending AbstractProvider)
    • ➕ Added: provide a way to use IpInfoDB country precision
    • ➕ Added: cached responses for BingMaps provider (tests)
    • ➕ Added: cached reponse for GoogleMaps provider (tests)
    • ➕ Added: ProviderAggregator (replacing the former Geocoder class)
    • ➕ Added: ability to change providers locale at runtime
    • 📚 Documentation: almost entirely rewritten
    • 📚 Documentation: a note on versioning has been added
    • 📚 Documentation: a Contributor Code of Conduct has been added for the entire
      Geocoder project
    • 🛠 Fixed: phpdoc, wording
    • 🛠 Fixed: providers are now highly configurable, even at runtime
    • 🛠 Fixed: FreeGeoIp property because of an API change
    • 🚚 Moved: IGN OpenLS provider to geocoder-extra (#339)
    • 🚚 Moved: OIORest provider to geocoder-extra (#336)
    • 🚚 Moved: GeoCoder.us provider to geocoder-extra (#338)
    • 🚚 Moved: GeoCoder.ca provider to geocoder-extra (#337)
    • 🚚 Moved: DataScienceToolkit provider to geocoder-extra (#340)
    • 🚚 Moved: Baidu provider to geocoder-extra (#341)
    • 🚚 Moved: IpGeoBase provider to geocoder-extra (#342)
    • 📇 Renamed: properties such as:
      • city => locality
      • cityDistrict => subLocality
      • zipcode => postalCode
    • 🔨 Refactored: dumpers (remove Interface suffix, define a new method signature)
    • 🔨 Refactored: class names!
    • 🔨 Refactored: all providers now implement the Geocoder interface
    • 🔨 Refactored: exception messages are a bit more verbose
    • ✂ Removed: Provider, Dumper, Interface, and Exception suffixes
    • ✂ Removed: autoload.php file
    • ✂ Removed: OpenStreetMapsProvider class (#335)
    • ✂ Removed: HTTP adapters layer
    • ✂ Removed: the Geocoder class does not exist anymore and has been replaced by
      the ProviderAggregator class