Back to Repositories

Testing Geocoding Operations and Coordinate Handling in alexreisner/geocoder

This test suite validates core functionality of the Geocoder gem, covering both forward and reverse geocoding operations, coordinate calculations, and caching mechanisms.

Test Coverage Overview

The test suite provides comprehensive coverage of Geocoder’s essential features including:

Distance calculation and coordinate handling
Forward and reverse geocoding operations
Address string processing and validation
Geographic center calculations
Custom lookup handling and result processing

Implementation Analysis

The testing approach employs Ruby’s built-in Test::Unit framework with custom test cases. It utilizes mock objects and parameterized test methods to verify both basic functionality and edge cases. The implementation demonstrates proper isolation of geocoding operations and result handling.

Technical Details

Key technical components include:

Test::Unit as the testing framework
Custom test case inheritance for shared functionality
Mock geocoding objects and parameters
Nominatim lookup service integration
Cache configuration validation

Best Practices Demonstrated

The test suite exhibits several testing best practices:

Isolation of individual geocoding operations
Verification of return value types and classes
Testing of both success and failure scenarios
Validation of configuration defaults
Protection against argument mutation

alexreisner/geocoder

test/unit/geocoder_test.rb

            
# encoding: utf-8
require 'test_helper'

class GeocoderTest < GeocoderTestCase

  def test_distance_to_returns_float
    v = Place.new(*geocoded_object_params(:msg))
    v.latitude, v.longitude = [40.750354, -73.993371]
    assert (v.distance_to([30, -94])).is_a?(Float)
  end

  def test_coordinates_method_returns_array
    assert Geocoder.coordinates("Madison Square Garden, New York, NY").is_a?(Array)
  end

  def test_address_method_returns_string
    assert Geocoder.address([40.750354, -73.993371]).is_a?(String)
  end

  def test_geographic_center_doesnt_overwrite_argument_value
    # test for the presence of a bug that was introduced in version 0.9.11
    orig_points = [[52,8], [46,9], [42,5]]
    points = orig_points.clone
    Geocoder::Calculations.geographic_center(points)
    assert_equal orig_points, points
  end

  def test_geocode_assigns_and_returns_coordinates
    v = Place.new(*geocoded_object_params(:msg))
    assert_equal [Float, Float], v.geocode.map(&:class)
    assert_kind_of Numeric, v.latitude
    assert_kind_of Numeric, v.longitude
  end

  def test_geocode_block_executed_when_no_results
    v = PlaceWithCustomResultsHandling.new("Nowhere", "no results")
    v.geocode
    assert_equal "NOT FOUND", v.coords_string
  end

  def test_reverse_geocode_assigns_and_returns_address
    v = PlaceReverseGeocoded.new(*reverse_geocoded_object_params(:msg))
    assert_match(/New York/, v.reverse_geocode)
    assert_match(/New York/, v.address)
  end

  def test_forward_and_reverse_geocoding_on_same_model_works
    g = PlaceWithForwardAndReverseGeocoding.new("Exxon")
    g.address = "404 New St, Middletown, CT"
    g.geocode
    assert_not_nil g.lat
    assert_not_nil g.lon

    assert_nil g.location
    g.reverse_geocode
    assert_not_nil g.location
  end

  def test_geocode_with_custom_lookup_param
    v = PlaceWithCustomLookup.new(*geocoded_object_params(:msg))
    v.geocode
    assert_equal "Geocoder::Result::Nominatim", v.result_class.to_s
  end

  def test_geocode_with_custom_lookup_proc_param
    v = PlaceWithCustomLookupProc.new(*geocoded_object_params(:msg))
    v.geocode
    assert_equal "Geocoder::Result::Nominatim", v.result_class.to_s
  end

  def test_reverse_geocode_with_custom_lookup_param
    v = PlaceReverseGeocodedWithCustomLookup.new(*reverse_geocoded_object_params(:msg))
    v.reverse_geocode
    assert_equal "Geocoder::Result::Nominatim", v.result_class.to_s
  end

  def test_default_geocoder_caching_config
    assert_nil Geocoder.config[:cache]
    assert_nil Geocoder.config[:cache_options][:expiration]
    assert_equal 'geocoder:', Geocoder.config[:cache_options][:prefix]
  end
end