Spec-Zone.ru › Homebrew

Модуль: Homebrew::Search Приватный

Расширен модулем:
Utils::Output::Mixin
Определён в:
search.rb

Обзор

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

Вспомогательный модуль для поиска формул или cask-пакетов.

Краткое описание констант свернуть

QUERY_REGEX =

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

%r{^/(.*)/$}
SearchBlockType =

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

T.type_alias do
  T.nilable(
    T.proc
     .params(arg0: T.any(T::Array[String], T::Array[T::Array[String]]))
     .returns(T.nilable(T.any(String, T::Array[String]))),
  )
end
SearchResultType =

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

T.type_alias do
  T.any(
    T::Array[String],
    T::Array[T::Array[String]],
    T::Hash[String, T.nilable(String)],
    T::Hash[String, T::Array[T.nilable(String)]],
  )
end
SelectableType =

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

T.type_alias do
  # These must define a `select` method that takes a block and returns an array or hash.
  # Since sorbet has minimal support for overloading sig, the return type must be casted to the actual type.
  # DescriptionCacheStore and Hash instances will return a Hash, other types will return an Array.
  T.any(DescriptionCacheStore, SearchResultType)
end

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

  • .ignore_cask?(_cask) ⇒ Boolean приватный
  • .query_regexp(query) ⇒ Regexp, String приватный
  • .search(selectable, string_or_regex, &block) ⇒ SearchResultType приватный
  • .search_casks(string_or_regex) ⇒ Array<String> приватный
  • .search_descriptions(string_or_regex, args, search_type: nil) ⇒ void приватный
  • .search_formulae(string_or_regex) ⇒ Array<String> приватный
  • .search_names(string_or_regex, args) ⇒ Array<(Array<String>, Array<String>)> приватный
  • .search_regex(selectable, regex, &_block) ⇒ SearchResultType приватный
  • .search_string(selectable, string, &_block) ⇒ SearchResultType приватный
  • .simplify_string(string) ⇒ String приватный

Методы, включённые из Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_uninstalled, pretty_upgradable, pretty_warning

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

.ignore_cask?(_cask) ⇒ Boolean

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

Параметры:

  • _cask (Cask::Cask)

Возвращает:

  • (Boolean)


50
# File 'search.rb', line 50

def self.ignore_cask?(_cask) = false

.query_regexp(query) ⇒ Regexp, String

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

Параметры:

  • query (String)

Возвращает:

  • (Regexp, String)


39
40
41
42
43
44
45
46
47
# File 'search.rb', line 39

def self.query_regexp(query)
  if (m = query.match(QUERY_REGEX))
    Regexp.new(T.must(m[1]))
  else
    query
  end
rescue RegexpError
  raise "#{query} is not a valid regex."
end

.search(selectable, string_or_regex, &block) ⇒ SearchResultType

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

Параметры:

  • selectable (SelectableType)
  • string_or_regex (Regexp, String)
  • block (SearchBlockType)

Возвращает:

  • (SearchResultType)


222
223
224
225
226
227
228
229
# File 'search.rb', line 222

def self.search(selectable, string_or_regex, &block)
  case string_or_regex
  when Regexp
    search_regex(selectable, string_or_regex, &block)
  else
    search_string(selectable, string_or_regex.to_str, &block)
  end
end

.search_casks(string_or_regex) ⇒ Array<String>

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

Параметры:

  • string_or_regex (Regexp, String)

Возвращает:

  • (Array<String>)


159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'search.rb', line 159

def self.search_casks(string_or_regex)
  if string_or_regex.is_a?(String) && string_or_regex.match?(HOMEBREW_TAP_CASK_REGEX)
    return begin
      matched_cask = Cask::CaskLoader.load(string_or_regex)
      ignore_cask?(matched_cask) ? [] : [matched_cask.token]
    rescue Cask::CaskUnavailableError
      []
    end
  end

  cask_tokens = Tap.each_with_object([]) do |tap, array|
    # We can exclude the core cask tap because `CoreCaskTap#cask_tokens` returns short names by default.
    if tap.official? && !tap.core_cask_tap?
      tap.cask_tokens.each { |token| array << token.sub(%r{^homebrew/cask.*/}, "") }
    else
      tap.cask_tokens.each { |token| array << token }
    end
  end.uniq

  results = T.cast(search(cask_tokens, string_or_regex), T::Array[String])
  if string_or_regex.is_a?(String)
    results += DidYouMean::SpellChecker.new(dictionary: cask_tokens)
                                       .correct(string_or_regex)
  end

  results.sort.filter_map do |name|
    cask = Cask::CaskLoader.load(name.to_s)
    next if ignore_cask?(cask)

    pretty_install_status(
      cask.full_name,
      installed:        cask.installed?,
      deprecated:       cask.deprecated?,
      disabled:         cask.disabled?,
      mark_uninstalled: false,
    )
  end.uniq
end

.search_descriptions(string_or_regex, args, search_type: nil) ⇒ void

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

Этот метод возвращает неопределённое значение.

Параметры:

  • string_or_regex (Regexp, String)
  • args (Homebrew::Cmd::Desc::Args, Homebrew::Cmd::SearchCmd::Args)
  • search_type (Descriptions::SearchField, nil) (по умолчанию: nil)


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'search.rb', line 61

