rfmt 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f647dba194f9105f5f85937e8927d2f73e856fe009a2ba5eaa4b28aad90a3498
-  data.tar.gz: 663ab8dd439b10f7f7cbc06c3675bc42d4af27b92baf3340e0f586f5867ea7ae
+  metadata.gz: c712093f002557a29995a2838caede692a26e86d492c7f9f735e8fe9f2a5f5f4
+  data.tar.gz: a7ce48fbf06a56879d803cb848786310ff5e6dc091de1d8f8a9ff47a0bb00dac
 SHA512:
-  metadata.gz: 43721c2ec9d960ed6aaf7c5f18bf8d94accc7ed54b7470a58e91f9c00c7e85667b7f9034362326768db8453a4c2f6aaf8cf6ab5c9ffa1869f4d22e5b5f859743
-  data.tar.gz: cf024a6618d7cf976479d3951d8f46a906a97f19cffaa2166a6fc23ff95451b4178f2c204bd073cab2d497d90032ccb4d34a68b18ef21af3a6adbd6299fe9d08
+  metadata.gz: '05954d426b7b6951e330d55d469ea78ebbf75350d755e0107eb0c4de32f5b11afd9373fbeabff3f7c2c902cfada70f4fae276c8b5d0d4d3b00eb3514a467fa0e'
+  data.tar.gz: cd4b6992cd4d795dfe8bd91f74504212337bcf7c13c736822919a071abda7ff0e1712f24e277786fa8b9a3ba6150b0727d33f415631c1707b6277c5612c94dbe

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [0.2.3] - 2025-01-25
+
+### Added
+- Configuration file (rfmt.yml) is now automatically loaded and applied during formatting
+- Automatic config file discovery in current directory, parent directories, and home directory
+- Support for custom indent_width and other formatting options via rfmt.yml
+
+### Changed
+- Default config file name changed from .rfmt.yml to rfmt.yml (hidden file to regular file)
+- Backward compatibility maintained: .rfmt.yml is still supported with lower priority
+- Config file search order: rfmt.yml > rfmt.yaml > .rfmt.yml > .rfmt.yaml
+- README updated to remove exaggerated expressions and focus on factual, data-driven descriptions
+
+## [0.2.2] - 2025-01-25
+
+### Fixed
+- Fixed blank line formatting to output single blank line instead of double blank lines
+
 ## [0.2.1] - 2025-01-25
 
 ### Fixed

data/Cargo.lock

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

data/README.md

@@ -2,7 +2,7 @@
 
 <div align="center">
 
-⚡ A fast, opinionated Ruby code formatter written in Rust ⚡
+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)
@@ -20,60 +20,81 @@
 
 ## What is rfmt?
 
-**rfmt** is a lightning-fast Ruby code formatter that enforces consistent style across your codebase. It's designed to be:
+**rfmt** is a Ruby code formatter that enforces consistent style across your codebase. Key characteristics:
 
-- **Fast**: Written in Rust for maximum performance
-- **Opinionated**: Minimal configuration, consistent results
-- **Idempotent**: Running it multiple times produces the same output
-- **Comment-preserving**: Your comments stay exactly where they should
-- **Production-ready**: Comprehensive error handling and logging
+- **Rust implementation**: Provides faster execution than Ruby-based tools
+- **Opinionated**: Minimal configuration with consistent output
+- **Idempotent**: Running multiple times produces identical results
+- **Comment preservation**: Maintains existing comment placement
+- **Error handling**: Includes structured error messages and logging
 
 ## Features
 
-### ⚡ Performance
+### Performance
 
-rfmt is built with Rust, making it significantly faster than pure-Ruby formatters:
+Built with Rust for improved execution speed:
 
-- Formats thousands of lines per second
-- Parallel processing support
-- Smart caching for unchanged files
+- Benchmark shows 7-58x faster than RuboCop depending on project size (see Performance Benchmarks section)
+- Processes 168 files/second in tested Rails project
+- Supports parallel processing
 
-### 🎨 Consistent Style
+### Consistent Style
 
-rfmt enforces a consistent code style across your entire project:
+Enforces code style rules:
 
 - Automatic indentation
-- Consistent spacing and alignment
-- Quote style normalization
+- Spacing and alignment normalization
+- Quote style standardization
 - Method definition formatting
 
