Class: Modulorails::SuccessData

Inherits:
Object
  • Object
show all
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 collapse

Instance Method Summary collapse

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)



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

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

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



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

def data
  @data
end

#r data(data) ⇒ Object

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



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

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. ;)



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

def success?
  true
end