rufo 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87b9e11a2d83bf366134074b750fca515da61d65c626ad4a85cb029b3246f314
-  data.tar.gz: 5f2caf3f22b5b7e8411e7a35f9e73c27bfd7a92f7f8246f3099ed98ecacef359
+  metadata.gz: '050197c783154878217024914afe1fc208e624521b5c3c1c4cd182c29ce70795'
+  data.tar.gz: 8ec88b8b3bc5fa60afbfa7eb7bcf395a2dd906c2b51e2c256d9f11876540279f
 SHA512:
-  metadata.gz: 00742ceee28433e130ccceffd31ee41a8a827135d3f986f552d42821e62acc6b5a7c795771c5bdea5ec46069374a1ca014f964ca21fcd425240ffeedc101b72f
-  data.tar.gz: ade0daa5611c2cbe51f9bf59de4df7750aaac6ecec829eaad97b9f478cba2d5f5a4671ac054c9d2850f5b1758b07881b51474e94a1cbe754f02a6348ccaa1607
+  metadata.gz: 7cce9d7529456084473d761247402c659950460bb75155d3689d8c89bc89993793d9638fc0bc47d45a40d97eaf2d06d13c175f1db0aeef1356ad12a8124f5bfe
+  data.tar.gz: f4e46d300e1a94fc05c1d2aaa99ea6f24fa244faba984e8841f9874e5326ef324cc38b915008948156ec5825c572024dc0e57a0600f6b235fe06f7b7f3695e60

