rfmt 1.3.4 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac6a3e001e85e27839f04ba78564e5bc16675818b2603a179f62d7fa35c9062
-  data.tar.gz: 4957bbc0de84f4e5c72dacf514ea0e87f211979667a50b53f365c005f1ee710a
+  metadata.gz: a17203d9ab18d011d42790fc039889490f78bd9c1eb86701a15e15784bfafd4c
+  data.tar.gz: ae34f8b79a4d7e64fec13ea9b1a24ae8d1b46f03aeb4c64f302e52a3895c62e6
 SHA512:
-  metadata.gz: 470807974090b7b41d5c9bf5dd437cd34d80cdbb45ed1c9af2d97f93c0a01c88e5e709dcb47b6e077909be7bbb586f7df4eb798e2403dd2186a4d08b6770463e
-  data.tar.gz: 6620293ef2c43673eecbf478e2c4d3ba1b79a0ad71e67ec984547c0aeda36e03f7c10d848c646a74bc392e4057aeb2f4c4dc56d2602a96e295bf77f0fbedbf3e
+  metadata.gz: 390bd25696b21224e5c182b6516a4a1733281a93bae01eb3ae58a787f3d53b430e308a760d1b47adc1389f2bd389b544aa6fe41e6990d0de654c5ead89d8e31f
+  data.tar.gz: f638716804d25efc8d74cd18c6a2c1e014d459a63a91dea4968ff2e1f21fee4c51890781051e6c92e2c5cac6e924687b531d9ac412d1e9eae6bfef8155b1b166

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [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
+- New `rfmt_fast` executable for optimized performance
+- Automatic parallel processing detection logic  
+- Enhanced logging and summary display functionality
+- CLI option mapping for `-v/--version` commands
+
+### Fixed
+- Fixed `-v` flag incorrectly triggering format instead of showing version
+- Fixed `--diff` option dependency issues (added `diffy` and `diff-lcs` to gemspec)
+- CLI option conflicts between verbose and version flags
+
+### Changed
+- Updated performance benchmarks documentation
+- Code formatting improvements with Rubocop compliance
+- Dependencies alphabetically sorted in gemspec
+
 ## [1.3.4] - 2026-01-17
 
 ### Added

data/Cargo.lock

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

data/README.md

@@ -46,33 +46,31 @@ Enforces code style rules:
 - Quote style standardization
 - Method definition formatting
 
-## Performance Benchmarks
+## Performance
 
-Execution time comparison on a Rails project (111 files, 3,241 lines):
+rfmt delivers consistent, fast formatting across projects of any size:
 
-| Test Type | Files | rfmt | RuboCop | Ratio |
-|-----------|-------|------|---------|-------|
-| Single File | 1 | 191ms | 1.38s | 7.2x |
-| Directory | 14 | 176ms | 1.68s | 9.6x |
-| Full Project (check) | 111 | 172ms | 4.36s | 25.4x |
+| Project Size | Files | Execution Time | Throughput |
+|-------------|-------|----------------|------------|
+| Small | 9 files | ~105ms | 85 files/sec |
+| Medium | 35 files | ~110ms | 315 files/sec |
+| Large | 151 files | ~100ms | 1,560 files/sec |
 
-**About this comparison:**
-- RuboCop times include startup overhead and loading all cops (linting rules)
-- RuboCop was run with default configuration (all cops enabled)
-- rfmt is a formatting-only tool with minimal overhead
-- Both tools were measured in check mode (no file modifications)
-- Results are averages from 10 runs per test
+**Key Performance Characteristics:**
 
-**Observations:**
-- rfmt execution time remains constant (172-191ms) regardless of file count
-- Low variance across runs (standard deviation: 8-23ms)
+- **Constant Time**: Execution time stays around 100ms regardless of project size
+- **Parallel Processing**: Automatic scaling with available CPU cores
+- **High Throughput**: Up to 1,500+ files per second on large projects
+- **Low Overhead**: Minimal startup time and memory usage
 
 **Test Environment:**
 - CPU: Apple Silicon (arm64)
-- Ruby: 3.4.5
-- rfmt: 0.3.0, RuboCop: 1.81.7
+- Ruby: 3.4.8
+- Average of 5 runs per test
 
-See [detailed benchmark report](docs/benchmark.md) for complete data.
+*Built with Rust for optimal performance and memory efficiency.*
+
+For detailed performance comparisons and benchmarks, see [Performance Benchmarks](docs/benchmark.md).
 
 ## Installation
 

data/ext/rfmt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rfmt"
-version = "1.3.4"
+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/cli.rb

@@ -3,7 +3,7 @@
 require 'thor'
 
 # Check for verbose flag before loading rfmt to set debug mode early
-ENV['RFMT_DEBUG'] = '1' if ARGV.include?('-v') || ARGV.include?('--verbose')
+ENV['RFMT_DEBUG'] = '1' if ARGV.include?('--verbose')
 
 require 'rfmt'
 require 'rfmt/configuration'
@@ -49,10 +49,14 @@ module Rfmt
     PROGRESS_INTERVAL = 10   # Update progress every N files
 
     class_option :config, type: :string, desc: 'Path to configuration file'
-    class_option :verbose, type: :boolean, aliases: '-v', desc: 'Verbose output'
+    class_option :verbose, type: :boolean, desc: 'Verbose output'
 
     default_command :format
 
+    # Map -v and --version to version command
+    map '-v' => 'version'
+    map '--version' => 'version'
+
     desc 'format [FILES]', 'Format Ruby files (default command)'
     option :write, type: :boolean, default: true, desc: 'Write formatted output'
     option :check, type: :boolean, desc: "Check if files are formatted (don't write)"

data/lib/rfmt/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.1
 platform: ruby
 authors:
 - fujitani sora
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2026-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rb_sys
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.120
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Write a longer description or delete this line.
 email:
 - fujitanisora0414@gmail.com