Class: Factorix::Dependency::ValidationResult

Inherits:

Object

• Object
• Factorix::Dependency::ValidationResult

Defined in:

lib/factorix/dependency/validation_result.rb

Overview

Represents the result of MOD dependency validation

Holds errors and warnings found during validation.

Defined Under Namespace

Classes: Error, Suggestion, Warning

Constant Summary

MISSING_DEPENDENCY =

Error types

:missing_dependency

DISABLED_DEPENDENCY =

:disabled_dependency

VERSION_MISMATCH =

:version_mismatch

CONFLICT =

:conflict

CIRCULAR_DEPENDENCY =

:circular_dependency

MOD_IN_LIST_NOT_INSTALLED =

Warning types

:mod_in_list_not_installed

MOD_INSTALLED_NOT_IN_LIST =

:mod_installed_not_in_list

Instance Attribute Summary

• #dependency ⇒ Factorix::MOD^? readonly

  Dependency MOD.

• #errors ⇒ Array<Error> readonly

  Get all errors.

• #message ⇒ String readonly

  Suggestion message.

• #mod ⇒ Factorix::MOD readonly

  Related MOD.

• #suggestions ⇒ Array<Suggestion> readonly

  Get all suggestions.

• #type ⇒ Symbol readonly

  Warning type.

• #version ⇒ Factorix::MODVersion readonly

  Suggested version.

• #warnings ⇒ Array<Warning> readonly

  Get all warnings.

Instance Method Summary

• #add_error(type:, message:, mod: nil, dependency: nil) ⇒ void

  Add an error.

• #add_suggestion(message:, mod:, version:) ⇒ void

  Add a suggestion.

• #add_warning(type:, message:, mod: nil) ⇒ void

  Add a warning.

• #errors? ⇒ Boolean

  Check if there are any errors.

• #initialize ⇒ ValidationResult constructor

  A new instance of ValidationResult.

• #suggestions? ⇒ Boolean

  Check if there are any suggestions.

• #valid? ⇒ Boolean

  Check if validation passed (no errors).

• #warnings? ⇒ Boolean

  Check if there are any warnings.

Constructor Details

#initialize ⇒ ValidationResult

Returns a new instance of ValidationResult.

# File 'lib/factorix/dependency/validation_result.rb', line 71

def initialize
  @errors = []
  @warnings = []
  @suggestions = []
end

Instance Attribute Details

#dependency ⇒ Factorix::MOD^? (readonly)

Returns dependency MOD.

Returns:

• (Factorix::MOD, nil) —

  dependency MOD

# File 'lib/factorix/dependency/validation_result.rb', line 15

#errors ⇒ Array<Error> (readonly)

Get all errors

Returns:

• (Array<Error>)

# File 'lib/factorix/dependency/validation_result.rb', line 105

def errors
  @errors
end

#message ⇒ String (readonly)

Returns suggestion message.

Returns:

• (String) —

  suggestion message

# File 'lib/factorix/dependency/validation_result.rb', line 15

#mod ⇒ Factorix::MOD (readonly)

Returns related MOD.

Returns:

• (Factorix::MOD) —

  related MOD

# File 'lib/factorix/dependency/validation_result.rb', line 15

#suggestions ⇒ Array<Suggestion> (readonly)

Get all suggestions

Returns:

• (Array<Suggestion>)

# File 'lib/factorix/dependency/validation_result.rb', line 115

def suggestions
  @suggestions
end

#type ⇒ Symbol (readonly)

Returns warning type.

Returns:

• (Symbol) —

  warning type

# File 'lib/factorix/dependency/validation_result.rb', line 15

#version ⇒ Factorix::MODVersion (readonly)

Returns suggested version.

Returns:

• (Factorix::MODVersion) —

  suggested version

# File 'lib/factorix/dependency/validation_result.rb', line 45

#warnings ⇒ Array<Warning> (readonly)

Get all warnings

Returns:

• (Array<Warning>)

# File 'lib/factorix/dependency/validation_result.rb', line 110

def warnings
  @warnings
end

Instance Method Details

#add_error(type:, message:, mod: nil, dependency: nil) ⇒ void

This method returns an undefined value.

Add an error

Parameters:

• type (Symbol) —

  Error type

• message (String) —

  Error message

• mod (Factorix::MOD, nil) (defaults to: nil) —

  Related MOD

• dependency (Factorix::MOD, nil) (defaults to: nil) —

  Dependency MOD

# File 'lib/factorix/dependency/validation_result.rb', line 84

def add_error(type:, message:, mod: nil, dependency: nil) = @errors << Error[type:, message:, mod:, dependency:]

#add_suggestion(message:, mod:, version:) ⇒ void

This method returns an undefined value.

Add a suggestion

Parameters:

• message (String) —

  Suggestion message

• mod (Factorix::MOD) —

  Related MOD

• version (Factorix::MODVersion) —

  Suggested version

# File 'lib/factorix/dependency/validation_result.rb', line 100

def add_suggestion(message:, mod:, version:) = @suggestions << Suggestion[message:, mod:, version:]

#add_warning(type:, message:, mod: nil) ⇒ void

This method returns an undefined value.

Add a warning

Parameters:

• type (Symbol) —

  Warning type

• message (String) —

  Warning message

• mod (Factorix::MOD, nil) (defaults to: nil) —

  Related MOD

# File 'lib/factorix/dependency/validation_result.rb', line 92

def add_warning(type:, message:, mod: nil) = @warnings << Warning[type:, message:, mod:]

#errors? ⇒ Boolean

Check if there are any errors

Returns:

• (Boolean)

# File 'lib/factorix/dependency/validation_result.rb', line 120

def errors? = !@errors.empty?

#suggestions? ⇒ Boolean

Check if there are any suggestions

Returns:

• (Boolean)

# File 'lib/factorix/dependency/validation_result.rb', line 130

def suggestions? = !@suggestions.empty?

#valid? ⇒ Boolean

Check if validation passed (no errors)

Returns:

• (Boolean)

# File 'lib/factorix/dependency/validation_result.rb', line 135

def valid? = !errors?

#warnings? ⇒ Boolean

Check if there are any warnings

Returns:

• (Boolean)

# File 'lib/factorix/dependency/validation_result.rb', line 125

def warnings? = !@warnings.empty?