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.

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 65

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 = {}
  specs[:verified]   = @verified   = T.let(verified, T.nilable(String))
  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)



37
38
39

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

def branch
  @branch
end

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

Returns:

(Hash{String => String}, nil)



19
20
21

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

def cookies
  @cookies
end

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

Returns:

(Hash{String => String}, nil)



19
20
21

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

def data
  @data
end

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

Returns:

(Array<String>, nil)



22
23
24

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

def header
  @header
end

#only_path ⇒ `String`^? (readonly)

Returns:

(String, nil)



37
38
39

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

def only_path
  @only_path
end

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

Returns:

(URI::Generic, String, nil)



25
26
27

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

def referer
  @referer
end

#revision ⇒ `String`^? (readonly)

Returns:

(String, nil)



37
38
39

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

def revision
  @revision
end

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

Returns:

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



13
14
15

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

def revisions
  @revisions
end

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

Returns:

(Hash{Symbol => T.untyped})



28
29
30

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

def specs
  @specs
end

#tag ⇒ `String`^? (readonly)

Returns:

(String, nil)



37
38
39

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

def tag
  @tag
end

#trust_cert ⇒ `Boolean`^? (readonly)

Returns:

(Boolean, nil)



16
17
18

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

def trust_cert
  @trust_cert
end

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

Returns:

(URI::Generic)



10
11
12

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

def uri
  @uri
end

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

Returns:

(Symbol, String, nil)



31
32
33

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

def user_agent
  @user_agent
end

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

Returns:

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



34
35
36

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

def using
  @using
end

#verified ⇒ `String`^? (readonly)

Returns:

(String, nil)



37
38
39

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

def verified
  @verified
end

Instance Method Details

#location ⇒ `Homebrew::SourceLocation`

Returns:

(Homebrew::SourceLocation)



95
96
97

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

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 100

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

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`