rigortype 0.4.0 → 0.4.2

data/lib/rigor/environment/gated_signature_plan.rb

@@ -0,0 +1,339 @@
+# frozen_string_literal: true
+
+require "rbs"
+
+module Rigor
+  class Environment
+    # Issue #1713 — loading a {RequiredFeatures}-gated vendored directory minus only what another signature
+    # source already declares, instead of standing the whole directory down.
+    #
+    # `RbsLoader.build_env_for` first tries the directory whole. When that costs the environment something
+    # (`RbsLoader.gated_failures`), it builds the environment WITHOUT the directory and plans against it with
+    # {.build}: the plan is the directory's parsed declarations, rewritten in memory (the files on disk are never
+    # touched), so that
+    #
+    # - a method, attribute or alias another source declares on the same class is left out (an overload
+    #   continuation, `def m: ... | ...`, declares nothing of its own and needs the vendored base, so it keeps
+    #   it); a member declaring two methods loses only the one taken — an `attr_accessor` narrows to its reader
+    #   or writer, a `def self?.m` to its instance or singleton side;
+    # - a type whose header disagrees with another source's — a class one side declares as a module, or a
+    #   different generic arity — stands down as a whole: its declaration becomes a *shell*, the other source's
+    #   header with no members and no superclass, which keeps the vendored types nested inside it in their
+    #   lexical context;
+    # - a type in `shelled` (the types the trial build of a previous plan still failed for) is shelled the same
+    #   way when another source declares it. When none does — the type failed because something it names was
+    #   displaced, a superclass the project redeclared as a module, say — it keeps its own members and nested
+    #   types but loses its superclass, and is stamped as a Rigor-synthesized stub type
+    #   (`RbsLoader::SYNTHETIC_STUB_BUFFER`): its own members still type, and a call it no longer answers reads
+    #   `Dynamic[top]` rather than drawing `call.undefined-method` for a method it inherits at runtime.
+    #
+    # The kept declarations load where the directory would have loaded, ahead of the project's signatures, so
+    # which declaration is a class's primary one does not move; the shells load after them, so a shell never
+    # becomes the primary declaration of a class the project declares. The trial build stays the arbiter:
+    # `build_env_for` keeps a plan's environment only when every gated type builds in it.
+    #
+    # {.standdowns} reads what stood down back off a built environment, the way the other `rbs.coverage.*`
+    # notices are derived, so a warm run off the env cache reports what the cold run reported.
+    module GatedSignaturePlan
+      # Buffer name stamped on the shell declarations. Never a real path, so {.standdowns} tells a shell from the
+      # vendored declaration it replaced by it.
+      SHELL_BUFFER = "(rigor: vendored stand-down shells)"
+
+      # The buffer names Rigor synthesizes declarations under. They stand for no source, so neither a plan nor
+      # a stand-down report reads them as another source's declaration.
+      def self.synthetic_buffers
+        [SHELL_BUFFER, RbsLoader::SYNTHETIC_NAMESPACE_BUFFER, RbsLoader::SYNTHETIC_STUB_BUFFER]
+      end
+
+      # A planned load: `leading` and `shells` are `[buffer, directives, decls]` sources, `changed` is false
+      # when the plan is the directory as it stands.
+      Plan = Data.define(:leading, :shells, :changed)
+
+      # One plan's walk over the vendored declarations: the environment it plans against, the types to shell
+      # whatever their headers, and whether anything was left out.
+      class Planner
+        attr_reader :changed
+
+        def initialize(base_env, shelled)
+          @base_env = base_env
+          @shelled = shelled
+          @changed = false
+        end
+
+        # Splits `decls` into what loads ahead of the project's signatures and what loads after them.
+        def plan_decls(decls, namespace)
+          lead = []
+          shell = []
+          decls.each do |decl|
+            unless GatedSignaturePlan.type_declaration?(decl)
+              lead << decl
+              next
+            end
+
+            kept, shelled = plan_type(decl, GatedSignaturePlan.qualify(namespace, decl.name))
+            lead << kept if kept
+            shell << shelled if shelled
+          end
+          [lead, shell]
+        end
+
+        private
+
+        def plan_type(decl, name)
+          others = GatedSignaturePlan.other_declarations(@base_env, name)
+          nested = decl.members.select { |member| GatedSignaturePlan.type_declaration?(member) }
+          nested_lead, nested_shell = plan_decls(nested, name)
+          if GatedSignaturePlan.header_conflict?(decl, others) || (@shelled.include?(name) && !others.empty?)
+            @changed = true
+            return [nil, GatedSignaturePlan.header_copy(others.first, decl.name, nested_lead + nested_shell)]
+          end
+          return [nil, open_type(decl, nested_lead + nested_shell)] if @shelled.include?(name)
+
+          wrapper = nested_shell.empty? ? nil : GatedSignaturePlan.header_copy(decl, decl.name, nested_shell)
+          [keep_type(decl, others, nested_lead), wrapper]
+        end
+
+        # `decl` less the methods `others` declare, with its nested types replaced by their planned kept halves.
+        def keep_type(decl, others, nested_lead)
+          taken = GatedSignaturePlan.declared_keys(others)
+          own = decl.members.reject { |member| GatedSignaturePlan.type_declaration?(member) }
+          members = own.filter_map { |member| GatedSignaturePlan.untaken(member, taken) }
+          @changed ||= members.size != own.size || members.zip(own).any? { |kept, member| !kept.equal?(member) }
+          GatedSignaturePlan.rebuild(decl, members: members + nested_lead)
+        end
+
+        # A type no other source declares that still failed to build: its own members, no superclass, stamped as a
+        # synthesized stub type so what it no longer inherits reads untyped.
+        def open_type(decl, nested)
+          @changed = true
+          own = decl.members.reject { |member| GatedSignaturePlan.type_declaration?(member) }
+          GatedSignaturePlan.header_copy(decl, decl.name, own + nested, buffer_name: RbsLoader::SYNTHETIC_STUB_BUFFER)
+        end
+      end
+
+      module_function
+
+      # @param roots — the gated directories (Pathnames) to plan, each loaded whole on the first attempt.
+      # @param base_env — the environment built without them: every other signature source, resolved.
+      # @param shelled — absolute-less type names to shell regardless of their headers.
+      def build(roots, base_env, shelled = Set.new)
+        planner = Planner.new(base_env, shelled)
+        leading = []
+        shells = []
+        signature_files(roots).each do |file|
+          buffer, directives, decls = RbsLoader.parse_signature_file(file)
+          next if buffer.nil?
+
+          lead, shell = planner.plan_decls(decls, nil)
+          leading << [buffer, directives, lead]
+          shells << [shell_buffer, directives, shell] unless shell.empty?
+        end
+        Plan.new(leading: leading, shells: shells, changed: planner.changed)
+      end
+
+      def signature_files(roots)
+        roots.flat_map { |root| Dir.glob(File.join(root.to_s, "*.rbs")).sort }
+      end
+
+      def shell_buffer
+        ::RBS::Buffer.new(name: SHELL_BUFFER, content: "")
+      end
+
+      # The declarations of `name` in `env` that some other source made, synthesized stubs left out.
+      def other_declarations(env, name)
+        entry = env&.class_decls&.[](::RBS::TypeName.parse("::#{name}"))
+        return [] if entry.nil?
+
+        RbsLoader.entry_declarations(entry).reject { |decl| synthetic?(decl) }
+      end
+
+      def synthetic?(decl)
+        synthetic_buffers.include?(RbsLoader.declaration_buffer_name(decl))
+      end
+
+      # A class one side declares as a module, or a different number of type parameters. A disagreement the
+      # declarations do not show this plainly — a superclass, a variance, a bound — is the trial build's to find.
+      def header_conflict?(decl, others)
+        first = others.first
+        return false if first.nil?
+        return true unless first.instance_of?(decl.class)
+
+        first.type_params.size != decl.type_params.size
+      end
+
+      def declared_keys(others)
+        others.each_with_object(Set.new) do |other, keys|
+          other.members.each { |member| RbsLoader.member_method_keys(member).each { |key| keys << key } }
+        end
+      end
+
+      # `member` less the methods in `taken`: itself when it declares none of them, nil when it declares only
+      # them, else narrowed to the one it declares that is not taken.
+      def untaken(member, taken)
+        keys = RbsLoader.member_method_keys(member)
+        left = keys.reject { |key| taken.include?(key) }
+        return member if left.size == keys.size
+        return nil if left.empty?
+
+        narrowed(member, left.first)
+      end
+
+      # The two members that declare two methods: an `attr_accessor` (a reader and a writer) and a
+      # `def self?.m` (an instance and a singleton method). The instance side of a `self?` method is private
+      # (a module function), so narrowing to it keeps that.
+      def narrowed(member, key)
+        method_name, kind = key
+        if member.is_a?(::RBS::AST::Members::MethodDefinition)
+          return member.update(kind: kind, visibility: kind == :instance ? :private : member.visibility)
+        end
+
+        attribute = method_name.to_s.end_with?("=") ? ::RBS::AST::Members::AttrWriter : ::RBS::AST::Members::AttrReader
+        attribute.new(
+          name: member.name, type: member.type, ivar_name: member.ivar_name, kind: member.kind,
+          annotations: member.annotations, location: member.location, comment: member.comment,
+          visibility: member.visibility
+        )
+      end
+
+      # `source`'s kind and type parameters under `name`, carrying only `members` — no superclass, self types,
+      # annotations or members of its own, all of which a reopening declaration may omit.
+      def header_copy(source, name, members, buffer_name: SHELL_BUFFER)
+        location = ::RBS::Location.new(::RBS::Buffer.new(name: buffer_name, content: ""), 0, 0)
+        if source.is_a?(::RBS::AST::Declarations::Class)
+          ::RBS::AST::Declarations::Class.new(
+            name: name, type_params: source.type_params, super_class: nil, members: members,
+            annotations: [], location: location, comment: nil
+          )
+        else
+          ::RBS::AST::Declarations::Module.new(
+            name: name, type_params: source.type_params, members: members, self_types: [],
+            annotations: [], location: location, comment: nil
+          )
+        end
+      end
+
+      def rebuild(decl, members:)
+        if decl.is_a?(::RBS::AST::Declarations::Class)
+          ::RBS::AST::Declarations::Class.new(
+            name: decl.name, type_params: decl.type_params, super_class: decl.super_class, members: members,
+            annotations: decl.annotations, location: decl.location, comment: decl.comment
+          )
+        else
+          ::RBS::AST::Declarations::Module.new(
+            name: decl.name, type_params: decl.type_params, members: members, self_types: decl.self_types,
+            annotations: decl.annotations, location: decl.location, comment: decl.comment
+          )
+        end
+      end
+
+      def type_declaration?(decl)
+        decl.is_a?(::RBS::AST::Declarations::Class) || decl.is_a?(::RBS::AST::Declarations::Module)
+      end
+
+      def qualify(namespace, type_name)
+        text = type_name.to_s
+        return text.delete_prefix("::") if text.start_with?("::") || namespace.nil?
+
+        "#{namespace}::#{text}"
+      end
+
+      # What stood down from each of `roots` in `env`, as `[dir, entries, whole]`: `entries` are
+      # `[declaration, cause_file, reason]`, `declaration` reading `Integer#prime?`, `Integer.from_prime_division`
+      # or `Prime` (a whole type), `cause_file` the buffer name of the other source's declaration, or nil when it
+      # cannot be named, and `reason` one of `"member"` (another source declares that method), `"type"` (the
+      # type stood down whole, its header contradicted or failing beside another source's declaration) or
+      # `"open"` (it failed with no other source declaring it, and was kept without its superclass, unchecked).
+      # `whole` is true when the directory stood down entirely; its entries are then only the clashes the
+      # environment still shows. A directory nothing stood down from is left out.
+      #
+      # @param roots — `{dir_basename => Pathname}` of the gated directories the run activated.
+      # @param project_files — the project's own signature files: a cause is named from them (or from inline
+      #   RBS) in preference to another source, and only from them when the type failed rather than clashed.
+      def standdowns(env, roots, project_files = Set.new)
+        return [] if env.nil?
+
+        loaded = RbsLoader.loaded_signature_buffers(env)&.to_set { |buffer| buffer.name.to_s } || Set.new
+        roots.sort.filter_map do |dir, root|
+          files = signature_files([root])
+          whole = files.none? { |file| loaded.include?(file) }
+          entries = files.flat_map { |file| file_standdowns(env, file, whole, project_files) }.uniq
+          [dir, entries, whole] if whole || !entries.empty?
+        end
+      rescue ::RBS::BaseError
+        []
+      end
+
+      def file_standdowns(env, file, whole, project_files)
+        _buffer, _directives, decls = RbsLoader.parse_signature_file(file)
+        return [] if decls.nil?
+
+        entries = []
+        each_type(decls, nil) do |decl, name|
+          entries.concat(type_standdowns(env, file, [decl, name], whole, project_files))
+        end
+        entries
+      end
+
+      def each_type(decls, namespace, &block)
+        decls.each do |decl|
+          next unless type_declaration?(decl)
+
+          name = qualify(namespace, decl.name)
+          block.call(decl, name)
+          each_type(decl.members, name, &block)
+        end
+      end
+
+      def type_standdowns(env, file, (decl, name), whole, project_files)
+        entry = env.class_decls[::RBS::TypeName.parse("::#{name}")]
+        declarations = entry.nil? ? [] : RbsLoader.entry_declarations(entry)
+        vendored = declarations.select { |other| RbsLoader.declaration_buffer_name(other) == file }
+        others = declarations.reject { |other| vendored.include?(other) || synthetic?(other) }
+        # A partial load shells a type that stood down, so its vendored declaration is gone; a whole stand-down
+        # removed every vendored declaration, and only a header the environment still contradicts names a type.
+        conflict = header_conflict?(decl, others)
+        type_row = [[name, type_cause(others, conflict, project_files), "type"]]
+        return conflict ? type_row : member_standdowns(decl, name, [], others, true) if whole
+        return member_standdowns(decl, name, vendored, others, false) unless vendored.empty?
+        return [[name, nil, "open"]] if others.empty? && declarations.any? { |other| stub?(other) }
+
+        type_row
+      end
+
+      # A header clash names the declaration it clashed with, preferring the project's own; a type that only
+      # failed beside another source names a project or inline declaration of it, never core or a gem's copy.
+      def type_cause(others, conflict, project_files)
+        own = others.find do |other|
+          name = buffer_of(other).to_s
+          project_files.include?(name) || name.start_with?("virtual:")
+        end
+        buffer_of(own || (conflict ? others.first : nil))
+      end
+
+      def stub?(decl)
+        RbsLoader.declaration_buffer_name(decl) == RbsLoader::SYNTHETIC_STUB_BUFFER
+      end
+
+      def member_standdowns(decl, name, vendored, others, whole)
+        present = declared_keys(vendored)
+        decl.members.flat_map do |member|
+          RbsLoader.member_method_keys(member).reject { |key| present.include?(key) }.filter_map do |key|
+            cause = others.find { |other| other.members.any? { |m| RbsLoader.member_method_keys(m).include?(key) } }
+            next if whole && cause.nil?
+
+            [member_label(name, key), buffer_of(cause), "member"]
+          end
+        end
+      end
+
+      def member_label(name, key)
+        method_name, kind = key
+        "#{name}#{kind == :singleton ? '.' : '#'}#{method_name}"
+      end
+
+      def buffer_of(decl)
+        decl && RbsLoader.declaration_buffer_name(decl)
+      end
+    end
+  end
+end

