class RubyInstaller::Build::Msys2Installation

Constants

MSYS2_INSTALL_KEY

Attributes

mingw_package_prefix[R]
mingwarch[R]
mingwdir[R]
ruby_bin_dir[R]

Public Class Methods

new(msys_path: nil, mingwarch: nil, mingw_package_prefix: nil, ruby_bin_dir: nil) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 19
def initialize(msys_path: nil, mingwarch: nil, mingw_package_prefix: nil, ruby_bin_dir: nil)
  @msys_path = msys_path
  @msys_path_fixed = msys_path ? true : false
  @mingwdir = nil
  @mingwarch = mingwarch || (RUBY_PLATFORM=~/x64/ ? 'mingw64' : 'mingw32')
  @mingw_package_prefix = mingw_package_prefix || (RUBY_PLATFORM=~/x64/ ? "mingw-w64-x86_64" : "mingw-w64-i686")
  @ruby_bin_dir = ruby_bin_dir || File.join(RbConfig::TOPDIR, "bin")
end

Public Instance Methods

disable_dll_search_paths() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 106
def disable_dll_search_paths
  @mingwdir.remove if @mingwdir
  @mingwdir = nil
end
disable_msys_apps(if_no_msys: :hint) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 176
def disable_msys_apps(if_no_msys: :hint)
  vars = with_msys_install_hint(if_no_msys) do
    msys_apps_envvars
  end
  changed = false
  if path=vars.delete("PATH")
    old_path = ENV['PATH']
    ENV['PATH'] = old_path.gsub(path + ";", "")
    changed = ENV['PATH'] != old_path
  end
  vars.each do |key, val|
    changed = true if ENV[key]
    ENV.delete(key)
  end

  changed
end
disable_msys_apps_per_cmd() click to toggle source

This method is used for the ridk command.

# File lib/ruby_installer/build/msys2_installation.rb, line 224
def disable_msys_apps_per_cmd
  vars = with_msys_install_hint{ msys_apps_envvars }
  str = "".dup
  if path=vars.delete("PATH")
    str << "PATH=#{ ENV['PATH'].gsub(path + ";", "") }\n"
  end
  str << vars.map do |key, val|
    "#{key}="
  end.join("\n")
end
disable_msys_apps_per_ps1() click to toggle source

This method is used for the ridk command.

# File lib/ruby_installer/build/msys2_installation.rb, line 247
def disable_msys_apps_per_ps1
  vars = with_msys_install_hint{ msys_apps_envvars }
  str = "".dup
  if path=vars.delete("PATH")
    str << "$env:PATH=\"#{ ENV['PATH'].gsub(path + ";", "").gsub('"', '`"') }\";"
  end
  str << vars.map do |key, val|
    "$env:#{key}=''"
  end.join(";")
end
enable_dll_search_paths() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 96
def enable_dll_search_paths
  @mingwdir ||= begin
    DllDirectory.set_defaults
    path = mingw_bin_path
    DllDirectory.new(path) if File.directory?(path)
  rescue MsysNotFound
    # We silently ignore this error to allow Ruby installations without MSYS2.
  end
end
enable_msys_apps(if_no_msys: :hint, for_gem_install: false) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 151
def enable_msys_apps(if_no_msys: :hint, for_gem_install: false)
  vars = with_msys_install_hint(if_no_msys) do
    msys_apps_envvars
  end

  changed = false

  if (path=vars.delete("PATH")) && !ENV['PATH'].include?(path)
    phrase = "Temporarily enhancing PATH for MSYS/MINGW..."
    if for_gem_install && defined?(Gem)
      Gem.ui.say(phrase) if Gem.configuration.verbose
    elsif $DEBUG
      $stderr.puts phrase
    end
    changed = true
    ENV['PATH'] = path + ";" + ENV['PATH']
  end
  vars.each do |key, val|
    changed = true if ENV[key] != val
    ENV[key] = val
  end

  changed
end
enable_msys_apps_per_cmd() click to toggle source

This method is used for the ridk command.

# File lib/ruby_installer/build/msys2_installation.rb, line 213
def enable_msys_apps_per_cmd
  vars = with_msys_install_hint{ msys_apps_envvars }
  if (path=vars.delete("PATH")) && !ENV['PATH'].include?(path)
    vars['PATH'] = path + ";" + ENV['PATH']
  end
  vars.map do |key, val|
    "#{key}=#{val}"
  end.join("\n")
end
enable_msys_apps_per_ps1() click to toggle source

This method is used for the ridk command.

# File lib/ruby_installer/build/msys2_installation.rb, line 236
def enable_msys_apps_per_ps1
  vars = with_msys_install_hint{ msys_apps_envvars }
  if (path=vars.delete("PATH")) && !ENV['PATH'].include?(path)
    vars['PATH'] = path + ";" + ENV['PATH']
  end
  vars.map do |key, val|
    "$env:#{key}=\"#{val.gsub('"', '`"')}\""
  end.join(";")
end
install_mingw_packages(packages, verbose: false) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 274
def install_mingw_packages(packages, verbose: false)
  packages = packages.map{|pack| "#{mingw_package_prefix}-#{pack}" }
  install_packages(packages, verbose: verbose)