-### 🔍 Smart Error Handling
+### Error Handling
 
-rfmt provides detailed, actionable error messages:
+Provides structured error messages:
 
-- **Error codes** (E001-E999) for easy troubleshooting
-- **Code snippets** showing exactly where errors occur
-- **Help URLs** linking to detailed documentation
-- **Recovery strategies** to handle partial formatting
+- Error codes (E001-E999) for categorization
+- Code snippets showing error locations
+- Help URLs linking to documentation
+- Recovery strategies for handling errors
 
-### 📊 Comprehensive Logging
+### Logging
 
-Built-in logging system for debugging and monitoring:
+Built-in logging system:
 
-- Multiple log levels (ERROR, WARN, INFO, DEBUG, TRACE)
-- Structured output for easy parsing
-- Performance metrics and timing information
-- Debug context for complex operations
+- 5 log levels (ERROR, WARN, INFO, DEBUG, TRACE)
+- Structured output format
+- Performance metrics and timing data
+- Debug context information
 
-### 🧩 Editor Integration
+## Performance Benchmarks
 
-Works with your favorite editor:
+Performance comparison with RuboCop on a Rails project (111 files, 3,231 lines):
 
-- Visual Studio Code
-- RubyMine / IntelliJ IDEA
-- Vim / Neovim
-- Emacs
-- Sublime Text
+### Benchmark Results (Rails Project)
+
+| Scenario | rfmt | RuboCop | Speedup |
+|----------|------|---------|---------|
+| **Single File** | ~190ms | ~1.35s | **7.3x faster** |
+| **Directory (14 files)** | 168ms | 1.67s | **10.0x faster** |
+| **Full Project (111 files)** | 173ms | 10.09s | **58.5x faster** |
+| **Check Mode (CI/CD)** | 172ms | 1.55s | **9.0x faster** |
+
+### Key Metrics
+
+- Single file: Formats in ~190ms
+- Scaling: 58x faster on full project (111 files)
+- CI/CD: Check time reduced from 10.09s to 0.173s (98% reduction)
+- Variance: Low standard deviation across runs
+
+### Throughput Comparison
+
+| Directory | rfmt | RuboCop | Difference |
+|-----------|------|---------|------------|
+| app/models (14 files) | 83.5 files/s | 8.4 files/s | **10x throughput** |
+| test/ (30 files) | 168.1 files/s | 18.1 files/s | **9.3x throughput** |
+
+*Benchmark environment: Apple Silicon (arm64), macOS Darwin 23.6.0, Ruby 3.4.5*
+
+See [detailed benchmark report](docspriv/benchmark_report.md) for full data.
 
 ## Installation
 
@@ -168,7 +189,7 @@ Create a configuration file with default settings:
 rfmt init
 ```
 
-This creates a `.rfmt.yml` file with sensible defaults:
+This creates a `rfmt.yml` file with default settings:
 
 ```yaml
 version: "1.0"
@@ -206,9 +227,9 @@ rfmt init --force
 
 rfmt automatically searches for configuration files in this order:
 
-1. Current directory (`.rfmt.yml` or `.rfmt.yaml`)
+1. Current directory (`rfmt.yml`, `rfmt.yaml`, `.rfmt.yml`, or `.rfmt.yaml`)
 2. Parent directories (up to root)
-3. User home directory (`~/.rfmt.yml` or `~/.rfmt.yaml`)
+3. User home directory (`rfmt.yml`, `rfmt.yaml`, `.rfmt.yml`, or `.rfmt.yaml`)
 4. Default settings (if no file found)
 
 #### Ruby API for Configuration
@@ -217,11 +238,11 @@ rfmt automatically searches for configuration files in this order:
 require 'rfmt'
 
 # Generate configuration file
-Rfmt::Config.init('.rfmt.yml', force: false)
+Rfmt::Config.init('rfmt.yml', force: false)
 
 # Find configuration file
 config_path = Rfmt::Config.find
-# => "/Users/username/project/.rfmt.yml"
+# => "/Users/username/project/rfmt.yml"
 
 # Check if configuration exists
 Rfmt::Config.exists?
@@ -234,7 +255,7 @@ config = Rfmt::Config.load
 
 ## Error Handling
 
