Module: RSpec::Core::Formatters::Helpers

Includes:
BacktraceFormatter
Included in:
BaseFormatter
Defined in:
lib/rspec/core/formatters/helpers.rb

Constant Summary

SUB_SECOND_PRECISION =
5
DEFAULT_PRECISION =
2

Instance Method Summary (collapse)

Methods included from BacktraceFormatter

#format_backtrace

Instance Method Details

- (String) format_duration(duration)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Formats seconds into a human-readable string.

Examples:

format_duration(1) #=>  "1 minute 1 second"
format_duration(135.14) #=> "2 minutes 15.14 seconds"

Parameters:

  • duration (Float, Fixnum)

    in seconds

Returns:

  • (String)

    human-readable time



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/rspec/core/formatters/helpers.rb', line 45

def format_duration(duration)
  precision = case
              when duration < 1;    SUB_SECOND_PRECISION
              when duration < 120;  DEFAULT_PRECISION
              when duration < 300;  1
              else                  0
              end

  if duration > 60
    minutes = (duration.to_i / 60).to_i
    seconds = duration - minutes * 60

    "#{pluralize(minutes, 'minute')} #{pluralize(format_seconds(seconds, precision), 'second')}"
  else
    pluralize(format_seconds(duration, precision), 'second')
  end
end

- (String) format_seconds(float, precision = nil)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Formats seconds to have 5 digits of precision with trailing zeros removed if the number is less than 1 or with 2 digits of precision if the number is greater than zero.

The precision used is set in Helpers::SUB<em>SECOND</em>PRECISION and DEFAULT_PRECISION.

Examples:

format_seconds(0.000006) #=> "0.00001"
format_seconds(0.020000) #=> "0.02"
format_seconds(1.00000000001) #=> "1"

Parameters:

  • float (Float)

Returns:

  • (String)

    formatted float

See Also:



79
80
81
82
83
# File 'lib/rspec/core/formatters/helpers.rb', line 79

def format_seconds(float, precision = nil)
  precision ||= (float < 1) ? SUB_SECOND_PRECISION : DEFAULT_PRECISION
  formatted = sprintf("%.#{precision}f", float)
  strip_trailing_zeroes(formatted)
end

- (String) pluralize(count, string)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Pluralize a word based on a count.

Parameters:

  • count (Fixnum)

    number of objects

  • string (String)

    word to be pluralized

Returns:

  • (String)

    pluralized word



103
104
105
# File 'lib/rspec/core/formatters/helpers.rb', line 103

def pluralize(count, string)
  "#{count} #{string}#{'s' unless count.to_f == 1}"
end

- (String) strip_trailing_zeroes(string)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Remove trailing zeros from a string.

Parameters:

  • string (String)

    string with trailing zeros

Returns:

  • (String)

    string with trailing zeros removed



91
92
93
94
# File 'lib/rspec/core/formatters/helpers.rb', line 91

def strip_trailing_zeroes(string)
  stripped = string.sub(/[^1-9]+$/, '')
  stripped.empty? ? "0" : stripped
end