Class: Boxen::Hook

Inherits:
Object
  • Object
show all
Defined in:
lib/boxen/hook.rb,
lib/boxen/hook/web.rb,
lib/boxen/hook/github_issue.rb

Direct Known Subclasses

GitHubIssue, Web

Defined Under Namespace

Classes: GitHubIssue, Web

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, checkout, puppet, result) ⇒ Hook

Returns a new instance of Hook.



22
23
24
25
26
27
 
# File 'lib/boxen/hook.rb', line 22

def initialize(config, checkout, puppet, result)
  @config   = config
  @checkout = checkout
  @puppet   = puppet
  @result   = result
end

Instance Attribute Details

#checkout ⇒ Object (readonly)

Returns the value of attribute checkout.



4
5
6
 
# File 'lib/boxen/hook.rb', line 4

def checkout
  @checkout
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



3
4
5
 
# File 'lib/boxen/hook.rb', line 3

def config
  @config
end

#puppet ⇒ Object (readonly)

Returns the value of attribute puppet.



5
6
7
 
# File 'lib/boxen/hook.rb', line 5

def puppet
  @puppet
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



6
7
8
 
# File 'lib/boxen/hook.rb', line 6

def result
  @result
end

Class Method Details

.all ⇒ Object 



18
19
20
 
# File 'lib/boxen/hook.rb', line 18

def self.all
  @hooks || []
end

.register(hook) ⇒ Object 



10
11
12
 
# File 'lib/boxen/hook.rb', line 10

def self.register(hook)
  @hooks << hook
end

.unregister(hook) ⇒ Object 



14
15
16
 
# File 'lib/boxen/hook.rb', line 14

def self.unregister(hook)
  @hooks.delete hook
end

Instance Method Details

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
32
33
34
 
# File 'lib/boxen/hook.rb', line 29

def enabled?
  required_vars = Array(required_environment_variables)
  required_vars.any? && required_vars.all? do |var|
    ENV[var] && !ENV[var].empty?
  end
end

#perform? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/boxen/hook.rb', line 36

def perform?
  false
end

#run ⇒ Object 



40
41
42
 
# File 'lib/boxen/hook.rb', line 40

def run
  call if perform?
end