rfmt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1344ebd75598608c54dc975f8afecc17be05152039542ac1c1e80007086530fc
-  data.tar.gz: b5a29adb45e5163fdfdbbea2526d4ac72bdbca410ee86e888ecb224f3b98c922
+  metadata.gz: 3077996bae0d4959192fb7885a197916fc85679858ebc10ea00ea8696bf6d320
+  data.tar.gz: c3adf00614cc4ed60df41858c482e77b9618f06f7dadc7e9bc016c7b4d419f99
 SHA512:
-  metadata.gz: 71db0a1b94b8a2288a5fae7e3a09ec41fac6e834abd9760fd45b4ac7dfef71baac7ada32582a6018b74fa22a6d0711f529b8372c491179dfbe66cc9c56c287aa
-  data.tar.gz: c7dc265d4ba68a15c653715bd26d8c087be6d361a7bb3170bd59057c0b9a65cfbf2093c02ff8528dcffd8a2b4ca445faef2fdc4fa4c5035016360d64ad297b9e
+  metadata.gz: 8c1a042bcbcd8e74ac67918428fee08f8f4cf85e4f5f67a0cd9196bf7305489808176c442e8d388ae50c32c7d3f329706788c02a62ef69708be9126e600556bf
+  data.tar.gz: 2f13782fff7bb4eaea95a78bc8e3d55c4f00395074b9e5befb6d93e66b803673f5bfb1f285ae74facb009d65dbdf2ae8322f405232277994c010d88135d62746

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-11-26
+
+### Added
+- Verbose mode option (`--verbose` flag) for detailed output during formatting
+- Git commit hook configuration with Lefthook integration for automatic formatting
+- RubyGems badge and installation instructions in README
+
+### Changed
+- Improved documentation structure and readability in user guides (English and Japanese)
+- Enhanced logging system with verbose output support
+- Updated benchmark documentation in README
+
+### Fixed
+- Command formatting to execution conversion issues
+- Documentation version command display
+- Various code quality improvements based on Clippy suggestions
+
 ## [0.3.0] - 2025-11-25
 
 ### Changed

data/Cargo.lock

