Class: Cask::DSL::Caveats Private

Inherits:
Base
  • Object
show all
Extended by:
Predicable
Defined in:
cask/dsl/caveats.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Class corresponding to the caveats stanza.

Each method should handle output, following the convention of at least one trailing blank line so that the user can distinguish separate caveats.

The return value of the last method in the block is also sent to the output by the caller, but that feature is only for the convenience of cask authors.

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Methods inherited from Base

#method_missing, #system_command

Constructor Details

#initialize(*args) ⇒ Caveats

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a new instance of Caveats.



22
23
24
25
26
27
 
# File 'cask/dsl/caveats.rb', line 22

def initialize(*args)
  super(*args)
  @built_in_caveats = {}
  @custom_caveats = []
  @discontinued = false
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Cask::DSL::Base

Instance Method Details

#eval_caveats(&block) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



50
51
52
53
54
55
56
 
# File 'cask/dsl/caveats.rb', line 50

def eval_caveats(&block)
  result = instance_eval(&block)
  return unless result
  return if result == :built_in_caveat

  @custom_caveats << result.to_s.sub(/\s*\Z/, "\n")
end

#puts(*args) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Override puts to collect caveats.



45
46
47
48
 
# File 'cask/dsl/caveats.rb', line 45

def puts(*args)
  @custom_caveats += args
  :built_in_caveat
end

#to_s ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



40
41
42
 
# File 'cask/dsl/caveats.rb', line 40

def to_s
  (@custom_caveats + @built_in_caveats.values).join("\n")
end