calcpace 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb37c0c8cf8bb5944459915e43549229d6db504b77538729cea721fa041f7266
-  data.tar.gz: d6900ff2d3cd7e2a821d4637d96beafa69cd8e656a31f2251b68d9e7a818cefb
+  metadata.gz: f8e3c9a491b95568c00e5fabb1a9ba33be46c07035f72a24e51155b60bd6ecaa
+  data.tar.gz: 7c644cc582c27f1204a98bf86238c45b5a236520350c97786d04d119698a2840
 SHA512:
-  metadata.gz: 683f9af0342d287411cc79fd6b2acbf3ebae0d2bf408a282f2309b36a6f62e7478d51983d9ab86bb9c5b524ffe55ab0b445ac9c6b212bd628466adba84e0e249
-  data.tar.gz: 95286680a44cceede252bb0b9429ba321be66a895246986339dd261af30c0547f8f95726d36bfc85fc2da1e8333fad9141d3836f2659b0237ef39a56ea8f1f6a
+  metadata.gz: a503fad2dcb76fc61459315f9f6d866dc47cad64fff8459c5ea94ba3b82f22664e2b04a2e7a105de4130e169661de7c01b7b6dc54950bdf2b5179279d30e75d4
+  data.tar.gz: 28e0d2c909e0a7c811d0f992a397b63de2be086ed76a64e29839884a5597d6f1ce161dca9b3092a308947fb49c0bf7d7aca4fdfb351c51fe56253a5096e92efa

data/.github/workflows/tests.yml

@@ -8,12 +8,24 @@ on:
     branches: [ "main" ]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: .ruby-version
+        bundler-cache: true
+    - name: Run RuboCop
+      run: bundle exec rubocop
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
+        ruby: ['3.2', '3.3', '3.4', '4.0']
     steps:
     - name: Checkout code
       uses: actions/checkout@v4

data/.gitignore

@@ -1,3 +1,5 @@
+coverage/
+
 calcpace-*.gem
 !calcpace.gemspec
 improvements_plan.md

data/.rubocop.yml

@@ -4,7 +4,7 @@
 # Following Ruby best practices and style guidelines
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - 'vendor/**/*'
@@ -55,6 +55,14 @@ Metrics/BlockLength:
     - 'test/**/*'
     - '*.gemspec'
 
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/calcpace/race_splits.rb'
+
 # Allow both single and double quotes for strings
 Style/StringLiteralsInInterpolation:
   Enabled: false

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.1] - 2026-03-06
+
+### Added
+- SimpleCov integration for code coverage measurement
+- RuboCop lint job to CI pipeline
+- YARD documentation for all previously undocumented public methods in `Calculator` (`checked_velocity`, `clock_velocity`, `checked_pace`, `clock_pace`, `time`, `checked_time`, `clock_time`, `distance`, `checked_distance`)
+
+### Changed
+- Minimum required Ruby version bumped from 2.7 to 3.2
+- CI matrix updated: removed EOL Ruby versions (2.7, 3.0, 3.1), added Ruby 4.0
+- CI lint job uses `.ruby-version` file instead of a hardcoded version
+- Bundler updated to 4.0.6
+- `Rakefile.rb` renamed to `Rakefile` (standard convention)
+- `PaceConverter` constants `MI_TO_KM` and `KM_TO_MI` consolidated into `Converter::Distance`
+- Negative and positive split calculations refactored to share common logic
+- Test files refactored to inherit from shared `CalcpaceTest` base class
+
 ## [1.8.0] - 2026-02-14
 
 ### Added

data/Gemfile

@@ -7,3 +7,4 @@ gem 'rake', '~> 13.2'
 gem 'rake-compiler', '~> 1.0'
 gem 'rdoc', '~> 6.2'
 gem 'rubocop', '~> 1.69'
+gem 'simplecov', '~> 0.22', require: false

data/Gemfile.lock