data/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: ['3.2', '3.1', '3.0', '2.7']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+
+    - name: Bundle update
+      run: |
+        bundle update
+
+    - name: Run test
+      run: |
+        bundle exec rspec --profile 10 \
+                          --format RspecJunitFormatter \
+                          --out test_results/rspec.xml \
+                          --format progress
+
+    - name: Upload code coverage
+      uses: codecov/codecov-action@v3
+      with:
+        files: ./coverage/coverage.xml
+
+    - name: Run rubocop
+      run: |
+        bundle exec rake rubocop
+
+    - name: Run rufo
+      run: |
+        bundle exec rake rufo:run
+
+    - name: Verify rufo works against sample codebases
+      run: |
+        bin/verify-sample-code
+
+    - name: Save test results
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: coverage-ruby-${{ matrix.ruby_version }}
+        path: coverage

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 /*.gem
+/.ruby-version
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -12,9 +12,41 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+## [0.14.0] - 2023-01-25
+
+### Fixed
+
+- Correctly interpret erb scriptlets with more than one control-flow/block statement
+
+### Changed
+
+- Dropped support for Ruby 2.6 as it is end of life.
+
+### Added
+
+- Support for partial argument forwarding. (issue [268](https://github.com/ruby-formatter/rufo/issues/268))
+- Support for endless method. (issue [271](https://github.com/ruby-formatter/rufo/issues/271))
+- Add Ruby 3.2.0 to test runs on CI.
+
+## [0.13.0] - 2021-05-07
+
+### Fixed
+
+- Properly format comma when a heredoc is passed as a call argument
+- Correctly interpret case statements with multiple when clauses in ERB files
+
+### Changed
+
+- Dropped support for Ruby 2.4 and 2.5 as they are end of life.
+
+### Added
+
+- Add Ruby 3.0.1 to test runs on CI.
+
 ## [0.12.0] - 2020-03-08
 
 ### Fixed
+
 - File.read default encode UTF-8
 - Handle case where the code is invalid but ripper does not raise an error.
 - Removed implicit dependency on `rake`.

data/README.md

@@ -1,6 +1,6 @@
 # Rufo
 
-[![CircleCI](https://circleci.com/gh/ruby-formatter/rufo.svg?style=svg)](https://circleci.com/gh/ruby-formatter/rufo)
+[![GitHub Actions](https://github.com/ruby-formatter/rufo/workflows/CI/badge.svg)](https://github.com/ruby-formatter/rufo/actions/workflows/ci.yml)
 [![Gem](https://img.shields.io/gem/v/rufo.svg)](https://rubygems.org/gems/rufo)
 
 **Ru**by **fo**rmatter
@@ -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.4.**5**, due to a bug in Ruby's Ripper parser.
+Rufo supports all Ruby versions >= 2.7.0.
 
 ## Installation
 
@@ -35,7 +35,7 @@ Or install it system wide with:
 Once the gem is installed, enable format on save integration in your editor of choice with the following libraries:
 
 - Atom: [rufo-atom](https://github.com/bmulvihill/rufo-atom) :construction:
-- Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction: or [rufo.el](https://github.com/danielma/rufo.el)
+- Emacs [emacs-rufo](https://github.com/aleandros/emacs-rufo) :construction: or [rufo.el](https://github.com/danielma/rufo.el) or [run rufo with reformatter](https://gist.github.com/kzkn/5c80c24d39e5e7b7881d55ad04605c5b)
 - Sublime Text: [sublime-rufo](https://github.com/ruby-formatter/sublime-rufo)
 - Vim: [rufo-vim](https://github.com/splattael/rufo-vim)
 - Visual Studio Code: [vscode-rufo](https://marketplace.visualstudio.com/items?itemName=mbessey.vscode-rufo) or [rufo-vscode](https://marketplace.visualstudio.com/items?itemName=siliconsenthil.rufo-vscode)

data/bin/verify-sample-code

@@ -8,6 +8,9 @@ repos = {
       "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_spec.rb",
+      "spec/rspec/core/formatters/documentation_formatter_spec.rb",
+      "spec/rspec/core/formatters/progress_formatter_spec.rb"
     ].join(","),
   },
 }

data/docs/settings.md

@@ -23,7 +23,7 @@ See https://github.com/ruby-formatter/rufo/issues/2 for more context!
 - [parens_in_def](#parens_in_def)
 - [trailing_commas](#trailing_commas)
 - [quote_style](#quote_style)
-- [includes and excludes](#includes%20and%20excludes)
+- [includes and excludes](#includes-and-excludes)
 
 ### align_case_when
 
@@ -284,5 +284,5 @@ Files can be excluded or included in formatting with rufo by specifying glob pat
 For example:
 ```
 includes [*.txt,*.text]
-excludes [*.rb]
+excludes [**/*.erb]
 ```

data/lib/rufo/erb_formatter.rb

@@ -104,13 +104,51 @@ class Rufo::ErbFormatter
     result.strip
   end
 
+  def format_affix(affix, levels, type)
+    string = ""
+    case type
+    when :prefix
+      count = 0
+      while count < levels
+        count += 1
+        string += (" " * Rufo::Formatter::INDENT_SIZE * (count > 0 ? count - 1 : 0)) + affix
+        string += "\n" if count < levels
+      end
+    when :suffix
+      count = levels
+      while count > 0
+        count -= 1
+        string += "\n"
+        string += (" " * Rufo::Formatter::INDENT_SIZE * (count > 0 ? count - 1 : 0)) + affix
+      end
+    end
+    string
+  end
+
   def determine_code_wrappers(code_str)
-    return nil, "\nend" if Ripper.sexp("#{code_str}\nend")
+    keywords = Ripper.lex("#{code_str}").filter { |lex_token| lex_token[1] == :on_kw }
+    lexical_tokens = keywords.filter { |lex_token| lex_token[2] != "when" }.map { |lex_token| lex_token[3].to_s }
+    state_tally = lexical_tokens.group_by(&:itself).transform_values(&:count)
+    beg_token = state_tally["BEG"] || state_tally["EXPR_BEG"] || 0
+    end_token = state_tally["END"] || state_tally["EXPR_END"] || 0
+    depth = beg_token - end_token
+
+    if depth > 0
+      affix = format_affix("end", depth.abs, :suffix)
+      return nil, affix if Ripper.sexp("#{code_str}#{affix}")
+    end
+
     return nil, "}" if Ripper.sexp("#{code_str} }")
     return "{", nil if Ripper.sexp("{ #{code_str}")
-    return "begin", nil if Ripper.sexp("begin #{code_str}")
+
+    if depth < 0
+      affix = format_affix("begin", depth.abs, :prefix)
+      return affix, nil if Ripper.sexp("#{affix}#{code_str}")
+    end
+
     return "begin\n", "\nend" if Ripper.sexp("begin\n#{code_str}\nend")
     return "if a\n", "\nend" if Ripper.sexp("if a\n#{code_str}\nend")
+    return "case a\n", "\nend" if Ripper.sexp("case a\n#{code_str}\nend")
     raise_syntax_error!(code_str)
   end
 

data/lib/rufo/formatter.rb

@@ -212,7 +212,7 @@ class Rufo::Formatter
     when :@float
       # Float literal
       #
-      # [:@int, "123.45", [1, 0]]
+      # [:@float, "123.45", [1, 0]]
       consume_token :on_float
     when :@rational
       # Rational literal
@@ -1126,11 +1126,14 @@ class Rufo::Formatter
 
       found_comma = comma?
 
+      heredoc_needs_newline = true
+
       if found_comma
         if needs_trailing_newline
           write "," if trailing_commas && !block_arg
 
           next_token
+          heredoc_needs_newline = !newline?
           indent(next_indent) do
             consume_end_of_line
           end
@@ -1142,7 +1145,7 @@ class Rufo::Formatter
       end
 
       if newline? || comment?
-        if needs_trailing_newline
+        if needs_trailing_newline && !@last_was_heredoc
           write "," if trailing_commas && want_trailing_comma
 
           indent(next_indent) do
@@ -1154,7 +1157,7 @@ class Rufo::Formatter
         end
       else
         if needs_trailing_newline && !found_comma
-          write "," if trailing_commas && want_trailing_comma
+          write "," if trailing_commas && want_trailing_comma && !@last_was_heredoc
           consume_end_of_line
           write_indent
         end
@@ -1169,8 +1172,9 @@ class Rufo::Formatter
       call_info << @line
     end
 
-    if @last_was_heredoc
+    if @last_was_heredoc && heredoc_needs_newline
       write_line
+      write_indent
     end
     consume_token :on_rparen
   end
@@ -1452,14 +1456,10 @@ class Rufo::Formatter
     # check for ||
     if empty_params && !local_params
       # Don't write || as it's meaningless
-      if current_token_value == "|"
-        next_token
-        skip_space_or_newline
-        check :on_op
-        next_token
-      else
-        next_token
-      end
+      next_token
+      skip_space_or_newline
+      check :on_op
+      next_token
       return
     end
 
@@ -1571,7 +1571,12 @@ class Rufo::Formatter
 
     line = @line
 
-    indent_body body
+    endless = body[0].is_a?(Symbol)
+    if endless
+      visit body
+    else
+      indent_body body
+    end
 
     while rescue_body
       # [:rescue, type, name, body, more_rescue]
@@ -1616,7 +1621,7 @@ class Rufo::Formatter
     end
 
     write_indent if @line != line
-    consume_keyword "end"
+    consume_keyword "end" unless endless
   end
 
   def visit_rescue_types(node)
@@ -1992,6 +1997,19 @@ class Rufo::Formatter
     #   [:@ident, "foo", [1, 6]],
     #   [:params, nil, nil, nil, nil, nil, nil, nil],
     #   [:bodystmt, [[:void_stmt]], nil, nil, nil]]
+    #
+    # OR For endless methods (in 3.0)
+    # [:def,
+    #   [:@ident, "foo", [1, 6]],
+    #   nil,
+    #   [:string_literal, [:string_content, [:@tstring_content, "bar", [1, 11]
+    # OR For endless methods (in 3.1)
+    # [:def,
+    #   [:@ident, "foo", [1, 6]],
+    #   nil,
+    #   [:bodystmt,
+    #    [:string_literal, [:string_content, [:@tstring_content, "bar", [1, 11]
+
     _, name, params, body = node
 
     consume_keyword "def"
@@ -2028,6 +2046,7 @@ class Rufo::Formatter
   def visit_def_from_name(name, params, body)
     visit name
 
+    params = [] if params.nil?
     params = params[1] if params[0] == :paren
 
     skip_space
@@ -2068,6 +2087,7 @@ class Rufo::Formatter
         end
         write ")"
         next_token
+        skip_space
       end
     elsif !empty_params?(params)
       if parens_in_def == :yes
@@ -2081,9 +2101,18 @@ class Rufo::Formatter
       skip_space
     end
 
+    format_endless_method if current_token_kind == :on_op
+
     visit body
   end
 
+  def format_endless_method
+    consume_space
+    consume_op "="
+    consume_space
+    skip_space
+  end
+
   def empty_params?(node)
     _, a, b, c, d, e, f, g = node
     !a && !b && !c && !d && !e && !f && !g
@@ -2139,6 +2168,7 @@ class Rufo::Formatter
       when 0, [:excessed_comma]
         write_params_comma
       when [:args_forward]
+        write_params_comma if needs_comma
         consume_op "..."
       else
         # [:rest_param, [:@ident, "x", [1, 15]]]
@@ -2175,16 +2205,22 @@ class Rufo::Formatter
 
     if double_star_param
       write_params_comma if needs_comma
-      consume_op "**"
-      skip_space_or_newline
+      case double_star_param
+      when [:args_forward] # may be [:args_forward] in 3.1.0
+        consume_op "..."
+      else
+        consume_op "**" # here
+        skip_space_or_newline
 
-      # A nameless double star comes as an... Integer? :-S
-      visit double_star_param if double_star_param.is_a?(Array)
-      skip_space_or_newline
-      needs_comma = true
+        # A nameless double star comes as an... Integer? :-S
+        visit double_star_param if double_star_param.is_a?(Array)
+        skip_space_or_newline
+        needs_comma = true
+      end
     end
 
-    if blockarg
+    # In 3.1.0 blockarg may be just a symbol `:&`
+    if blockarg && blockarg.is_a?(Array)
       # [:blockarg, [:@ident, "block", [1, 16]]]
       write_params_comma if needs_comma
       skip_space_or_newline
@@ -3184,13 +3220,6 @@ class Rufo::Formatter
         last_space = current_token
         next_token
       when :on_nl, :on_ignored_nl
-        # I don't know why but sometimes a on_ignored_nl
-        # can appear with nil as the "text", and that's wrong
-        if current_token[2].nil?
-          next_token
-          next
-        end
-
         if last == :newline
           # If we pass through consecutive newlines, don't print them
           # yet, but remember this fact
@@ -3884,11 +3913,7 @@ class Rufo::Formatter
     when :assoclist_from_args
       node_line(beginning ? node[1][0] : node[1].last, beginning: beginning)
     when :dyna_symbol
-      if node[1][0].is_a?(Symbol)
-        node_line(node[1], beginning: beginning)
-      else
-        node_line(node[1][0], beginning: beginning)
-      end
+      node_line(node[1], beginning: beginning)
     when :@label, :@int, :@ident, :@tstring_content, :@kw
       node[2][0]
     end

data/lib/rufo/version.rb

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

data/rufo.gemspec

@@ -20,12 +20,13 @@ 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.4.5"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.add_development_dependency "bundler", ">= 1.15"
   spec.add_development_dependency "byebug", "~> 11.0.1"
   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.4.1"
   spec.add_development_dependency "rubocop", "~> 0.79.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rufo
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ary Borenszweig
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !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
@@ -144,8 +158,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -180,7 +194,7 @@ homepage: https://github.com/ruby-formatter/rufo
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,15 +202,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.5
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Ruby code formatter
 test_files: []

data/.circleci/config.yml

@@ -1,110 +0,0 @@
-"-": &dockerbuild
-  steps:
-    - checkout
-
-    # Which version of ruby?
-    - run:
-        name: Which ruby?
-        command: ruby --version | tee ruby-version-for-ci.txt
-
-    # Which version of bundler?
-    - run:
-        name: Which bundler?
-        command: bundle -v
-
-    # Restore bundle cache
-    - restore_cache:
-        keys:
-          - bundler-packages-v2-{{ checksum "ruby-version-for-ci.txt" }}-{{ checksum "rufo.gemspec" }}-{{ checksum "bin/verify-sample-code" }}
-
-    - run:
-        name: Bundle Install
-        command: bundle check || bundle install
-
-    - run:
-        name: Run rspec
-        command: |
-          bundle exec rspec --profile 10 \
-                            --format RspecJunitFormatter \
-                            --out test_results/rspec.xml \
-                            --format progress
-    - run:
-          name: Upload code coverage
-          command: bash <(curl -s https://codecov.io/bash) -f 'coverage/coverage.xml'
-    - run:
-        name: Run RuboCop
-        command: |
-          bundle exec rake rubocop
-    - run:
-        name: Run Rufo
-        command: |
-          bundle exec rake rufo:run
-
-    - run:
-        name: Verify rufo works against sample codebases
-        command: |
-          bin/verify-sample-code
-
-    # Store bundle cache
-    - save_cache:
-        key: bundler-packages-v2-{{ checksum "ruby-version-for-ci.txt" }}-{{ checksum "rufo.gemspec" }}-{{ checksum "bin/verify-sample-code" }}
-        paths:
-          - vendor/bundle
-          - Gemfile.lock
-
-    # Save test results for timing analysis
-    - store_test_results:
-        path: test_results
-
-version: 2
-jobs:
-  build-2-7-0:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.7.0
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: /home/circleci/project/vendor/bundle
-  build-2-6-3:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.6.3
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: /home/circleci/project/vendor/bundle
-  build-2-6-1:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.6.1
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: vendor/bundle
-  build-2-5-3:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.5.3
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: vendor/bundle
-  build-2-4-5:
-    <<: *dockerbuild
-    docker:
-      - image: circleci/ruby:2.4.5
-        environment:
-          BUNDLE_JOBS: "3"
-          BUNDLE_RETRY: "3"
-          BUNDLE_PATH: vendor/bundle
-
-workflows:
-  version: 2
-  test:
-    jobs:
-      - build-2-7-0
-      - build-2-6-3
-      - build-2-6-1
-      - build-2-5-3
-      - build-2-4-5