calcpace 1.5.5 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '04889c91e456d34e17974f8aeafa14bb99c0f44957bb42fdc6cac4a3c1a87bf1'
-  data.tar.gz: 60b0d8e24f2f10905c8ee8697c892b63efef0fca92fecb42dc86e9cf797b37a9
+  metadata.gz: d05362249daa1675ba18bb4f6dfc65b79d3380787d451e64b55bc436e3952381
+  data.tar.gz: 3374e54393bb54e443c9feb610e05caf36842d5d1c1d5ceb3e517bc79022f6ef
 SHA512:
-  metadata.gz: af863c188a3e74b28211bac8956c5fd1ad7440e9cdb8316f5c329a06daf5387ad81ecdeacced1b0011bfad304b0f8b9607c9deeca63dfba628e04162c718cb1f
-  data.tar.gz: ba0a4e7fd03714ca47c9a1cb9b1d8081327e2821b9da44730866437e3ba54c74aec43d93ae9f2f75ac69f7fe1672ee4fb62f4c17f015a35a83045583ebe872e4
+  metadata.gz: bb5a709698a85d9169ec683a47992eb2dfaf4dfdad430ef4a949b525896378814061a7f31a8f906f7475ff39c141e51e939a5847178baea87e1be9a69cc3015a
+  data.tar.gz: af509b94cb168456939af0329bcc93ee7c7cd0bdb95a8951c34267cfb175681f72ae02c8191671203feb988f30f89d673ef32bb87c197712c960a5febdc4a25b

data/.github/workflows/tests.yml

@@ -1,4 +1,6 @@
 name: Tests
+permissions:
+  contents: read
 on:
   push:
     branches: [ "main" ]

data/.ruby-version

@@ -1 +1 @@
-3.4.2
+3.4.4

data/.tool-versions

@@ -0,0 +1,2 @@
+nodejs 24.1.0
+ruby 3.4.4

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.5.5&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.6.0&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.5.5'
+gem 'calcpace', '~> 1.6.0'
 ```
 
 Then run:
@@ -87,15 +87,15 @@ To learn more about BigDecimal, check the [documentation](https://ruby-doc.org/s
 
 ### Convert Distances and Velocities
 
-Use the `convert` method to convert a distance or velocity. The first parameter is the value to be converted, and the second parameter is the unit to which the value will be converted. The unit must be a string with the abbreviation of the unit. The gem supports 26 different units, including kilometers, miles, meters, knots, and feet.
+Use the `convert` method to convert a distance or velocity. The first parameter is the value to be converted, and the second parameter is the unit to which the value will be converted. The unit can be a string (e.g. 'km to meters') or a symbol (e.g. :km_to_meters). The gem supports 42 different units, including kilometers, miles, meters, knots, and feet.
 
 Here are some examples:
 
 ```ruby
 converter.convert(10, :km_to_meters) # => 1000
-converter.convert(10, :mi_to_km) # => 16.0934
+converter.convert(10, 'mi to km') # => 16.0934
 converter.convert(1, :nautical_mi_to_km) # => 1.852
-converter.convert(1, :km_h_to_m_s) # => 0.277778
+converter.convert(1, 'km h to m s') # => 0.277778
 converter.convert(1, :m_s_to_mi_h) # => 2.23694
 ```
 
@@ -118,12 +118,17 @@ converter.convert(1, :m_s_to_mi_h) # => 2.23694
 | :km_h_to_mi_h        | Kilometers per Hour to Miles per Hour    |
 | :mi_h_to_km_h        | Miles per Hour to Kilometers per Hour    |
 
-You can list all the available units [here](/lib/calcpace/converter.rb), or using `list` methods:
+You can list all the available units [here](/lib/calcpace/converter.rb), or using `list` methods. The return will be a hash with the unit and a description of the unit.
 
 ```ruby
 converter.list_all
+# => {:km_to_mi=>"KM to MI", :mi_to_km=>"MI to KM", ...}
+
 converter.list_distance
+# => {:km_to_mi=>"KM to MI", :mi_to_km=>"MI to KM", ...}
+
 converter.list_speed
