rfmt 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4f41a4ba34f1bc106746712bf144fe6f5ee8cf5a80cf26efaecc8450645d89
-  data.tar.gz: 94f896c28015d9592d959ef3a42b4db80e309ad664ef97d5f28b0e8479605892
+  metadata.gz: a17203d9ab18d011d42790fc039889490f78bd9c1eb86701a15e15784bfafd4c
+  data.tar.gz: ae34f8b79a4d7e64fec13ea9b1a24ae8d1b46f03aeb4c64f302e52a3895c62e6
 SHA512:
-  metadata.gz: 0aef4d71101fd621bcecf87b0160e437ec9f7836e12759dbb28cd56416d1428bb3b54aabae888566548dc11557d1179e519aa5c971e613c3c37c775590eef981
-  data.tar.gz: 3ee34d6c250fdd9263822a8b361dc3fdde5005c36570a5a6a0be346f717090c581822c90cd08bee43674495c97a15fb22677558bd5be5b85f9ccd4c1d4fd9e51
+  metadata.gz: 390bd25696b21224e5c182b6516a4a1733281a93bae01eb3ae58a787f3d53b430e308a760d1b47adc1389f2bd389b544aa6fe41e6990d0de654c5ead89d8e31f
+  data.tar.gz: f638716804d25efc8d74cd18c6a2c1e014d459a63a91dea4968ff2e1f21fee4c51890781051e6c92e2c5cac6e924687b531d9ac412d1e9eae6bfef8155b1b166

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.4.1] - 2026-01-17
+
+### Fixed
+- Fixed comment positioning issue where standalone comments before `end` statements were incorrectly attached to previous code lines
+- Improved comment semantic preservation to maintain developer's original placement intent
+- Enhanced standalone comment detection logic to distinguish between inline and independent comments
+
 ## [1.4.0] - 2026-01-17
 
 ### Added

data/Cargo.lock

@@ -1214,7 +1214,7 @@ checksum = "7a2d987857b319362043e95f5353c0535c1f58eec5336fdfcf626430af7def58"
 
 [[package]]
 name = "rfmt"
-version = "1.4.0"
+version = "1.4.1"
 dependencies = [
  "anyhow",
  "clap",

data/ext/rfmt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rfmt"
-version = "1.4.0"
+version = "1.4.1"
 edition = "2021"
 authors = ["fujitani sora <fujitanisora0414@gmail.com>"]
 license = "MIT"

data/ext/rfmt/src/emitter/mod.rs

@@ -237,34 +237,58 @@ impl Emitter {
             })
     }
 
