calcpace 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2fca26e59f2126bc2c6912786ea9808f8e73af4bc2860de63c5ab85ccf4b01
-  data.tar.gz: 11907a7faff02d37df75a1db8d2540f114f46afe70bdb6a426ed3ed6f6bd1a81
+  metadata.gz: 5f044557de907efbc86496d835e45575a5302a965de92cfcb38f52eb64f0e861
+  data.tar.gz: 6c676c4d91b34b38593a1f696697d70c8da4025cb3fe34492f98bdd554f54c3c
 SHA512:
-  metadata.gz: 451d2883e1b75c140bf5fbd85e9d1ec5b03dc770a471a173a8698ad6243b025736221ea157288c0ad23e5796287db4941f9177dfb3c7130deed50ac0bac6e126
-  data.tar.gz: 7141e05845a0d88fcd52fb50dfef307ab3f8c73bbc8b332108fb3dfd13d4a3294ae3ae93b1eb983b98b2134ec67407aa8ba49659e38b169eddce342381bfd8c0
+  metadata.gz: 8d1878a80782cec3056945bd66aae3b185dd6889fd0de6d330fbf0de990f35f2779196b7032d2dd53364df2fcfef8ee4313132d045a9521fbc72e2134ba9d15d
+  data.tar.gz: c578de2a7229f1b2be9fd01e5b0f825b8a03ae6b54b0ca9bacf78923916a28ebd779a50e77811710f4845456a573d65dc30c943ed372597506b915219701bb8d

data/lib/calcpace/calculator.rb

@@ -2,18 +2,18 @@
 
 require 'bigdecimal'
 
-# Module to calculate time, distance and velocity
+# Module to calculate time, distance, pace and velocity
 module Calculator
   def velocity(time, distance)
-    time / distance
+    check_positive(distance)
+    check_positive(time)
+    distance.to_f / time
   end
 
   def checked_velocity(time, distance)
     check_time(time)
-    check_positive(distance)
-    distance_to_calc = convert_to_bigdecimal(distance)
-    seconds = convert_to_bigdecimal(convert_to_seconds(time))
-    velocity(seconds, distance_to_calc)
+    seconds = convert_to_seconds(time)
+    velocity(seconds, distance)
   end
 
   def clock_velocity(time, distance)
@@ -21,16 +21,33 @@ module Calculator
     convert_to_clocktime(velocity_in_seconds)
   end
 
+  def pace(time, distance)
+    check_positive(distance)
+    check_positive(time)
+    time.to_f / distance
+  end
+
+  def checked_pace(time, distance)
+    check_time(time)
+    seconds = convert_to_seconds(time)
+    pace(seconds, distance)
+  end
+
+  def clock_pace(time, distance)
+    velocity_in_seconds = checked_pace(time, distance)
+    convert_to_clocktime(velocity_in_seconds)
+  end
+
   def time(velocity, distance)
+    check_positive(distance)
+    check_positive(velocity)
     velocity * distance
   end
 
   def checked_time(velocity, distance)
     check_time(velocity)
-    check_positive(distance)
-    distance_to_calc = convert_to_bigdecimal(distance)
-    velocity_seconds = convert_to_bigdecimal(convert_to_seconds(velocity))
-    time(velocity_seconds, distance_to_calc)
+    velocity_seconds = convert_to_seconds(velocity)
+    time(velocity_seconds, distance)
   end
 
   def clock_time(velocity, distance)
@@ -39,14 +56,16 @@ module Calculator
   end
 
   def distance(time, velocity)
-    time / velocity
+    check_positive(time)
+    check_positive(velocity)
+    time.to_f / velocity
   end
 
   def checked_distance(time, velocity)
     check_time(time)
     check_time(velocity)
-    time_seconds = convert_to_bigdecimal(convert_to_seconds(time))
-    velocity_seconds = convert_to_bigdecimal(convert_to_seconds(velocity))
+    time_seconds = convert_to_seconds(time)
+    velocity_seconds = convert_to_seconds(velocity)
     distance(time_seconds, velocity_seconds)
   end
 end

data/lib/calcpace/checker.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Module to check if the input is valid
+# Module to check if the input is valid or of the correct type
 module Checker
   def check_positive(number)
     raise 'It must be a X.X positive number' unless number.positive?

data/lib/calcpace/converter.rb

@@ -35,9 +35,7 @@ module Converter
   def convert(value, unit)
     check_positive(value)
     unit_constant = constant(unit)
-    value_to_convert = convert_to_bigdecimal(value)
-    unit_to_convert = convert_to_bigdecimal(unit_constant)
-    value_to_convert * unit_to_convert
+    value * unit_constant
   end
 
   def convert_to_seconds(time)
@@ -50,15 +48,11 @@ module Converter
     Time.at(seconds.to_i).utc.strftime(format)
   end
 
