vcdeps 0.1.0 → 0.1.1

data/lib/vcdeps/triplet.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require "rbconfig"
-
-module Vcdeps
-  # Derives the vcpkg triplet for the running Ruby and validates user-supplied
-  # triplets. The default is the dynamic-CRT, dynamic-library triplet that
-  # matches an `-MD` mswin Ruby (x64 -> "x64-windows"); static-CRT triplets are
-  # rejected (the LNK2005/dual-heap hazard, R§4).
-  #
-  # No "x64" literal lives in code: the architecture token is derived from
-  # RbConfig::CONFIG["arch"], so arm64-mswin derives "arm64-windows" for free.
-  module Triplet
-    module_function
-
-    # Maps a Ruby arch string to its vcpkg architecture token, or nil if
-    # unrecognized. Mirrors Vcvars::Doctor.arch's regexes.
-    #   "x64-mswin64_140"   -> "x64"
-    #   "arm64-mswin64_140" -> "arm64"
-    #   "i386-mswin32"      -> "x86"
-    def arch_token(arch)
-      a = arch.to_s
-      return "x64"   if a =~ /\A(?:x64|x86_64|amd64)/i
-      return "arm64" if a =~ /arm64|aarch64/i
-      return "x86"   if a =~ /\A(?:i[3-6]86|x86)/i
-      nil
-    end
-
-    # Known architecture prefixes a triplet may start with — used to detect an
-    # arch mismatch against the running Ruby.
-    ARCH_TOKENS = %w[x64 x86 arm64 arm].freeze
-
-    # The default triplet for the given Ruby arch (dynamic CRT, dynamic libs).
-    # Raises Vcdeps::TripletError for an unrecognized arch.
-    def default(arch = RbConfig::CONFIG["arch"])
-      token = arch_token(arch)
-      raise TripletError, "vcdeps: cannot derive a vcpkg triplet for arch " \
-        "#{arch.inspect} (recognized: x64, x86, arm64). Set VCDEPS_TRIPLET or " \
-        "pass --with-vcdeps-triplet=<triplet> explicitly." if token.nil?
-
-      "#{token}-windows"
-    end
-
-    # Validate a triplet against §2.6 and return it unchanged, or raise
-    # Vcdeps::TripletError. `arch` is the running Ruby's arch (for the mismatch
-    # check); pass it explicitly in tests to exercise the forward-compat path.
-    def validate!(triplet, arch: RbConfig::CONFIG["arch"])
-      t = triplet.to_s
-
-      unless t =~ /\A[a-z0-9][a-z0-9-]*\z/
-        raise TripletError, "vcdeps: invalid triplet #{triplet.inspect} " \
-          "(must match /\\A[a-z0-9][a-z0-9-]*\\z/). Run `vcdeps doctor`."
-      end
-
-      # Reject a static-CRT triplet (-static suffix). static-md (static libs +
-      # dynamic CRT) is fine; plain -static sets VCPKG_CRT_LINKAGE static.
-      if t =~ /-static\z/
-        raise TripletError, "vcdeps: triplet #{triplet.inspect} uses a STATIC " \
-          "CRT, which is ABI-incompatible with this -MD Ruby (LNK2005 / dual " \
-          "heap). Use #{t.sub(/-static\z/, '-static-md')} (static libs, dynamic " \
-          "CRT — no DLLs to vendor) or the default #{default(arch)}."
-      end
-
-      # If the triplet leads with a known arch token that differs from this
-      # Ruby's arch, it would LNK1112 at link time.
-      lead = t.split("-", 2).first
-      ruby_token = arch_token(arch)
-      if ARCH_TOKENS.include?(lead) && ruby_token && lead != ruby_token
-        raise TripletError, "vcdeps: triplet #{triplet.inspect} targets #{lead} " \
-          "but this Ruby is #{ruby_token} (#{arch}); linking would fail with " \
-          "LNK1112. Use a #{ruby_token}-* triplet (default #{default(arch)})."
-      end
-
-      t
-    end
-  end
-end

