Class: CKick::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/ckick/plugin.rb

Direct Known Subclasses

ClangComplete, GTest

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Plugin

Returns a new instance of Plugin.



8
9
 
# File 'lib/ckick/plugin.rb', line 8

def initialize args
end

Instance Method Details

#call(project) ⇒ Object

Ran after project’s structure creation (create_structure)



32
33
34
 
# File 'lib/ckick/plugin.rb', line 32

def call(project)
  nil
end

#cmake ⇒ Object

Plugin’s output to add to main CMakeLists.txt



22
23
24
 
# File 'lib/ckick/plugin.rb', line 22

def cmake
  ""
end

#include(project) ⇒ Object

Appends project’s includes path before structure creation



37
38
39
 
# File 'lib/ckick/plugin.rb', line 37

def include(project)
  []
end

#lib(project) ⇒ Object

Appends project’s libraries path before structure creation



42
43
44
 
# File 'lib/ckick/plugin.rb', line 42

def lib(project)
  []
end

#name ⇒ Object

Plugin’s name, defaults to class name



12
13
14
 
# File 'lib/ckick/plugin.rb', line 12

def name
  self.class.name
end

#run(project) ⇒ Object

Ran before project’s structure creation



27
28
29
 
# File 'lib/ckick/plugin.rb', line 27

def run(project)
  nil
end

#to_hash ⇒ Object

Plugin to hash is :name => “class name”



17
18
19
 
# File 'lib/ckick/plugin.rb', line 17

def to_hash
  {name: self.class.name}
end