Class: Cask::Cask

Inherits:
Object
  • Object
show all
Extended by:
Enumerable, Forwardable, Searchable
Includes:
Metadata
Defined in:
brew/Library/Homebrew/cask/cask.rb

Constant Summary

Constants included from Metadata

Metadata::METADATA_SUBDIR, Metadata::TIMESTAMP_FORMAT

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Searchable

search

Methods included from Metadata

#metadata_master_container_path, #metadata_subdir, #metadata_timestamped_path, #metadata_versioned_path

Constructor Details

#initialize(token, sourcefile_path: nil, tap: nil, &block) ⇒ Cask

Returns a new instance of Cask.



34
35
36
37
38
39
40
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 34

def initialize(token, sourcefile_path: nil, tap: nil, &block)
  @token = token
  @sourcefile_path = sourcefile_path
  @tap = tap
  @block = block
  self.config = Config.for_cask(self)
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



16
17
18
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 16

def config
  @config
end

#sourcefile_path ⇒ Object (readonly)

Returns the value of attribute sourcefile_path.



16
17
18
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 16

def sourcefile_path
  @sourcefile_path
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



16
17
18
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 16

def token
  @token
end

Class Method Details

.each ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 18

def self.each
  return to_enum unless block_given?

  Tap.flat_map(&:cask_files).each do |f|
    yield CaskLoader::FromTapPathLoader.new(f).load
  rescue CaskUnreadableError => e
    opoo e.message
  end
end

Instance Method Details

#caskroom_path ⇒ Object 



97
98
99
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 97

def caskroom_path
  @caskroom_path ||= Caskroom.path.join(token)
end

#config_path ⇒ Object 



93
94
95
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 93

def config_path
  metadata_master_container_path/"config.json"
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:

  • (Boolean) 


133
134
135
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 133

def eql?(other)
  token == other.token
end

#full_name ⇒ Object 



70
71
72
73
74
75
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 70

def full_name
  return token if tap.nil?
  return token if tap.user == "Homebrew"

  "#{tap.name}/#{token}"
end

#hash ⇒ Object 



129
130
131
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 129

def hash
  token.hash
end

#install_time ⇒ Object 



81
82
83
84
85
86
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 81

def install_time
  _, time = timestamped_versions.last
  return unless time

  Time.strptime(time, Metadata::TIMESTAMP_FORMAT)
end

#installed? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 77

def installed?
  !versions.empty?
end

#installed_caskfile ⇒ Object 



88
89
90
91
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 88

def installed_caskfile
  installed_version = timestamped_versions.last
  metadata_master_container_path.join(*installed_version, "Casks", "#{token}.rb")
end

#outdated?(greedy = false) ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 101

def outdated?(greedy = false)
  !outdated_versions(greedy).empty?
end

#outdated_versions(greedy = false) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 105

def outdated_versions(greedy = false)
  # special case: tap version is not available
  return [] if version.nil?

  if greedy
    return versions if version.latest?
  elsif auto_updates
    return []
  end

  installed = versions
  current   = installed.last

  # not outdated unless there is a different version on tap
  return [] if current == version

  # collect all installed versions that are different than tap version and return them
  installed.reject { |v| v == version }
end

#tap ⇒ Object 



28
29
30
31
32
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 28

def tap
  return super if block_given? # Object#tap

  @tap
end

#timestamped_versions ⇒ Object 



56
57
58
59
60
61
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 56

def timestamped_versions
  Pathname.glob(metadata_timestamped_path(version: "*", timestamp: "*"))
          .map { |p| p.relative_path_from(p.parent.parent) }
          .sort_by(&:basename) # sort by timestamp
          .map { |p| p.split.map(&:to_s) }
end

#to_h ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 138

def to_h
  {
    "token"          => token,
    "name"           => name,
    "homepage"       => homepage,
    "url"            => url,
    "appcast"        => appcast,
    "version"        => version,
    "sha256"         => sha256,
    "artifacts"      => artifacts.map(&method(:to_h_gsubs)),
    "caveats"        => (to_h_string_gsubs(caveats) unless caveats.empty?),
    "depends_on"     => depends_on,
    "conflicts_with" => conflicts_with,
    "container"      => container,
    "auto_updates"   => auto_updates,
  }
end

#to_s ⇒ Object 



125
126
127
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 125

def to_s
  @token
end

#versions ⇒ Object 



63
64
65
66
67
68
 
# File 'brew/Library/Homebrew/cask/cask.rb', line 63

def versions
  timestamped_versions.map(&:first)
                      .reverse
                      .uniq
                      .reverse
end