data/lib/rigor/environment/lockfile_resolver.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../config_path"
+
 module Rigor
   class Environment
     # Gemfile.lock parser for target-project bundler awareness (O4 Layer 3, implemented).
@@ -109,11 +111,18 @@ module Rigor
       end
       private_class_method :do_parse_dependency_names
 
+      # The absolute path a configured `lockfile:` names, whether or not the file exists. The one place the
+      # setting is expanded (a leading `~/` is the home directory), shared by `resolve_lockfile_path` and
+      # by `WriteGuard`, which must watch the very path the run reads.
+      def self.configured_lockfile_path(lockfile_path, project_root = Dir.pwd)
+        Rigor::ConfigPath.absolute(lockfile_path.to_s, project_root)
+      end
+
       # Returns the resolved lockfile path (`Pathname`) or `nil` when neither explicit nor auto-detect
       # produces one. Public so the stats banner can show what rigor picked up.
       def self.resolve_lockfile_path(lockfile_path:, project_root: Dir.pwd, auto_detect: true)
         if lockfile_path
-          path = Pathname.new(File.expand_path(lockfile_path.to_s, project_root))
+          path = Pathname.new(configured_lockfile_path(lockfile_path, project_root))
           return path if path.file?
 
           return nil

data/lib/rigor/environment/rbs_collection_discovery.rb

