rfmt 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17203d9ab18d011d42790fc039889490f78bd9c1eb86701a15e15784bfafd4c
-  data.tar.gz: ae34f8b79a4d7e64fec13ea9b1a24ae8d1b46f03aeb4c64f302e52a3895c62e6
+  metadata.gz: 75dbfbcc5bd176d4dc5394a718354c0d027c6ae2d855e2ee70422b3b17c91c8f
+  data.tar.gz: dafa925df2d12a4f055da3e03c777f96fb235eb5fde1b1d28c34ca8ba2ad110d
 SHA512:
-  metadata.gz: 390bd25696b21224e5c182b6516a4a1733281a93bae01eb3ae58a787f3d53b430e308a760d1b47adc1389f2bd389b544aa6fe41e6990d0de654c5ead89d8e31f
-  data.tar.gz: f638716804d25efc8d74cd18c6a2c1e014d459a63a91dea4968ff2e1f21fee4c51890781051e6c92e2c5cac6e924687b531d9ac412d1e9eae6bfef8155b1b166
+  metadata.gz: 6444ec42f910b398e3129dbb9028577a9eb893de5224fcf35bd1ccc961142b6a9f33bda5f26c369ca6b8c569a5d26c166a81526c323f1cf7483d639e6e8dbc14
+  data.tar.gz: 4c013c8e0f7263c472c38cdbbdb12990f517e66fa5be011b9d7535ccb2cba473ba9ed958e0b5ff7fc789c693bc39c47bafa3cdfdb7bf06f6d55ba6d4b5b2e6a3

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 ## [Unreleased]
 
