Class: Cask::Artifact::AbstractArtifact Private

Inherits:
Object
  • Object
show all
Extended by:
Predicable, T::Sig
Includes:
Comparable
Defined in:
cask/artifact/abstract_artifact.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.

Abstract superclass for all artifacts.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Constructor Details

#initialize(cask) ⇒ AbstractArtifact

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 a new instance of AbstractArtifact.



130
131
132
# File 'cask/artifact/abstract_artifact.rb', line 130

def initialize(cask)
  @cask = cask
end

Instance Attribute Details

#caskObject (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.



128
129
130
# File 'cask/artifact/abstract_artifact.rb', line 128

def cask
  @cask
end

Class Method Details

.dirmethodObject

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.



27
28
29
# File 'cask/artifact/abstract_artifact.rb', line 27

def self.dirmethod
  @dirmethod ||= "#{dsl_key}dir".to_sym
end

.dsl_keyObject

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.



23
24
25
# File 'cask/artifact/abstract_artifact.rb', line 23

def self.dsl_key
  @dsl_key ||= name.sub(/^.*:/, "").gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym
end

.english_articleObject

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.



19
20
21
# File 'cask/artifact/abstract_artifact.rb', line 19

def self.english_article
  @english_article ||= (english_name =~ /^[aeiou]/i) ? "an" : "a"
end

.english_nameObject

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.



15
16
17
# File 'cask/artifact/abstract_artifact.rb', line 15

def self.english_name
  @english_name ||= name.sub(/^.*:/, "").gsub(/(.)([A-Z])/, '\1 \2')
end

.read_script_arguments(arguments, stanza, default_arguments = {}, override_arguments = {}, key = nil) ⇒ Object

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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'cask/artifact/abstract_artifact.rb', line 94

def self.read_script_arguments(arguments, stanza, default_arguments = {}, override_arguments = {}, key = nil)
  # TODO: when stanza names are harmonized with class names,
  #       stanza may not be needed as an explicit argument
  description = key ? "#{stanza} #{key.inspect}" : stanza.to_s

  # backward-compatible string value
  arguments = { executable: arguments } if arguments.is_a?(String)

  # key sanity
  permitted_keys = [:args, :input, :executable, :must_succeed, :sudo, :print_stdout, :print_stderr]
  unknown_keys = arguments.keys - permitted_keys
  unless unknown_keys.empty?
    opoo "Unknown arguments to #{description} -- " \
         "#{unknown_keys.inspect} (ignored). Running " \
         "`brew update; brew cleanup` will likely fix it."
  end
  arguments.select! { |k| permitted_keys.include?(k) }

  # key warnings
  override_keys = override_arguments.keys
  ignored_keys = arguments.keys & override_keys
  unless ignored_keys.empty?
    onoe "Some arguments to #{description} will be ignored -- :#{unknown_keys.inspect} (overridden)."
  end

  # extract executable
  executable = arguments.key?(:executable) ? arguments.delete(:executable) : nil

  arguments = default_arguments.merge arguments
  arguments.merge! override_arguments

  [executable, arguments]
end

Instance Method Details

#<=>(other) ⇒ Object

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.



50
51
52
53
54
55
56
57
58
59
60
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
# File 'cask/artifact/abstract_artifact.rb', line 50

def <=>(other)
  return unless other.class < AbstractArtifact
  return 0 if instance_of?(other.class)

  @@sort_order ||= [ # rubocop:disable Style/ClassVars
    PreflightBlock,
    # The `uninstall` stanza should be run first, as it may
    # depend on other artifacts still being installed.
    Uninstall,
    Installer,
    # `pkg` should be run before `binary`, so
    # targets are created prior to linking.
    # `pkg` should be run before `app`, since an `app` could
    # contain a nested installer (e.g. `wireshark`).
    Pkg,
    [
      App,
      Suite,
      Artifact,
      Colorpicker,
      Prefpane,
      Qlplugin,
      Mdimporter,
      Dictionary,
      Font,
      Service,
      InputMethod,
      InternetPlugin,
      AudioUnitPlugin,
      VstPlugin,
      Vst3Plugin,
      ScreenSaver,
    ],
    Binary,
    Manpage,
    PostflightBlock,
    Zap,
  ].each_with_index.flat_map { |classes, i| Array(classes).map { |c| [c, i] } }.to_h

  (@@sort_order[self.class] <=> @@sort_order[other.class]).to_i
end

#configObject

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.



134
135
136
# File 'cask/artifact/abstract_artifact.rb', line 134

def config
  cask.config
end

#staged_path_join_executable(path) ⇒ Object

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.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'cask/artifact/abstract_artifact.rb', line 31

def staged_path_join_executable(path)
  path = Pathname(path)
  path = path.expand_path if path.to_s.start_with?("~")

  absolute_path = if path.absolute?
    path
  else
    cask.staged_path.join(path)
  end

  FileUtils.chmod "+x", absolute_path if absolute_path.exist? && !absolute_path.executable?

  if absolute_path.exist?
    absolute_path
  else
    path
  end
end

#to_sString

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:



139
140
141
# File 'cask/artifact/abstract_artifact.rb', line 139

def to_s
  "#{summarize} (#{self.class.english_name})"
end