Class: Decode::Definition

Inherits:
Object
  • Object
show all
Defined in:
lib/decode/definition.rb

Overview

A symbol with attached documentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, parent: nil, language: parent.language, comments: nil) ⇒ Definition

Initialize the symbol.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/decode/definition.rb', line 29

def initialize(name, parent: nil, language: parent.language, comments: nil)
  @name = name
  
  @comments = comments
  @language = language
  @parent = parent
  
  @path = nil
  @qualified_name = nil
  @documentation = nil
end

Instance Attribute Details

#comments ⇒ Object (readonly)

The comment lines which directly preceeded the definition.



57
58
59
 
# File 'lib/decode/definition.rb', line 57

def comments
  @comments
end

#language ⇒ Object (readonly)

The language the symbol is defined within.



53
54
55
 
# File 'lib/decode/definition.rb', line 53

def language
  @language
end

#name ⇒ Object (readonly)

The symbol name. e.g. ‘:Decode`.



47
48
49
 
# File 'lib/decode/definition.rb', line 47

def name
  @name
end

#parent ⇒ Object (readonly)

The parent symbol, defining lexical scope.



50
51
52
 
# File 'lib/decode/definition.rb', line 50

def parent
  @parent
end

Instance Method Details

#container? ⇒ Boolean

Whether this definition can contain nested definitions.

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/decode/definition.rb', line 142

def container?
  false
end

#convert(kind) ⇒ Object

Convert this definition into another kind of definition.

Raises:

  • (ArgumentError) 


82
83
84
 
# File 'lib/decode/definition.rb', line 82

def convert(kind)
  raise ArgumentError, "Unable to convert #{self} into #{kind}!"
end

#documentation ⇒ Object

Structured access to the definitions comments.



156
157
158
159
160
 
# File 'lib/decode/definition.rb', line 156

def documentation
  if @comments&.any?
    @documentation ||= Documentation.new(@comments, @language)
  end
end

#long_form ⇒ Object

A long form of the definition. e.g. ‘def initialize(kind, name, comments, **options)`.



114
115
116
 
# File 'lib/decode/definition.rb', line 114

def long_form
  self.short_form
end

#multiline? ⇒ Boolean

Whether the definition spans multiple lines.

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/decode/definition.rb', line 129

def multiline?
  false
end

#nested? ⇒ Boolean

Whether this represents a single entity to be documented (along with it’s contents).

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/decode/definition.rb', line 149

def nested?
  container?
end

#nested_name ⇒ Object

The name of this definition plus the nesting prefix.



73
74
75
 
# File 'lib/decode/definition.rb', line 73

def nested_name
  "::#{@name}"
end

#path ⇒ Object Also known as: lexical_path

The lexical scope which is an array of lexical Key instances as generated by key.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/decode/definition.rb', line 88

def path
  if @path
    # Cached version:
    @path
  elsif @parent
    # Merge with parent:
    @path = [*@parent.path, @name].freeze
  else
    # At top:
    @path = [@name].freeze
  end
end

#qualified_form ⇒ Object

A long form which uses the qualified name if possible. Defaults to #long_form.



122
123
124
 
# File 'lib/decode/definition.rb', line 122

def qualified_form
  self.long_form
end

#qualified_name ⇒ Object

The qualified name is an absolute name which includes any and all namespacing.



61
62
63
64
65
66
67
68
69
 
# File 'lib/decode/definition.rb', line 61

def qualified_name
  @qualified_name ||= begin
    if @parent
      @parent.qualified_name + self.nested_name
    else
      @name.to_s
    end
  end
end

#short_form ⇒ Object

A short form of the definition. e.g. ‘def short_form`.



107
108
 
# File 'lib/decode/definition.rb', line 107

def short_form
end

#start_with?(prefix) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/decode/definition.rb', line 77

def start_with?(prefix)
  self.nested_name.start_with?(prefix)
end

#text ⇒ Object

The full text of the definition.



136
137
 
# File 'lib/decode/definition.rb', line 136

def text
end

#to_s ⇒ Object 



41
42
43
 
# File 'lib/decode/definition.rb', line 41

def to_s
  "\#<#{self.class} #{qualified_name}>"
end