Spec-Zone.ru › Homebrew

Класс: Livecheck Приватный

Наследует:
Object
  • Object
  • Livecheck
показать все
Расширен модулем:
Forwardable
Определён в:
livecheck.rb,
sorbet/rbi/dsl/livecheck.rbi

Обзор

Этот класс является частью приватного API. Этот класс можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого класса, так как он может быть удалён или изменён без предупреждения.

Класс Livecheck реализует методы DSL, используемые в блоке livecheck формулы, cask-пакета или ресурса, и хранит связанные переменные экземпляра. Большинство этих методов также возвращают соответствующую переменную экземпляра, если аргумент не указан.

Эта информация используется командой brew livecheck для управления её поведением. Примеры блоков livecheck можно найти в документации brew livecheck.

Краткое описание атрибутов экземпляра свернуть

  • #options ⇒ Homebrew::Livecheck::Options только для чтения приватный

    Параметры для изменения поведения livecheck.
  • #skip_msg ⇒ String? только для чтения приватный

    Краткое описание причины пропуска формулы/cask-пакета/ресурса (например, No longer developed or maintained).
  • #strategy_block ⇒ Proc? только для чтения приватный

    Блок, используемый стратегиями для определения сведений о версии.
  • #throttle_days ⇒ Integer? только для чтения приватный

    Количество дней после последнего обновления версии, по истечении которых можно сообщить о новой версии.

Краткое описание методов экземпляра свернуть

  • #cask(cask_name = T.unsafe(nil)) ⇒ String? приватный

    Устанавливает переменную экземпляра @referenced_cask_name в переданное значение String или возвращает переменную экземпляра @referenced_cask_name, если аргумент не указан.
  • #formula(formula_name = T.unsafe(nil)) ⇒ String, ... приватный

    Устанавливает переменную экземпляра @referenced_formula_name в переданное значение String/Symbol или возвращает переменную экземпляра @referenced_formula_name, если аргумент не указан.
  • #initialize(package_or_resource) ⇒ void конструктор приватный
  • #regex(pattern = T.unsafe(nil)) ⇒ Regexp? приватный

    Устанавливает переменную экземпляра @regex в переданное значение Regexp или возвращает переменную экземпляра @regex, если аргумент не указан.
  • #skip(skip_msg = T.unsafe(nil)) ⇒ Boolean приватный

    Устанавливает переменную экземпляра @skip в значение true и устанавливает переменную экземпляра @skip_msg, если предоставлено значение String.
  • #skip? ⇒ Boolean приватный

    Следует ли livecheck пропустить эту формулу/cask-пакет/ресурс?
  • #strategy(symbol = T.unsafe(nil), &block) ⇒ Symbol? приватный

    Устанавливает переменную экземпляра @strategy в переданное значение Symbol или возвращает переменную экземпляра @strategy, если аргумент не указан.
  • #throttle(rate = T.unsafe(nil), days: nil) ⇒ Integer? приватный

    Устанавливает переменную экземпляра @throttle в переданное значение Integer или возвращает переменную экземпляра @throttle, если аргумент не указан.
  • #to_hash ⇒ Hash{String => T.untyped} приватный

    Возвращает Hash всех значений переменных экземпляра.
  • #url(url = T.unsafe(nil), compressed: nil, cookies: nil, header: nil, homebrew_curl: nil, post_form: nil, post_json: nil, referer: nil, user_agent: nil) ⇒ String, ... приватный

    Устанавливает переменную экземпляра @url в переданный аргумент или возвращает переменную экземпляра @url, если аргумент не указан.
  • #url_options(*args, &block) ⇒ T.untyped приватный

Подробное описание конструкторов

#initialize(package_or_resource) ⇒ void

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.

Параметры:

  • package_or_resource (Cask::Cask, T.class_of(Formula), Resource) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'livecheck.rb', line 38

def initialize(package_or_resource)
  @package_or_resource = package_or_resource
  @options = T.let(Homebrew::Livecheck::Options.new, Homebrew::Livecheck::Options)
  @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))
  @throttle_days = T.let(nil, T.nilable(Integer))
  @url = T.let(nil, T.nilable(T.any(String, Symbol)))
end

Подробное описание атрибутов экземпляра

#options ⇒ Homebrew::Livecheck::Options (только для чтения)

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.

Параметры для изменения поведения livecheck.

Возвращает:

  • (Homebrew::Livecheck::Options) 


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

def options
  @options
end

#skip_msg ⇒ String? (только для чтения)

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.

Краткое описание причины пропуска формулы/cask-пакета/ресурса (например, No longer developed or maintained).

Возвращает:

  • (String, nil) 


26
27
28
 
# File 'livecheck.rb', line 26

def skip_msg
  @skip_msg
end

#strategy_block ⇒ Proc? (только для чтения)

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.

Блок, используемый стратегиями для определения сведений о версии.

Возвращает:

  • (Proc, nil) 


30
31
32
 
# File 'livecheck.rb', line 30

def strategy_block
  @strategy_block
end

#throttle_days ⇒ Integer? (только для чтения)

Этот метод является частью приватного API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.

Количество дней после последнего обновления версии, по истечении которых можно сообщить о новой версии.

Возвращает:

  • (Integer, nil) 


35
36
37
 
# File 'livecheck.rb', line 35

def throttle_days
  @throttle_days
end

Подробное описание методов экземпляра

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

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @referenced_cask_name в указанное значение String или возвращает переменную экземпляра @referenced_cask_name, если аргумент не передан. Унаследованные значения livecheck из указанного cask (например, регулярное выражение) можно переопределить в блоке livecheck.

Параметры:

  • cask_name (String) (по умолчанию: T.unsafe(nil))

