rufo 0.17.1 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5df151931108df0740d8602c1bf8b931503e3bede6a337f25a9bf75cb549c70
-  data.tar.gz: 73a321c4a0960f8fc021b062149ccbe3f96ccfc231c780e2612de00e011f590b
+  metadata.gz: f4dd74a9e383128ba24cedbdfc7f008332f3a540ab89f9a5ab33be306413269a
+  data.tar.gz: f725c8a39471a92251294a041a9ae63dcefab5f55614b4ed3215cf11bfb29c4e
 SHA512:
-  metadata.gz: 8a2176ae1780bce5ec076052b63576fc54370a4a5b2a7837166e8d42ec4f6f4f47cc1b4590f5742a6b7a263d7cb2b59fc7985a2dd9f1a37fa41939c502515253
-  data.tar.gz: aad26fad18830aad211ba7d16f65643b78648b4f755d0a43ac1b65edbba1d7f97e05535f7c2f499dc3a5a7fa2cfff295e2a5da1aa63af859090873598406ab60
+  metadata.gz: a59736abaa4d40516afea2e130c835da5683ac17fbe34f540f64c61ad7a4051c3ba02c05b846b90d97438c6bb0909922261463b3d62003931fde81140ab74295
+  data.tar.gz: 73bb9af67241c6552de2a3a6610d406c5566c50a5e473b753fbd18741d589a9009f6f2578754220456098f92cc91f4f457a29f3c95e51c89b16c8f5f671312b3

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', '2.7']
+        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/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
   Exclude:
     - "spec/**/*"
     - "vendor/**/*"
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Layout:
   Enabled: false

data/CHANGELOG.md

@@ -12,6 +12,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+## [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 ([#323](https://github.com/ruby-formatter/rufo/pull/323))
+
+### Changed
+- Dropped support for Ruby 2.7 as it is end of life.
+
+### Added
+
 ## [0.17.1] - 2024-02-03
 
 ### Fixed

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", "~> 2.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,18 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 repos = {
-  "rspec/rspec-expectations" => {},
-  "rspec/rspec-mocks" => {},
+  "rspec/rspec-core" => {
+    "--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])

data/lib/rufo/formatter.rb

@@ -18,6 +18,7 @@ class Rufo::Formatter
 
     @tokens = Rufo::Parser.lex(code).reverse!
     @sexp = Rufo::Parser.sexp(code)
+    @sexp ||= Rufo::Parser.sexp_unparsable_code(code)
 
     # sexp being nil means that the code is not valid.
     # Parse the code so we get better error messages.
@@ -251,23 +252,22 @@ class Rufo::Formatter
         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
+        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) ||
-                (current_token_kind == :on_embexpr_beg)
-            check current_token_kind
-            break if current_token_kind == :on_embexpr_beg
+                (current_token_kind == :on_tstring_content)
             consume_token current_token_kind
           end
         end
@@ -1083,7 +1083,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
@@ -1475,11 +1475,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?
@@ -2208,14 +2204,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
@@ -2325,7 +2321,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)
@@ -2339,7 +2335,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.
@@ -2712,7 +2708,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
@@ -2924,11 +2920,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
@@ -3083,46 +3087,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
@@ -3132,36 +3165,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
-    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
+      visit_literal_elements post_rest, inside_array: true, token_column: token_column, keep_final_newline: !left_paren_token
     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
 
@@ -4193,4 +4203,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/parser.rb

@@ -10,4 +10,48 @@ class Rufo::Parser < Ripper
   def on_parse_error(msg)
     raise ::Rufo::SyntaxError.new(msg, lineno)
   end
+
+  def self.sexp_unparsable_code(code)
+    code_type = detect_unparsable_code_type(code)
+
+    case code_type
+    when :yield
+      extract_original_code_sexp(
+        "def __rufo_dummy; #{code}; end",
+        ->(exp) { exp => [:def, *, [:bodystmt, exps, *]]; exps }
+      )
+    when :next, :break, :redo
+      extract_original_code_sexp(
+        "loop do; #{code}; end",
+        ->(exp) { exp => [:method_add_block, *, [:do_block, nil, [:bodystmt, [[:void_stmt], *exps], *]]]; exps }
+      )
+    when :retry
+      extract_original_code_sexp(
+        "begin; rescue; #{code}; end",
+        ->(exp) { exp => [:begin, [:bodystmt, Array, [:rescue, nil, nil, exps, *], *]]; exps }
+      )
+    end
+  end
+
+  def self.detect_unparsable_code_type(code)
+    tokens = self.lex(code)
+    token = tokens.find { |_, kind| kind != :on_sp && kind != :on_ignored_nl }
+
+    case token
+    in [_, :on_kw, "yield" | "next" | "break" | "retry" | "redo" => kw, _]
+      kw.to_sym
+    else
+      nil
+    end
+  end
+
+  def self.extract_original_code_sexp(decorated_code, extractor)
+    sexp = self.sexp(decorated_code)
+    return nil unless sexp
+
+    # [:program, [exp]]
+    exp = sexp[1][0]
+    code_exps = extractor.call(exp)
+    [:program, code_exps]
+  end
 end

data/lib/rufo/version.rb

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

data/rufo.gemspec

@@ -20,17 +20,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.7.0"
+  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,15 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.1
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-03 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-02-22 00:00:00.000000000 Z
+dependencies: []
 description: Fast and unobtrusive Ruby code formatter
 email:
 - asterite@gmail.com
@@ -203,14 +63,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby code formatter