Refactor _latlng to Strava::Models::LatLng.

dblock · dblock · commit f432e00876dc · 2025-10-20T13:12:38.000-04:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,11 +1,16 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-16 14:15:33 UTC using RuboCop version 1.68.0.
+# on 2025-10-20 02:25:48 UTC using RuboCop version 1.68.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/FloatComparison:
+  Exclude:
+    - 'spec/strava/models/lat_lng_spec.rb'
+
 # Offense count: 1
 RSpec/AnyInstance:
   Exclude:
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -52,6 +52,19 @@ There are several API changes.
 
 See [#96](https://github.com/dblock/strava-ruby-client/pull/96) for details.
 
+#### Latitude and Longitude are now instances of `Strava::Models::LatLng`
+
+Properties, such as `DetailedActivity#start_latlng` are now of the `Strava::Models::LatLng` type. 
+
+```ruby
+activity.start_latlng # Strava::Models::LatLng
+activity.start_latlng.to_a # [36.377702, -94.207242]
+activity.start_latlng.lat # 36.377702
+activity.start_latlng.lng # -94.207242
+```
+
+See [#98](https://github.com/dblock/strava-ruby-client/pull/98) for details.
+
 #### Removed `id` from `Strava::Models::Photo`
 
 The Strava Photos API returns `unique_id` and does not return `id`. The latter has been removed.
diff --git a/lib/strava-ruby-client.rb b/lib/strava-ruby-client.rb
@@ -38,6 +38,7 @@
 require_relative 'strava/models/token'
 require_relative 'strava/models/authorization'
 
+require_relative 'strava/models/lat_lng'
 require_relative 'strava/models/achievement'
 require_relative 'strava/models/activity_stats'
 require_relative 'strava/models/activity_total'
diff --git a/lib/strava/models/club_event.rb b/lib/strava/models/club_event.rb
@@ -23,7 +23,7 @@ class ClubEvent < Strava::Models::Response
       property 'zone'
       property 'address'
       property 'joined'
-      property 'start_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
 
       def strava_url
         "https://www.strava.com/clubs/#{club_id}/group_events/#{id}"
diff --git a/lib/strava/models/detailed_activity.rb b/lib/strava/models/detailed_activity.rb
@@ -20,8 +20,8 @@ class DetailedActivity < Strava::Models::Response
       property 'start_date', transform_with: ->(v) { Time.parse(v) }
       include Mixins::StartDateLocal
       property 'timezone'
-      property 'start_latlng'
-      property 'end_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'achievement_count'
       property 'kudos_count'
       property 'comment_count'
diff --git a/lib/strava/models/detailed_segment.rb b/lib/strava/models/detailed_segment.rb
@@ -12,8 +12,8 @@ class DetailedSegment < Strava::Models::Response
       property 'maximum_grade'
       property 'elevation_high'
       property 'elevation_low'
-      property 'start_latlng'
-      property 'end_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'climb_category'
       property 'city'
       property 'state'
diff --git a/lib/strava/models/explorer_segment.rb b/lib/strava/models/explorer_segment.rb
@@ -9,8 +9,8 @@ class ExplorerSegment < Strava::Models::Response
       property 'climb_category'
       property 'climb_category_desc'
       property 'avg_grade'
-      property 'start_latlng'
-      property 'end_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'elev_difference'
       include Mixins::Distance
       property 'points'
diff --git a/lib/strava/models/lat_lng.rb b/lib/strava/models/lat_lng.rb
@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Strava
+  module Models
+    class LatLng
+      attr_accessor :latlng
+
+      def lat
+        @latlng[0]
+      end
+
+      def lng
+        @latlng[1]
+      end
+
+      def lat=(value)
+        @latlng ||= [nil, nil]
+        @latlng[0] = value
+      end
+
+      def lng=(value)
+        @latlng ||= [nil, nil]
+        @latlng[1] = value
+      end
+
+      def ==(other)
+        case other
+        when LatLng
+          @latlng == other.to_a
+        when Array
+          @latlng == other
+        else
+          false
+        end
+      end
+
+      def to_a
+        @latlng
+      end
+
+      def initialize(latlng = nil)
+        @latlng = latlng
+      end
+    end
+  end
+end
diff --git a/lib/strava/models/summary_activity.rb b/lib/strava/models/summary_activity.rb
@@ -19,8 +19,8 @@ class SummaryActivity < Strava::Models::Response
       property 'start_date', transform_with: ->(v) { Time.parse(v) }
       include Mixins::StartDateLocal
       property 'timezone'
-      property 'start_latlng'
-      property 'end_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'achievement_count'
       property 'kudos_count'
       property 'comment_count'
diff --git a/lib/strava/models/summary_segment.rb b/lib/strava/models/summary_segment.rb
@@ -12,8 +12,8 @@ class SummarySegment < Strava::Models::Response
       property 'maximum_grade'
       property 'elevation_high'
       property 'elevation_low'
-      property 'start_latlng'
-      property 'end_latlng'
+      property 'start_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'end_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'climb_category'
       property 'city'
       property 'state'
diff --git a/lib/strava/models/waypoint.rb b/lib/strava/models/waypoint.rb
@@ -4,8 +4,8 @@ module Strava
   module Models
     # https://developers.strava.com/docs/reference/#api-models-Waypoint
     class Waypoint < Strava::Models::Response
-      property 'latlng'
-      property 'target_latlng'
+      property 'latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
+      property 'target_latlng', transform_with: ->(v) { Strava::Models::LatLng.new(v) }
       property 'categories'
       property 'title'
       property 'description'
diff --git a/spec/fixtures/strava/models/athlete_segment_stats.json b/spec/fixtures/strava/models/athlete_segment_stats.json
@@ -0,0 +1,8 @@
+{
+  "pr_elapsed_time": 116,
+  "pr_date": "2018-06-22",
+  "pr_visibility": "everyone",
+  "pr_activity_id": 1655832792,
+  "pr_activity_visibility": "everyone",
+  "effort_count": 5
+}
diff --git a/spec/strava/api/client/endpoints/activities/activity_ride_spec.rb b/spec/strava/api/client/endpoints/activities/activity_ride_spec.rb
@@ -55,6 +55,8 @@
     expect(activity.start_date_local).to eq Time.parse('2022-05-14 14:21:19 -0400')
 
     expect(activity.utc_offset).to eq(-14_400.0)
+    expect(activity.start_latlng.lat).to eq 49.197681
+    expect(activity.start_latlng.lng).to eq 7.883777
     expect(activity.start_latlng).to eq [49.197681, 7.883777]
     expect(activity.end_latlng).to eq [49.034333, 7.94529]
     expect(activity.location_city).to be_nil
diff --git a/spec/strava/models/lat_lng_spec.rb b/spec/strava/models/lat_lng_spec.rb
@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Strava::Models::LatLng do
+  let(:latlng) { described_class.new([40.7128, -74.0060]) }
+
+  describe '#initialize' do
+    it 'sets the latlng array' do
+      expect(latlng.to_a).to eq([40.7128, -74.0060])
+    end
+
+    it 'can be initialized with nil' do
+      expect(described_class.new.to_a).to be_nil
+    end
+  end
+
+  describe '#lat' do
+    it 'returns the latitude' do
+      expect(latlng.lat).to eq(40.7128)
+    end
+  end
+
+  describe '#lng' do
+    it 'returns the longitude' do
+      expect(latlng.lng).to eq(-74.0060)
+    end
+  end
+
+  describe '#lat=' do
+    it 'sets the latitude' do
+      latlng.lat = 34.0522
+      expect(latlng.lat).to eq(34.0522)
+      expect(latlng.lng).to eq(-74.0060)
+    end
+
+    it 'initializes array if nil' do
+      new_latlng = described_class.new(nil)
+      new_latlng.lat = 40.7128
+      expect(new_latlng.lat).to eq(40.7128)
+      expect(new_latlng.lng).to be_nil
+    end
+  end
+
+  describe '#lng=' do
+    it 'sets the longitude' do
+      latlng.lng = -118.2437
+      expect(latlng.lng).to eq(-118.2437)
+      expect(latlng.lat).to eq(40.7128)
+    end
+
+    it 'initializes array if nil' do
+      new_latlng = described_class.new(nil)
+      new_latlng.lng = -74.0060
+      expect(new_latlng.lng).to eq(-74.0060)
+      expect(new_latlng.lat).to be_nil
+    end
+  end
+
+  describe '#==' do
+    context 'when comparing with another LatLng' do
+      it 'returns true for identical LatLng objects' do
+        expect(latlng == described_class.new([40.7128, -74.0060])).to be true
+      end
+
+      it 'returns false for different LatLng objects' do
+        expect(latlng == described_class.new([34.0522, -118.2437])).to be false
+      end
+    end
+
+    context 'when comparing with an array' do
+      it 'returns true for identical array' do
+        expect(latlng == [40.7128, -74.0060]).to be true
+      end
+
+      it 'returns false for different array' do
+        expect(latlng == [34.0522, -118.2437]).to be false
+      end
+
+      it 'returns false for array with different length' do
+        expect(latlng == [40.7128]).to be false
+      end
+    end
+
+    context 'when comparing with other types' do
+      it 'returns false for string' do
+        expect(latlng == '40.7128,-74.0060').to be false
+      end
+
+      it 'returns false for number' do
+        expect(latlng == 40.7128).to be false
+      end
+
+      it 'returns false for nil' do
+        expect(latlng.nil?).to be false
+      end
+    end
+  end
+
+  describe '#to_a' do
+    it 'returns the latlng array' do
+      expect(latlng.to_a).to eq([40.7128, -74.0060])
+    end
+  end
+end
