Class: Modulorails::SuccessData

Inherits:

Object

• Object
• Modulorails::SuccessData

Defined in:

lib/modulorails/success_data.rb

Overview

A success resulting from an operation with optional additional data.

Author:

• Matthieu Ciappara <ciappa_m@modulotech>

Instance Attribute Summary

• #data ⇒ Object readonly

  Returns the value of attribute data.

• #r data(data) ⇒ Object

  An object to transport some data (for instance the result of the operation).

Instance Method Summary

• #initialize(data = nil) ⇒ SuccessData constructor

  A new instance of SuccessData.

• #success? ⇒ true

  A success always means the operation was a success.

Constructor Details

#initialize(data = nil) ⇒ SuccessData

Returns a new instance of SuccessData.

Parameters:

• data (Object) (defaults to: nil) —

  An object to transport some data (for instance the result of the operation)

# File 'lib/modulorails/success_data.rb', line 10

def initialize(data=nil)
  @data = data
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.

# File 'lib/modulorails/success_data.rb', line 7

def data
  @data
end

#r data(data) ⇒ Object

An object to transport some data (for instance the result of the operation). Defaults to nil.

# File 'lib/modulorails/success_data.rb', line 7

attr_reader :data

Instance Method Details

#success? ⇒ true

Returns A success always means the operation was a success. ;).

Returns:

• (true) —

  A success always means the operation was a success. ;)

# File 'lib/modulorails/success_data.rb', line 15

def success?
  true
end