@@ -1219,7 +1219,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rfmt"
-version = "0.3.0"
+version = "0.4.0"
 dependencies = [
  "anyhow",
  "clap",

data/README.md

@@ -4,8 +4,7 @@
 
 A Ruby code formatter written in Rust
 
-[![Gem Version](https://badge.fury.io/rb/rfmt.svg)](https://badge.fury.io/rb/rfmt)
-[![Test Status](https://github.com/fujitanisora/rfmt/workflows/test/badge.svg)](https://github.com/fujitanisora/rfmt/actions)
+[![Gem Version](https://badge.fury.io/rb/rfmt.svg)](https://rubygems.org/gems/rfmt)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 [Installation](#installation) •
@@ -20,6 +19,8 @@ A Ruby code formatter written in Rust
 
 ## What is rfmt?
 
+[RubyGems reference](https://rubygems.org/gems/rfmt)
+
 **rfmt** is a Ruby code formatter that enforces consistent style across your codebase. Key characteristics:
 
 - **Opinionated**: Minimal configuration with consistent output
@@ -44,7 +45,7 @@ Enforces code style rules:
 
 ## Performance Benchmarks
 
-Performance comparison with RuboCop on a Rails project (111 files, 3,241 lines):
+Execution time comparison on a Rails project (111 files, 3,241 lines):
 
 | Test Type | Files | rfmt | RuboCop | Ratio |
 |-----------|-------|------|---------|-------|
@@ -52,6 +53,13 @@ Performance comparison with RuboCop on a Rails project (111 files, 3,241 lines):
 | Directory | 14 | 176ms | 1.68s | 9.6x |
 | Full Project (check) | 111 | 172ms | 4.36s | 25.4x |
 
+**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
+
 **Observations:**
 - rfmt execution time remains constant (172-191ms) regardless of file count
 - Low variance across runs (standard deviation: 8-23ms)
@@ -59,7 +67,7 @@ Performance comparison with RuboCop on a Rails project (111 files, 3,241 lines):
 **Test Environment:**
 - CPU: Apple Silicon (arm64)
 - Ruby: 3.4.5
-- rfmt: 0.2.4, RuboCop: 1.81.7
+- rfmt: 0.3.0, RuboCop: 1.81.7
 
 See [detailed benchmark report](docs/benchmark.md) for complete data.
 
@@ -146,13 +154,13 @@ rfmt init --force
 Format a single file:
 
 ```bash
-rfmt format lib/user.rb
+rfmt exec lib/user.rb
 ```
 
 Format multiple files:
 
 ```bash
-rfmt format lib/**/*.rb
+rfmt exec lib/**/*.rb
 ```
 
 Check if files need formatting (CI/CD):
@@ -164,7 +172,15 @@ rfmt check .
 Show diff without modifying files:
 
 ```bash
-rfmt format lib/user.rb --diff
+rfmt exec lib/user.rb --diff
+```
+
+Enable verbose output for debugging:
+
+```bash
+rfmt exec lib/user.rb --verbose
+# or use environment variable
+DEBUG=1 rfmt exec lib/user.rb
 ```
 
 ### Ruby API
@@ -255,6 +271,48 @@ class User < ApplicationRecord
 end
 ```
 
+## Development
+
+### Setup
+
+After cloning the repository:
+
+```bash
+bundle install
+bundle exec lefthook install
+```
+
+### Git Hooks
+
+This project uses [lefthook](https://github.com/evilmartians/lefthook) for automated validation before push:
+
+**Pre-push checks:**
+- RuboCop (Ruby linting)
+- cargo fmt --check (Rust formatting)
+- cargo clippy (Rust linting)
+
+**Skip hooks temporarily:**
+```bash
+# Skip all hooks for this push
+LEFTHOOK=0 git push
+
+# Skip specific hook
+LEFTHOOK_EXCLUDE=rubocop git push
+```
+
+### Running Tests
+
+```bash
+# Ruby tests
+bundle exec rspec
+
+# Rust tests
+cargo test --manifest-path ext/rfmt/Cargo.toml
+
+# All tests
+bundle exec rake dev:test_all
+```
+
 ## Documentation
 
 Documentation is available in the [docs](docs/) directory:

data/ext/rfmt/Cargo.toml

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

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

@@ -174,6 +174,7 @@ impl Node {
 
     /// Add metadata to the node
     #[cfg(test)]
+    #[allow(dead_code)]
     pub fn with_metadata(mut self, metadata: HashMap<String, String>) -> Self {
         self.metadata = metadata;
         self
@@ -181,6 +182,7 @@ impl Node {
 
     /// Add comments to the node
     #[cfg(test)]
+    #[allow(dead_code)]
     pub fn with_comments(mut self, comments: Vec<Comment>) -> Self {
         self.comments = comments;
         self

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

@@ -181,6 +181,7 @@ impl Config {
     }
 
     /// Get the indent string based on configuration
+    #[cfg(test)]
     pub fn indent_string(&self) -> String {
         match self.formatting.indent_style {
             IndentStyle::Spaces => " ".repeat(self.formatting.indent_width),

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

@@ -309,11 +309,18 @@ impl Emitter {
     /// Emit if/unless/elsif/else node
     /// is_elsif: true if this is an elsif clause (don't emit 'end')
     /// keyword: "if" or "unless"
-    fn emit_if_unless(&mut self, node: &Node, indent_level: usize, is_elsif: bool, keyword: &str) -> Result<()> {
+    fn emit_if_unless(
+        &mut self,
+        node: &Node,
+        indent_level: usize,
+        is_elsif: bool,
+        keyword: &str,
+    ) -> Result<()> {
         // Check if this is a postfix if (modifier form)
         // In postfix if, the statements come before the if keyword in source
         let is_postfix = if let (Some(predicate), Some(statements)) =
-            (node.children.first(), node.children.get(1)) {
+            (node.children.first(), node.children.get(1))
+        {
             statements.location.start_offset < predicate.location.start_offset
         } else {
             false
@@ -399,7 +406,7 @@ impl Emitter {
                 NodeType::ElseNode => {
                     // This is an else clause
                     self.emit_indent(indent_level)?;
-                    write!(self.buffer, "else\n")?;
+                    writeln!(self.buffer, "else")?;
 
                     // Emit else body (first child of ElseNode)
                     if let Some(else_statements) = consequent.children.first() {

data/ext/rfmt/src/lib.rs

@@ -29,7 +29,10 @@ fn format_ruby_code(ruby: &Ruby, source: String, json: String) -> Result<String,
     // Load configuration from file or use defaults
     log::info!("Attempting to discover config file...");
     let config = Config::discover().map_err(|e| e.to_magnus_error(ruby))?;
-    log::info!("Config loaded successfully, line_length: {}", config.formatting.line_length);
+    log::info!(
+        "Config loaded successfully, line_length: {}",
+        config.formatting.line_length
+    );
     let mut emitter = Emitter::with_source(config, source);
 
     let formatted = emitter.emit(&ast).map_err(|e| e.to_magnus_error(ruby))?;

data/ext/rfmt/src/logging/logger.rs

@@ -22,10 +22,20 @@ impl RfmtLogger {
     }
 
     pub fn init() {
+        // Check for debug mode via environment variables
+        let debug_mode = std::env::var("DEBUG").is_ok()
+            || std::env::var("RFMT_DEBUG").is_ok()
+            || std::env::var("RUST_LOG").is_ok();
+
         let level = std::env::var("RFMT_LOG")
             .ok()
             .and_then(|s| s.parse().ok())
-            .unwrap_or(LevelFilter::Info);
+            .unwrap_or(if debug_mode {
+                LevelFilter::Info
+            } else {
+                // In normal mode, only show warnings and errors
+                LevelFilter::Warn
+            });
         let logger = Self::new(level);
         log::set_boxed_logger(Box::new(logger)).expect("Failed to initialize logger");
         log::set_max_level(LevelFilter::Trace);
@@ -63,7 +73,6 @@ impl Log for RfmtLogger {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use log::{debug, error, info, trace, warn};
     use std::sync::{Arc, Mutex};
 
     struct TestWriter {

data/lib/rfmt/cli.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 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')
+
 require 'rfmt'
 require 'rfmt/configuration'
 require 'rfmt/cache'
@@ -43,7 +47,7 @@ module Rfmt
     class_option :config, type: :string, desc: 'Path to configuration file'
     class_option :verbose, type: :boolean, aliases: '-v', desc: 'Verbose output'
 
-    desc 'format [FILES]', 'Format Ruby files'
+    desc 'exec [FILES]', 'Format Ruby files'
     option :write, type: :boolean, default: true, desc: 'Write formatted output'
     option :check, type: :boolean, desc: "Check if files are formatted (don't write)"
     option :diff, type: :boolean, desc: 'Show diff of changes'
@@ -52,7 +56,7 @@ module Rfmt
     option :jobs, type: :numeric, desc: 'Number of parallel jobs (default: CPU count)'
     option :cache, type: :boolean, default: true, desc: 'Use cache to skip unchanged files'
     option :cache_dir, type: :string, desc: 'Cache directory (default: ~/.cache/rfmt)'
-    def format(*files)
+    def exec(*files)
       config = load_config
       files = files.empty? ? config.files_to_format : files.flatten
 
@@ -92,7 +96,7 @@ module Rfmt
 
     desc 'check [FILES]', 'Check if files need formatting'
     def check(*files)
-      invoke :format, files, check: true, write: false
+      invoke :exec, files, check: true, write: false
     end
 
     desc 'version', 'Show version'

data/lib/rfmt/version.rb

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

metadata

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