-    /// Emit comments that are within a given line range (exclusive of end_line)
-    /// Uses BTreeMap index for O(log n) lookup instead of O(n) iteration
-    fn emit_comments_in_range(
+    /// Emit comments that appear immediately before the end statement while preserving their position
+    /// This is crucial for maintaining semantic relationships between comments and the code they precede
+    fn emit_comments_before_end(
         &mut self,
-        start_line: usize,
-        end_line: usize,
+        construct_start_line: usize,
+        construct_end_line: usize,
         indent_level: usize,
     ) -> Result<()> {
         self.ensure_indent_cache(indent_level);
 
-        let indices = self.get_comment_indices_in_range(start_line, end_line);
+        // Implement proper comment positioning logic
+        // Only emit standalone comments that appear on their own lines
+        // This prevents comments from being incorrectly attached to code statements
+
+        // Find comments that are between the construct and the end line
+        // Only emit comments that haven't been emitted yet AND are on their own lines
+        let indices =
+            self.get_comment_indices_in_range(construct_start_line + 1, construct_end_line);
 
         let mut comments_to_emit: Vec<_> = indices
             .into_iter()
-            .filter(|&idx| self.all_comments[idx].location.end_line < end_line)
+            .filter(|&idx| {
+                let comment = &self.all_comments[idx];
+                // Only emit if: not already emitted, before end line, and is standalone
+                !self.emitted_comment_indices.contains(&idx)
+                    && comment.location.end_line < construct_end_line
+                    && self.is_standalone_comment(comment)
+            })
             .map(|idx| {
                 let comment = &self.all_comments[idx];
                 (idx, comment.location.start_line, comment.location.end_line)
             })
             .collect();
 
+        if comments_to_emit.is_empty() {
+            return Ok(());
+        }
+
         comments_to_emit.sort_by_key(|(_, start, _)| *start);
 
-        let mut last_comment_end_line: Option<usize> = None;
+        // Ensure newline before first comment if buffer doesn't end with one
+        if !self.buffer.ends_with('\n') {
+            self.buffer.push('\n');
+        }
 
+        let mut last_emitted_line: Option<usize> = None;
+
+        // Emit comments while preserving their exact line positioning
         for (idx, comment_start_line, comment_end_line) in comments_to_emit {
-            if let Some(prev_end) = last_comment_end_line {
-                let gap = comment_start_line.saturating_sub(prev_end);
+            // Preserve blank lines between comments
+            if let Some(prev_line) = last_emitted_line {
+                let gap = comment_start_line.saturating_sub(prev_line);
                 for _ in 1..gap {
                     self.buffer.push('\n');
                 }
@@ -276,12 +300,50 @@ impl Emitter {
                 &self.indent_cache[indent_level], &self.all_comments[idx].text
             )?;
             self.emitted_comment_indices.insert(idx);
-            last_comment_end_line = Some(comment_end_line);
+            last_emitted_line = Some(comment_end_line);
         }
 
         Ok(())
     }
 
+    /// Check if a comment should be treated as standalone
+    /// A standalone comment is one that should appear on its own line,
+    /// not attached to the end of a code statement
+    fn is_standalone_comment(&self, comment: &Comment) -> bool {
+        let comment_line = comment.location.start_line;
+        let _comment_start_offset = comment.location.start_offset;
+
+        // Get the source lines to analyze the comment's position
+        let lines: Vec<&str> = self.source.lines().collect();
+
+        // Check if we have a valid line number (1-indexed to 0-indexed)
+        if comment_line == 0 || comment_line > lines.len() {
+            return false;
+        }
+
+        let line = lines[comment_line - 1]; // Convert to 0-indexed
+
+        // Find where the comment starts within the line
+        let comment_text = &comment.text;
+
+        // Look for the comment marker (#) in the line
+        if let Some(hash_pos) = line.find('#') {
+            // Check if there's only whitespace before the comment
+            let before_comment = &line[..hash_pos];
+            let is_only_whitespace = before_comment.trim().is_empty();
+
+            // Also verify this is actually our comment by checking the text matches
+            let line_comment_text = &line[hash_pos..];
+            let is_same_comment = line_comment_text.trim_end() == comment_text.trim_end();
+
+            return is_only_whitespace && is_same_comment;
+        }
+
+        // If we can't find the comment marker, assume it's standalone
+        // This is a fallback for edge cases
+        false
+    }
+
     /// Emit comments that are within a given line range, preserving blank lines from prev_line
     /// Uses BTreeMap index for O(log n) lookup instead of O(n) iteration
     fn emit_comments_in_range_with_prev_line(
@@ -464,9 +526,8 @@ impl Emitter {
             self.emit_node(child, indent_level + 1)?;
         }
 
-        // Emit comments that are inside the class body but not attached to any node
-        // These are comments between class_start_line and class_end_line
-        self.emit_comments_in_range(class_start_line + 1, class_end_line, indent_level + 1)?;
+        // Emit comments that appear before the end statement while preserving their position
+        self.emit_comments_before_end(class_start_line, class_end_line, indent_level + 1)?;
 
         // Add newline before end if there was body content or internal comments
         if (has_body_content || self.has_comments_in_range(class_start_line + 1, class_end_line))
@@ -512,8 +573,8 @@ impl Emitter {
             self.emit_node(child, indent_level + 1)?;
         }
 
-        // Emit comments that are inside the module body but not attached to any node
-        self.emit_comments_in_range(module_start_line + 1, module_end_line, indent_level + 1)?;
+        // Emit comments that appear before the end statement while preserving their position
+        self.emit_comments_before_end(module_start_line, module_end_line, indent_level + 1)?;
 
         // Add newline before end if there was body content or internal comments
         if (has_body_content || self.has_comments_in_range(module_start_line + 1, module_end_line))
@@ -573,6 +634,13 @@ impl Emitter {
             self.emit_node(child, indent_level + 1)?;
         }
 
+        // Emit comments that appear before the end statement while preserving their position
+        self.emit_comments_before_end(
+            node.location.start_line,
+            node.location.end_line,
+            indent_level + 1,
+        )?;
+
         // Add newline before end if there was body content
         if node
             .children
@@ -1457,8 +1525,8 @@ impl Emitter {
             }
         }
 
-        // Emit comments inside the singleton class body
-        self.emit_comments_in_range(class_start_line + 1, class_end_line, indent_level + 1)?;
+        // Emit comments that appear before the end statement while preserving their position
+        self.emit_comments_before_end(class_start_line, class_end_line, indent_level + 1)?;
 
         // Add newline before end if there was body content
         if (has_body_content || self.has_comments_in_range(class_start_line + 1, class_end_line))

data/lib/rfmt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rfmt
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - fujitani sora