def self.search_descriptions(string_or_regex, args, search_type: nil)
  require "descriptions"

  search_type ||= Descriptions::SearchField::Description
  both = !args.formula? && !args.cask?
  eval_all = args.eval_all? || Homebrew::EnvConfig.tap_trust_configured?

  if args.formula? || both
    ohai "Formulae"
    if eval_all
      CacheStoreDatabase.use(:descriptions) do |db|
        cache_store = DescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
        Descriptions.search(string_or_regex, search_type, cache_store, eval_all:).print
      end
    else
      unofficial = Tap.all.sum { |tap| tap.official? ? 0 : tap.formula_files.size }
      if unofficial.positive?
        opoo "Set `HOMEBREW_REQUIRE_TAP_TRUST=1` or `HOMEBREW_NO_REQUIRE_TAP_TRUST=1` to search " \
             "#{unofficial} additional " \
             "#{Utils.pluralize("formula", unofficial)} in third party taps."
      end
      formulae = Homebrew::API::Internal.formula_hashes
      descriptions = formulae.transform_values { |data| data["desc"] }
      status_data = formulae.transform_values do |data|
        { deprecated: data["deprecate_present"].present?, disabled: data["disable_present"].present? }
      end
      Descriptions.search(string_or_regex, search_type, descriptions, status_data:, eval_all:).print
    end
  end
  return if !args.cask? && !both

  puts if both

  ohai "Casks"
  if eval_all
    CacheStoreDatabase.use(:cask_descriptions) do |db|
      cache_store = CaskDescriptionCacheStore.new(T.cast(db, CacheStoreDatabase[String, T.anything]))
      Descriptions.search(string_or_regex, search_type, cache_store, eval_all:).print
    end
  else
    unofficial = Tap.all.sum { |tap| tap.official? ? 0 : tap.cask_files.size }
    if unofficial.positive?
      opoo "Set `HOMEBREW_REQUIRE_TAP_TRUST=1` or `HOMEBREW_NO_REQUIRE_TAP_TRUST=1` to search " \
           "#{unofficial} additional " \
           "#{Utils.pluralize("cask", unofficial)} in third party taps."
    end
    casks = Homebrew::API::Internal.cask_hashes
    descriptions = casks.transform_values { |cask| [cask["names"].join(", "), cask["desc"]] }
    status_data = casks.transform_values do |cask|
      { deprecated: cask["deprecate_present"].present?, disabled: cask["disable_present"].present? }
    end
    Descriptions.search(string_or_regex, search_type, descriptions, status_data:, eval_all:).print
  end
end

.search_formulae(string_or_regex) ⇒ Array<String>

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

Параметры:

  • string_or_regex (Regexp, String)

Возвращает:

  • (Array<String>)


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'search.rb', line 117

def self.search_formulae(string_or_regex)
  if string_or_regex.is_a?(String) && string_or_regex.match?(HOMEBREW_TAP_FORMULA_REGEX)
    return begin
      [Formulary.factory(string_or_regex).name]
    rescue FormulaUnavailableError
      []
    end
  end

  aliases = Formula.alias_full_names
  results = T.cast(search(Formula.full_names + aliases, string_or_regex), T::Array[String]).sort
  if string_or_regex.is_a?(String)
    results |= Formula.fuzzy_search(string_or_regex).map do |n|
      Formulary.factory(n).full_name
    end
  end

  results.filter_map do |name|
    formula, canonical_full_name = begin
      f = Formulary.factory(name)
      [f, f.full_name]
    rescue
      [nil, name]
    end

    # Ignore aliases from results when the full name was also found
    next if aliases.include?(name) && results.include?(canonical_full_name)

    installed = formula&.any_version_installed? == true
    next if formula && !formula.valid_platform? && !installed

    pretty_install_status(
      name,
      installed:,
      deprecated:       formula&.deprecated? == true,
      disabled:         formula&.disabled? == true,
      mark_uninstalled: false,
    )
  end
end

.search_names(string_or_regex, args) ⇒ Array<(Array<String>, Array<String>)>

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

Параметры:

  • string_or_regex (Regexp, String)
  • args (Homebrew::Cmd::Desc::Args, Homebrew::Cmd::InstallCmd::Args, Homebrew::Cmd::SearchCmd::Args)

Возвращает:

  • (Array<(Array<String>, Array<String>)>)


206
207
208
209
210
211
212
213
214
215
216
# File 'search.rb', line 206

def self.search_names(string_or_regex, args)
  if !args.formula? && !args.cask? # both
    [search_formulae(string_or_regex), search_casks(string_or_regex)]
  elsif args.formula?
    [search_formulae(string_or_regex), []]
  elsif args.cask?
    [[], search_casks(string_or_regex)]
  else
    [[], []]
  end
end

.search_regex(selectable, regex, &_block) ⇒ SearchResultType

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

Параметры:

  • selectable (SelectableType)
  • regex (Regexp)
  • _block (SearchBlockType)

Возвращает:

  • (SearchResultType)


237
238
239
240
241
242
243
# File 'search.rb', line 237

def self.search_regex(selectable, regex, &_block)
  selectable.select do |*args|
    args = yield(*args) if block_given?
    args = Array(args).flatten.compact
    args.any? { |arg| arg.match?(regex) }
  end
end

.search_string(selectable, string, &_block) ⇒ SearchResultType

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

Параметры:

  • selectable (SelectableType)
  • string (String)
  • _block (SearchBlockType)

Возвращает:

  • (SearchResultType)


246
247
248
249
250
251
252
253
# File 'search.rb', line 246

def self.search_string(selectable, string, &_block)
  simplified_string = simplify_string(string)
  selectable.select do |*args|
    args = yield(*args) if block_given?
    args = Array(args).flatten.compact
    args.any? { |arg| simplify_string(arg).include?(simplified_string) }
  end
end

.simplify_string(string) ⇒ String

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

Параметры:

  • string (String)

Возвращает:

  • (String)


232
233
234
# File 'search.rb', line 232

def self.simplify_string(string)
  string.downcase.gsub(/[^a-z\d@+]/i, "")
end

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

Spec-Zone.ru

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