@@ -2,6 +2,8 @@
 
 require "yaml"
 
+require_relative "../config_path"
+
 module Rigor
   class Environment
     # `rbs collection install` awareness (O4 Layer 3 slice 2, implemented).
@@ -68,11 +70,18 @@ module Rigor
         gem_paths_from(collection_root, data, skip_gem_names.to_set)
       end
 
+      # The absolute path a configured `lockfile:` names, whether or not the file exists. The one place the
+      # setting is expanded (a leading `~/` is the home directory), shared by `resolve_lockfile_path` and
+      # by `WriteGuard`, which must watch the very path the run reads.
+      def self.configured_lockfile_path(lockfile_path, project_root = Dir.pwd)
+        Rigor::ConfigPath.absolute(lockfile_path.to_s, project_root)
+      end
+
       # Returns the resolved lockfile path (`Pathname`) or `nil` when neither explicit nor auto-detect
       # produces one. Public so the stats banner can surface what rigor found.
       def self.resolve_lockfile_path(lockfile_path:, project_root: Dir.pwd, auto_detect: true)
         if lockfile_path
-          path = Pathname.new(File.expand_path(lockfile_path.to_s, project_root))
+          path = Pathname.new(configured_lockfile_path(lockfile_path, project_root))
           return path if path.file?
 
           return nil

data/lib/rigor/environment/rbs_coverage_report.rb

@@ -32,7 +32,7 @@ module Rigor
       # hard-coding is acceptable; a directory walk at every call would add stat-cost to no benefit.)
       VENDORED_GEM_NAMES = Set[
         "ast", "bcrypt", "bundler", "cgi", "did_you_mean",
-        "idn-ruby", "mysql2", "nokogiri", "pg", "prism", "racc", "redis", "rubygems"
+        "idn-ruby", "mysql2", "nokogiri", "pg", "prime", "prism", "racc", "redis", "rubygems"
       ].freeze
 
       # @param locked_gems — The lockfile-resolved gem set. Empty