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



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

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



117
118
119
 
# File 'lib/dry/cli/parser.rb', line 117

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



121
122
123
 
# File 'lib/dry/cli/parser.rb', line 121

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



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

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



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

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



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

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.

Since:

  • 0.1.0



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

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.

Since:

  • 0.1.0



139
140
141
 
# File 'lib/dry/cli/parser.rb', line 139

def help?
  @help
end