calcpace 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4525dc354de18e5ae106e84f2628eb649a28457deff01f9a4ecdf692a210d81
-  data.tar.gz: b16f270b98de14001122a466d2d19d11e5316262ef5319944c25ac236ac56615
+  metadata.gz: 4076fd00047c9b763ee7c4d38d5b3c75b638ec851c0af06895c70d050a122b10
+  data.tar.gz: 2c69b89a9f5508cd58a5f34b33f67517f6ac9a37218ae0e01fbbed600a269712
 SHA512:
-  metadata.gz: 7827da6cf956685513b3f56728a9475f9d5d5843ea2808b51a9a83800787779e71d4417c45d4e03779e6eb077a3158b1ca19c841c1ded861682ac8fa8f72beab
-  data.tar.gz: e17f9a94e680266f856fe94d36c57cea4988d10c4941dd415af7e0efe5b52d801a2e4721dd8758a2ae1d0228685f4c6a27208fad462b6a1d081e384152bbd248
+  metadata.gz: '029f28e39b899c3d2ddc13c873db6ed76a3a3b743080c4c167263a592550c56f1dd68bb19e4bb353c15846c63a339d6ba07d7e1a33c1ce83ff8d3159f059d5e7'
+  data.tar.gz: 2878a6024448fd28264e9b7df4d26fc19f2f41d02016dab82caa7c87f46b8b3bce0de55e5edaff627ca5ffa1b945e2461e5a3d49188df12f533a0cf003011eeb

data/lib/calcpace/calculator.rb

@@ -1,25 +1,40 @@
-# frozen_string_literal: true
-
-module Calculator
-  def pace(time, distance)
-    check_digits(time, distance)
-    convert_to_clocktime(convert_to_seconds(time) / distance.to_f)
-  end
-
-  def total_time(pace, distance)
-    check_digits(pace, distance)
-    convert_to_clocktime(convert_to_seconds(pace) * distance.to_f)
-  end
-
-  def distance(time, pace)
-    check_digits_time(time)
-    check_digits_time(pace)
-    convert_to_seconds(time).to_f / convert_to_seconds(pace).round(2)
-  end
-
-  def convert_distance(distance, unit)
-    check_digits_distance(distance)
-    check_unit(unit)
-    convert(distance, unit)
-  end
-end
+require 'bigdecimal'
+
+module Calculator
+  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)
+    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_seconds(pace, distance, bigdecimal = false)
+    check_time(pace)
+    check_distance(distance)
+    pace_seconds = convert_to_seconds(pace)
+    bigdecimal ? pace_seconds * BigDecimal(distance.to_s) : pace_seconds * distance
+  end
+
+  def distance(time, pace, bigdecimal = false)
+    check_time(time)
+    check_time(pace)
+    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/checker.rb

@@ -1,20 +1,19 @@
-# frozen_string_literal: true
-
-module Checker
-  def check_digits(time, distance)
-    check_digits_time(time)
-    check_digits_distance(distance)
-  end
-
-  def check_digits_distance(distance)
-    raise 'It must be a X.X positive number' unless distance.positive?
-  end
-
-  def check_digits_time(time_string)
-    raise 'It must be a XX:XX:XX time' unless time_string =~ /\d{0,2}(:)*?\d{1,2}(:)\d{1,2}/
-  end
-
-  def check_unit(unit)
-    raise 'It must be km or mi' unless %w[km mi].include?(unit)
-  end
-end
+# frozen_string_literal: true
+
+module Checker
+  def check_distance(distance)
+    raise 'It must be a X.X positive number' unless distance.positive?
+  end
+
+  def check_time(time_string)
+    raise 'It must be a XX:XX:XX time' unless time_string =~ /\d{0,2}(:)*?\d{1,2}(:)\d{1,2}/
+  end
+
+  def check_integer(second)
+    raise 'It must be a positive number' unless second.is_a?(Integer) && second.positive?
+  end
+
+  def check_unit(unit)
+    raise 'It must be km or mi' unless %w[km mi].include?(unit)
+  end
+end

data/lib/calcpace/converter.rb

@@ -1,22 +1,44 @@
 # 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)