-  def convert_to_bigdecimal(value)
-    bigdecimal ? BigDecimal(value.to_s) : value
-  end
-
-  def constant(string)
-    Converter.const_get(string.upcase.gsub(' ', '_'))
+  def constant(symbol)
+    Converter.const_get(symbol.to_s.upcase)
   end
 
   def list_constants
-    Converter.constants
+    Converter.constants.map { |c| c.downcase.to_sym }
   end
 end

data/lib/calcpace.rb

@@ -4,7 +4,7 @@ require_relative 'calcpace/calculator'
 require_relative 'calcpace/checker'
 require_relative 'calcpace/converter'
 
-# Main class to calculate velocity, time, distance and velocity
+# Main class to calculate velocity, pace, time, distance and velocity
 class Calcpace
   include Calculator
   include Checker
@@ -12,7 +12,5 @@ class Calcpace
 
   attr_reader :bigdecimal
 
-  def initialize(bigdecimal = false)
-    @bigdecimal = bigdecimal
-  end
+  def initialize; end
 end

data/test/calcpace/test_calculator.rb

@@ -7,12 +7,14 @@ require_relative '../../lib/calcpace'
 class TestCalculator < Minitest::Test
   def setup
     @checker = Calcpace.new
-    @checker_bigdecimal = Calcpace.new(true)
   end
 
   def test_velocity
-    assert_equal 300, @checker.velocity(3600, 12)
-    assert_equal 122.81076923076924, @checker.velocity(71_844.3, 585.0)
+    assert_equal 3.333, @checker.velocity(3600, 12_000).round(3)
+    assert_equal 12.3, @checker.velocity(5841, 71_844.3)
+    assert_equal 3.6, @checker.velocity(10_000, 36_000.0)
+    assert_raises(RuntimeError) { @checker.velocity(0, 10) }
+    assert_raises(RuntimeError) { @checker.velocity(10, -1) }
   end
 
   def test_checked_velocity
@@ -20,13 +22,9 @@ class TestCalculator < Minitest::Test
     assert_raises(RuntimeError) { @checker.checked_velocity('invalid', 10) }
     assert_raises(RuntimeError) { @checker.checked_velocity('00:00:00', 0) }
     assert_raises(RuntimeError) { @checker.checked_velocity('00:00:00', -1) }
-    assert_equal 360, @checker.checked_velocity('01:00:00', 10)
-    assert_equal 474.8780487804878, @checker.checked_velocity('01:37:21', 12.3)
-  end
-
-  def test_checked_velocity_with_bigdecimal_precision
-    assert_equal BigDecimal('0.474878048780487804878048780487804878049e3'),
-                 @checker_bigdecimal.checked_velocity('01:37:21', 12.3)
+    assert_equal 2.778, @checker.checked_velocity('01:00:00', 10_000).round(3)
+    assert_equal 10, @checker.checked_velocity('00:00:01', 10)
+    assert_equal 12.3, @checker.checked_velocity('01:37:21', 71_844.3)
   end
 
   def test_clock_velocity
@@ -34,13 +32,40 @@ class TestCalculator < Minitest::Test
     assert_raises(RuntimeError) { @checker.clock_velocity('invalid', 10) }
     assert_raises(RuntimeError) { @checker.clock_velocity('00:00:00', 0) }
     assert_raises(RuntimeError) { @checker.clock_velocity('00:00:00', -1) }
