Class: Formulary::FromURILoader Private

Inherits:
FormulaLoader show all
Defined in:
formulary.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.

Loads formula from a URI.

Instance Attribute Summary collapse

Attributes inherited from FormulaLoader

#alias_path, #name, #path, #tap

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from FormulaLoader

#get_formula, #klass

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Methods included from Context

current, current=, #debug?, #quiet?, #verbose?, #with_context

Constructor Details

#initialize(url, from: nil) ⇒ 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:

  • url (URI::Generic, String)
  • from (Symbol, nil) (defaults to: nil)

Raises:

  • (ArgumentError) 


628
629
630
631
632
633
634
635
636
 
# File 'formulary.rb', line 628

def initialize(url, from: nil)
  @url = url
  @from = from
  uri_path = URI(url).path
  raise ArgumentError, "URL has no path component" unless uri_path

  formula = File.basename(uri_path, ".rb")
  super formula, HOMEBREW_CACHE_FORMULA/File.basename(uri_path)
end

Instance Attribute Details

#url ⇒ URI::Generic, 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.

Returns:



625
626
627
 
# File 'formulary.rb', line 625

def url
  @url
end

Class Method Details

.try_new(ref, from: nil, warn: false) ⇒ T.attached_class?

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:

  • ref (String, Pathname, URI::Generic)
  • from (Symbol, nil) (defaults to: nil)
  • warn (Boolean) (defaults to: false)

Returns:

  • (T.attached_class, nil) 


605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'formulary.rb', line 605

def self.try_new(ref, from: nil, warn: false)
  return if Homebrew::EnvConfig.forbid_packages_from_paths?

  # Cache compiled regex
  @uri_regex ||= T.let(begin
    uri_regex = ::URI::RFC2396_PARSER.make_regexp
    Regexp.new("\\A#{uri_regex.source}\\Z", uri_regex.options)
  end, T.nilable(Regexp))

  uri = ref.to_s
  return unless uri.match?(@uri_regex)

  uri = URI(uri)
  return unless uri.path
  return unless uri.scheme.present?

  new(uri, from:)
end

Instance Method Details

#load_file(flags:, ignore_errors:) ⇒ 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.

This method returns an undefined value.

Parameters:



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'formulary.rb', line 639

def load_file(flags:, ignore_errors:)
  url_scheme = URI(url).scheme
  if ALLOWED_URL_SCHEMES.exclude?(url_scheme)
    raise UnsupportedInstallationMethod,
          "Non-checksummed download of #{name} formula file from an arbitrary URL is unsupported! " \
          "Use `brew version-install` to install a formula file from your own custom tap " \
          "instead."
  end
  HOMEBREW_CACHE_FORMULA.mkpath
  FileUtils.rm_f(path)
  Utils::Curl.curl_download url.to_s, to: path
  super
rescue MethodDeprecatedError => e
  if (match_data = url.to_s.match(%r{github.com/(?<user>[\w-]+)/(?<repo>[\w-]+)/}).presence)
    e.issues_url = "https://github.com/#{match_data[:user]}/#{match_data[:repo]}/issues/new"
  end
  raise
end