calcpace 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 200091226ac840d686c80783b1ffdd25880e33d055023584bcf0d6ad4f80942b
-  data.tar.gz: 983b752d6d4569accd2deebeecf0d071dd7d5d7c4d86ad13949b0dc57992efcb
+  metadata.gz: '08aafc87c8fa3b75db3dfac8e186f803cbfec584991945e9849648a0d91c7341'
+  data.tar.gz: 886d0b4b83bc2bbc07b3f2dc5d4b3b605459cc15df13a51c22e4ba87f2620ff4
 SHA512:
-  metadata.gz: bc18311a99f36de42c7684bab706665d875abf9d579ca31a05d2cebbd8ae75be66f6c34d5242d6d76538f78198c7ef4931a427c43a62b444abf1e0c8cfdc89da
-  data.tar.gz: '0086fe8432f284529da6c6c7ded77488895360da55542f8ca6f50c8fd2976e3d8c2bf2e22d9c56cd10f9a560a4ad4666a12fc34655dbea263cd4f698eafb4e9c'
+  metadata.gz: 0e3b69e165c445f5c2885c91a8b866020095ba3de87431817eed0d75df2f6f3e65da15cb73205904cff8c3844d590ce3b3edeabdf91cd74f31bbeafe84ac085c
+  data.tar.gz: 311f84fa56b4f5d3bec6e0c16cac2d6650a488828058f169c8bf1f12c410bff8a91c9be667ffd30ed6dcf40a856f5c64a63aa4b9386095f9a0fdbd7c83548844

data/lib/calcpace/calculator.rb

@@ -1,21 +1,42 @@
 # frozen_string_literal: true
 
+require 'bigdecimal'
+
 module Calculator
-  def pace(time, distance)
+  def pace(time, distance, bigdecimal = false)
+    pace_in_seconds = pace_seconds(time, distance, bigdecimal)
+    convert_to_clocktime(pace_in_seconds)
+  end
+
+  def pace_seconds(time, distance, bigdecimal = false)
     check_time(time)
     check_distance(distance)
-    convert_to_clocktime(convert_to_seconds(time) / distance.to_f)
+    seconds = convert_to_seconds(time)
+    bigdecimal ? seconds / BigDecimal(distance.to_s) : seconds / distance
+  end
+
+  def total_time(pace, distance, bigdecimal = false)
+    total_time_in_seconds = total_time_seconds(pace, distance, bigdecimal)
+    convert_to_clocktime(total_time_in_seconds)
   end
 
-  def total_time(pace, distance)
+  def total_time_seconds(pace, distance, bigdecimal = false)
     check_time(pace)
     check_distance(distance)
-    convert_to_clocktime(convert_to_seconds(pace) * distance.to_f)
+    pace_seconds = convert_to_seconds(pace)
+    bigdecimal ? pace_seconds * BigDecimal(distance.to_s) : pace_seconds * distance
   end
 
-  def distance(time, pace)
+  def distance(time, pace, bigdecimal = false)
     check_time(time)
     check_time(pace)
-    convert_to_seconds(time).to_f / convert_to_seconds(pace).round(2)
+    if bigdecimal
+      time_seconds = BigDecimal(convert_to_seconds(time).to_s)
+      pace_seconds = BigDecimal(convert_to_seconds(pace).to_s)
+    else
+      time_seconds = convert_to_seconds(time)
+      pace_seconds = convert_to_seconds(pace)
+    end
+    time_seconds / pace_seconds
   end
 end

data/lib/calcpace/converter.rb

