Module: NRSER::RSpex

Defined in:
lib/nrser/rspex.rb,
lib/nrser/rspex/shared_examples.rb

Defined Under Namespace

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

Constant Summary collapse

PREFIXES_BASE =

Symbols

Sources:

{
  section: '§',
  group: '•',
  invocation: '𝑓⟮𝑥⟯',
}
PREFIXES_MATH_ITALIC = 
PREFIXES_BASE.merge(
  module:       '𝑀',
  method:       '𝑚',
  class:        '𝐶',
  attribute:    '𝑎',
  file:         '𝐹',
)
PREFIXES_MATH_CURSIVE_WORDS = 
PREFIXES_BASE.merge(
  module:       '𝓜 𝓸𝓭𝓾𝓵𝓮',
  method:       '𝓶𝓮𝓽',
  class:        '𝐶',
  attribute:    '𝑎',
  file:         '𝐹',
)
PREFIXES =

PREFIXES_MATH_GREEK = PREFIXES_BASE.merge(

# module: "𝓜 𝓸𝓭𝓾𝓵𝓮",
module:       '𝛭',
method:       '𝜆',
class:        '𝛤',
attribute:    '𝛼',

)

PREFIXES_MATH_ITALIC

Class Method Summary collapse

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) 


217
218
219
 
# File 'lib/nrser/rspex.rb', line 217

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.



205
206
207
 
# File 'lib/nrser/rspex.rb', line 205

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.



192
193
194
 
# File 'lib/nrser/rspex.rb', line 192

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