Class: Livecheck

Inherits:
Object
  • Object
show all
Defined in:
brew/Library/Homebrew/livecheck.rb

Overview

Livecheck can be used to check for newer versions of the software. The livecheck DSL specified in the formula is evaluated the methods of this class, which set the instance variables accordingly. The information is used by brew livecheck when checking for newer versions of the software.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(formula) ⇒ Livecheck

Returns a new instance of Livecheck.



13
14
15
16
17
18
19
20
 
# File 'brew/Library/Homebrew/livecheck.rb', line 13

def initialize(formula)
  @formula = formula
  @regex = nil
  @skip = false
  @skip_msg = nil
  @strategy = nil
  @url = nil
end

Instance Attribute Details

#skip_msg ⇒ Object (readonly)

The reason for skipping livecheck for the formula. e.g. Not maintained



11
12
13
 
# File 'brew/Library/Homebrew/livecheck.rb', line 11

def skip_msg
  @skip_msg
end

Instance Method Details

#regex(pattern = nil) ⇒ Object

Sets the regex instance variable to the argument given, returns the regex instance variable when no argument is given.



24
25
26
27
28
 
# File 'brew/Library/Homebrew/livecheck.rb', line 24

def regex(pattern = nil)
  return @regex if pattern.nil?

  @regex = pattern
end

#skip(skip_msg = nil) ⇒ Object

Sets the skip instance variable to true, indicating that livecheck must be skipped for the formula. If an argument is given and present, its value is assigned to the skip_msg instance variable, else nil is assigned.



34
35
36
37
 
# File 'brew/Library/Homebrew/livecheck.rb', line 34

def skip(skip_msg = nil)
  @skip = true
  @skip_msg = skip_msg.presence
end

#skip? ⇒ Boolean

Should livecheck be skipped for the formula?

Returns:

  • (Boolean) 


40
41
42
 
# File 'brew/Library/Homebrew/livecheck.rb', line 40

def skip?
  @skip
end

#strategy(symbol = nil) ⇒ Object

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: nil) —

    symbol for the desired strategy



49
50
51
52
53
54
55
56
57
58
 
# File 'brew/Library/Homebrew/livecheck.rb', line 49

def strategy(symbol = nil)
  case symbol
  when nil
    @strategy
  when Symbol
    @strategy = symbol
  else
    raise TypeError, "Livecheck#strategy expects a Symbol"
  end
end

#to_hash ⇒ Object

Returns a Hash of all instance variable values.



76
77
78
79
80
81
82
83
84
 
# File 'brew/Library/Homebrew/livecheck.rb', line 76

def to_hash
  {
    "regex"    => @regex,
    "skip"     => @skip,
    "skip_msg" => @skip_msg,
    "strategy" => @strategy,
    "url"      => @url,
  }
end

#url(val = nil) ⇒ Object

Sets the url instance variable to the argument given, returns the url instance variable when no argument is given.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'brew/Library/Homebrew/livecheck.rb', line 62

def url(val = nil)
  return @url if val.nil?

  @url = case val
  when :head, :stable, :devel
    @formula.send(val).url
  when :homepage
    @formula.homepage
  else
    val
  end
end