Class: Cask::URL Private

Inherits:

Object

Object
Cask::URL

show all

Extended by:: Forwardable

Defined in:: cask/url.rb,
sorbet/rbi/dsl/cask/url.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.

Class corresponding to the url stanza.

Constant Summary collapse

DEPRECATED_URL_SPECS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

URL kwargs still accepted from existing cask metadata but otherwise ignored.

[:verified].freeze

Instance Attribute Summary collapse

#branch ⇒ String^? readonly private
#cookies ⇒ Hash{String => String}^? readonly private
#data ⇒ Hash{String => String}^? readonly private
#header ⇒ Array<String>^? readonly private
#only_path ⇒ String^? readonly private
#referer ⇒ URI::Generic, ... readonly private
#revision ⇒ String^? readonly private
#revisions ⇒ Hash{Symbol, String => String}^? readonly private
#specs ⇒ Hash{Symbol => T.untyped} readonly private
#tag ⇒ String^? readonly private
#trust_cert ⇒ Boolean^? readonly private
#uri ⇒ URI::Generic readonly private
#user_agent ⇒ Symbol, ... readonly private
#using ⇒ T::Class[AbstractDownloadStrategy], ... readonly private
#verified ⇒ String^? readonly private

Instance Method Summary collapse

#initialize(uri, verified: nil, using: nil, tag: nil, branch: nil, revisions: nil, revision: nil, trust_cert: nil, cookies: nil, referer: nil, header: nil, user_agent: nil, data: nil, only_path: nil, caller_location: caller_locations.fetch(0)) ⇒ void constructor
Creates a url stanza.
#location ⇒ Homebrew::SourceLocation private
#path(*args, &block) ⇒ T.untyped private
#scheme(*args, &block) ⇒ T.untyped private
#unversioned?(ignore_major_version: false) ⇒ Boolean private

Constructor Details

#initialize(uri, verified: nil, using: nil, tag: nil, branch: nil, revisions: nil, revision: nil, trust_cert: nil, cookies: nil, referer: nil, header: nil, user_agent: nil, data: nil, only_path: nil, caller_location: caller_locations.fetch(0)) ⇒ `void`

Creates a url stanza.

Parameters:

uri (URI::Generic, String)
verified (String, nil) (defaults to: nil)
using (T::Class[AbstractDownloadStrategy], Symbol, nil) (defaults to: nil)
tag (String, nil) (defaults to: nil)
branch (String, nil) (defaults to: nil)
revisions (Hash{Symbol, String => String}, nil) (defaults to: nil)
revision (String, nil) (defaults to: nil)
trust_cert (Boolean, nil) (defaults to: nil)
cookies (Hash{String, Symbol => String}, nil) (defaults to: nil)
referer (URI::Generic, String, nil) (defaults to: nil)
header (String, Array<String>, nil) (defaults to: nil)
user_agent (Symbol, String, nil) (defaults to: nil)
data (Hash{String => String}, nil) (defaults to: nil)
only_path (String, nil) (defaults to: nil)
caller_location (Thread::Backtrace::Location) (defaults to: caller_locations.fetch(0))

# File 'cask/url.rb', line 69