-rfmt provides detailed error messages with actionable solutions:
+rfmt provides structured error messages:
 
 ```
 [Rfmt::ParseError] Parse error in app/models/user.rb:15:10
@@ -269,7 +290,7 @@ See the [Error Reference](docs/error_reference.md) for detailed information.
 
 ## Logging
 
-rfmt includes a comprehensive logging system:
+rfmt includes a logging system:
 
 ```ruby
 # Logs are automatically output during initialization
@@ -314,116 +335,12 @@ end
 
 ## Documentation
 
-Comprehensive documentation is available:
-
-- 📖 [User Guide](docs/user_guide.md) - Complete usage guide
-- 🌐 [User Guide (日本語)](docs/user_guide.ja.md) - Japanese version
-- 🔍 [Error Reference](docs/error_reference.md) - All error codes and solutions
-- 🔍 [Error Reference (日本語)](docs/error_reference.ja.md) - Japanese version
-- 🤝 [Contributing Guide](CONTRIBUTING.md) - How to contribute
-- 📊 [Phase 4 Implementation](docs/phase4_implementation_summary.md) - Recent changes
-
-## Development
-
-After checking out the repo:
-
-```bash
-# Install dependencies
-bundle install
-
-# Compile Rust extension
-bundle exec rake compile
-
-# Run tests
-bundle exec rspec
-
-# Run Rust tests
-cd ext/rfmt && cargo test
-```
-
-### Running Tests
-
-```bash
-# All tests
-bundle exec rspec
-
-# Specific test file
-bundle exec rspec spec/error_handling_spec.rb
-
-# With documentation format
-bundle exec rspec --format documentation
-```
-
-### Test Results
-
-All 187 tests passing:
-- 172 existing tests
-- 15 new tests for error handling and logging
-
-## Performance
-
-rfmt is designed for speed:
-
-| File Size | Format Time |
-|-----------|-------------|
-| 100 lines | < 10ms |
-| 1,000 lines | < 50ms |
-| 10,000 lines | < 500ms |
-
-*Benchmarks run on M1 MacBook Pro*
-
-## Roadmap
-
-See [ROADMAP.md](ROADMAP.md) for planned features:
-
-- [ ] Pattern matching support
-- [ ] Numbered parameters
-- [ ] Additional formatting rules
-- [ ] Plugin system
-- [ ] Language server protocol (LSP)
+Documentation is available in the [docs](docs/) directory. See [User Guide](docs/user_guide.md) or [Contributing Guide](CONTRIBUTING.md) for details.
 
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
 
