Sha256: 778ab48047f824bdaf202dbb869573af2137c6a75c0ff8309f7295b8e33ed4e3

Contents?: true

Size: 1.87 KB

Versions: 17

Compression:

Stored size: 1.87 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Layout
      # Ensures that each key in a multi-line hash
      # starts on a separate line.
      #
      # @example AllowMultilineFinalElement: false (default)
      #
      #   # bad
      #   {
      #     a: 1, b: 2,
      #     c: 3
      #   }
      #
      #   # bad
      #   { a: 1, b: {
      #     c: 3,
      #   }}
      #
      #   # good
      #   {
      #     a: 1,
      #     b: 2,
      #     c: 3
      #   }
      #
      #   # good
      #   {
      #     a: 1,
      #     b: {
      #       c: 3,
      #     }
      #   }
      #
      # @example AllowMultilineFinalElement: true
      #
      #   # bad
      #   {
      #     a: 1, b: 2,
      #     c: 3
      #   }
      #
      #   # good
      #   { a: 1, b: {
      #     c: 3,
      #   }}
      #
      #   # good
      #   {
      #     a: 1,
      #     b: 2,
      #     c: 3
      #   }
      #
      #
      #   # good
      #   {
      #     a: 1,
      #     b: {
      #       c: 3,
      #     }
      #   }
      class MultilineHashKeyLineBreaks < Base
        include MultilineElementLineBreaks
        extend AutoCorrector

        MSG = 'Each key in a multi-line hash must start on a separate line.'

        def on_hash(node)
          # This cop only deals with hashes wrapped by a set of curly
          # braces like {foo: 1}. That is, not a kwargs hashes.
          # Style/MultilineMethodArgumentLineBreaks handles those.
          return unless starts_with_curly_brace?(node)
          return unless node.loc.begin

          check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
        end

        private

        def starts_with_curly_brace?(node)
          node.loc.begin
        end

        def ignore_last_element?
          !!cop_config['AllowMultilineFinalElement']
        end
      end
    end
  end
end

Version data entries

17 entries across 17 versions & 3 rubygems

Version Path
rubocop-1.50.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.50.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.49.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
call_your_name-0.1.0 vendor/bundle/ruby/3.1.0/gems/rubocop-1.48.1/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.48.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.48.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.47.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
zilla-0.2.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.46.0/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.46.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.45.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.45.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.44.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.44.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.43.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.42.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.41.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.41.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb