pray-cli 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3eed0e334baf8334039a526f2221f2122c34bbf490a815fb8a210c21eeba13b
-  data.tar.gz: 36cb614f2b19bd710caa82c775e46557d1701f49e3e8b411eadfd23bc88afbc1
+  metadata.gz: 7712d0c9a8ea370b50c90c7212ab7d15ea2c8ea90a304365194f9c34242b72dc
+  data.tar.gz: 0a5a5de36c49409e1e9bb8d689a1fdd7284eaa79b472eee210f19144835812a4
 SHA512:
-  metadata.gz: 7aeea821b13ff710f042ea0834216d1721358a740ed9965c483014fb40835495acf75ebf9ec70c67c3f0703cf02fe5c24c2fd40d6db020220d5ac4a00a857be0
-  data.tar.gz: 6e89e827f444588cd1c679e8e185c9a6bd2259c45ed2963edd832ae9e468017d73ba9ce63e476af6f8618de1b2f1ff4bfb5346bee8c4916f1f6ee65188484262
+  metadata.gz: 6750b00e4f4cc372849209ec4e23ae222cee7ef49134afe7dd2f2fbd19d2efcfd1bed5a143ae829b17c68b596d2320e1a8095be36c01c335c894f07c4415bcc0
+  data.tar.gz: 173d7e11c528fec7a3d816aedb511952e8189e2ba8fd061245c0cf13b3a00a9f658df255be54c0e44b75326c47435f88933d867bea0db4ffa99cc0456089effa

data/lib/pray/verify.rb

@@ -20,7 +20,7 @@ module Pray
     module_function
 
     def inspect_project(project, lockfile)
-      collect_verification_report(project, lockfile).first
+      collect_verification_report(project, lockfile)[0]
     end
 
     def verify_project(project, lockfile, strict: false)
@@ -35,21 +35,21 @@ module Pray
     end
 
     def drift_project(project, lockfile)
-      report, rendered_targets = collect_verification_report(project, lockfile)
-      Render.render_project(project).each do |target|
-        normalized_fresh = Hashing.normalize_line_endings(target.content)
-        on_disk = rendered_targets[target.path]
+      report, rendered_targets, fresh_targets = collect_verification_report(project, lockfile)
+      fresh_targets.each do |path, fresh_content|
+        normalized_fresh = Hashing.normalize_line_endings(fresh_content)
+        on_disk = rendered_targets[path]
         on_disk = Hashing.normalize_line_endings(on_disk) if on_disk
         unless on_disk == normalized_fresh
           report.findings << VerificationFinding.new(
             kind: "renderer_drift",
-            message: "#{target.path} differs from fresh render"
+            message: "#{path} differs from fresh render"
           )
         end
-        unless lockfile_targets(lockfile).include?(target.path)
+        unless lockfile_targets(lockfile).include?(path)
           report.findings << VerificationFinding.new(
             kind: "renderer_drift",
-            message: "#{target.path} is not tracked in lockfile"
+            message: "#{path} is not tracked in lockfile"
           )
         end
       end
@@ -64,6 +64,7 @@ module Pray
     def collect_verification_report(project, lockfile)
       report = VerificationReport.new
       rendered_targets = {}
+      fresh_targets = Render.render_project(project).to_h { |target| [target.path, target.content] }
 
       if project.manifest_hash != lockfile.manifest_hash
         report.findings << VerificationFinding.new(
@@ -125,21 +126,30 @@ module Pray
               message: "`#{target_path}` is missing managed marker `#{span.id}` for `#{span.package}::#{span.export}`. Run `pray install` to restore the managed span."
             )
           else
-            open_line, close_line, checksum = marker
+            _open_line, _close_line, checksum = marker
             if checksum != span.ideal_checksum
               report.findings << VerificationFinding.new(
                 kind: "custom_implementation",
                 message: "`#{target_path}` marker `#{span.id}` (`#{span.package}::#{span.export}`) was edited. Restore the managed block or run `pray install` to regenerate it."
               )
             end
-            if open_line != span.open_line || close_line != span.close_line
-              report.findings << VerificationFinding.new(
-                kind: "position_drift",
-                message: "`#{target_path}` marker `#{span.id}` (`#{span.package}::#{span.export}`) moved to different lines. Run `pray install` to restore expected positions."
-              )
-            end
           end
         end
+        fresh_lines = fresh_targets[target_path]&.lines(chomp: true)
+        summary = VerifyPosition.summarize_position_drift(
+          target_path,
+          spans,
+          markers,
+          lines,
+          fresh_lines,
+          project.local_files
+        )
+        if summary
+          report.findings << VerificationFinding.new(
+            kind: "position_drift",
+            message: VerifyPosition.format_position_drift_message(summary)
+          )
+        end
         find_orphan_marker_findings(spans, markers, target_path).each do |finding|
           report.findings << finding
         end
@@ -155,7 +165,7 @@ module Pray
         )
       end
 
-      [report, rendered_targets]
+      [report, rendered_targets, fresh_targets]
     end
 
     def find_orphan_marker_findings(spans, markers, target_path)