data/lib/vcdeps/vendor.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-require "fileutils"
-require "rbconfig"
-require "vcdeps/version"
-
-module Vcdeps
-  # Syncs an Installed's runtime DLLs, per-port copyright files, and a standalone
-  # Fiddle-preload shim into a vendor directory (§2.2/§2.7). This is a SYNC, not
-  # a copy: vendor! OWNS <into>\*.dll, <into>\licenses\* and <into>\preload.rb —
-  # it overwrites the computed write list and DELETES any owned file no longer on
-  # it (so a port removed from vcpkg.json leaves no stale DLL the shim would
-  # preload and the precompiled-gem glob would ship). Nothing else under `into`
-  # is touched, so authors may keep unrelated assets there.
-  module Vendor
-    module_function
-
-    SHIM_NAME = "preload.rb"
-    LICENSES_DIR = "licenses"
-
-    # Returns the list of files written (absolute, backslashed). See §2.2 for the
-    # four-case table; stale owned files are deleted whenever `into` exists.
-    def sync!(installed, into:, licenses: true, shim: true, out: $stderr)
-      dlls = installed.dlls
-      copyrights = licenses ? installed.copyright_files : {}
-
-      # The write plan: a DLL is vendored only when there is something to vendor;
-      # the shim is written only when DLLs exist; licenses ship whenever copyright
-      # files exist (including static-md, where there are no DLLs).
-      write_dlls   = dlls
-      write_shim   = shim && !dlls.empty?
-      write_copies = copyrights
-
-      # Nothing to write AND nothing to clean (into absent) -> [] without
-      # creating `into` (§2.2 last case).
-      if write_dlls.empty? && write_copies.empty? && !write_shim &&
-         !File.directory?(into)
-        return []
-      end
-
-      written = []
-      FileUtils.mkdir_p(into)
-
-      # Owned DLLs we intend to keep (base names), for the stale sweep.
-      kept_dll_names = []
-      write_dlls.each do |src|
-        base = File.basename(src)
-        dest = File.join(into, base)
-        FileUtils.cp(src, dest)
-        kept_dll_names << base.downcase
-        written << win(dest)
-        warn_on_ruby_bin_collision(base, out)
-      end
-
-      # Licenses.
-      kept_license_names = []
-      unless write_copies.empty?
-        ldir = File.join(into, LICENSES_DIR)
-        FileUtils.mkdir_p(ldir)
-        write_copies.each do |port, src|
-          dest = File.join(ldir, "#{port}-copyright.txt")
-          FileUtils.cp(src, dest)
-          kept_license_names << File.basename(dest).downcase
-          written << win(dest)
-        end
-      end
-
-      # Shim.
-      shim_path = File.join(into, SHIM_NAME)
-      if write_shim
-        File.write(shim_path, shim_source)
-        written << win(shim_path)
-      end
-
-      # Stale sweep of OWNED files only.
-      sweep_stale!(into, kept_dll_names, kept_license_names, write_shim)
-
-      written
-    end
-
-    # The generated preload shim (exact §2.7 template). Standalone: stdlib only,
-    # no vcdeps require, safe to require twice, safe with zero DLLs present.
-    def shim_source
-      <<~SHIM
-        # frozen_string_literal: true
-        #
-        # Generated by vcdeps #{Vcdeps::VERSION}. Do not edit; regenerate with `vcdeps vendor`.
-        #
-        # Preloads the vendored vcpkg runtime DLLs by ABSOLUTE path before the C
-        # extension loads. Windows resolves an extension's dependent DLLs via the
-        # standard search order, which checks the loaded-module list (step 4) long
-        # before PATH (step 12) and NEVER checks the .so's own directory — so loading
-        # each DLL here, by full path, is what makes `require "<gem>/<gem>"` work.
-        #
-        # The dlopen handles are intentionally leaked for process lifetime: the DLLs
-        # must stay loaded as long as the extension is loaded.
-        require "fiddle"
-
-        pending = Dir[File.join(__dir__, "*.dll")].sort
-        until pending.empty?
-          progressed = false
-          pending.delete_if do |dll|
-            Fiddle.dlopen(dll)
-            progressed = true
-            true
-          rescue Fiddle::DLError
-            false   # depends on a sibling not yet loaded — retry next pass
-          end
-          break unless progressed   # truly unloadable; let the require raise its own LoadError
-        end
-      SHIM
-    end
-
-    # --- internals -----------------------------------------------------------
-
-    # Delete any *.dll directly in `into` not on the kept list, any licenses\*
-    # file not kept, and a stale shim when no shim is being written.
-    def sweep_stale!(into, kept_dll_names, kept_license_names, write_shim)
-      Dir[File.join(into.tr("\\", "/"), "*.dll")].each do |dll|
-        File.delete(dll) unless kept_dll_names.include?(File.basename(dll).downcase)
-      end
-
-      ldir = File.join(into.tr("\\", "/"), LICENSES_DIR)
-      if File.directory?(ldir)
-        Dir[File.join(ldir, "*")].each do |f|
-          next unless File.file?(f)
-
-          File.delete(f) unless kept_license_names.include?(File.basename(f).downcase)
-        end
-        # Remove an empty licenses dir we no longer populate.
-        begin
-          Dir.rmdir(ldir) if Dir.empty?(ldir)
-        rescue SystemCallError
-          nil
-        end
-      end
-
-      shim = File.join(into.tr("\\", "/"), SHIM_NAME)
-      File.delete(shim) if !write_shim && File.exist?(shim)
-    end
-
-    # Warn when a vendored DLL base name also exists in Ruby's bindir
-    # (zlib1.dll/ffi-8.dll/yaml.dll shadowing, R§9.2) — first-loaded wins.
-    def warn_on_ruby_bin_collision(base, out)
-      bindir = RbConfig::CONFIG["bindir"].to_s
-      return if bindir.empty?
-
-      ruby_copy = File.join(bindir, base)
-      return unless File.exist?(ruby_copy)
-
-      out&.puts("[vcdeps] WARNING: #{base} also ships in #{bindir.tr('/', '\\')} " \
-                "— the copy loaded first wins process-wide; preload.rb runs " \
-                "first under normal require order.")
-    end
-
-    def win(path)
-      path.nil? ? path : path.tr("/", "\\")
-    end
-  end
-end

data/lib/vcdeps/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Vcdeps
-  VERSION = "0.1.0"
-end