-    Time.at(seconds).utc.strftime('%H:%M:%S')
+    format = seconds >= 86_400 ? '%d %H:%M:%S' : '%H:%M:%S'
+    Time.at(seconds.to_i).utc.strftime(format)
   end
 
-  # tem que chamar as checagens de digitos antes de chamar o convert_distance
-  def convert(distance, unit)
+  def convert_the_distance(distance, unit, round_limit = 2)
     case unit
     when 'km'
-      (distance * 0.621371).round(2)
+      (distance * KM_TO_MI).round(round_limit)
     when 'mi'
-      (distance * 1.60934).round(2)
+      (distance * MI_TO_KM).round(round_limit)
     end
   end
-end
+end

data/lib/calcpace.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
-require_relative 'calcpace/calculator'
-require_relative 'calcpace/checker'
-require_relative 'calcpace/converter'
-
-class Calcpace
-  include Calculator
-  include Checker
-  include Converter
-
-  def initialize; end
-end
+# frozen_string_literal: true
+
+require_relative 'calcpace/calculator'
+require_relative 'calcpace/checker'
+require_relative 'calcpace/converter'
+
+class Calcpace
+  include Calculator
+  include Checker
+  include Converter
+
+  def initialize; end
+end

data/test/calcpace/test_calculator.rb

@@ -1,40 +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
-
-  def test_convert_distance
-    assert_raises(RuntimeError) { @checker.convert_distance(10, 'invalid') }
-    assert_raises(RuntimeError) { @checker.convert_distance(-1, 'km') }
-    assert_raises(RuntimeError) { @checker.convert_distance(0, 'km') }
-    assert_equal 6.21, @checker.convert_distance(10, 'km')
-    assert_equal 16.09, @checker.convert_distance(10, 'mi')
-  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 71844.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_checker.rb

@@ -1,32 +1,27 @@
-# frozen_string_literal: true
-
-require 'minitest/autorun'
-require_relative '../../lib/calcpace'
-
-class TestChecker < Minitest::Test
-  def setup
-    @checker = Calcpace.new
-  end
-
-  def test_check_digits_distance
-    assert_raises(RuntimeError) { @checker.check_digits_distance(-1) }
-    assert_raises(RuntimeError) { @checker.check_digits_distance(0) }
-    assert_nil @checker.check_digits_distance(1)
-  end
-
-  def test_check_digits_time
-    assert_raises(RuntimeError) { @checker.check_digits_time('') }
-    assert_nil @checker.check_digits_time('00:00:00')
-  end
-
-  def test_check_digits
-    assert_raises(RuntimeError) { @checker.check_digits('00:00:00', 0) }
-    assert_raises(RuntimeError) { @checker.check_digits('', 1) }
-    assert_nil @checker.check_digits('00:00:00', 1)
-  end
-
-  def test_convert
-    assert_equal 6.21, @checker.convert(10, 'km')
-    assert_equal 16.09, @checker.convert(10, 'mi')
-  end
-end
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require_relative '../../lib/calcpace'
+
+class TestChecker < Minitest::Test
+  def setup
+    @checker = Calcpace.new
+  end
+
+  def test_check_distance
+    assert_raises(RuntimeError) { @checker.check_distance(-1) }
+    assert_raises(RuntimeError) { @checker.check_distance(0) }
+    assert_nil @checker.check_distance(1)
+  end
+
+  def test_check_time
+    assert_raises(RuntimeError) { @checker.check_time('') }
+    assert_nil @checker.check_time('00:00:00')
+  end
+
+  def test_check_integer
+    assert_raises(RuntimeError) { @checker.check_integer(-1) }
+    assert_raises(RuntimeError) { @checker.check_integer(0) }
+    assert_nil @checker.check_integer(1)
+  end
+end

data/test/calcpace/test_converter.rb

@@ -1,24 +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_convert_to_clocktime
-    assert_equal '01:11:02', @checker.convert_to_clocktime(4262)
-  end
-
-  def test_convert_distance_km
-    assert_equal 6.21, @checker.convert_distance(10, 'km')
-    assert_equal 16.09, @checker.convert_distance(10, 'mi')
-    assert_raises(RuntimeError) { @checker.convert_distance(10, '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(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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joao Gilberto Saraiva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-25 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.2.33
+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