Class: Cask::Pkg Private

Inherits:
Object
  • Object
show all
Defined in:
Library/Homebrew/cask/pkg.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Helper class for uninstalling .pkg installers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(package_id, command = SystemCommand) ⇒ Pkg

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Pkg.


19
20
21
22
# File 'Library/Homebrew/cask/pkg.rb', line 19

def initialize(package_id, command = SystemCommand)
  @package_id = package_id
  @command = command
end

Instance Attribute Details

#package_idObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/cask/pkg.rb', line 17

def package_id
  @package_id
end

Class Method Details

.all_matching(regexp, command) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


11
12
13
14
15
# File 'Library/Homebrew/cask/pkg.rb', line 11

def self.all_matching(regexp, command)
  command.run("/usr/sbin/pkgutil", args: ["--pkgs=#{regexp}"]).stdout.split("\n").map do |package_id|
    new(package_id.chomp, command)
  end
end

Instance Method Details

#forgetObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


68
69
70
71
# File 'Library/Homebrew/cask/pkg.rb', line 68

def forget
  odebug "Unregistering pkg receipt (aka forgetting)"
  @command.run!("/usr/sbin/pkgutil", args: ["--forget", package_id], sudo: true)
end

#infoObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


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

def info
  @info ||= @command.run!("/usr/sbin/pkgutil", args: ["--pkg-info-plist", package_id])
                    .plist
end

#pkgutil_bom_allObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


85
86
87
88
89
90
91
# File 'Library/Homebrew/cask/pkg.rb', line 85

def pkgutil_bom_all
  @pkgutil_bom_all ||= @command.run!("/usr/sbin/pkgutil", args: ["--files", package_id])
                               .stdout
                               .split("\n")
                               .map { |path| root.join(path) }
                               .reject(&MacOS.public_method(:undeletable?))
end

#pkgutil_bom_dirsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


81
82
83
# File 'Library/Homebrew/cask/pkg.rb', line 81

def pkgutil_bom_dirs
  @pkgutil_bom_dirs ||= pkgutil_bom_all.select(&:directory?) - pkgutil_bom_specials
end

#pkgutil_bom_filesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


73
74
75
# File 'Library/Homebrew/cask/pkg.rb', line 73

def pkgutil_bom_files
  @pkgutil_bom_files ||= pkgutil_bom_all.select(&:file?) - pkgutil_bom_specials
end

#pkgutil_bom_specialsObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


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

def pkgutil_bom_specials
  @pkgutil_bom_specials ||= pkgutil_bom_all.select(&method(:special?))
end

#rootObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


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

def root
  @root ||= Pathname.new(info.fetch("volume")).join(info.fetch("install-location"))
end

#uninstallObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'Library/Homebrew/cask/pkg.rb', line 24

def uninstall
  unless pkgutil_bom_files.empty?
    odebug "Deleting pkg files"
    @command.run!(
      "/usr/bin/xargs",
      args:  [
        "-0", "--", "/bin/rm", "--"
      ],
      input: pkgutil_bom_files.join("\0"),
      sudo:  true,
    )
  end

  unless pkgutil_bom_specials.empty?
    odebug "Deleting pkg symlinks and special files"
    @command.run!(
      "/usr/bin/xargs",
      args:  [
        "-0", "--", "/bin/rm", "--"
      ],
      input: pkgutil_bom_specials.join("\0"),
      sudo:  true,
    )
  end

  unless pkgutil_bom_dirs.empty?
    odebug "Deleting pkg directories"
    deepest_path_first(pkgutil_bom_dirs).each do |dir|
      with_full_permissions(dir) do
        clean_broken_symlinks(dir)
        clean_ds_store(dir)
        rmdir(dir)
      end
    end
  end

  if root.directory? && !MacOS.undeletable?(root)
    clean_ds_store(root)
    rmdir(root)
  end

  forget
end