data/lib/pray/verify_position.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Pray
+  module VerifyPosition
+    module_function
+
+    PositionDriftSummary = Struct.new(
+      :target_path,
+      :marker_count,
+      :uniform_delta,
+      :first_id,
+      :lock_open,
+      :lock_close,
+      :file_open,
+      :file_close,
+      :cause,
+      keyword_init: true
+    )
+
+    def summarize_position_drift(target_path, spans, markers, on_disk_lines, fresh_lines, local_files)
+      drifted = []
+      spans.each do |span|
+        marker = markers[span.id]
+        next if marker.nil?
+
+        open_line, close_line, checksum = marker
+        next if checksum != span.ideal_checksum
+        next if open_line == span.open_line && close_line == span.close_line
+
+        drifted << {
+          id: span.id,
+          lock_open: span.open_line,
+          lock_close: span.close_line,
+          file_open: open_line,
+          file_close: close_line
+        }
+      end
+      return nil if drifted.empty?
+
+      drifted.sort_by! { |marker| marker[:file_open] }
+      first = drifted.first
+      deltas = drifted.map { |marker| marker[:file_open] - marker[:lock_open] }
+      uniform_delta = (deltas.all? { |delta| delta == deltas.first }) ? deltas.first : nil
+      cause = if fresh_lines
+        unmarked_drift_cause(target_path, on_disk_lines, fresh_lines, local_files)
+      end
+
+      PositionDriftSummary.new(
+        target_path: target_path,
+        marker_count: drifted.length,
+        uniform_delta: uniform_delta,
+        first_id: first[:id],
+        lock_open: first[:lock_open],
+        lock_close: first[:lock_close],
+        file_open: first[:file_open],
+        file_close: first[:file_close],
+        cause: cause
+      )
+    end
+
+    def format_position_drift_message(summary)
+      shift = if summary.uniform_delta && !summary.uniform_delta.zero?
+        format(" (%+d lines)", summary.uniform_delta)
+      else
+        ""
+      end
+      marker_word = (summary.marker_count == 1) ? "marker" : "markers"
+      parts = [
+        "`#{summary.target_path}` position drift#{shift} across #{summary.marker_count} #{marker_word}",
+        "first marker `#{summary.first_id}` lock #{summary.lock_open}:#{summary.lock_close}, file #{summary.file_open}:#{summary.file_close}"
+      ]
+      parts << "cause: #{summary.cause}" if summary.cause
+      parts << "Align unmarked text with compose sources, or run `pray install` to refresh lock positions."
+      parts.join("; ")
+    end
+
+    def unmarked_drift_cause(target_path, on_disk_lines, fresh_lines, local_files)
+      disk_preamble = preamble_lines(on_disk_lines)
+      fresh_preamble = preamble_lines(fresh_lines)
+      diff = first_line_diff(disk_preamble, fresh_preamble)
+      return nil unless diff
+
+      index, disk_line, fresh_line = diff
+      target_line = index + 1
+      if (local = locate_line_in_locals(local_files, fresh_line))
+        return "`#{target_path}:#{target_line}` unmarked text differs from `#{local[0]}:#{local[1]}`"
+      end
+      if (local = locate_line_in_locals(local_files, disk_line))
+        return "`#{target_path}:#{target_line}` unmarked text differs from `#{local[0]}:#{local[1]}`"
+      end
+
+      "`#{target_path}:#{target_line}` unmarked text differs from fresh composition"
+    end
+
+    def preamble_lines(lines)
+      preamble = []
+      lines.each do |line|
+        break if managed_marker?(line)
+
+        preamble << line
+      end
+      preamble
+    end
+
+    def managed_marker?(line)
+      trimmed = line.strip
+      return false unless trimmed.start_with?("<!-- pray:") && trimmed.end_with?(" -->")
+
+      id = trimmed.delete_prefix("<!-- pray:").delete_suffix(" -->")
+      id != "0 ignore-comments" && id.match?(/\A[a-z0-9]+\z/)
+    end
+
+    def first_line_diff(left, right)
+      shared = [left.length, right.length].min
+      shared.times do |index|
+        return [index, left[index], right[index]] if left[index] != right[index]
+      end
+      return nil if left.length == right.length
+
+      index = shared
+      [index, left[index] || "", right[index] || ""]
+    end
+
+    def locate_line_in_locals(local_files, line)
+      return nil if line.nil? || line.empty?
+
+      local_files.each do |local|
+        local.content.each_line(chomp: true).with_index do |candidate, index|
+          return [local.manifest_path, index + 1] if candidate == line
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/pray/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Pray
-  VERSION = "1.8.0"
-  GENERATED_BY = "pray 1.8.0"
+  VERSION = "1.8.1"
+  GENERATED_BY = "pray 1.8.1"
 end

data/lib/pray.rb

@@ -22,6 +22,7 @@ require_relative "pray/resolve_context"
 require_relative "pray/invocation"
 require_relative "pray/resolve"
 require_relative "pray/render"
+require_relative "pray/verify_position"
 require_relative "pray/verify"
 require_relative "pray/registry"
 require_relative "pray/archive"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pray-cli
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Andrei Makarov
@@ -155,6 +155,7 @@ files:
 - lib/pray/trust_feed.rb
 - lib/pray/trust_ops.rb
 - lib/pray/verify.rb
+- lib/pray/verify_position.rb
 - lib/pray/version.rb
 - pray-cli.gemspec
 homepage: https://pray.kisko.dev