Class: Yap::Addon::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/yap/addon/base.rb

Direct Known Subclasses

RcFile

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: true) ⇒ Base

Returns a new instance of Base.



43
44
45
 
# File 'lib/yap/addon/base.rb', line 43

def initialize(enabled: true)
  @yap_enabled = enabled
end

Class Method Details

.addon_name ⇒ Object 



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/yap/addon/base.rb', line 8

def self.addon_name
  @addon_name ||= begin
    addon_name = self.name.split(/::/)
      .last.scan(/[A-Z][^A-Z]+/)
      .map(&:downcase).reject{ |f| f == "addon" }
      .join("_")
      .to_sym
    addon_name.length == 0 ? self.name : addon_name
  end
end

.export_as(name = nil) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/yap/addon/base.rb', line 19

def self.export_as(name=nil)
  if name
    @export_as = name.to_sym
  end
  @export_as
end

.load_addon ⇒ Object 



4
5
6
 
# File 'lib/yap/addon/base.rb', line 4

def self.load_addon
  @instance ||= new
end

.logger ⇒ Object 



26
27
28
29
 
# File 'lib/yap/addon/base.rb', line 26

def self.logger
  calling_method = caller[1][/`.*'/][1..-2]
  Treefell["addon:#{export_as}"]["#{name}##{calling_method}"]
end

Instance Method Details

#addon_name ⇒ Object 



31
32
33
 
# File 'lib/yap/addon/base.rb', line 31

def addon_name
  @addon_name ||= self.class.addon_name
end

#export_as ⇒ Object 



39
40
41
 
# File 'lib/yap/addon/base.rb', line 39

def export_as
  self.class.export_as
end

#logger ⇒ Object 



35
36
37
 
# File 'lib/yap/addon/base.rb', line 35

def logger
  self.class.logger
end

#yap_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/yap/addon/base.rb', line 47

def yap_enabled?
  @yap_enabled
end