Sha256: 8d08ec5bf8f690b40f7fc1e68ff531e7385afec9605844f89e1fa00fcdcd2029

Contents?: true

Size: 1.17 KB

Versions: 16

Compression:

Stored size: 1.17 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # Checks for while and until statements that would fit on one line
      # if written as a modifier while/until. The maximum line length is
      # configured in the `Layout/LineLength` cop.
      #
      # @example
      #   # bad
      #   while x < 10
      #     x += 1
      #   end
      #
      #   # good
      #   x += 1 while x < 10
      #
      # @example
      #   # bad
      #   until x > 10
      #     x += 1
      #   end
      #
      #   # good
      #   x += 1 until x > 10
      class WhileUntilModifier < Base
        include StatementModifier
        extend AutoCorrector

        MSG = 'Favor modifier `%<keyword>s` usage when ' \
              'having a single-line body.'

        def on_while(node)
          return unless node.multiline? && single_line_as_modifier?(node)

          add_offense(node.loc.keyword, message: format(MSG, keyword: node.keyword)) do |corrector|
            oneline = "#{node.body.source} #{node.keyword} #{node.condition.source}"

            corrector.replace(node, oneline)
          end
        end
        alias on_until on_while
      end
    end
  end
end

Version data entries

16 entries across 16 versions & 3 rubygems

Version Path
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
plaid-14.10.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
plaid-14.7.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/style/while_until_modifier.rb
rubocop-1.2.0 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-1.1.0 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-1.0.0 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.93.1 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.93.0 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.92.0 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.91.1 lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.91.0 lib/rubocop/cop/style/while_until_modifier.rb
grape-extra_validators-2.0.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.90.0/lib/rubocop/cop/style/while_until_modifier.rb
rubocop-0.90.0 lib/rubocop/cop/style/while_until_modifier.rb