test_latlng.rb

require File.join(File.dirname(__FILE__), 'helper')

class LatLngTest < Test::Unit::TestCase #:nodoc: all
  def setup
    @loc_a = Geokit::LatLng.new(32.918593, -96.958444)
    @loc_e = Geokit::LatLng.new(32.969527, -96.990159)
    @point = Geokit::LatLng.new(@loc_a.lat, @loc_a.lng)
  end

  def valid_reverse_geocoding_result
    location = Geokit::GeoLoc.new(
      city: 'Essen',
      country_code: 'DE',
      lat: 51.4578329,
      lng: 7.0166848,
      provider: 'google',
      state: 'Nordrhein-Westfalen',
      street_address: 'Porscheplatz 1',
      zip: '45127',
    )

    location.full_address = 'Porscheplatz 1, 45127 Essen, Deutschland'
    location.precision = 'address'
    location.provider = 'google'
    location.success = true
    location
  end

  def test_existance_of_latitude_alias
    assert_respond_to(@loc_a, :latitude)
  end

  def test_existance_of_longitude_alias
    assert_respond_to(@loc_a, :longitude)
  end

  def test_that_lat_and_latitude_are_same_object
    assert_same(@loc_a.lat, @loc_a.latitude)
  end

  def test_that_lng_and_longitude_are_same_object
    assert_same(@loc_a.lng, @loc_a.longitude)
  end

  def test_distance_between_same_using_defaults
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a)
    assert_equal 0, @loc_a.distance_to(@loc_a)
  end

  def test_distance_between_same_with_miles_and_flat
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :miles, formula: :flat)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :miles, formula: :flat)
  end

  def test_distance_between_same_with_kms_and_flat
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :kms, formula: :flat)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :kms, formula: :flat)
  end

  def test_distance_between_same_with_nms_and_flat
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :nms, formula: :flat)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :nms, formula: :flat)
  end

  def test_distance_between_same_with_miles_and_sphere
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :miles, formula: :sphere)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :miles, formula: :sphere)
  end

  def test_distance_between_same_with_kms_and_sphere
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :kms, formula: :sphere)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :kms, formula: :sphere)
  end

  def test_distance_between_same_with_nms_and_sphere
    assert_equal 0, Geokit::LatLng.distance_between(@loc_a, @loc_a, units: :nms, formula: :sphere)
    assert_equal 0, @loc_a.distance_to(@loc_a, units: :nms, formula: :sphere)
  end

  def test_distance_between_diff_using_defaults
    assert_in_delta 3.97, Geokit::LatLng.distance_between(@loc_a, @loc_e), 0.01
    assert_in_delta 3.97, @loc_a.distance_to(@loc_e), 0.01
  end

  def test_distance_between_diff_with_miles_and_flat
    assert_in_delta 3.97, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :miles, formula: :flat), 0.2
    assert_in_delta 3.97, @loc_a.distance_to(@loc_e, units: :miles, formula: :flat), 0.2
  end

  def test_distance_between_diff_with_kms_and_flat
    assert_in_delta 6.39, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :kms, formula: :flat), 0.4
    assert_in_delta 6.39, @loc_a.distance_to(@loc_e, units: :kms, formula: :flat), 0.4
  end

  def test_distance_between_diff_with_meters_and_flat
    assert_in_delta 6390, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :meters, formula: :flat), 2
    assert_in_delta 6390, @loc_a.distance_to(@loc_e, units: :meters, formula: :flat), 2
  end

  def test_distance_between_diff_with_nms_and_flat
    assert_in_delta 3.334, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :nms, formula: :flat), 0.4
    assert_in_delta 3.334, @loc_a.distance_to(@loc_e, units: :nms, formula: :flat), 0.4
  end

  def test_distance_between_diff_with_miles_and_sphere
    assert_in_delta 3.97, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :miles, formula: :sphere), 0.01
    assert_in_delta 3.97, @loc_a.distance_to(@loc_e, units: :miles, formula: :sphere), 0.01
  end

  def test_distance_between_diff_with_kms_and_sphere
    assert_in_delta 6.39, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :kms, formula: :sphere), 0.01
    assert_in_delta 6.39, @loc_a.distance_to(@loc_e, units: :kms, formula: :sphere), 0.01
  end

  def test_distance_between_diff_with_nms_and_sphere
    assert_in_delta 3.454, Geokit::LatLng.distance_between(@loc_a, @loc_e, units: :nms, formula: :sphere), 0.01
    assert_in_delta 3.454, @loc_a.distance_to(@loc_e, units: :nms, formula: :sphere), 0.01
  end

  def test_manually_mixed_in
    assert_equal 0, Geokit::LatLng.distance_between(@point, @point)
    assert_equal 0, @point.distance_to(@point)
    assert_equal 0, @point.distance_to(@loc_a)
    assert_in_delta 3.97, @point.distance_to(@loc_e, units: :miles, formula: :flat), 0.2
    assert_in_delta 6.39, @point.distance_to(@loc_e, units: :kms, formula: :flat), 0.4
    assert_in_delta 3.334, @point.distance_to(@loc_e, units: :nms, formula: :flat), 0.4
  end

  def test_heading_between
    assert_in_delta 332, Geokit::LatLng.heading_between(@loc_a, @loc_e), 0.5
  end

  def test_heading_to
    assert_in_delta 332, @loc_a.heading_to(@loc_e), 0.5
  end

  def test_class_endpoint
    endpoint = Geokit::LatLng.endpoint(@loc_a, 332, 3.97)
    assert_in_delta @loc_e.lat, endpoint.lat, 0.0005
    assert_in_delta @loc_e.lng, endpoint.lng, 0.0005
  end

  def test_instance_endpoint
    endpoint = @loc_a.endpoint(332, 3.97)
    assert_in_delta @loc_e.lat, endpoint.lat, 0.0005
    assert_in_delta @loc_e.lng, endpoint.lng, 0.0005
  end

  def test_midpoint
    midpoint = @loc_a.midpoint_to(@loc_e)
    assert_in_delta 32.944061, midpoint.lat, 0.0005
    assert_in_delta(-96.974296, midpoint.lng, 0.0005)
  end

  def test_normalize
    lat = 37.7690
    lng = -122.443
    res = Geokit::LatLng.normalize(lat, lng)
    assert_equal res, Geokit::LatLng.new(lat, lng)
    res = Geokit::LatLng.normalize("#{lat}, #{lng}")
    assert_equal res, Geokit::LatLng.new(lat, lng)
    res = Geokit::LatLng.normalize("#{lat} #{lng}")
    assert_equal res, Geokit::LatLng.new(lat, lng)
    res = Geokit::LatLng.normalize("#{lat.to_i} #{lng.to_i}")
    assert_equal res, Geokit::LatLng.new(lat.to_i, lng.to_i)
    res = Geokit::LatLng.normalize([lat, lng])
    assert_equal res, Geokit::LatLng.new(lat, lng)
  end

  def test_hash
    lat = 37.7690
    lng = -122.443
    first = Geokit::LatLng.new(lat, lng)
    second = Geokit::LatLng.new(lat, lng)
    assert_equal first.hash, second.hash
  end

  def test_eql?
    lat = 37.7690
    lng = -122.443
    first = Geokit::LatLng.new(lat, lng)
    second = Geokit::LatLng.new(lat, lng)
    assert first.eql?(second)
    assert second.eql?(first)
  end

  def test_valid_when_lat_and_lng_defined
    assert Geokit::LatLng.new(37.7690, -122.443).valid?
  end

  def test_not_valid_when_lat_is_nil
    assert !Geokit::LatLng.new(nil, -122.443).valid?
  end

  def test_not_valid_when_lng_is_nil
    assert !Geokit::LatLng.new(37.7690, nil).valid?
  end

  def test_reverse_geocode
    point = Geokit::LatLng.new(51.4578329, 7.0166848)
    Geokit::Geocoders::MultiGeocoder.expects(:reverse_geocode).with(point).returns(valid_reverse_geocoding_result)
    res = point.reverse_geocode

    assert_equal 'Nordrhein-Westfalen', res.state
    assert_equal 'Essen', res.city
    assert_equal '45127', res.zip
    assert_equal '51.4578329,7.0166848', res.ll # slightly dif from yahoo
    assert res.is_us? == false
    assert_equal 'Porscheplatz 1, 45127 Essen, Deutschland', res.full_address # slightly different from yahoo
  end

  def test_reverse_geocoding_using_specific_geocoder
    point = Geokit::LatLng.new(51.4578329, 7.0166848)
    Geokit::Geocoders::GoogleGeocoder.expects(:reverse_geocode).with(point).returns(valid_reverse_geocoding_result)
    res = point.reverse_geocode(using: Geokit::Geocoders::GoogleGeocoder)

    assert_equal 'Nordrhein-Westfalen', res.state
    assert_equal 'Essen', res.city
    assert_equal '45127', res.zip
    assert_equal '51.4578329,7.0166848', res.ll # slightly dif from yahoo
    assert res.is_us? == false
    assert_equal 'Porscheplatz 1, 45127 Essen, Deutschland', res.full_address # slightly different from yahoo
    assert_equal 'google', res.provider
  end

  def test_reverse_geocoding_using_specific_geocoder_short_syntax
    point = Geokit::LatLng.new(51.4578329, 7.0166848)
    Geokit::Geocoders::GoogleGeocoder.expects(:reverse_geocode).with(point).returns(valid_reverse_geocoding_result)
    res = point.reverse_geocode(using: :google)

    assert_equal 'Nordrhein-Westfalen', res.state
    assert_equal 'Essen', res.city
    assert_equal '45127', res.zip
    assert_equal '51.4578329,7.0166848', res.ll # slightly dif from yahoo
    assert res.is_us? == false
    assert_equal 'Porscheplatz 1, 45127 Essen, Deutschland', res.full_address # slightly different from yahoo
    assert_equal 'google', res.provider
  end

  def test_to_dms
    point = Geokit::LatLng.new(41.957254, -87.660333)

    dms = point.lat_dms
    assert_kind_of Array, dms
    assert_equal 3, dms.length
    assert_kind_of Numeric, dms.length
    assert_equal [41, 57], dms[0, 2]
    assert_equal 26, dms[2].round

    dms = point.lng_dms
    assert_kind_of Array, dms
    assert_equal 3, dms.length
    assert_kind_of Numeric, dms.length
    assert_equal [-87, 39], dms[0, 2]
    assert_equal 37, dms[2].round
  end

  def test_invalid_units
    expected_exception_message = 'feet is an unsupported unit of length.'

    exception = assert_raise(ArgumentError) do
      @loc_a.distance_to(@loc_e, units: :feet)
    end
    assert_equal expected_exception_message, exception.message

    exception = assert_raise(ArgumentError) do
      @loc_a.endpoint(332, 3.97, units: :feet)
    end
    assert_equal expected_exception_message, exception.message
  end
end