Class: LcpRuby::Actions::Result

Inherits:
Data
  • Object
show all
Defined in:
lib/lcp_ruby/actions/base_action.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type: :success, success:, message: nil, redirect_to: nil, data: nil, errors: []) ⇒ Result

Returns a new instance of Result.



61
62
63
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 61

def initialize(type: :success, success:, message: nil, redirect_to: nil, data: nil, errors: [])
  super(type:, success:, message:, redirect_to:, data:, errors:)
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data

Returns:

  • (Object) —

    the current value of data



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def data
  @data
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors

Returns:

  • (Object) —

    the current value of errors



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def errors
  @errors
end

#message ⇒ Object (readonly)

Returns the value of attribute message

Returns:

  • (Object) —

    the current value of message



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def message
  @message
end

#redirect_to ⇒ Object (readonly)

Returns the value of attribute redirect_to

Returns:

  • (Object) —

    the current value of redirect_to



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def redirect_to
  @redirect_to
end

#success ⇒ Object (readonly)

Returns the value of attribute success

Returns:

  • (Object) —

    the current value of success



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def success
  @success
end

#type ⇒ Object (readonly)

Returns the value of attribute type

Returns:

  • (Object) —

    the current value of type



60
61
62
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 60

def type
  @type
end

Class Method Details

.unauthorized ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 65

def self.unauthorized
  new(
    success: false,
    message: I18n.t("lcp_ruby.actions.not_authorized", default: "Not authorized to execute this action"),
    errors: [ "unauthorized" ]
  )
end

Instance Method Details

#continue? ⇒ Boolean

Returns:

  • (Boolean) 


75
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 75

def continue? = type == :continue

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


74
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 74

def failure? = !success

#file_download? ⇒ Boolean

Returns:

  • (Boolean) 


76
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 76

def file_download? = type == :file_download

#success? ⇒ Boolean

Returns:

  • (Boolean) 


73
 
# File 'lib/lcp_ruby/actions/base_action.rb', line 73

def success? = success