Class: Utils::IRB::Shell::WrapperBase
- Includes:
- Comparable
- Defined in:
- lib/utils/irb.rb
Overview
Base class for wrapping objects with descriptive metadata.
This class provides a foundation for creating wrapper objects that associate descriptive information with underlying objects. It handles name conversion and provides common methods for accessing and comparing wrapped objects.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#description ⇒ String?
(also: #to_str, #inspect, #to_s)
readonly
The description reader method provides access to the description attribute.
-
#name ⇒ String
readonly
The name reader method returns the value of the name instance variable.
Instance Method Summary collapse
-
#<=>(other) ⇒ Integer
The <=> method compares the names of two objects for sorting purposes.
-
#==(name) ⇒ Object
(also: #eql?)
The == method assigns a new name value to the instance variable.
-
#hash ⇒ Integer
The hash method returns the hash value of the name attribute.
-
#initialize(name) ⇒ WrapperBase
constructor
The initialize method sets up the instance name by converting the input to a string representation.
Constructor Details
#initialize(name) ⇒ WrapperBase
The initialize method sets up the instance name by converting the input to a string representation.
This method handles different input types by converting them to a string, prioritizing to_str over to_sym and falling back to to_s if neither is available.
255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/utils/irb.rb', line 255 def initialize(name) @name = case when name.respond_to?(:to_str) name.to_str when name.respond_to?(:to_sym) name.to_sym.to_s else name.to_s end end |
Instance Attribute Details
#description ⇒ String? (readonly) Also known as: to_str, inspect, to_s
The description reader method provides access to the description attribute.
277 278 279 |
# File 'lib/utils/irb.rb', line 277 def description @description end |
#name ⇒ String (readonly)
The name reader method returns the value of the name instance variable.
271 272 273 |
# File 'lib/utils/irb.rb', line 271 def name @name end |
Instance Method Details
#<=>(other) ⇒ Integer
The <=> method compares the names of two objects for sorting purposes.
309 310 311 |
# File 'lib/utils/irb.rb', line 309 def <=>(other) @name <=> other.name end |
#==(name) ⇒ Object Also known as: eql?
The == method assigns a new name value to the instance variable.
290 291 292 |
# File 'lib/utils/irb.rb', line 290 def ==(name) @name = name end |
#hash ⇒ Integer
The hash method returns the hash value of the name attribute.
299 300 301 |
# File 'lib/utils/irb.rb', line 299 def hash @name.hash end |