-    assert_equal '00:06:00', @checker.clock_velocity('01:00:00', 10)
-    assert_equal '00:07:54', @checker.clock_velocity('01:37:21', 12.3)
+    assert_equal '00:00:02', @checker.clock_velocity('01:00:00', 10_000)
+    assert_equal '00:00:12', @checker.clock_velocity('01:37:21', 71_844.3)
+  end
+
+  def test_pace
+    assert_equal 300, @checker.pace(3600, 12)
+    assert_equal 122.81076923076924, @checker.pace(71_844.3, 585.0)
+    assert_raises(RuntimeError) { @checker.pace(0, 10) }
+    assert_raises(RuntimeError) { @checker.pace(10, -1) }
+  end
+
+  def test_checked_pace
+    assert_raises(RuntimeError) { @checker.checked_pace('', 10) }
+    assert_raises(RuntimeError) { @checker.checked_pace('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.checked_pace('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.checked_pace('00:00:00', -1) }
+    assert_equal 360, @checker.checked_pace('01:00:00', 10)
+    assert_equal 474.8780487804878, @checker.checked_pace('01:37:21', 12.3)
+  end
+
+  def test_clock_pace
+    assert_raises(RuntimeError) { @checker.clock_pace('', 10) }
+    assert_raises(RuntimeError) { @checker.clock_pace('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.clock_pace('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.clock_pace('00:00:00', -1) }
+    assert_equal '00:06:00', @checker.clock_pace('01:00:00', 10)
+    assert_equal '00:07:54', @checker.clock_pace('01:37:21', 12.3)
   end
 
   def test_time
     assert_equal 43_200, @checker.time(3600, 12)
     assert_equal 5841.0, @checker.time(12.3, 474.8780487804878)
+    assert_raises(RuntimeError) { @checker.time(0, 10) }
+    assert_raises(RuntimeError) { @checker.time(10, -1) }
   end
 
   def test_checked_time
@@ -52,10 +77,6 @@ class TestCalculator < Minitest::Test
     assert_equal 71_844.3, @checker.checked_time('01:37:21', 12.3)
   end
 
-  def test_checked_time_with_bigdecimal_precision
-    assert_equal BigDecimal('0.718443e5'), @checker_bigdecimal.checked_time('01:37:21', 12.3)
-  end
-
   def test_clock_time
     assert_raises(RuntimeError) { @checker.clock_time('', 10) }
     assert_raises(RuntimeError) { @checker.clock_time('invalid', 10) }
@@ -67,17 +88,31 @@ class TestCalculator < Minitest::Test
   def test_distance
     assert_equal 30, @checker.distance(3600, 120)
     assert_equal 12.3, @checker.distance(5841.0, 474.8780487804878)
+    assert_raises(RuntimeError) { @checker.distance(0, 10) }
+    assert_raises(RuntimeError) { @checker.distance(10, -1) }
   end
 
   def test_checked_distance
     assert_raises(RuntimeError) { @checker.checked_distance('', '00:05:00') }
     assert_raises(RuntimeError) { @checker.checked_distance('01:00:00', '') }
     assert_equal 18.0, @checker.checked_distance('01:30:00', '00:05:00')
-    assert_equal 15.0, @checker.checked_distance('01:37:21', '00:06:17')
+    assert_equal 15.493, @checker.checked_distance('01:37:21', '00:06:17').round(3)
+  end
+
+  def test_readme_examples_one
+    assert_equal 3.386206896551724, @checker.velocity(3625, 12_275)
+    assert_equal 305.4166666666667, @checker.pace(3665, 12)
+    assert_equal 2520.0, @checker.time(210, 12)
+    assert_equal 80.5, @checker.distance(9660, 120)
   end
 
-  def test_checked_distance_with_bigdecimal_precision
-    assert_equal BigDecimal('0.15493368700265251989389920424403183024e2'),
-                 @checker_bigdecimal.checked_distance('01:37:21', '00:06:17')
+  def test_readme_examples_two
+    assert_equal 2.8658333333333332, @checker.checked_velocity('01:00:00', 10_317)
+    assert_equal '00:00:02', @checker.clock_velocity('01:00:00', 10_317)
+    assert_equal 489.2, @checker.checked_pace('01:21:32', 10)
+    assert_equal '00:08:09', @checker.clock_pace('01:21:32', 10)
+    assert_equal 4170.599999999999, @checker.checked_time('00:05:31', 12.6)
+    assert_equal '01:09:30', @checker.clock_time('00:05:31', 12.6)
+    assert_equal 12.640826873385013, @checker.checked_distance('01:21:32', '00:06:27')
   end
 end

data/test/calcpace/test_converter.rb

@@ -6,7 +6,6 @@ require_relative '../../lib/calcpace'
 class TestConverter < Minitest::Test
   def setup
     @checker = Calcpace.new
-    @checker_bigdecimal = Calcpace.new(true)
   end
 
   def test_convert_to_seconds
@@ -17,40 +16,49 @@ class TestConverter < Minitest::Test
     assert_equal '01:11:02', @checker.convert_to_clocktime(4262)
   end
 
-  def test_convert_distance
-    assert_equal 0.621371, @checker.convert(1, 'KM_TO_MI')
-    assert_equal 1.60934, @checker.convert(1, 'MI_TO_KM')
-    assert_equal 1.852, @checker.convert(1, 'NAUTICAL_MI_TO_KM')
-    assert_equal 0.539957, @checker.convert(1, 'KM_TO_NAUTICAL_MI')
-    assert_equal 0.001, @checker.convert(1, 'METERS_TO_KM')
-    assert_equal 1000, @checker.convert(1, 'KM_TO_METERS')
-    assert_equal 0.000621371, @checker.convert(1, 'METERS_TO_MI')
-    assert_equal 1609.34, @checker.convert(1, 'MI_TO_METERS')
-    assert_equal 3.28084, @checker.convert(1, 'METERS_TO_FEET')
-    assert_equal 0.3048, @checker.convert(1, 'FEET_TO_METERS')
-    assert_equal 1.09361, @checker.convert(1, 'METERS_TO_YARDS')
-    assert_equal 0.9144, @checker.convert(1, 'YARDS_TO_METERS')
-    assert_equal 39.3701, @checker.convert(1, 'METERS_TO_INCHES')
-    assert_equal 0.0254, @checker.convert(1, 'INCHES_TO_METERS')
-  end
-
-  def test_convert_velocity
-    assert_equal 3.60, @checker.convert(1, 'M_S_TO_KM_H')
-    assert_equal 0.277778, @checker.convert(1, 'KM_H_TO_M_S')
-    assert_equal 2.23694, @checker.convert(1, 'M_S_TO_MI_H')
-    assert_equal 0.44704, @checker.convert(1, 'MI_H_TO_M_S')
-    assert_equal 1.94384, @checker.convert(1, 'M_S_TO_NAUTICAL_MI_H')
-    assert_equal 0.514444, @checker.convert(1, 'NAUTICAL_MI_H_TO_M_S')
-    assert_equal 0.621371, @checker.convert(1, 'KM_H_TO_MI_H')
-    assert_equal 1.60934, @checker.convert(1, 'MI_H_TO_KM_H')
-    assert_equal 1.94384, @checker.convert(1, 'M_S_TO_KNOTS')
-    assert_equal 0.514444, @checker.convert(1, 'KNOTS_TO_M_S')
+  def test_convert_distance_one
+    assert_equal 0.621371, @checker.convert(1, :km_to_mi)
+    assert_equal 1.60934, @checker.convert(1, :mi_to_km)
+    assert_equal 1.852, @checker.convert(1, :nautical_mi_to_km)
+    assert_equal 0.539957, @checker.convert(1, :km_to_nautical_mi)
+    assert_equal 0.001, @checker.convert(1, :meters_to_km)
+    assert_equal 1000, @checker.convert(1, :km_to_meters)
+  end
+
+  def test_convert_distance_two
+    assert_equal 0.000621371, @checker.convert(1, :meters_to_mi)
+    assert_equal 1609.34, @checker.convert(1, :mi_to_meters)
+    assert_equal 3.28084, @checker.convert(1, :meters_to_feet)
+    assert_equal 0.3048, @checker.convert(1, :feet_to_meters)
+    assert_equal 1.09361, @checker.convert(1, :meters_to_yards)
+  end
+
+  def test_convert_distance_three
+    assert_equal 0.9144, @checker.convert(1, :yards_to_meters)
+    assert_equal 39.3701, @checker.convert(1, :meters_to_inches)
+    assert_equal 0.0254, @checker.convert(1, :inches_to_meters)
+  end
+
+  def test_convert_velocity_one
+    assert_equal 3.60, @checker.convert(1, :m_s_to_km_h)
+    assert_equal 0.277778, @checker.convert(1, :km_h_to_m_s)
+    assert_equal 2.23694, @checker.convert(1, :m_s_to_mi_h)
+    assert_equal 0.44704, @checker.convert(1, :mi_h_to_m_s)
+    assert_equal 1.94384, @checker.convert(1, :m_s_to_nautical_mi_h)
+  end
+
+  def test_convert_velocity_two
+    assert_equal 0.514444, @checker.convert(1, :nautical_mi_h_to_m_s)
+    assert_equal 0.621371, @checker.convert(1, :km_h_to_mi_h)
+    assert_equal 1.60934, @checker.convert(1, :mi_h_to_km_h)
+    assert_equal 1.94384, @checker.convert(1, :m_s_to_knots)
+    assert_equal 0.514444, @checker.convert(1, :knots_to_m_s)
   end
 
   def test_constant
-    assert_equal 0.621371, @checker.constant('KM_TO_MI')
-    assert_equal 1.60934, @checker.constant('MI_TO_KM')
-    assert_equal 1.852, @checker.constant('NAUTICAL_MI_TO_KM')
+    assert_equal 0.621371, @checker.constant(:km_to_mi)
+    assert_equal 1.60934, @checker.constant(:mi_to_km)
+    assert_equal 1.852, @checker.constant(:nautical_mi_to_km)
   end
 
   def test_list_constants

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joao Gilberto Saraiva
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-08 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -80,9 +80,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.66'
-description: Calcpace is a Ruby gem that helps with calculations related to distance
-  and time. It can calculate velocity, total time, and distance. It also converts
-  distance and velocity, check formats of time and can handle calculus with BigDecimal.
+description: Calcpace is designed for calculations and conversions related to distance
+  and time. It can calculate velocity, pace, total time, and distance and it supports
+  conversion to 26 different units, including kilometers, miles, meters, and feet.
 email: joaogilberto@tuta.io
 executables: []
 extensions: []
@@ -115,11 +115,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: 'Calcpace: calculate total, distance, velocity and convert distances in an
-  easy and precise way.'
+  easy way.'
 test_files:
 - test/calcpace/test_calculator.rb
 - test/calcpace/test_checker.rb