+# => {:m_s_to_km_h=>"M S to KM H", :km_h_to_m_s=>"KM H to M S", ...}
 ```
 
 ### Other Useful Methods
@@ -151,7 +156,7 @@ For example:
 begin
   calculate.pace(945, -1)
 rescue Calcpace::NonPositiveInputError => e
-  puts e.message # => "Input must be a positive number"
+  puts e.message # => "Distance must be a positive number"
 end
 
 begin

data/calcpace.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/calcpace/version'
 
 Gem::Specification.new do |spec|

data/lib/calcpace/calculator.rb

@@ -3,7 +3,7 @@
 # Module to calculate time, distance, pace and velocity
 module Calculator
   def velocity(time, distance)
-    validate_positive(time, distance)
+    validate_positive({ time: time, distance: distance })
     distance.to_f / time
   end
 
@@ -17,7 +17,7 @@ module Calculator
   end
 
   def pace(time, distance)
-    validate_positive(time, distance)
+    validate_positive({ time: time, distance: distance })
     time.to_f / distance
   end
 
@@ -31,7 +31,7 @@ module Calculator
   end
 
   def time(velocity, distance)
-    validate_positive(velocity, distance)
+    validate_positive({ velocity: velocity, distance: distance })
     velocity * distance
   end
 
@@ -45,7 +45,7 @@ module Calculator
   end
 
   def distance(time, velocity)
-    validate_positive(time, velocity)
+    validate_positive({ time: time, velocity: velocity })
     time.to_f / velocity
   end
 
@@ -57,8 +57,8 @@ module Calculator
 
   private
 
-  def validate_positive(*values)
-    values.each { |value| check_positive(value) }
+  def validate_positive(values)
+    values.each { |name, value| check_positive(value, name.capitalize) }
   end
 
   def validate_time(time)

data/lib/calcpace/checker.rb

@@ -4,11 +4,11 @@ require_relative 'errors'
 
 # Module to check if the input is valid or of the correct type
 module Checker
-  def check_positive(number)
+  def check_positive(number, name = 'Input')
     return if number.is_a?(Numeric) && number.positive?
 
     raise Calcpace::NonPositiveInputError,
-          'It must be a positive number'
+          "#{name} must be a positive number"
   end
 
   def check_time(time_string)

data/lib/calcpace/converter.rb

@@ -51,7 +51,7 @@ module Converter
   end
 
   def convert(value, unit)
-    check_positive(value)
+    check_positive(value, 'Value')
     unit_constant = constant(unit)
     value * unit_constant
   end
@@ -73,21 +73,32 @@ module Converter
     Time.at(seconds).utc.strftime(format)
   end
 
-  def constant(symbol)
-    Distance.const_get(symbol.to_s.upcase)
+  def constant(unit)
+    unit = format_unit(unit) if unit.is_a?(String)
+    Distance.const_get(unit.to_s.upcase)
   rescue NameError
-    Speed.const_get(symbol.to_s.upcase)
+    Speed.const_get(unit.to_s.upcase)
   end
 
   def list_all
-    (Distance.constants + Speed.constants).map { |c| c.downcase.to_sym }
+    format_list(Distance.constants + Speed.constants)
   end
 
   def list_speed
-    Speed.constants.map { |c| c.downcase.to_sym }
+    format_list(Speed.constants)
   end
 
   def list_distance
-    Distance.constants.map { |c| c.downcase.to_sym }
+    format_list(Distance.constants)
+  end
+
+  private
+
+  def format_unit(unit)
+    unit.downcase.gsub(' ', '_').to_sym
+  end
+
+  def format_list(constants)
+    constants.to_h { |c| [c.downcase.to_sym, c.to_s.gsub('_', ' ').gsub(' TO ', ' to ')] }
   end
 end

data/lib/calcpace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Calcpace
-  VERSION = "1.5.5"
+  VERSION = '1.6.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: calcpace
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - João Gilberto Saraiva
 bindir: exe
 cert_chain: []
-date: 2025-06-28 00:00:00.000000000 Z
+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.
@@ -20,6 +20,7 @@ files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".ruby-version"
+- ".tool-versions"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -51,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Ruby gem for pace, distance, and time calculations.
 test_files: []