rufo 0.18.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2239283a440e83e68074430ba36c303f94701858ff8983394bf6eda08f588089
-  data.tar.gz: 141195447e27a7cc31b98f66b919142ffa46c49c5221617dcf9b3a6c3d25a306
+  metadata.gz: 87b000f131dd4c6b9e87e82513ed7009a9cbcc7078e44e51627a8b6205f15ea0
+  data.tar.gz: 05a5878c0d790d5fb867606b2cc6f064f0789757a9eecb62037e2adb41af249a
 SHA512:
-  metadata.gz: 9f71537f4b5741d60dc0b23ed49cff278708ce2d58901b07765be00c34ec87e6a9cba70963fe3e60beaa2bcf9281b03e15535f3b7df76b1cb81235dc18e3616b
-  data.tar.gz: '091c1fe438ad222e6958b5016543882a21e943cde22b56f7a10cc67baf356ae43d3d54646a7576530711e224ae915227c647c6d95c6d51709814432416036d00'
+  metadata.gz: 329e2b72b0755c40bb44226722b34199a8907a7911244c330e453d9fe3bc824d45179933d55736162727147068595e8e090f44e1852ad4b5ce0eb794a4dea517
+  data.tar.gz: e44a00c12494e7fd015583ed481e97fca7878115942fb4e5cfa5c10a6575ea46d6d1d21f4157871a738e2f2659354f310f0c4772bcd37922eb97dfb796887ae2

data/.github/workflows/ci.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby_version: ['3.3', '3.2', '3.1', '3.0']
+        ruby_version: ['3.4', '3.3', '3.2', '3.1', '3.0']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
@@ -36,7 +36,7 @@ jobs:
                           --format progress
 
     - name: Upload code coverage
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         files: ./coverage/coverage.xml
 
@@ -53,7 +53,7 @@ jobs:
         bin/verify-sample-code
 
     - name: Save test results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       if: always()
       with:
         name: coverage-ruby-${{ matrix.ruby_version }}

data/CHANGELOG.md