Возвращает:

  • (String, nil) 


63
64
65
66
67
68
69
70
 
# File 'livecheck.rb', line 63

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, ...

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @referenced_formula_name в указанное значение String/Symbol или возвращает переменную экземпляра @referenced_formula_name, если аргумент не передан. Унаследованные значения livecheck из указанной formula (например, регулярное выражение) можно переопределить в блоке livecheck.

Параметры:

  • formula_name (String, Symbol) (по умолчанию: T.unsafe(nil))

Возвращает:

  • (String, Symbol, nil) 


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

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

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

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @regex в указанное значение Regexp или возвращает переменную экземпляра @regex, если аргумент не передан.

Параметры:

  • pattern (Regexp) (по умолчанию: T.unsafe(nil))

Возвращает:

  • (Regexp, nil) 


99
100
101
102
103
104
105
106
 
# File 'livecheck.rb', line 99

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

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

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @skip в значение true и устанавливает переменную экземпляра @skip_msg, если указано значение String. @skip используется, чтобы указать, что formula/cask/ресурс следует пропустить, а skip_msg кратко объясняет причину пропуска (например, «Больше не разрабатывается и не поддерживается»).

Параметры:

  • skip_msg (String) (по умолчанию: T.unsafe(nil))

Возвращает:

  • (Boolean) 


119
120
121
122
123
 
# File 'livecheck.rb', line 119

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

  @skip = true
end

#skip? ⇒ Boolean

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Следует ли livecheck пропустить эту formula/cask/ресурс?

Возвращает:

  • (Boolean) 


127
128
129
 
# File 'livecheck.rb', line 127

def skip?
  @skip
end

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

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @strategy в указанное значение Symbol или возвращает переменную экземпляра @strategy, если аргумент не передан. Символы стратегий записываются в формате snake_case (например, :page_match) и соответствуют имени файла стратегии.

Параметры:

  • symbol (Symbol) (по умолчанию: T.unsafe(nil))
  • block (Proc, nil)

Возвращает:

  • (Symbol, nil) 


142
143
144
145
146
147
148
149
150
151
 
# File 'livecheck.rb', line 142

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), days: nil) ⇒ Integer?

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @throttle в указанное значение Integer или возвращает переменную экземпляра @throttle, если аргумент не передан. Аргумент days задаёт @throttle_days.

Если указаны и интервал ограничения частоты, и количество дней, количество дней используется как запасной вариант, если новая версия с ограничением частоты не появляется до окончания интервала ограничения.

Параметры:

  • rate (Integer) (по умолчанию: T.unsafe(nil))
  • days (Integer, nil) (по умолчанию: nil)

Возвращает:

  • (Integer, nil) 


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

def throttle(rate = T.unsafe(nil), days: nil)
  @throttle_days = days unless days.nil?

  case rate
  when nil
    @throttle
  when Integer
    @throttle = rate
  end
end

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

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Возвращает Hash всех значений переменных экземпляра.

Возвращает:

  • (Hash{String => T.untyped}) 


241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'livecheck.rb', line 241

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

#url(url = T.unsafe(nil), compressed: nil, cookies: nil, header: nil, homebrew_curl: nil, post_form: nil, post_json: nil, referer: nil, user_agent: nil) ⇒ String, ...

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Устанавливает переменную экземпляра @url в переданный аргумент или возвращает переменную экземпляра @url, если аргумент не передан. Аргументом может быть String (URL) или поддерживаемое Symbol, соответствующее URL в formula/cask/ресурсе (например, :stable, :homepage, :head, :url). Все параметры, переданные методу, передаются методам Strategy (page_headers, page_content).

Параметры:

  • url (String, Symbol) (по умолчанию: T.unsafe(nil))
  • compressed (Boolean, nil) (по умолчанию: nil)
  • cookies (Hash{String => String}, nil) (по умолчанию: nil)
  • header (String, Array<String>, nil) (по умолчанию: nil)
  • homebrew_curl (Boolean, nil) (по умолчанию: nil)
  • post_form (Hash{Symbol => String}, nil) (по умолчанию: nil)
  • post_json (Hash{Symbol => T.anything}, nil) (по умолчанию: nil)
  • referer (String, nil) (по умолчанию: nil)
  • user_agent (String, Symbol, nil) (по умолчанию: nil)

Возвращает:

  • (String, Symbol, nil)

Вызывает исключение:

  • (ArgumentError) 


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'livecheck.rb', line 199

def url(
  url = T.unsafe(nil),
  compressed: nil,
  cookies: nil,
  header: nil,
  homebrew_curl: nil,
  post_form: nil,
  post_json: nil,
  referer: nil,
  user_agent: nil
)
  raise ArgumentError, "`compressed` option should only be `false` or omitted" if compressed == true
  raise ArgumentError, "`homebrew_curl` option should only be `true` or omitted" if homebrew_curl == false
  raise ArgumentError, "Only use `post_form` or `post_json`, not both" if post_form && post_json

  @options.compressed = compressed unless compressed.nil?
  @options.cookies = cookies unless cookies.nil?
  @options.header = header unless header.nil?
  @options.homebrew_curl = homebrew_curl unless homebrew_curl.nil?
  @options.post_form = post_form unless post_form.nil?
  @options.post_json = post_json unless post_json.nil?
  @options.referer = referer unless referer.nil?
  @options.user_agent = user_agent unless user_agent.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

#url_options(*args, &block) ⇒ T.untyped

Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.

Параметры:

  • args (T.untyped)
  • block (T.untyped)

Возвращает:

  • (T.untyped) 


10
 
# File 'sorbet/rbi/dsl/livecheck.rbi', line 10

def url_options(*args, &block); end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/Livecheck.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API