def initialize(
  uri, verified: nil, using: nil, tag: nil, branch: nil, revisions: nil, revision: nil, trust_cert: nil,
  cookies: nil, referer: nil, header: nil, user_agent: nil, data: nil, only_path: nil,
  caller_location: caller_locations.fetch(0)
)
  @uri = T.let(URI(uri), URI::Generic)

  header = Array(header) unless header.nil?

  specs = {}
  # `verified` is accepted as a no-op for compatibility with existing casks.
  @verified = verified
  specs[:using]      = @using      = T.let(using, T.nilable(T.any(T::Class[AbstractDownloadStrategy], Symbol)))
  specs[:tag]        = @tag        = T.let(tag, T.nilable(String))
  specs[:branch]     = @branch     = T.let(branch, T.nilable(String))
  specs[:revisions]  = @revisions  = T.let(revisions, T.nilable(T::Hash[T.any(Symbol, String), String]))
  specs[:revision]   = @revision   = T.let(revision, T.nilable(String))
  specs[:trust_cert] = @trust_cert = T.let(trust_cert, T.nilable(T::Boolean))
  specs[:cookies]    =
    @cookies = T.let(cookies&.transform_keys(&:to_s), T.nilable(T::Hash[String, String]))
  specs[:referer]    = @referer    = T.let(referer, T.nilable(T.any(URI::Generic, String)))
  specs[:headers]    = @header     = T.let(header, T.nilable(T::Array[String]))
  specs[:user_agent] = @user_agent = T.let(user_agent || :default, T.nilable(T.any(Symbol, String)))
  specs[:data]       = @data       = T.let(data, T.nilable(T::Hash[String, String]))
  specs[:only_path]  = @only_path  = T.let(only_path, T.nilable(String))

  @specs = T.let(specs.compact, T::Hash[Symbol, T.untyped])
  @caller_location = caller_location
end

Instance Attribute Details

#branch ⇒ `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:

(String, nil)



38
39
40

# File 'cask/url.rb', line 38

def branch
  @branch
end

#cookies ⇒ `Hash{String => String}`^? (readonly)

Returns:

(Hash{String => String}, nil)



20
21
22

# File 'cask/url.rb', line 20

def cookies
  @cookies
end

#data ⇒ `Hash{String => String}`^? (readonly)

Returns:

(Hash{String => String}, nil)



20
21
22

# File 'cask/url.rb', line 20

def data
  @data
end

#header ⇒ `Array<String>`^? (readonly)

Returns:

(Array<String>, nil)



23
24
25

# File 'cask/url.rb', line 23

def header
  @header
end

#only_path ⇒ `String`^? (readonly)

Returns:

(String, nil)



38
39
40

# File 'cask/url.rb', line 38

def only_path
  @only_path
end

#referer ⇒ `URI::Generic`, ... (readonly)

Returns:

(URI::Generic, String, nil)



26
27
28

# File 'cask/url.rb', line 26

def referer
  @referer
end

#revision ⇒ `String`^? (readonly)

Returns:

(String, nil)



38
39
40

# File 'cask/url.rb', line 38

def revision
  @revision
end

#revisions ⇒ `Hash{Symbol, String => String}`^? (readonly)

Returns:

(Hash{Symbol, String => String}, nil)



14
15
16

# File 'cask/url.rb', line 14

def revisions
  @revisions
end

#specs ⇒ `Hash{Symbol => T.untyped}` (readonly)

Returns:

(Hash{Symbol => T.untyped})



29
30
31

# File 'cask/url.rb', line 29

def specs
  @specs
end

#tag ⇒ `String`^? (readonly)

Returns:

(String, nil)



38
39
40

# File 'cask/url.rb', line 38

def tag
  @tag
end

#trust_cert ⇒ `Boolean`^? (readonly)

Returns:

(Boolean, nil)



17
18
19

# File 'cask/url.rb', line 17

def trust_cert
  @trust_cert
end

#uri ⇒ `URI::Generic` (readonly)

Returns:

(URI::Generic)



11
12
13

# File 'cask/url.rb', line 11

def uri
  @uri
end

#user_agent ⇒ `Symbol`, ... (readonly)

Returns:

(Symbol, String, nil)



32
33
34

# File 'cask/url.rb', line 32

def user_agent
  @user_agent
end

#using ⇒ `T::Class[AbstractDownloadStrategy]`, ... (readonly)

Returns:

(T::Class[AbstractDownloadStrategy], Symbol, nil)



35
36
37

# File 'cask/url.rb', line 35

def using
  @using
end

#verified ⇒ `String`^? (readonly)

Returns:

(String, nil)



38
39
40

# File 'cask/url.rb', line 38

def verified
  @verified
end

Instance Method Details