@@ -1,39 +1,44 @@
-# frozen_string_literal: true
-
-module Converter
-  def to_seconds(time)
-    check_time(time)
-    convert_to_seconds(time)
-  end
-
-  def to_clocktime(seconds)
-    check_integer(seconds)
-    convert_to_clocktime(seconds)
-  end
-
-  def convert(distance, unit, round_limit = 2)
-    check_distance(distance)
-    check_unit(unit)
-    check_integer(round_limit)
-    convert_the_distance(distance, unit, round_limit)
-  end
-
-  def convert_to_seconds(time)
-    hour, minute, seconds = time.split(':').map(&:to_i)
-    (hour * 3600) + (minute * 60) + seconds
-  end
-
-  def convert_to_clocktime(seconds)
-    seconds >= 86_400 ? time = '%d %H:%M:%S' : time = '%H:%M:%S'
-    Time.at(seconds).utc.strftime(time)
-  end
-
-  def convert_the_distance(distance, unit, round_limit = 2)
-    case unit
-    when 'km'
-      (distance * 0.621371).round(round_limit)
-    when 'mi'
-      (distance * 1.60934).round(round_limit)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Converter
+  KM_TO_MI = BigDecimal('0.621371')
+  MI_TO_KM = BigDecimal('1.60934')
+
+  def to_seconds(time)
+    check_time(time)
+    convert_to_seconds(time)
+  end
+
+  def to_clocktime(seconds)
+    check_integer(seconds)
+    convert_to_clocktime(seconds)
+  end
+
+  def convert(distance, unit, round_limit = 2)
+    check_distance(distance)
+    check_unit(unit)
+    check_integer(round_limit)
+    convert_the_distance(BigDecimal(distance.to_s), unit, round_limit)
+  end
+
+  def convert_to_seconds(time)
+    hour, minute, seconds = time.split(':').map(&:to_i)
+    (hour * 3600) + (minute * 60) + seconds
+  end
+
+  def convert_to_clocktime(seconds)
+    format = seconds >= 86_400 ? '%d %H:%M:%S' : '%H:%M:%S'
+    Time.at(seconds.to_i).utc.strftime(format)
+  end
+
+  def convert_the_distance(distance, unit, round_limit = 2)
+    case unit
+    when 'km'
+      (distance * KM_TO_MI).round(round_limit)
+    when 'mi'
+      (distance * MI_TO_KM).round(round_limit)
+    end
+  end
+end

data/test/calcpace/test_calculator.rb