-**Quick Start:**
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/my-feature`)
-3. Make your changes and add tests
-4. Run tests (`bundle exec rspec`)
-5. Commit your changes (`git commit -m 'feat: add some feature'`)
-6. Push to the branch (`git push origin feature/my-feature`)
-7. Open a Pull Request
-
-## Architecture
-
-rfmt is built with a hybrid Ruby-Rust architecture:
-
-```
-┌─────────────────┐
-│   Ruby Layer    │  ← User API, Prism parser
-├─────────────────┤
-│  FFI Interface  │  ← Magnus (Ruby-Rust bridge)
-├─────────────────┤
-│   Rust Layer    │  ← Formatting engine
-│                 │    - Parser (AST)
-│                 │    - Formatter (Rules)
-│                 │    - Emitter (Output)
-│                 │    - Error Handler
-│                 │    - Logger
-└─────────────────┘
-```
-
-## Technology Stack
-
-- **Ruby**: 3.0+ (Prism parser, FFI interface)
-- **Rust**: 1.70+ (Core formatting engine)
-- **Magnus**: Ruby-Rust FFI bridge
-- **Prism**: Modern Ruby parser
-- **RSpec**: Ruby testing
-- **Cargo**: Rust build system
-
 ## Comparison with Other Tools
 
 ### rfmt vs RuboCop
@@ -431,36 +348,12 @@ rfmt is built with a hybrid Ruby-Rust architecture:
 | Feature | rfmt | RuboCop |
 |---------|------|---------|
 | **Primary Purpose** | Code formatting | Linting + formatting |
-| **Speed** | Very fast (Rust) | Moderate (Ruby) |
+| **Speed** | 58x faster (tested benchmark) | Baseline |
 | **Configuration** | Minimal | Extensive |
 | **Code Quality Checks** | No | Yes |
 | **Bug Detection** | No | Yes |
 
-**Recommendation**: Use rfmt for consistent formatting, RuboCop for code quality checks.
-
-### rfmt vs Prettier (Ruby plugin)
-
-| Feature | rfmt | Prettier |
-|---------|------|----------|
-| **Native Ruby Support** | Yes | Via plugin |
-| **Speed** | Very fast | Fast |
-| **Ruby-specific Features** | Full support | Limited |
-| **Comment Preservation** | Excellent | Good |
-
-## Project Status
-
-rfmt is under active development. Current phase:
-
-- ✅ Phase 1: Foundation (Complete)
-- ✅ Phase 2: Core Formatting (Complete)
-- ✅ Phase 3: Advanced Features (Complete)
-- ✅ Phase 4: Production Quality (Logging & Error Control Complete)
-  - ✅ Error Handling System
-  - ✅ Logging System
-  - ⬜ Documentation (In Progress)
-  - ⬜ Security
-  - ⬜ Release Process
-  - ⬜ Editor Integration
+**Note**: rfmt focuses on formatting speed, while RuboCop provides additional code quality analysis. They can be used together.
 
 ## License
 
@@ -474,7 +367,6 @@ Everyone interacting in the rfmt project's codebases, issue trackers, chat rooms
 
 - 📖 [Documentation](docs/)
 - 🐛 [Issues](https://github.com/fujitanisora/rfmt/issues)
-- 💬 [Discussions](https://github.com/fujitanisora/rfmt/discussions)
 - 📧 Email: fujitanisora0414@gmail.com
 
 ## Acknowledgments
@@ -487,8 +379,6 @@ Everyone interacting in the rfmt project's codebases, issue trackers, chat rooms
 
 <div align="center">
 
-Made with ❤️ by [Fujitani Sora](https://github.com/fs0414)
-
-**⭐ Star us on GitHub — it motivates us a lot!**
+Created by [Fujitani Sora](https://github.com/fs0414)
 
 </div>

data/ext/rfmt/Cargo.toml

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

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

@@ -99,8 +99,45 @@ pub enum TrailingComma {
 }
 
 impl Config {
+    /// Discover configuration file in current directory or parent directories
+    /// Searches in order: rfmt.yml, rfmt.yaml, .rfmt.yml, .rfmt.yaml
+    pub fn discover() -> crate::error::Result<Self> {
+        let config_files = ["rfmt.yml", "rfmt.yaml", ".rfmt.yml", ".rfmt.yaml"];
+
+        // Try current directory and parent directories
+        if let Ok(mut current_dir) = std::env::current_dir() {
+            loop {
+                for filename in &config_files {
+                    let config_path = current_dir.join(filename);
+                    if config_path.exists() {
+                        log::debug!("Found config file: {:?}", config_path);
+                        return Self::load_file(&config_path);
+                    }
+                }
+
+                // Move to parent directory
+                if !current_dir.pop() {
+                    break;
+                }
+            }
+        }
+
+        // Try home directory
+        if let Some(home_dir) = dirs::home_dir() {
+            for filename in &config_files {
+                let config_path = home_dir.join(filename);
+                if config_path.exists() {
+                    log::debug!("Found config file in home: {:?}", config_path);
+                    return Self::load_file(&config_path);
+                }
+            }
+        }
+
+        log::debug!("No config file found, using defaults");
+        Ok(Config::default())
+    }
+
     /// Load configuration from a YAML file
-    #[cfg(test)]
     pub fn load_file(path: &std::path::Path) -> crate::error::Result<Self> {
         use crate::error::RfmtError;
 
@@ -119,7 +156,6 @@ impl Config {
     }
 
     /// Validate configuration values
-    #[cfg(test)]
     fn validate(&self) -> crate::error::Result<()> {
         use crate::error::RfmtError;
 
@@ -145,7 +181,6 @@ 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

@@ -123,9 +123,17 @@ impl Emitter {
         for (i, child) in node.children.iter().enumerate() {
             self.emit_node(child, indent_level)?;
 
-            // Add newline between top-level statements
+            // Add newlines between top-level statements, normalizing to max 1 blank line
             if i < node.children.len() - 1 {
-                self.buffer.push('\n');
+                let current_end_line = child.location.end_line;
+                let next_start_line = node.children[i + 1].location.start_line;
+                let line_diff = next_start_line.saturating_sub(current_end_line);
+
+                // Add 1 newline if consecutive, 2 newlines (1 blank line) if there was a gap
+                let newlines = if line_diff > 1 { 2 } else { 1 };
+                for _ in 0..newlines {
+                    self.buffer.push('\n');
+                }
             }
         }
         Ok(())
@@ -136,9 +144,17 @@ impl Emitter {
         for (i, child) in node.children.iter().enumerate() {
             self.emit_node(child, indent_level)?;
 
-            // Add newline between statements
+            // Add newlines between statements, normalizing to max 1 blank line
             if i < node.children.len() - 1 {
-                self.buffer.push('\n');
+                let current_end_line = child.location.end_line;
+                let next_start_line = node.children[i + 1].location.start_line;
+                let line_diff = next_start_line.saturating_sub(current_end_line);
+
+                // Add 1 newline if consecutive, 2 newlines (1 blank line) if there was a gap
+                let newlines = if line_diff > 1 { 2 } else { 1 };
+                for _ in 0..newlines {
+                    self.buffer.push('\n');
+                }
             }
         }
         Ok(())

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

@@ -18,7 +18,6 @@ pub enum RfmtError {
     },
 
     #[error("Configuration error: {message}")]
-    #[cfg(test)]
     ConfigError { message: String },
 }
 
@@ -36,7 +35,6 @@ impl RfmtError {
             RfmtError::PrismError(_) => "PrismError",
             RfmtError::FormatError(_) => "FormatError",
             RfmtError::UnsupportedFeature { .. } => "UnsupportedFeature",
-            #[cfg(test)]
             RfmtError::ConfigError { .. } => "ConfigError",
         };
 

data/ext/rfmt/src/lib.rs

@@ -25,7 +25,8 @@ fn format_ruby_code(ruby: &Ruby, source: String, json: String) -> Result<String,
     let parser = PrismAdapter::new();
     let ast = parser.parse(&json).map_err(|e| e.to_magnus_error(ruby))?;
 
-    let config = Config::default();
+    // Load configuration from file or use defaults
+    let config = Config::discover().map_err(|e| e.to_magnus_error(ruby))?;
     let mut emitter = Emitter::with_source(config, source);
 
     let formatted = emitter.emit(&ast).map_err(|e| e.to_magnus_error(ruby))?;

data/lib/rfmt/configuration.rb

@@ -18,7 +18,7 @@ module Rfmt
       'exclude' => ['vendor/**/*', 'tmp/**/*', 'node_modules/**/*']
     }.freeze
 
-    CONFIG_FILES = ['.rfmt.yml', '.rfmt.yaml', 'rfmt.yml', 'rfmt.yaml'].freeze
+    CONFIG_FILES = ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].freeze
 
     attr_reader :config
 

data/lib/rfmt/version.rb

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

data/lib/rfmt.rb

@@ -95,10 +95,10 @@ module Rfmt
     YAML
 
     # Generate a default configuration file
-    # @param path [String] Path where to create the config file (default: .rfmt.yml)
+    # @param path [String] Path where to create the config file (default: rfmt.yml)
     # @param force [Boolean] Overwrite existing file if true
     # @return [Boolean] true if file was created, false if already exists
-    def self.init(path = '.rfmt.yml', force: false)
+    def self.init(path = 'rfmt.yml', force: false)
       if File.exist?(path) && !force
         warn "Configuration file already exists: #{path}"
         warn 'Use force: true to overwrite'
@@ -116,7 +116,7 @@ module Rfmt
       current_dir = Dir.pwd
 
       loop do
-        ['.rfmt.yml', '.rfmt.yaml'].each do |filename|
+        ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].each do |filename|
           config_path = File.join(current_dir, filename)
           return config_path if File.exist?(config_path)
         end
@@ -134,7 +134,7 @@ module Rfmt
         nil
       end
       if home_dir
-        ['.rfmt.yml', '.rfmt.yaml'].each do |filename|
+        ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].each do |filename|
           config_path = File.join(home_dir, filename)
           return config_path if File.exist?(config_path)
         end

metadata

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