Class: Dry::CLI::Parser::Result Private

Inherits:
Object
  • Object
show all
Defined in:
lib/dry/cli/parser.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.

Since:

  • 0.1.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments: {}, error: nil, help: false) ⇒ Result

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 Result.

Since:

  • 0.1.0



118
119
120
121
122
 
# File 'lib/dry/cli/parser.rb', line 118

def initialize(arguments: {}, error: nil, help: false)
  @arguments = arguments
  @error     = error
  @help      = help
end

Instance Attribute Details

#arguments ⇒ Object (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.

Since:

  • 0.1.0



110
111
112
 
# File 'lib/dry/cli/parser.rb', line 110

def arguments
  @arguments
end

#error ⇒ Object (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.

Since:

  • 0.1.0



114
115
116
 
# File 'lib/dry/cli/parser.rb', line 114

def error
  @error
end

Class Method Details

.failure(error = "Error: Invalid param provided") ⇒ Object

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.

Since:

  • 0.1.0



104
105
106
 
# File 'lib/dry/cli/parser.rb', line 104

def self.failure(error = "Error: Invalid param provided")
  new(error: error)
end

.help ⇒ Object

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.

Since:

  • 0.1.0



92
93
94
 
# File 'lib/dry/cli/parser.rb', line 92

def self.help
  new(help: true)
end

.success(arguments = {}) ⇒ Object

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.

Since:

  • 0.1.0



98
99
100
 
# File 'lib/dry/cli/parser.rb', line 98

def self.success(arguments = {})
  new(arguments: arguments)
end

Instance Method Details

#error? ⇒ Boolean

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:

  • (Boolean)

Since:

  • 0.1.0



126
127
128
 
# File 'lib/dry/cli/parser.rb', line 126

def error?
  !error.nil?
end

#help? ⇒ Boolean

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:

  • (Boolean)

Since:

  • 0.1.0



132
133
134
 
# File 'lib/dry/cli/parser.rb', line 132

def help?
  @help
end