Module: NRSER::RSpex

Defined in:

lib/nrser/rspex/example.rb,
lib/nrser/rspex/example_group.rb,
lib/nrser/rspex/shared_examples.rb,
lib/nrser/rspex.rb

Overview

Extensions

Defined Under Namespace

Modules: Example, ExampleGroup, Format, SharedExamples Classes: Args, List, Opts

Constant Summary

PREFIXES =

Symbol characters for specific example group types.

Sources:

• en.wikipedia.org/wiki/Mathematical_operators_and_symbols_in_Unicode

{
  section: '§',
  group: '•',
  invocation: '𝑓⟮𝑥⟯',
}

Class Method Summary

• .dot_rel_path(dest) ⇒ String

  Get the relative path from the working directory with the ‘./` in front.

• .format(*args) ⇒ return_type
• .short_s(value, max = 64) ⇒ return_type

Class Method Details

.dot_rel_path(dest) ⇒ String

Get the relative path from the working directory with the ‘./` in front.

Parameters:

• dest (String | Pathname) —

  Destination file path.

Returns:

• (String)

# File 'lib/nrser/rspex.rb', line 188

def self.dot_rel_path dest
  File.join '.', dest.to_pn.relative_path_from( Pathname.getwd )
end

.format(*args) ⇒ return_type

TODO:

Document format method.

Returns @todo Document return value.

Parameters:

• arg_name (type) —

  @todo Add name param description.

Returns:

• (return_type) —

  @todo Document return value.

# File 'lib/nrser/rspex.rb', line 176

def self.format *args
  NRSER::RSpex::Format.description *args
end

.short_s(value, max = 64) ⇒ return_type

TODO:

Document short_s method.

Returns @todo Document return value.

Parameters:

• arg_name (type) —

  @todo Add name param description.

Returns:

• (return_type) —

  @todo Document return value.

# File 'lib/nrser/rspex.rb', line 163

def self.short_s value, max = 64
  NRSER.smart_ellipsis value.inspect, max
end