@@ -1,45 +1,68 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    date (3.4.1)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
+    addressable (2.8.9)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    bigdecimal (4.0.1)
+    date (3.5.1)
+    docile (1.4.1)
+    erb (6.0.2)
+    json (2.19.0)
+    json-schema (6.2.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    minitest (5.25.4)
-    parallel (1.26.3)
-    parser (3.3.7.1)
+    mcp (0.8.0)
+      json-schema (>= 4.1)
+    minitest (5.27.0)
+    parallel (1.27.0)
+    parser (3.3.10.2)
       ast (~> 2.4.1)
       racc
-    psych (5.2.3)
+    prism (1.9.0)
+    psych (5.3.1)
       date
       stringio
+    public_suffix (7.0.5)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    rake-compiler (1.2.9)
+    rake (13.3.1)
+    rake-compiler (1.3.1)
       rake
-    rdoc (6.12.0)
+    rdoc (6.17.0)
+      erb
       psych (>= 4.0.0)
-    regexp_parser (2.10.0)
-    rubocop (1.73.2)
+      tsort
+    regexp_parser (2.11.3)
+    rubocop (1.85.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
+      mcp (~> 0.6)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.1)
-      parser (>= 3.3.1.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
     ruby-progressbar (1.13.0)
-    stringio (3.1.5)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.2.0)
+    tsort (0.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   ruby
@@ -50,6 +73,7 @@ DEPENDENCIES
   rake-compiler (~> 1.0)
   rdoc (~> 6.2)
   rubocop (~> 1.69)
+  simplecov (~> 0.22)
 
 BUNDLED WITH
-   2.4.22
+  4.0.6

data/README.md

@@ -1,4 +1,4 @@
-# Calcpace [![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&r=r&ts=1683906897&type=6e&v=1.8.0&x2=0)](https://badge.fury.io/rb/calcpace)
+# Calcpace [![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&r=r&ts=1683906897&type=6e&v=1.8.1&x2=0)](https://badge.fury.io/rb/calcpace)
 
 Calcpace is a Ruby gem designed for calculations and conversions related to distance and time. It can calculate velocity, pace, total time, and distance, accepting time in various formats, including HH:MM:SS. The gem supports conversion to 42 different units, including kilometers, miles, meters, and feet. It also provides methods to validate input.
 
@@ -7,7 +7,7 @@ Calcpace is a Ruby gem designed for calculations and conversions related to dist
 ### Add to your Gemfile
 
 ```ruby
-gem 'calcpace', '~> 1.8.0'
+gem 'calcpace', '~> 1.8.1'
 ```
 
 Then run:

data/calcpace.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |spec|
   spec.email         = ['joaogilberto@tuta.io']
 
   spec.summary       = 'A Ruby gem for pace, distance, and time calculations.'
-  spec.description   = 'Calcpace provides methods to calculate and convert values related to pace, distance, time, and speed. It supports various time formats and unit conversions.'
+  spec.description   = 'Ruby gem for pace, distance, time, and speed calculations. Supports multiple units and formats.'
   spec.homepage      = 'https://github.com/0jonjo/calcpace'
   spec.metadata['source_code_uri'] = spec.homepage
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
   spec.metadata['rubygems_mfa_required'] = 'true'

data/lib/calcpace/calculator.rb

@@ -21,11 +21,31 @@ module Calculator
     distance.to_f / time
   end
 
+  # Calculates velocity from a time string
+  #
+  # @param time [String] time in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit (e.g., meters, kilometers)
+  # @return [Float] velocity (distance/time)
+  # @raise [Calcpace::InvalidTimeFormatError] if time string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   checked_velocity('01:00:00', 10_000) #=> 2.778 (10000 meters / 3600 seconds)
   def checked_velocity(time, distance)
     seconds = convert_to_seconds(validate_time(time))
     velocity(seconds, distance)
   end
 
+  # Calculates velocity from a time string and returns result as a clock time string
+  #
+  # @param time [String] time in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit
+  # @return [String] velocity in HH:MM:SS format
+  # @raise [Calcpace::InvalidTimeFormatError] if time string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   clock_velocity('01:00:00', 10_000) #=> '00:00:00'
   def clock_velocity(time, distance)
     convert_to_clocktime(checked_velocity(time, distance))
   end
@@ -44,34 +64,101 @@ module Calculator
     time.to_f / distance
   end
 
+  # Calculates pace from a time string
+  #
+  # @param time [String] time in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit (e.g., kilometers, miles)
+  # @return [Float] pace (time/distance) in seconds
+  # @raise [Calcpace::InvalidTimeFormatError] if time string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   checked_pace('00:50:00', 10) #=> 300.0 (300 seconds/km = 5:00/km)
   def checked_pace(time, distance)
     seconds = convert_to_seconds(validate_time(time))
     pace(seconds, distance)
   end
 
+  # Calculates pace from a time string and returns result as a clock time string
+  #
+  # @param time [String] time in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit
+  # @return [String] pace in HH:MM:SS format
+  # @raise [Calcpace::InvalidTimeFormatError] if time string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   clock_pace('00:50:00', 10) #=> '00:05:00'
   def clock_pace(time, distance)
     convert_to_clocktime(checked_pace(time, distance))
   end
 
+  # Calculates time given velocity and distance
+  #
+  # @param velocity [Numeric] velocity in any unit
+  # @param distance [Numeric] distance in any unit
+  # @return [Float] time (velocity * distance)
+  # @raise [Calcpace::NonPositiveInputError] if velocity or distance is not positive
+  #
+  # @example
+  #   time(300, 10) #=> 3000.0 (300 s/km * 10 km = 3000 seconds)
   def time(velocity, distance)
     validate_positive({ velocity: velocity, distance: distance })
     velocity * distance
   end
 
+  # Calculates time from a velocity string and distance
+  #
+  # @param velocity [String] velocity in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit
+  # @return [Float] time in seconds
+  # @raise [Calcpace::InvalidTimeFormatError] if velocity string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   checked_time('05:00', 10) #=> 3000.0 (5:00/km * 10 km = 3000 seconds)
   def checked_time(velocity, distance)
     velocity_seconds = convert_to_seconds(validate_time(velocity))
     time(velocity_seconds, distance)
   end
 
+  # Calculates time from a velocity string and returns result as a clock time string
+  #
+  # @param velocity [String] velocity in HH:MM:SS or MM:SS format
+  # @param distance [Numeric] distance in any unit
+  # @return [String] time in HH:MM:SS format
+  # @raise [Calcpace::InvalidTimeFormatError] if velocity string is invalid
+  # @raise [Calcpace::NonPositiveInputError] if distance is not positive
+  #
+  # @example
+  #   clock_time('05:00', 10) #=> '00:50:00'
   def clock_time(velocity, distance)
     convert_to_clocktime(checked_time(velocity, distance))
   end
 
+  # Calculates distance given time and velocity
+  #
+  # @param time [Numeric] time in any unit
+  # @param velocity [Numeric] velocity in any unit
+  # @return [Float] distance (time/velocity)
+  # @raise [Calcpace::NonPositiveInputError] if time or velocity is not positive
+  #
+  # @example
+  #   distance(3000, 300) #=> 10.0 (3000 seconds / 300 s/km = 10 km)
   def distance(time, velocity)
     validate_positive({ time: time, velocity: velocity })
     time.to_f / velocity
   end
 
+  # Calculates distance from time and velocity strings
+  #
+  # @param time [String] time in HH:MM:SS or MM:SS format
+  # @param velocity [String] velocity in HH:MM:SS or MM:SS format
+  # @return [Float] distance
+  # @raise [Calcpace::InvalidTimeFormatError] if any string is invalid
+  #
+  # @example
+  #   checked_distance('00:50:00', '05:00') #=> 10.0 (50 min / 5:00/km = 10 km)
   def checked_distance(time, velocity)
     time_seconds = convert_to_seconds(validate_time(time))
     velocity_seconds = convert_to_seconds(validate_time(velocity))

data/lib/calcpace/converter_chain.rb

@@ -39,7 +39,7 @@ module ConverterChain
   def convert_chain_with_description(value, conversions)
     initial_value = value
     result = convert_chain(value, conversions)
-    conversion_names = conversions.map(&:to_s).join(' → ')
+    conversion_names = conversions.join(' → ')
     description = "#{initial_value} → #{conversion_names} → #{result.round(4)}"
 
     { result: result, description: description }

data/lib/calcpace/pace_converter.rb

@@ -5,10 +5,6 @@
 # This module provides methods to convert running pace between kilometers
 # and miles, maintaining the time per distance unit format.
 module PaceConverter
-  # Conversion factor: 1 mile = 1.60934 kilometers
-  MI_TO_KM = 1.60934
-  KM_TO_MI = 0.621371
-
   # Converts pace from one unit to another
   #
   # @param pace [Numeric, String] pace in seconds per unit or time string (MM:SS)
@@ -87,10 +83,10 @@ module PaceConverter
     case conversion_type
     when :km_to_mi
       # If running at X seconds per km, pace per mile = X * (miles to km ratio)
-      pace_seconds * MI_TO_KM
+      pace_seconds * Converter::Distance::MI_TO_KM
     when :mi_to_km
       # If running at X seconds per mile, pace per km = X / (miles to km ratio)
-      pace_seconds * KM_TO_MI
+      pace_seconds * Converter::Distance::KM_TO_MI
     end
   end
 end

data/lib/calcpace/race_splits.rb

@@ -136,35 +136,7 @@ module RaceSplits
   # @param split_km [Float] split distance in kilometers
   # @return [Array<String>] array of cumulative split times
   def calculate_negative_splits(total_distance, target_seconds, split_km)
-    half_distance = total_distance / 2.0
-    avg_pace = target_seconds / total_distance
-
-    # First half: 4% slower, second half: 4% faster
-    first_half_pace = avg_pace * 1.04
-    second_half_pace = avg_pace * 0.96
-
-    splits = []
-    distance_covered = 0.0
-    cumulative_time = 0.0
-
-    while distance_covered < total_distance - 0.001
-      distance_covered += split_km
-      distance_covered = total_distance if distance_covered > total_distance
-
-      if distance_covered <= half_distance
-        # First half
-        cumulative_time = distance_covered * first_half_pace
-      else
-        # Second half
-        time_at_halfway = half_distance * first_half_pace
-        distance_in_second_half = distance_covered - half_distance
-        cumulative_time = time_at_halfway + (distance_in_second_half * second_half_pace)
-      end
-
-      splits << convert_to_clocktime(cumulative_time.round)
-    end
-
-    splits
+    calculate_variable_splits(total_distance, target_seconds, split_km, first_factor: 1.04, second_factor: 0.96)
   end
 
   # Calculates positive splits (first half faster than second half)
@@ -175,12 +147,22 @@ module RaceSplits
   # @param split_km [Float] split distance in kilometers
   # @return [Array<String>] array of cumulative split times
   def calculate_positive_splits(total_distance, target_seconds, split_km)
+    calculate_variable_splits(total_distance, target_seconds, split_km, first_factor: 0.96, second_factor: 1.04)
+  end
+
+  # Shared logic for variable pace split strategies
+  #
+  # @param total_distance [Float] total race distance in kilometers
+  # @param target_seconds [Float] target finish time in seconds
+  # @param split_km [Float] split distance in kilometers
+  # @param first_factor [Float] pace multiplier for the first half
+  # @param second_factor [Float] pace multiplier for the second half
+  # @return [Array<String>] array of cumulative split times
+  def calculate_variable_splits(total_distance, target_seconds, split_km, first_factor:, second_factor:)
     half_distance = total_distance / 2.0
     avg_pace = target_seconds / total_distance
-
-    # First half: 4% faster, second half: 4% slower
-    first_half_pace = avg_pace * 0.96
-    second_half_pace = avg_pace * 1.04
+    first_half_pace = avg_pace * first_factor
+    second_half_pace = avg_pace * second_factor
 
     splits = []
     distance_covered = 0.0
@@ -191,10 +173,8 @@ module RaceSplits
       distance_covered = total_distance if distance_covered > total_distance
 
       if distance_covered <= half_distance
-        # First half
         cumulative_time = distance_covered * first_half_pace
       else
-        # Second half
         time_at_halfway = half_distance * first_half_pace
         distance_in_second_half = distance_covered - half_distance
         cumulative_time = time_at_halfway + (distance_in_second_half * second_half_pace)

data/lib/calcpace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Calcpace
-  VERSION = '1.8.0'
+  VERSION = '1.8.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - João Gilberto Saraiva
@@ -9,8 +9,8 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Calcpace provides methods to calculate and convert values related to
-  pace, distance, time, and speed. It supports various time formats and unit conversions.
+description: Ruby gem for pace, distance, time, and speed calculations. Supports multiple
+  units and formats.
 email:
 - joaogilberto@tuta.io
 executables: []
@@ -26,7 +26,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
-- Rakefile.rb
+- Rakefile
 - calcpace.gemspec
 - lib/calcpace.rb
 - lib/calcpace/calculator.rb
@@ -53,14 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby gem for pace, distance, and time calculations.
 test_files: []