@@ -12,10 +12,33 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+## [0.18.2] - 2025-12-24
+
+### Fixed
+
+### Changed
+
+### Added
+- Support formatting ERB native comment. ([#352](https://github.com/ruby-formatter/rufo/pull/352))
+
+## [0.18.1] - 2025-02-22
+
+### Fixed
+- Fix error when formatting pattern matching syntax. ([#325](https://github.com/ruby-formatter/rufo/pull/325))
+- Fix bug for toplevel Array literal and Hash literal indentation. ([#327](https://github.com/ruby-formatter/rufo/pull/327))
+- Fix bug for inline pattern matching to case expression. ([#338](https://github.com/ruby-formatter/rufo/pull/338))
+- Fix bug for heredoc indentation. ([#342](https://github.com/ruby-formatter/rufo/pull/342))
+- Fix bug for passing anonymous block arg. ([#332](https://github.com/ruby-formatter/rufo/issues/332))
+
+### Changed
+
+### Added
+- Add Ruby 3.4 to test runs on CI. ([#337](https://github.com/ruby-formatter/rufo/pull/337))
+
 ## [0.18.0] - 2024-05-30
 
 ### Fixed
-- Fix error when formatting ERB ([#319](https://github.com/ruby-formatter/rufo/issues/319))
+- Fix error when formatting ERB ([#323](https://github.com/ruby-formatter/rufo/pull/323))
 
 ### Changed
 - Dropped support for Ruby 2.7 as it is end of life.

data/Gemfile

@@ -2,3 +2,14 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in rufo.gemspec
 gemspec
+
+# Development dependencies
+gem "bundler", ">= 1.15"
+gem "debug", ">= 1.0.0"
+gem "guard-rspec", "~> 4.0"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.6.0"
+gem "rubocop", "~> 1.69.2"
+gem "simplecov", "~> 0.22.0"
+gem "simplecov-cobertura", "~> 3.1"

data/README.md

@@ -12,7 +12,7 @@ Unlike the best known Ruby formatter [RuboCop](https://github.com/bbatsov/ruboco
 
 RuboCop does much more than just format code though, so feel free to run them both!
 
-Rufo supports all Ruby versions >= 2.7.0.
+Rufo supports all Ruby versions >= 3.0.0.
 
 ## Installation
 

data/bin/verify-sample-code

@@ -1,8 +1,21 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 repos = {
-  "rspec/rspec-expectations" => {},
-  "rspec/rspec-mocks" => {},
+  "rspec/rspec" => {
+    path: "rspec-core",
+    rspec_flags: {
+      "--exclude-pattern" => [
+        "spec/rspec/core/world_spec.rb",
+        "spec/rspec/core/formatters/exception_presenter_spec.rb",
+        "spec/rspec/core/formatters/snippet_extractor_spec.rb",
+        "spec/rspec/core/metadata_spec.rb",
+        "spec/rspec/core/formatters/html_formatter_spec.rb",
+        "spec/rspec/core/formatters/progress_formatter_spec.rb",
+        "spec/rspec/core/formatters_spec.rb",
+        "spec/rspec/core/formatters/documentation_formatter_spec.rb",
+      ].join(","),
+    },
+  },
 }
 
 def run_command(cmd, allowed_statuses: [0])
@@ -35,7 +48,7 @@ end
 
 def format_repo(repo)
   run_command(
-    "bundle exec rake rufo:run sample_code/#{repo}",
+    "bundle exec rake rufo:run[sample_code/#{repo}]",
     allowed_statuses: [0, 1, 3],
   )
 end
@@ -44,10 +57,13 @@ def post_format_checks(repo, rspec_flags)
   run_rspec(repo, rspec_flags)
 end
 
-repos.each do |repo, rspec_flags|
+repos.each do |repo, options|
+  path = "#{repo}/#{options[:path]}"
+  rspec_flags = options[:rspec_flags]
+
   clone_repo(repo)
-  setup_repo(repo)
-  pre_format_checks(repo, rspec_flags)
-  format_repo(repo)
-  post_format_checks(repo, rspec_flags)
+  setup_repo(path)
+  pre_format_checks(path, rspec_flags)
+  format_repo(path)
+  post_format_checks(path, rspec_flags)
 end

data/lib/rufo/erb_formatter.rb

@@ -34,7 +34,7 @@ class Rufo::ErbFormatter
   def format
     out = []
     process_erb do |(type, content)|
-      if type == :code
+      if type == :code && !erb_comment?(content)
         formatted_code = process_code(content)
         indented_code = formatted_code.lines.join(" " * current_column)
         out << " #{indented_code} "
@@ -176,4 +176,8 @@ class Rufo::ErbFormatter
   def disable_code_mode
     @code_mode = false
   end
+
+  def erb_comment?(code)
+    code.start_with?("#")
+  end
 end

data/lib/rufo/formatter.rb

@@ -243,36 +243,7 @@ class Rufo::Formatter
     when :string_concat
       visit_string_concat node
     when :@tstring_content
-      # [:@tstring_content, "hello ", [1, 1]]
-      heredoc, tilde = @current_heredoc
-      looking_at_newline = current_token_kind == :on_tstring_content && current_token_value == "\n"
-      if heredoc && tilde && !@last_was_newline && looking_at_newline
-        check :on_tstring_content
-        consume_token_value(current_token_value)
-        next_token
-      else
-        # For heredocs with tilde we sometimes need to align the contents
-        if heredoc && tilde && @last_was_newline
-          unless (current_token_value == "\n" ||
-                  current_token_kind == :on_heredoc_end)
-            write_indent(next_indent)
-          end
-          skip_ignored_space
-          if current_token_kind == :on_tstring_content
-            check :on_tstring_content
-            consume_token_value(current_token_value)
-            next_token
-          end
-        else
-          while (current_token_kind == :on_ignored_sp) ||
-                (current_token_kind == :on_tstring_content) ||
-                (current_token_kind == :on_embexpr_beg)
-            check current_token_kind
-            break if current_token_kind == :on_embexpr_beg
-            consume_token current_token_kind
-          end
-        end
-      end
+      visit_at_tstring_content node
     when :string_content
       # [:string_content, exp]
       visit_exps node[1..-1], with_lines: false
@@ -742,6 +713,38 @@ class Rufo::Formatter
     visit string2
   end
 
+  def visit_at_tstring_content(_node)
+    # [:@tstring_content, "hello ", [1, 1]]
+    heredoc, tilde = @current_heredoc
+    looking_at_newline = current_token_kind == :on_tstring_content && current_token_value == "\n"
+    if heredoc && tilde && !@last_was_newline && looking_at_newline
+      check :on_tstring_content
+      consume_token_value(current_token_value)
+      next_token
+    else
+      # For heredocs with tilde we sometimes need to align the contents
+      if heredoc && tilde
+        while (current_token_kind == :on_ignored_sp) ||
+              (current_token_kind == :on_tstring_content)
+          if @last_was_newline && current_token_value != "\n"
+            write_indent(next_indent)
+            @last_was_newline = false
+          end
+          if current_token_kind == :on_ignored_sp
+            skip_ignored_space
+          else
+            consume_token current_token_kind
+          end
+        end
+      else
+        while (current_token_kind == :on_ignored_sp) ||
+              (current_token_kind == :on_tstring_content)
+          consume_token current_token_kind
+        end
+      end
+    end
+  end
+
   def visit_string_interpolation(node)
     # [:string_embexpr, exps]
     consume_token :on_embexpr_beg
@@ -1084,7 +1087,7 @@ class Rufo::Formatter
       # Check if there's a block arg and if the call ends with hash key/values
       if args_node[0] == :args_add_block
         _, args, block_arg = args_node
-        want_trailing_comma = !block_arg
+        want_trailing_comma = block_arg_type(block_arg) == :no_arg
         if args.is_a?(Array) && (last_arg = args.last) && last_arg.is_a?(Array) &&
            last_arg[0].is_a?(Symbol) && last_arg[0] != :bare_assoc_hash
           want_trailing_comma = false
@@ -1476,11 +1479,7 @@ class Rufo::Formatter
       visit_comma_separated_list args
     end
 
-    # block_arg will be...
-    #  - named => node
-    #  - anonymous => nil
-    #  - no arg => false
-    if block_arg || block_arg.nil?
+    if block_arg_type(block_arg) != :no_arg
       skip_space_or_newline
 
       if comma?
@@ -2209,14 +2208,14 @@ class Rufo::Formatter
 
     _, elements = node
 
-    token_column = current_token_column
+    base_column = @column
 
     check :on_lbracket
     write "["
     next_token
 
     if elements
-      visit_literal_elements to_ary(elements), inside_array: true, token_column: token_column
+      visit_literal_elements to_ary(elements), inside_array: true, token_column: base_column
     else
       skip_space_or_newline
     end
@@ -2326,7 +2325,7 @@ class Rufo::Formatter
   def visit_hash(node)
     # [:hash, elements]
     _, elements = node
-    token_column = current_token_column
+    base_column = @column
 
     closing_brace_token, _ = find_closing_brace_token
     need_space = need_space_for_hash?(node, node[1], closing_brace_token)
@@ -2340,7 +2339,7 @@ class Rufo::Formatter
     if elements
       # [:assoclist_from_args, elements]
       push_hash(node) do
-        visit_literal_elements(elements[1], inside_hash: true, token_column: token_column)
+        visit_literal_elements(elements[1], inside_hash: true, token_column: base_column)
       end
       char_after_brace = @output[brace_position + 1]
       # Check that need_space is set correctly.
@@ -2713,7 +2712,7 @@ class Rufo::Formatter
     base_column = @column
     base_line = @line
     needs_final_space = (inside_hash || inside_array) && space?
-    first_space = skip_space
+    skip_space
 
     if inside_hash
       needs_final_space = false
@@ -2925,11 +2924,19 @@ class Rufo::Formatter
 
     # If node is inline pattern matching, case_expression will be false
     case_expression = keyword?("case")
+    already_visit_cond = false
     if case_expression
-      consume_keyword "case"
+      if cond && cond[0] == :case
+        visit cond
+        # In this case, the `case` token is for the `cond`, but not for `node`
+        case_expression = false
+        already_visit_cond = true
+      else
+        consume_keyword "case"
+      end
     end
 
-    if cond
+    if cond && !already_visit_cond
       consume_space
       visit cond
     end
@@ -3084,46 +3091,75 @@ class Rufo::Formatter
     _, const_ref, pre_rest, rest, post_rest = node
 
     if const_ref
-      return visit_constant_pattern(node)
+      visit const_ref
     end
 
+    left_paren_token, right_paren_token = if current_token_kind == :on_lparen
+        %i[on_lparen on_rparen]
+      elsif current_token_kind == :on_lbracket
+        %i[on_lbracket on_rbracket]
+      else
+        []
+      end
+
     # pattern is [*]
     if !pre_rest && !post_rest && rest == [:var_field, nil]
-      consume_token :on_lbracket
+      if left_paren_token
+        consume_token left_paren_token
+      end
+
       skip_space_or_newline
       consume_op "*"
       skip_space_or_newline
-      consume_token :on_rbracket
+
+      if right_paren_token
+        consume_token right_paren_token
+      end
       return
     end
 
     token_column = current_token_column
 
-    has_bracket = current_token_kind == :on_lbracket
-    if has_bracket
-      consume_token :on_lbracket
+    if left_paren_token
+      consume_token left_paren_token
       skip_space
     end
 
-    write_comma = false
+    newline = newline?
+    wrote_comma = false
     if pre_rest
-      visit_literal_elements pre_rest, inside_array: true, token_column: token_column, keep_final_newline: !has_bracket
-      write_comma = true
-    end
+      visit_comma_separated_list pre_rest
+      skip_space
 
-    # pattern like `[a,]` will make `rest` as `[:var_field, nil]`
-    if rest && ((var_name_node = rest[1]) || current_token_value == "*")
-      if write_comma
+      if comma?
+        check :on_comma
         write ","
-        consume_space
-      else
+        next_token
+        skip_space
+        wrote_comma = true
+      end
+      if newline
         skip_space_or_newline
+        write_line
+        write_indent
       end
+    end
 
-      consume_op "*"
-      if var_name_node
-        visit rest
+    if rest
+      if wrote_comma
+        consume_space
       end
+
+      # pattern like `[a,]` will make `rest` as `[:var_field, nil]`
+      if (var_name_node = rest[1]) || current_token_value == "*"
+        consume_op "*"
+        if var_name_node
+          visit rest
+        end
+      end
+    elsif wrote_comma && !newline?
+      # In Ruby 3.3, rest is nil when the code is like `[a,]`. Insert a space after comma at here.
+      consume_space
     end
 
     if post_rest
@@ -3133,36 +3169,13 @@ class Rufo::Formatter
       consume_space
       next_token
 
-      visit_literal_elements post_rest, inside_array: true, token_column: token_column, keep_final_newline: !has_bracket
+      visit_literal_elements post_rest, inside_array: true, token_column: token_column, keep_final_newline: !left_paren_token
     end
 
     skip_space
-    if has_bracket
-      consume_token :on_rbracket
-    end
-  end
-
-  def visit_constant_pattern(node)
-    # [:aryptn, const_ref, args]
-    _, const_ref, args = node
-
-    visit const_ref
-
-    parens = current_token_kind == :on_lparen
-    if parens
-      consume_token :on_lparen
-    else
-      consume_token :on_lbracket
-    end
 
-    skip_space
-    visit_comma_separated_list args
-
-    skip_space
-    if parens
-      consume_token :on_rparen
-    else
-      consume_token :on_rbracket
+    if right_paren_token
+      consume_token right_paren_token
     end
   end
 
@@ -4194,4 +4207,15 @@ class Rufo::Formatter
       node[2][0]
     end
   end
+
+  def block_arg_type(node)
+    case node
+    when nil
+      :anonymous
+    when false
+      :no_arg
+    else
+      node
+    end
+  end
 end

data/lib/rufo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rufo
-  VERSION = "0.18.0"
+  VERSION = "0.18.2"
 end

data/rufo.gemspec

@@ -22,15 +22,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 3.0.0"
   spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.add_development_dependency "bundler", ">= 1.15"
-  spec.add_development_dependency "byebug", "~> 11.1.3"
-  spec.add_development_dependency "guard-rspec", "~> 4.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rexml", "~> 3.2.5"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6.0"
-  spec.add_development_dependency "rubocop", "~> 1.44.1"
-  spec.add_development_dependency "simplecov", "~> 0.22.0"
-  spec.add_development_dependency "simplecov-cobertura", "~> 2.1"
 end

metadata

@@ -1,155 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.2
 platform: ruby
 authors:
 - Ary Borenszweig
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.1.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.1.3
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.5
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.44.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.44.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-cobertura
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+date: 2025-12-24 00:00:00.000000000 Z
+dependencies: []
 description: Fast and unobtrusive Ruby code formatter
 email:
 - asterite@gmail.com
@@ -195,7 +54,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby code formatter
 test_files: []