Class: Shomen::Model::Module

Inherits:
Abstract show all
Defined in:
lib/shomen/model/module.rb

Direct Known Subclasses

Class

Instance Attribute Summary collapse

Attributes inherited from Abstract

#path, #tags

Class Method Summary collapse

Methods inherited from Abstract

#initialize, #type

Methods inherited from AbstractPrime

#[], #[]=, attr_accessor, #initialize, #to_h

Constructor Details

This class inherits a constructor from Shomen::Model::Abstract

Instance Attribute Details

#accessorsObject

List of attributes.



45
46
47
# File 'lib/shomen/model/module.rb', line 45

def accessors
  @accessors
end

#classesObject

Returns the value of attribute classes.



39
40
41
# File 'lib/shomen/model/module.rb', line 39

def classes
  @classes
end

#commentObject

Comment associated with module.



21
22
23
# File 'lib/shomen/model/module.rb', line 21

def comment
  @comment
end

#constantsObject

Constants defined within this module.



33
34
35
# File 'lib/shomen/model/module.rb', line 33

def constants
  @constants
end

#extensionsObject

Metaclass mixins.



30
31
32
# File 'lib/shomen/model/module.rb', line 30

def extensions
  @extensions
end

#filesObject

The files in which the module is defined.



48
49
50
# File 'lib/shomen/model/module.rb', line 48

def files
  @files
end

#formatObject

Format of comment (rdoc, markdown or plain).



24
25
26
# File 'lib/shomen/model/module.rb', line 24

def format
  @format
end

#includesObject

Mixins.



27
28
29
# File 'lib/shomen/model/module.rb', line 27

def includes
  @includes
end

#methodsObject

List of instance methods defined in the module.



42
43
44
# File 'lib/shomen/model/module.rb', line 42

def methods
  @methods
end

#modulesObject

Returns the value of attribute modules.



36
37
38
# File 'lib/shomen/model/module.rb', line 36

def modules
  @modules
end

#nameObject

Method’s name.



14
15
16
# File 'lib/shomen/model/module.rb', line 14

def name
  @name
end

#namespaceObject

Namespace of module is the path of the class or module containing this module.



18
19
20
# File 'lib/shomen/model/module.rb', line 18

def namespace
  @namespace
end

Class Method Details

.typeObject



11
# File 'lib/shomen/model/module.rb', line 11

def self.type; 'module'; end