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)

• - (String) format_duration(duration) private

  Formats seconds into a human-readable string.

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

  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.

• - (String) pluralize(count, string) private

  Pluralize a word based on a count.

• - (String) strip_trailing_zeroes(string) private

  Remove trailing zeros from a string.

Methods included from BacktraceFormatter

#format_backtrace

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

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

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

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

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

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