Class: Boxen::Hook
- Inherits:
-
Object
- Object
- Boxen::Hook
- Defined in:
- lib/boxen/hook.rb,
lib/boxen/hook/web.rb,
lib/boxen/hook/github_issue.rb
Direct Known Subclasses
Defined Under Namespace
Classes: GitHubIssue, Web
Instance Attribute Summary collapse
-
#checkout ⇒ Object
readonly
Returns the value of attribute checkout.
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#puppet ⇒ Object
readonly
Returns the value of attribute puppet.
-
#result ⇒ Object
readonly
Returns the value of attribute result.
Class Method Summary collapse
Instance Method Summary collapse
- #enabled? ⇒ Boolean
-
#initialize(config, checkout, puppet, result) ⇒ Hook
constructor
A new instance of Hook.
- #perform? ⇒ Boolean
- #run ⇒ Object
Constructor Details
#initialize(config, checkout, puppet, result) ⇒ Hook
Returns a new instance of Hook.
15 16 17 18 19 20 |
# File 'lib/boxen/hook.rb', line 15 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
Instance Method Details
#enabled? ⇒ Boolean
22 23 24 25 26 27 |
# File 'lib/boxen/hook.rb', line 22 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
29 30 31 |
# File 'lib/boxen/hook.rb', line 29 def perform? false end |
#run ⇒ Object
33 34 35 |
# File 'lib/boxen/hook.rb', line 33 def run call if perform? end |