calcpace 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11ad12749e77c35206d4753b60f3db604ea548ab75724d1602606c9cb9eca196
-  data.tar.gz: fb65325f6210995dd7f64f0b1707e328a77e08b83a85dbfc0644bec1de7e6548
+  metadata.gz: 200091226ac840d686c80783b1ffdd25880e33d055023584bcf0d6ad4f80942b
+  data.tar.gz: 983b752d6d4569accd2deebeecf0d071dd7d5d7c4d86ad13949b0dc57992efcb
 SHA512:
-  metadata.gz: 61b82828b6d43b293744526ac4f34e434df820c19be0a8378e3cbfbe0995e357aaefb6a1caedb50831f5b7c81a9776d64ac599a5a3e858979b7b549737a6d5b9
-  data.tar.gz: e4d9c623fbf2c0a9ab4d9953cadbed377b7867a3c3b0be494fd572860bf467c5ae88cfbd80d038e4157fcea44b799f2cc4d476598a6f621b2d85057fca51958e
+  metadata.gz: bc18311a99f36de42c7684bab706665d875abf9d579ca31a05d2cebbd8ae75be66f6c34d5242d6d76538f78198c7ef4931a427c43a62b444abf1e0c8cfdc89da
+  data.tar.gz: '0086fe8432f284529da6c6c7ded77488895360da55542f8ca6f50c8fd2976e3d8c2bf2e22d9c56cd10f9a560a4ad4666a12fc34655dbea263cd4f698eafb4e9c'

data/lib/calcpace/calculator.rb

@@ -1,25 +1,21 @@
-# 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
+# frozen_string_literal: true
+
+module Calculator
+  def pace(time, distance)
+    check_time(time)
+    check_distance(distance)
+    convert_to_clocktime(convert_to_seconds(time) / distance.to_f)
+  end
+
+  def total_time(pace, distance)
+    check_time(pace)
+    check_distance(distance)
+    convert_to_clocktime(convert_to_seconds(pace) * distance.to_f)
+  end
+
+  def distance(time, pace)
+    check_time(time)
+    check_time(pace)
+    convert_to_seconds(time).to_f / convert_to_seconds(pace).round(2)
+  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,39 @@
 # 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)
-    Time.at(seconds).utc.strftime('%H:%M:%S')
+    seconds >= 86_400 ? time = '%d %H:%M:%S' : time = '%H:%M:%S'
+    Time.at(seconds).utc.strftime(time)
   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 * 0.621371).round(round_limit)
     when 'mi'
-      (distance * 1.60934).round(2)
+      (distance * 1.60934).round(round_limit)
     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

@@ -0,0 +1,32 @@
+# 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

data/test/calcpace/test_checker.rb

@@ -0,0 +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_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

@@ -0,0 +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

metadata

@@ -1,17 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Joao Gilberto Saraiva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-25 00:00:00.000000000 Z
-dependencies: []
-description: Calculate pace, time, distance, and convert distances for running and
-  cycling.
+date: 2024-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
 email: joaogilberto@tuta.io
 executables: []
 extensions: []
@@ -21,11 +106,16 @@ files:
 - lib/calcpace/calculator.rb
 - lib/calcpace/checker.rb
 - lib/calcpace/converter.rb
+- test/calcpace/test_calculator.rb
+- test/calcpace/test_checker.rb
+- test/calcpace/test_converter.rb
 homepage: https://github.com/0jonjo/calcpace
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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!
 rdoc_options: []
 require_paths:
 - lib
@@ -33,15 +123,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
-summary: Calcpace
-test_files: []
+summary: 'Calcpace: calculate time and distances for activities such as running and
+  cycling.'
+test_files:
+- test/calcpace/test_calculator.rb
+- test/calcpace/test_checker.rb
+- test/calcpace/test_converter.rb