123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Defined in: rspec-core/lib/rspec/core/formatters/helpers.rb

Overview

Constant Summary

Class Method Summary

Class Method Details

.format_duration(duration) ⇒ String

This method is for internal use only.

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

[ GitHub ] 

  


# File 'rspec-core/lib/rspec/core/formatters/helpers.rb', line 24



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

  if duration > 60
    minutes = (duration.round / 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(float, precision = nil)  ⇒ String 
  

  

    This method is for internal use only.
  



  

    

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 SUB_SECOND_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:

  
    
      
  • #strip_trailing_zeroes
    • 
      




  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/helpers.rb', line 60



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


  








  

    .organize_ids(ids)  
  

  

    This method is for internal use only.
  



  

    

Given a list of example ids, organizes them into a compact, ordered list.


  





  


  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/helpers.rb', line 102



def self.organize_ids(ids)
  grouped = ids.inject(Hash.new { |h, k| h[k] = [] }) do |hash, id|
    file, id = Example.parse_id(id)
    hash[file] << id
    hash
  end

  grouped.sort_by(&:first).map do |file, grouped_ids|
    grouped_ids = grouped_ids.sort_by { |id| id.split(':').map(&:to_i) }
    id = Metadata.id_from(:rerun_file_path => file, :scoped_id => grouped_ids.join(','))
    ShellEscape.conditionally_quote(id)
  end
end


  








  

    .pluralize(count, string)  ⇒ String 
  

  

    This method is for internal use only.
  



  

    

Pluralize a word based on a count.


  





  
Parameters:


    
  
  • 
    count
    (Fixnum)
—    
    

    number of objects
    

    
  
    • 
  
  • 
    string
    (String)
—    
    

    word to be pluralized
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    

    pluralized word
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/helpers.rb', line 88



def self.pluralize(count, string)
  pluralized_string = if count.to_f == 1
                        string
                      elsif string.end_with?('s') # e.g. "process"
                        "#{string}es" # e.g. "processes"
                      else
                        "#{string}s"
                      end

  "#{count} #{pluralized_string}"
end


  








  

    .strip_trailing_zeroes(string)  ⇒ String  (private)
  

  

    This method is for internal use only.
  



  

    

Remove trailing zeros from a string.



Only remove trailing zeros after a decimal place. see: rubular.com/r/ojtTydOgpn


  





  
Parameters:


    
  
  • 
    string
    (String)
—    
    

    string with trailing zeros
    

    
  
    • 



Returns:


    
  
  • 
    (String)
—    
    

    string with trailing zeros removed
    

    
  
    • 





  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/formatters/helpers.rb', line 76



def self.strip_trailing_zeroes(string)
  string.sub(/(?:(\..*[^0])0+|\.0+)$/, '\1')
end