Class: Nanoc::Core::OutdatednessReasons::Generic Private

Inherits:
Object
  • Object
show all
Defined in:
lib/nanoc/core/outdatedness_reasons.rb

Overview

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

A generic outdatedness reason. An outdatedness reason is basically a descriptive message that explains why a given object is outdated.

Direct Known Subclasses

AttributesModified

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, props = Nanoc::Core::DependencyProps.new) ⇒ Generic

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.

Returns a new instance of Generic.

Parameters:

  • message (String) —

    The descriptive message for this outdatedness reason



20
21
22
23
24
25
26
27
 
# File 'lib/nanoc/core/outdatedness_reasons.rb', line 20

def initialize(message, props = Nanoc::Core::DependencyProps.new)
  # TODO: Replace `DependencyProps` with its own `OutdatednessProps`
  # type. For `OutdatednessProps`, the only values are true/false;
  # giving a collection for `raw_content` makes no sense (anymore).

  @message = message
  @props = props
end

Instance Attribute Details

#message ⇒ String (readonly)

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.

Returns A descriptive message for this outdatedness reason.

Returns:

  • (String) —

    A descriptive message for this outdatedness reason



13
14
15
 
# File 'lib/nanoc/core/outdatedness_reasons.rb', line 13

def message
  @message
end

#props ⇒ Nanoc::Core::DependencyProps (readonly)

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.

Returns:



16
17
18
 
# File 'lib/nanoc/core/outdatedness_reasons.rb', line 16

def props
  @props
end