end
install_packages(packages, verbose: false) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 258
def install_packages(packages, verbose: false)
  return if packages.empty?

  with_msys_apps_enabled do
    Gem.ui.say("Installing required msys2 packages: #{packages.join(" ")}") if verbose

    args = ["pacman", "-S", "--needed", "--noconfirm", *packages]
    Gem.ui.say("> #{args.join(" ")}") if verbose==1

    res = IO.popen(args, &:read)
    raise CommandError, "pacman failed with the following output:\n#{res}" if !$? || $?.exitstatus != 0

    Gem.ui.say(res) if verbose==1
  end
end
iterate_msys_paths() { |join(TOPDIR, "msys64")| ... } click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 32
def iterate_msys_paths
  # Prefer MSYS2 when installed within the ruby directory.
  yield File.join(RbConfig::TOPDIR, "msys64")
  yield File.join(RbConfig::TOPDIR, "msys32")

  # Then try MSYS2 next to the ruby directory.
  yield File.join(File.dirname(RbConfig::TOPDIR), "msys64")
  yield File.join(File.dirname(RbConfig::TOPDIR), "msys32")

  # If msys2 is installed at the default location
  yield "c:/msys64"
  yield "c:/msys32"

  # If msys2 is installed per installer.exe
  require "win32/registry"
  begin
    Win32::Registry::HKEY_CURRENT_USER.open(backslachs(MSYS2_INSTALL_KEY)) do |reg|
      reg.each_key do |subkey|
        subreg = reg.open(subkey)
        begin
          if subreg['DisplayName'] =~ /^MSYS2 / && File.directory?(il=subreg['InstallLocation'])
            yield il
          end
        rescue Encoding::InvalidByteSequenceError, Win32::Registry::Error
          # Ignore entries without valid installer data or broken character encoding
        end
      end
    end
  rescue Win32::Registry::Error
  end

  ENV['PATH'].split(";").each do |path|
    # If /path/to/msys64 is in the PATH (e.g. Chocolatey)
    yield path
  end

  # If msys2 is installed by scoop package manager
  yield IO.popen(["scoop", "prefix", "msys2"], &:read).strip rescue StandardError

  raise MsysNotFound, "MSYS2 could not be found"
end
mingw_bin_path() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 88
def mingw_bin_path
  backslachs( File.join(msys_path, mingwarch, "bin") )
end
mingw_prefix() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 92
def mingw_prefix
  "/#{mingwarch}"
end
msys_bin_path() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 84
def msys_bin_path
  backslachs( File.join(msys_path, "/usr/bin") )
end
msys_path() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 74
def msys_path
  @msys_path ||= begin
    iterate_msys_paths do |path|
      if File.exist?(File.join(path, "usr/bin/msys-2.0.dll"))
        break backslachs(path)
      end
    end
  end
end
reset_cache() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 28
def reset_cache
  @msys_path = nil unless @msys_path_fixed
end
with_msys_apps_disabled(**args) { || ... } click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 203
def with_msys_apps_disabled(**args)
  changed = disable_msys_apps(**args)
  begin
    yield
  ensure
    enable_msys_apps(**args) if changed
  end
end
with_msys_apps_enabled(**args) { || ... } click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 194
def with_msys_apps_enabled(**args)
  changed = enable_msys_apps(**args)
  begin
    yield
  ensure
    disable_msys_apps(**args) if changed
  end
end

Private Instance Methods

backslachs(path) click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 111
        def backslachs(path)
  path.gsub("/", "\\")
end
msys_apps_envvars() click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 115
        def msys_apps_envvars
  vars = {}
  msys_bin = msys_bin_path
  mingw_bin = mingw_bin_path
  ruby_bin = backslachs( ruby_bin_dir )

  vars['PATH'] = ruby_bin + ";" + mingw_bin + ";" + msys_bin
  vars['RI_DEVKIT'] = msys_path
  vars['MSYSTEM'] = mingwarch.upcase
  vars['PKG_CONFIG_PATH'] = "#{mingw_prefix}/lib/pkgconfig:#{mingw_prefix}/share/pkgconfig"
  vars['ACLOCAL_PATH'] = "#{mingw_prefix}/share/aclocal:/usr/share/aclocal"
  vars['MANPATH'] = "#{mingw_prefix}/share/man"
  vars['MINGW_PACKAGE_PREFIX'] = mingw_package_prefix
  locale = IO.popen([File.join(msys_bin, "locale"), "-uU"], &:read) rescue SystemCallError
  vars['LANG'] = locale=~/UTF-8/ ? locale.to_s.strip : 'C'

  vars
end
with_msys_install_hint(if_no_msys = :hint) { || ... } click to toggle source
# File lib/ruby_installer/build/msys2_installation.rb, line 134
        def with_msys_install_hint(if_no_msys = :hint)
  case if_no_msys
  when :hint
    begin
      yield
    rescue MsysNotFound
      $stderr.puts "MSYS2 could not be found. Please run 'ridk install'"
      $stderr.puts "or download and install MSYS2 manually from https://msys2.github.io/"
      exit 1
    end
  when :raise
    yield
  else
    raise ArgumentError, "invalid value #{if_no_msys.inspect} for variable if_no_msys"
  end
end