#location ⇒ `Homebrew::SourceLocation`

Returns:

(Homebrew::SourceLocation)



100
101
102

# File 'cask/url.rb', line 100

def location
  Homebrew::SourceLocation.new(@caller_location.lineno, raw_url_line&.index("url"))
end

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

Parameters:

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

Returns:

(T.untyped)

10	# File 'sorbet/rbi/dsl/cask/url.rbi', line 10 def path(*args, &block); end

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

Parameters:

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

Returns:

(T.untyped)

13	# File 'sorbet/rbi/dsl/cask/url.rbi', line 13 def scheme(*args, &block); end

#unversioned?(ignore_major_version: false) ⇒ `Boolean`

Parameters:

ignore_major_version (Boolean) (defaults to: false)

Returns:

(Boolean)

# File 'cask/url.rb', line 105

def unversioned?(ignore_major_version: false)
  interpolated_url = raw_url_line&.then { |line| line[/url\s+"([^"]+)"/, 1] }

  return false unless interpolated_url

  interpolated_url = interpolated_url.gsub(/\#{\s*arch\s*}/, "")
  interpolated_url = interpolated_url.gsub(/\#{\s*version\s*\.major\s*}/, "") if ignore_major_version

  interpolated_url.exclude?('#{')
end

Class: Cask::URL Private

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri, verified: nil, using: nil, tag: nil, branch: nil, revisions: nil, revision: nil, trust_cert: nil, cookies: nil, referer: nil, header: nil, user_agent: nil, data: nil, only_path: nil, caller_location: caller_locations.fetch(0)) ⇒ void

Instance Attribute Details

#branch ⇒ String? (readonly)

#cookies ⇒ Hash{String => String}? (readonly)

#data ⇒ Hash{String => String}? (readonly)

#header ⇒ Array<String>? (readonly)

#only_path ⇒ String? (readonly)

#referer ⇒ URI::Generic, ... (readonly)

#revision ⇒ String? (readonly)

#revisions ⇒ Hash{Symbol, String => String}? (readonly)

#specs ⇒ Hash{Symbol => T.untyped} (readonly)

#tag ⇒ String? (readonly)

#trust_cert ⇒ Boolean? (readonly)

#uri ⇒ URI::Generic (readonly)

#user_agent ⇒ Symbol, ... (readonly)

#using ⇒ T::Class[AbstractDownloadStrategy], ... (readonly)

#verified ⇒ String? (readonly)

Instance Method Details

#location ⇒ Homebrew::SourceLocation

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

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

#unversioned?(ignore_major_version: false) ⇒ Boolean

#initialize(uri, verified: nil, using: nil, tag: nil, branch: nil, revisions: nil, revision: nil, trust_cert: nil, cookies: nil, referer: nil, header: nil, user_agent: nil, data: nil, only_path: nil, caller_location: caller_locations.fetch(0)) ⇒ `void`

#branch ⇒ `String`^? (readonly)

#cookies ⇒ `Hash{String => String}`^? (readonly)

#data ⇒ `Hash{String => String}`^? (readonly)

#header ⇒ `Array<String>`^? (readonly)

#only_path ⇒ `String`^? (readonly)

#referer ⇒ `URI::Generic`, ... (readonly)

#revision ⇒ `String`^? (readonly)

#revisions ⇒ `Hash{Symbol, String => String}`^? (readonly)

#specs ⇒ `Hash{Symbol => T.untyped}` (readonly)

#tag ⇒ `String`^? (readonly)

#trust_cert ⇒ `Boolean`^? (readonly)

#uri ⇒ `URI::Generic` (readonly)

#user_agent ⇒ `Symbol`, ... (readonly)

#using ⇒ `T::Class[AbstractDownloadStrategy]`, ... (readonly)

#verified ⇒ `String`^? (readonly)

#location ⇒ `Homebrew::SourceLocation`

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

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

#unversioned?(ignore_major_version: false) ⇒ `Boolean`