Class: Livecheck Private

Inherits:
Object show all
Extended by:
Forwardable
Defined in:
livecheck.rb,
sorbet/rbi/dsl/livecheck.rbi

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.

The Livecheck class implements the DSL methods used in a formula's, cask's or resource's livecheck block and stores related instance variables. Most of these methods also return the related instance variable when no argument is provided.

This information is used by the brew livecheck command to control its behavior. Example livecheck blocks can be found in the brew livecheck documentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(package_or_resource) ⇒ void

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.

Parameters:



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'livecheck.rb', line 24

def initialize(package_or_resource)
  @package_or_resource = package_or_resource
  @referenced_cask_name = T.let(nil, T.nilable(String))
  @referenced_formula_name = T.let(nil, T.nilable(String))
  @regex = T.let(nil, T.nilable(Regexp))
  @skip = T.let(false, T::Boolean)
  @skip_msg = T.let(nil, T.nilable(String))
  @strategy = T.let(nil, T.nilable(Symbol))
  @strategy_block = T.let(nil, T.nilable(Proc))
  @throttle = T.let(nil, T.nilable(Integer))
  @url = T.let(nil, T.any(NilClass, String, Symbol))
end

Instance Attribute Details

#skip_msg ⇒ String? (readonly)

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.

A very brief description of why the formula/cask/resource is skipped (e.g. No longer developed or maintained).

Returns:



21
22
23
 
# File 'livecheck.rb', line 21

def skip_msg
  @skip_msg
end

#strategy_block ⇒ Proc? (readonly)

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:

  • (Proc, nil) 


138
139
140
 
# File 'livecheck.rb', line 138

def strategy_block
  @strategy_block
end

Instance Method Details

#cask(cask_name = T.unsafe(nil)) ⇒ String?

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.

Sets the @referenced_cask_name instance variable to the provided String or returns the @referenced_cask_name instance variable when no argument is provided. Inherited livecheck values from the referenced cask (e.g. regex) can be overridden in the livecheck block.

Parameters:

  • cask_name (String) (defaults to: T.unsafe(nil))

Returns:



47
48
49
50
51
52
53
54
 
# File 'livecheck.rb', line 47

def cask(cask_name = T.unsafe(nil))
  case cask_name
  when nil
    @referenced_cask_name
  when String
    @referenced_cask_name = cask_name
  end
end

#formula(formula_name = T.unsafe(nil)) ⇒ String?

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.

Sets the @referenced_formula_name instance variable to the provided String or returns the @referenced_formula_name instance variable when no argument is provided. Inherited livecheck values from the referenced formula (e.g. regex) can be overridden in the livecheck block.

Parameters:

  • formula_name (String) (defaults to: T.unsafe(nil))

Returns:



66
67
68
69
70
71
72
73
 
# File 'livecheck.rb', line 66

def formula(formula_name = T.unsafe(nil))
  case formula_name
  when nil
    @referenced_formula_name
  when String
    @referenced_formula_name = formula_name
  end
end

#regex(pattern = T.unsafe(nil)) ⇒ Regexp?

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.

Sets the @regex instance variable to the provided Regexp or returns the @regex instance variable when no argument is provided.

Parameters:

  • pattern (Regexp) (defaults to: T.unsafe(nil))

Returns:

  • (Regexp, nil) 


83
84
85
86
87
88
89
90
 
# File 'livecheck.rb', line 83

def regex(pattern = T.unsafe(nil))
  case pattern
  when nil
    @regex
  when Regexp
    @regex = pattern
  end
end

#skip(skip_msg = T.unsafe(nil)) ⇒ Boolean

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.

Sets the @skip instance variable to true and sets the @skip_msg instance variable if a String is provided. @skip is used to indicate that the formula/cask/resource should be skipped and the skip_msg very briefly describes why it is skipped (e.g. "No longer developed or maintained").

Parameters:

  • skip_msg (String) (defaults to: T.unsafe(nil))

Returns:

  • (Boolean) 


103
104
105
106
107
 
# File 'livecheck.rb', line 103

def skip(skip_msg = T.unsafe(nil))
  @skip_msg = skip_msg if skip_msg.is_a?(String)

  @skip = true
end

#skip? ⇒ Boolean

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.

Should livecheck skip this formula/cask/resource?

Returns:

  • (Boolean) 


111
112
113
 
# File 'livecheck.rb', line 111

def skip?
  @skip
end

#strategy(symbol = T.unsafe(nil), &block) ⇒ Symbol?

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.

Sets the @strategy instance variable to the provided Symbol or returns the @strategy instance variable when no argument is provided. The strategy symbols use snake case (e.g. :page_match) and correspond to the strategy file name.

Parameters:

  • symbol (Symbol) (defaults to: T.unsafe(nil))
  • block (Proc, nil)

Returns:



126
127
128
129
130
131
132
133
134
135
 
# File 'livecheck.rb', line 126

def strategy(symbol = T.unsafe(nil), &block)
  @strategy_block = block if block

  case symbol
  when nil
    @strategy
  when Symbol
    @strategy = symbol
  end
end

#throttle(rate = T.unsafe(nil)) ⇒ Integer?

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.

Sets the @throttle instance variable to the provided Integer or returns the @throttle instance variable when no argument is provided.

Parameters:

  • rate (Integer) (defaults to: T.unsafe(nil))

Returns:

  • (Integer, nil) 


148
149
150
151
152
153
154
155
 
# File 'livecheck.rb', line 148

def throttle(rate = T.unsafe(nil))
  case rate
  when nil
    @throttle
  when Integer
    @throttle = rate
  end
end

#to_hash ⇒ Hash{String => T.untyped}

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 Hash of all instance variable values.

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'livecheck.rb', line 184

def to_hash
  {
    "cask"     => @referenced_cask_name,
    "formula"  => @referenced_formula_name,
    "regex"    => @regex,
    "skip"     => @skip,
    "skip_msg" => @skip_msg,
    "strategy" => @strategy,
    "throttle" => @throttle,
    "url"      => @url,
  }
end

#url(url = T.unsafe(nil)) ⇒ String, ...

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.

Sets the @url instance variable to the provided argument or returns the @url instance variable when no argument is provided. The argument can be a String (a URL) or a supported Symbol corresponding to a URL in the formula/cask/resource (e.g. :stable, :homepage, :head, :url).

Parameters:

Returns:



167
168
169
170
171
172
173
174
175
176
 
# File 'livecheck.rb', line 167

def url(url = T.unsafe(nil))
  case url
  when nil
    @url
  when String, :head, :homepage, :stable, :url
    @url = url
  when Symbol
    raise ArgumentError, "#{url.inspect} is not a valid URL shorthand"
  end
end