@@ -1,32 +1,68 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require_relative '../../lib/calcpace'
-
-class TestCalculator < Minitest::Test
-  def setup
-    @checker = Calcpace.new
-  end
-
-  def test_pace
-    assert_raises(RuntimeError) { @checker.pace('', 10) }
-    assert_raises(RuntimeError) { @checker.pace('invalid', 10) }
-    assert_raises(RuntimeError) { @checker.pace('00:00:00', 0) }
-    assert_raises(RuntimeError) { @checker.pace('00:00:00', -1) }
-    assert_equal '00:06:00', @checker.pace('01:00:00', 10)
-  end
-
-  def test_total_time
-    assert_raises(RuntimeError) { @checker.total_time('', 10) }
-    assert_raises(RuntimeError) { @checker.total_time('invalid', 10) }
-    assert_raises(RuntimeError) { @checker.total_time('00:00:00', 0) }
-    assert_raises(RuntimeError) { @checker.total_time('00:00:00', -1) }
-    assert_equal '01:00:00', @checker.total_time('00:05:00', 12)
-  end
-
-  def test_distance
-    assert_raises(RuntimeError) { @checker.distance('', '00:05:00') }
-    assert_raises(RuntimeError) { @checker.distance('01:00:00', '') }
-    assert_equal 18.0, @checker.distance('01:30:00', '00:05:00')
-  end
-end
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'bigdecimal'
+require_relative '../../lib/calcpace'
+
+class TestCalculator < Minitest::Test
+  def setup
+    @checker = Calcpace.new
+  end
+
+  def test_pace
+    assert_raises(RuntimeError) { @checker.pace('', 10) }
+    assert_raises(RuntimeError) { @checker.pace('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.pace('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.pace('00:00:00', -1) }
+    assert_equal '00:06:00', @checker.pace('01:00:00', 10)
+    assert_equal '00:07:54', @checker.pace('01:37:21', 12.3)
+  end
+
+  def test_pace_without_bigdecimal_precision
+    assert_equal '00:07:54', @checker.pace('01:37:21', 12.3, false)
+  end
+
+  def test_pace_seconds
+    assert_raises(RuntimeError) { @checker.pace_seconds('', 10) }
+    assert_raises(RuntimeError) { @checker.pace_seconds('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.pace_seconds('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.pace_seconds('00:00:00', -1) }
+    assert_equal BigDecimal('474.8780487804878'), @checker.pace_seconds('01:37:21', 12.3)
+  end
+
+  def test_pace_seconds_with_bigdecimal_precision
+    assert_equal BigDecimal('0.474878048780487804878048780487804878049e3'), @checker.pace_seconds('01:37:21', 12.3, true)
+  end
+
+  def test_total_time
+    assert_raises(RuntimeError) { @checker.total_time('', 10) }
+    assert_raises(RuntimeError) { @checker.total_time('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.total_time('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.total_time('00:00:00', -1) }
+    assert_equal '01:00:00', @checker.total_time('00:05:00', 12)
+  end
+
+  def test_total_time_seconds
+    assert_raises(RuntimeError) { @checker.total_time_seconds('', 10) }
+    assert_raises(RuntimeError) { @checker.total_time_seconds('invalid', 10) }
+    assert_raises(RuntimeError) { @checker.total_time_seconds('00:00:00', 0) }
+    assert_raises(RuntimeError) { @checker.total_time_seconds('00:00:00', -1) }
+    assert_equal 3600, @checker.total_time_seconds('00:05:00', 12)
+    assert_equal 71_844.3, @checker.total_time_seconds('01:37:21', 12.3)
+  end
+
+  def test_total_time_seconds_with_bigdecimal_precision
+    assert_equal BigDecimal('0.718443e5'), @checker.total_time_seconds('01:37:21', 12.3, true)
+  end
+
+  def test_distance
+    assert_raises(RuntimeError) { @checker.distance('', '00:05:00') }
+    assert_raises(RuntimeError) { @checker.distance('01:00:00', '') }
+    assert_equal 18.0, @checker.distance('01:30:00', '00:05:00')
+    assert_equal 15.0, @checker.distance('01:37:21', '00:06:17')
+  end
+
+  def test_distance_with_bigdecimal_precision
+    assert_equal BigDecimal('0.15493368700265251989389920424403183024e2'), @checker.distance('01:37:21', '00:06:17', true)
+  end
+end

data/test/calcpace/test_converter.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require_relative '../../lib/calcpace'
-
-class TestConverter < Minitest::Test
-  def setup
-    @checker = Calcpace.new
-  end
-
-  def test_convert_to_seconds
-    assert_equal 4262, @checker.convert_to_seconds('01:11:02')
-  end
-
-  def test_to_seconds
-    assert_equal 3600, @checker.to_seconds('01:00:00')
-    assert_raises(RuntimeError) { @checker.to_seconds('invalid') }
-  end
-
-  def test_convert_to_clocktime
-    assert_equal '01:11:02', @checker.convert_to_clocktime(4262)
-  end
-
-  def test_to_clocktime
-    assert_equal '01:00:00', @checker.to_clocktime(3600)
-    assert_equal '02 01:00:00', @checker.to_clocktime(90000)
-    assert_raises(RuntimeError) { @checker.to_clocktime(-1) }
-    assert_raises(RuntimeError) { @checker.to_clocktime(0) }
-    assert_raises(RuntimeError) { @checker.to_clocktime('invalid') }
-  end
-
-  def test_convert_the_distance
-    assert_equal 6.21, @checker.convert_the_distance(10, 'km')
-    assert_equal 6.2, @checker.convert_the_distance(10, 'km', 1)
-    assert_equal 6.214, @checker.convert_the_distance(10, 'km', 3)
-    assert_equal 16.09, @checker.convert_the_distance(10, 'mi')
-  end
-
-  def test_convert
-    assert_equal 6.21, @checker.convert(10, 'km')
-    assert_equal 16.09, @checker.convert(10, 'mi')
-    assert_equal 6.2, @checker.convert(10, 'km', 1)
-    assert_raises(RuntimeError) { @checker.convert(10, 'invalid') }
-    assert_raises(RuntimeError) { @checker.convert(-1, 'km') }
-    assert_raises(RuntimeError) { @checker.convert(10, 'km', -2) }
-    assert_raises(RuntimeError) { @checker.convert(10, 'km', 0) }
-    assert_raises(RuntimeError) { @checker.convert(10, 'km', 'invalid') }
-  end
-end
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require_relative '../../lib/calcpace'
+
+class TestConverter < Minitest::Test
+  def setup
+    @checker = Calcpace.new
+  end
+
+  def test_convert_to_seconds
+    assert_equal 4262, @checker.convert_to_seconds('01:11:02')
+  end
+
+  def test_to_seconds
+    assert_equal 3600, @checker.to_seconds('01:00:00')
+    assert_raises(RuntimeError) { @checker.to_seconds('invalid') }
+  end
+
+  def test_convert_to_clocktime
+    assert_equal '01:11:02', @checker.convert_to_clocktime(4262)
+  end
+
+  def test_to_clocktime
+    assert_equal '01:00:00', @checker.to_clocktime(3600)
+    assert_equal '02 01:00:00', @checker.to_clocktime(90_000)
+    assert_raises(RuntimeError) { @checker.to_clocktime(-1) }
+    assert_raises(RuntimeError) { @checker.to_clocktime(0) }
+    assert_raises(RuntimeError) { @checker.to_clocktime('invalid') }
+  end
+
+  def test_convert_the_distance
+    assert_equal 6.21, @checker.convert_the_distance(10, 'km')
+    assert_equal 6.2, @checker.convert_the_distance(10, 'km', 1)
+    assert_equal 6.214, @checker.convert_the_distance(10, 'km', 3)
+    assert_equal 16.09, @checker.convert_the_distance(10, 'mi')
+  end
+
+  def test_convert
+    assert_equal 6.21, @checker.convert(10, 'km')
+    assert_equal 16.09, @checker.convert(10, 'mi')
+    assert_equal 6.2, @checker.convert(10, 'km', 1)
+    assert_raises(RuntimeError) { @checker.convert(10, 'invalid') }
+    assert_raises(RuntimeError) { @checker.convert(-1, 'km') }
+    assert_raises(RuntimeError) { @checker.convert(10, 'km', -2) }
+    assert_raises(RuntimeError) { @checker.convert(10, 'km', 0) }
+    assert_raises(RuntimeError) { @checker.convert(10, 'km', 'invalid') }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Joao Gilberto Saraiva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-16 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -94,9 +94,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Calculate pace, total time, distance and easily convert distances (kilometers
-  and miles) for activities like running and cycling. Get readable results in HH:MM:SS
-  or X.X format for time and distance calculations.
+description: 'Calcpace is a Ruby gem that helps with calculations related to running/cycling
+  activities or general purposes involving distance and time. It can calculate pace,
+  total time, and distance. It also converts distances between miles and kilometers
+  and check formats of time and distance. The results are provided in a readable format,
+  with times in HH:MM:SS or seconds and distances in X.X format. If you need, the
+  gem supports BigDecimal to handle the calculations, '
 email: joaogilberto@tuta.io
 executables: []
 extensions: []
@@ -114,8 +117,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/0jonjo/calcpace
-post_install_message: It's time to grab your sneakers or hop on your bike and start
-  exercising! Thank you for installing Calcpace!
+post_install_message: It's time to calculate! Thank you for installing Calcpace.
 rdoc_options: []
 require_paths:
 - lib
@@ -130,11 +132,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
-summary: 'Calcpace: calculate time and distances for activities such as running and
-  cycling.'
+summary: 'Calcpace: calculate time, distance, pace, velocity and convert distances
+  in an easy and precise way.'
 test_files:
 - test/calcpace/test_calculator.rb
 - test/calcpace/test_checker.rb