+## [1.5.1] - 2026-02-21
+
+### Fixed
+- Fix inline modifier `if`/`unless` formatting (#87)
+- Fix heredoc command incorrectly removed (#90, #86)
+- Fix method chain command dependency handling (#89, #85)
+
+### Added
+- Heredoc comment deletion support
+- Place block loop emission support
+
+### Changed
+- Update README.md
+- Code formatting improvements (RuboCop compliance)
+
+## [1.5.0] - 2026-01-25
+
+### Added
+- Docker Compose test environment setup (#84)
+- Support for `then` expression emission (#80)
+- CI support for Ruby 3.4 and Ruby 4 (#82)
+
+### Changed
+- Upgrade Magnus (Rust-Ruby FFI library) (#83)
+- Optimize Docker build with multi-stage and caching (#84)
+- Upgrade unicode-emoji dependency
+
+### Fixed
+- Preserve heredoc content and closing identifier (#81)
+- Fix `rescue`/`ensure` clauses being deleted inside `do...end` blocks (#78)
+- Fix inline comment node handling (#77)
+- Fix BTreeMap range error (Issue #71)
+
 ## [1.4.1] - 2026-01-17
 
 ### Fixed

data/Cargo.lock

@@ -838,9 +838,9 @@ dependencies = [
 
 [[package]]
 name = "magnus"
-version = "0.6.4"
+version = "0.8.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1597ef40aa8c36be098249e82c9a20cf7199278ac1c1a1a995eeead6a184479"
+checksum = "3b36a5b126bbe97eb0d02d07acfeb327036c6319fd816139a49824a83b7f9012"
 dependencies = [
  "magnus-macros",
  "rb-sys",
@@ -850,9 +850,9 @@ dependencies = [
 
 [[package]]
 name = "magnus-macros"
-version = "0.6.0"
+version = "0.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5968c820e2960565f647819f5928a42d6e874551cab9d88d75e3e0660d7f71e3"
+checksum = "47607461fd8e1513cb4f2076c197d8092d921a1ea75bd08af97398f593751892"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1168,9 +1168,9 @@ dependencies = [
 
 [[package]]
 name = "rb-sys-env"
-version = "0.1.2"
+version = "0.2.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a35802679f07360454b418a5d1735c89716bde01d35b1560fc953c1415a0b3bb"
+checksum = "cca7ad6a7e21e72151d56fe2495a259b5670e204c3adac41ee7ef676ea08117a"
 
 [[package]]
 name = "redox_users"
@@ -1214,7 +1214,7 @@ checksum = "7a2d987857b319362043e95f5353c0535c1f58eec5336fdfcf626430af7def58"
 
 [[package]]
 name = "rfmt"
-version = "1.4.1"
+version = "1.5.1"
 dependencies = [
  "anyhow",
  "clap",

data/README.md

@@ -23,6 +23,7 @@ A Ruby code formatter written in Rust
 ## What is rfmt?
 
 [RubyGems reference](https://rubygems.org/gems/rfmt)
+[DeepWiki rfmt](https://deepwiki.com/fs0414/rfmt)
 
 **rfmt** is a Ruby code formatter that enforces consistent style across your codebase. Key characteristics:
 

data/ext/rfmt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rfmt"
-version = "1.4.1"
+version = "1.5.1"
 edition = "2021"
 authors = ["fujitani sora <fujitanisora0414@gmail.com>"]
 license = "MIT"
@@ -12,8 +12,8 @@ crate-type = ["cdylib"]
 
 [dependencies]
 # Ruby FFI
-magnus = { version = "0.6.2" }
-rb-sys = "0.9.117"
+magnus = { version = "0.8.2" }
+rb-sys = "0.9.124"
 
 # Serialization
 serde = { version = "1.0", features = ["derive"] }

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

@@ -144,6 +144,10 @@ impl Emitter {
     /// Get comment indices in the given line range [start_line, end_line)
     /// Uses BTreeMap range for O(log n) lookup instead of O(n) iteration
     fn get_comment_indices_in_range(&self, start_line: usize, end_line: usize) -> Vec<usize> {
+        // Guard against invalid range (e.g., endless methods where start_line >= end_line)
+        if start_line >= end_line {
+            return Vec::new();
+        }
         self.comments_by_line
             .range(start_line..end_line)
             .flat_map(|(_, indices)| indices.iter().copied())
@@ -228,6 +232,10 @@ impl Emitter {
     /// Check if there are any unemitted comments in the given line range
     /// Uses BTreeMap index for O(log n) lookup instead of O(n) iteration
     fn has_comments_in_range(&self, start_line: usize, end_line: usize) -> bool {
+        // Guard against invalid range (e.g., endless methods where start_line >= end_line)
+        if start_line >= end_line {
+            return false;
+        }
         self.comments_by_line
             .range(start_line..end_line)
             .flat_map(|(_, indices)| indices.iter())
@@ -344,6 +352,31 @@ impl Emitter {
         false
     }
 
+    /// Check if the node spans only a single line
+    fn is_single_line(&self, node: &Node) -> bool {
+        node.location.start_line == node.location.end_line
+    }
+
+    /// Extract and write source text for a node
+    fn write_source_text(&mut self, node: &Node) -> Result<()> {
+        let start = node.location.start_offset;
+        let end = node.location.end_offset;
+        if let Some(text) = self.source.get(start..end) {
+            write!(self.buffer, "{}", text)?;
+        }
+        Ok(())
+    }
+
+    /// Extract and write trimmed source text for a node
+    fn write_source_text_trimmed(&mut self, node: &Node) -> Result<()> {
+        let start = node.location.start_offset;
+        let end = node.location.end_offset;
+        if let Some(text) = self.source.get(start..end) {
+            write!(self.buffer, "{}", text.trim())?;
+        }
+        Ok(())
+    }
+
     /// 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(
@@ -899,25 +932,30 @@ impl Emitter {
 
         // Emit conditions with comma separator
         for (i, cond) in conditions.iter().enumerate() {
-            let start = cond.location.start_offset;
-            let end = cond.location.end_offset;
-            if let Some(text) = self.source.get(start..end) {
-                write!(self.buffer, "{}", text)?;
-            }
+            self.write_source_text(cond)?;
             if i < conditions.len() - 1 {
                 write!(self.buffer, ", ")?;
             }
         }
 
-        self.buffer.push('\n');
-
-        // Emit statements body
-        if let Some(statements) = node
+        let statements = node
             .children
             .iter()
-            .find(|c| matches!(c.node_type, NodeType::StatementsNode))
-        {
-            self.emit_statements(statements, indent_level + 1)?;
+            .find(|c| matches!(c.node_type, NodeType::StatementsNode));
+
+        if self.is_single_line(node) {
+            // Inline style: when X then Y
+            if let Some(statements) = statements {
+                write!(self.buffer, " then ")?;
+                self.write_source_text(statements)?;
+            }
+        } else {
+            // Multi-line style: when X\n  Y
+            self.buffer.push('\n');
+
+            if let Some(statements) = statements {
+                self.emit_statements(statements, indent_level + 1)?;
+            }
         }
 
         Ok(())
@@ -951,14 +989,7 @@ impl Emitter {
             // Emit statement
             if let Some(statements) = node.children.get(1) {
                 if matches!(statements.node_type, NodeType::StatementsNode) {
-                    // Extract the statement text (without extra indentation)
-                    if !self.source.is_empty() {
-                        let start = statements.location.start_offset;
-                        let end = statements.location.end_offset;
-                        if let Some(text) = self.source.get(start..end) {
-                            write!(self.buffer, "{}", text.trim())?;
-                        }
-                    }
+                    self.write_source_text_trimmed(statements)?;
                 }
             }
 
@@ -966,15 +997,10 @@ impl Emitter {
 
             // Emit condition
             if let Some(predicate) = node.children.first() {
-                if !self.source.is_empty() {
-                    let start = predicate.location.start_offset;
-                    let end = predicate.location.end_offset;
-                    if let Some(text) = self.source.get(start..end) {
-                        write!(self.buffer, "{}", text)?;
-                    }
-                }
+                self.write_source_text(predicate)?;
             }
 
+            self.emit_trailing_comments(node.location.end_line)?;
             return Ok(());
         }
 
@@ -991,26 +1017,14 @@ impl Emitter {
 
             // Emit condition
             if let Some(predicate) = node.children.first() {
-                if !self.source.is_empty() {
-                    let start = predicate.location.start_offset;
-                    let end = predicate.location.end_offset;
-                    if let Some(text) = self.source.get(start..end) {
-                        write!(self.buffer, "{}", text)?;
-                    }
-                }
+                self.write_source_text(predicate)?;
             }
 
             write!(self.buffer, " ? ")?;
 
             // Emit then expression
             if let Some(statements) = node.children.get(1) {
-                if !self.source.is_empty() {
-                    let start = statements.location.start_offset;
-                    let end = statements.location.end_offset;
-                    if let Some(text) = self.source.get(start..end) {
-                        write!(self.buffer, "{}", text.trim())?;
-                    }
-                }
+                self.write_source_text_trimmed(statements)?;
             }
 
             write!(self.buffer, " : ")?;
@@ -1018,16 +1032,38 @@ impl Emitter {
             // Emit else expression
             if let Some(else_node) = node.children.get(2) {
                 if let Some(else_statements) = else_node.children.first() {
-                    if !self.source.is_empty() {
-                        let start = else_statements.location.start_offset;
-                        let end = else_statements.location.end_offset;
-                        if let Some(text) = self.source.get(start..end) {
-                            write!(self.buffer, "{}", text.trim())?;
-                        }
-                    }
+                    self.write_source_text_trimmed(else_statements)?;
                 }
             }
 
+            self.emit_trailing_comments(node.location.end_line)?;
+            return Ok(());
+        }
+
+        // Check for inline then style: "if true then 1 end"
+        // Single line, not postfix, not ternary, no else clause
+        let is_inline_then =
+            !is_elsif && self.is_single_line(node) && node.children.get(2).is_none();
+
+        if is_inline_then {
+            self.emit_comments_before(node.location.start_line, indent_level)?;
+            self.emit_indent(indent_level)?;
+            write!(self.buffer, "{} ", keyword)?;
+
+            // Emit condition
+            if let Some(predicate) = node.children.first() {
+                self.write_source_text(predicate)?;
+            }
+
+            write!(self.buffer, " then ")?;
+
+            // Emit statement
+            if let Some(statements) = node.children.get(1) {
+                self.write_source_text_trimmed(statements)?;
+            }
+
+            write!(self.buffer, " end")?;
+            self.emit_trailing_comments(node.location.end_line)?;
             return Ok(());
         }
 
@@ -1046,14 +1082,7 @@ impl Emitter {
 
         // Emit predicate (condition) - first child
         if let Some(predicate) = node.children.first() {
-            // Extract predicate from source
-            if !self.source.is_empty() {
-                let start = predicate.location.start_offset;
-                let end = predicate.location.end_offset;
-                if let Some(text) = self.source.get(start..end) {
-                    write!(self.buffer, "{}", text)?;
-                }
-            }
+            self.write_source_text(predicate)?;
         }
 
         // Emit trailing comment on same line as if/unless/elsif
@@ -1169,6 +1198,16 @@ impl Emitter {
             if let Some(text) = self.source.get(start..end) {
                 // Trim trailing whitespace but preserve the content
                 write!(self.buffer, "{}", text.trim_end())?;
+
+                // Mark comments within the extracted range as emitted
+                for (idx, comment) in self.all_comments.iter().enumerate() {
+                    if !self.emitted_comment_indices.contains(&idx)
+                        && comment.location.start_offset >= start
+                        && comment.location.end_offset <= end
+                    {
+                        self.emitted_comment_indices.insert(idx);
+                    }
+                }
             }
         }
 
@@ -1193,14 +1232,27 @@ impl Emitter {
         let mut last_stmt_end_line = block_start_line;
 
         for child in &block_node.children {
-            if matches!(child.node_type, NodeType::StatementsNode) {
-                self.emit_statements(child, indent_level + 1)?;
-                // Track the last statement's end line for blank line preservation
-                if let Some(last_child) = child.children.last() {
-                    last_stmt_end_line = last_child.location.end_line;
+            match &child.node_type {
+                NodeType::StatementsNode => {
+                    self.emit_statements(child, indent_level + 1)?;
+                    // Track the last statement's end line for blank line preservation
+                    if let Some(last_child) = child.children.last() {
+                        last_stmt_end_line = last_child.location.end_line;
+                    }
+                    self.buffer.push('\n');
+                    break;
+                }
+                NodeType::BeginNode => {
+                    // Block with rescue/ensure/else - delegate to emit_begin
+                    // which handles implicit begin (no "begin" keyword)
+                    self.emit_begin(child, indent_level + 1)?;
+                    self.buffer.push('\n');
+                    last_stmt_end_line = child.location.end_line;
+                    break;
+                }
+                _ => {
+                    // Skip parameter nodes
                 }
-                self.buffer.push('\n');
-                break;
             }
         }
 
@@ -1236,6 +1288,7 @@ impl Emitter {
     fn emit_brace_block(&mut self, block_node: &Node, indent_level: usize) -> Result<()> {
         // Determine if block should be inline or multiline
         let is_multiline = block_node.location.start_line != block_node.location.end_line;
+        let block_end_line = block_node.location.end_line;
 
         if is_multiline {
             // Multiline brace block
@@ -1254,6 +1307,7 @@ impl Emitter {
 
             self.emit_indent(indent_level)?;
             write!(self.buffer, "}}")?;
+            self.emit_trailing_comments(block_end_line)?;
         } else {
             // Inline brace block - extract from source to preserve spacing
             write!(self.buffer, " ")?;
@@ -1263,6 +1317,7 @@ impl Emitter {
             {
                 write!(self.buffer, "{}", text)?;
             }
+            self.emit_trailing_comments(block_end_line)?;
         }
 
         Ok(())
@@ -1571,7 +1626,6 @@ impl Emitter {
             match &child.node_type {
                 NodeType::InNode => {
                     self.emit_in(child, indent_level)?;
-                    self.buffer.push('\n');
                 }
                 NodeType::ElseNode => {
                     self.emit_indent(indent_level)?;
@@ -1607,19 +1661,25 @@ impl Emitter {
 
         // First child is the pattern
         if let Some(pattern) = node.children.first() {
-            let start = pattern.location.start_offset;
-            let end = pattern.location.end_offset;
-            if let Some(text) = self.source.get(start..end) {
-                write!(self.buffer, "{}", text)?;
-            }
+            self.write_source_text(pattern)?;
         }
 
-        self.buffer.push('\n');
+        if self.is_single_line(node) {
+            // Inline style: in X then Y
+            if let Some(statements) = node.children.get(1) {
+                write!(self.buffer, " then ")?;
+                self.write_source_text(statements)?;
+            }
+            self.buffer.push('\n');
+        } else {
+            // Multi-line style: in X\n  Y
+            self.buffer.push('\n');
 
-        // Second child is the statements body
-        if let Some(statements) = node.children.get(1) {
-            if matches!(statements.node_type, NodeType::StatementsNode) {
-                self.emit_statements(statements, indent_level + 1)?;
+            // Second child is the statements body
+            if let Some(statements) = node.children.get(1) {
+                if matches!(statements.node_type, NodeType::StatementsNode) {
+                    self.emit_statements(statements, indent_level + 1)?;
+                }
             }
         }
 

data/ext/rfmt/src/lib.rs

@@ -10,7 +10,7 @@ use policy::SecurityPolicy;
 
 use config::Config;
 use emitter::Emitter;
-use magnus::{define_module, function, prelude::*, Error, Ruby};
+use magnus::{function, prelude::*, Error, Ruby};
 use parser::{PrismAdapter, RubyParser};
 
 fn format_ruby_code(ruby: &Ruby, source: String, json: String) -> Result<String, Error> {
@@ -45,10 +45,10 @@ fn rust_version() -> String {
 }
 
 #[magnus::init]
-fn init(_ruby: &Ruby) -> Result<(), Error> {
+fn init(ruby: &Ruby) -> Result<(), Error> {
     logging::RfmtLogger::init();
 
-    let module = define_module("Rfmt")?;
+    let module = ruby.define_module("Rfmt")?;
 
     module.define_singleton_method("format_code", function!(format_ruby_code, 2))?;
     module.define_singleton_method("parse_to_json", function!(parse_to_json, 1))?;

data/lib/rfmt/prism_bridge.rb

@@ -108,16 +108,69 @@ module Rfmt
     # Extract location information from node
     def self.extract_location(node)
       loc = node.location
+
+      # For heredoc nodes, the location only covers the opening tag (<<~CSV)
+      # We need to find the maximum end_offset including closing_loc
+      end_offset = loc.end_offset
+      end_line = loc.end_line
+      end_column = loc.end_column
+
+      # Check this node's closing_loc
+      if node.respond_to?(:closing_loc) && node.closing_loc
+        closing = node.closing_loc
+        if closing.end_offset > end_offset
+          end_offset = closing.end_offset
+          end_line = closing.end_line
+          end_column = closing.end_column
+        end
+      end
+
+      # Recursively check all descendant nodes for heredoc closing_loc
+      # Issue #74: handled direct children (e.g., LocalVariableWriteNode -> StringNode)
+      # Issue #86: handles deeper nesting (e.g., CallNode -> ArgumentsNode -> StringNode)
+      max_closing = find_max_closing_loc_recursive(node)
+      if max_closing && max_closing[:end_offset] > end_offset
+        end_offset = max_closing[:end_offset]
+        end_line = max_closing[:end_line]
+        end_column = max_closing[:end_column]
+      end
+
       {
         start_line: loc.start_line,
         start_column: loc.start_column,
-        end_line: loc.end_line,
-        end_column: loc.end_column,
+        end_line: end_line,
+        end_column: end_column,
         start_offset: loc.start_offset,
-        end_offset: loc.end_offset
+        end_offset: end_offset
       }
     end
 
+    # Recursively find the maximum closing_loc among all descendant nodes
+    # Returns nil if no closing_loc found, otherwise { end_offset:, end_line:, end_column: }
+    def self.find_max_closing_loc_recursive(node, depth: 0)
+      return nil if depth > 10
+
+      max_closing = nil
+
+      node.child_nodes.compact.each do |child|
+        if child.respond_to?(:closing_loc) && child.closing_loc
+          closing = child.closing_loc
+          if max_closing.nil? || closing.end_offset > max_closing[:end_offset]
+            max_closing = {
+              end_offset: closing.end_offset,
+              end_line: closing.end_line,
+              end_column: closing.end_column
+            }
+          end
+        end
+
+        child_max = find_max_closing_loc_recursive(child, depth: depth + 1)
+        max_closing = child_max if child_max && (max_closing.nil? || child_max[:end_offset] > max_closing[:end_offset])
+      end
+
+      max_closing
+    end
+
     # Extract child nodes
     def self.extract_children(node)
       children = []
@@ -176,6 +229,7 @@ module Rfmt
                      [
                        node.statements,
                        node.rescue_clause,
+                       node.else_clause,
                        node.ensure_clause
                      ].compact
                    when Prism::EnsureNode

data/lib/rfmt/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - fujitani sora
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -113,7 +112,6 @@ metadata:
   source_code_uri: https://github.com/fs0414/rfmt
   changelog_uri: https://github.com/fs0414/rfmt/releases
   ruby_lsp_addon: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.0.0
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby Formatter impl Rust lang.
 test_files: []