Contents

# encoding: utf-8

module RuboCop
  module Cop
    module Salsify
      # Use `dig` for deeply nested access.
      #
      # @example
      #
      #   # good
      #   my_hash.dig('foo', 'bar')
      #   my_array.dig(0, 1)
      #
      #   # bad
      #   my_hash['foo']['bar']
      #   my_hash['foo'] && my_hash['foo']['bar']
      #   my_array[0][1]

      class StyleDig < Cop
        extend TargetRubyVersion

        minimum_target_ruby_version 2.3

        MSG = 'Use `dig` for nested access.'.freeze

        def_node_matcher :nested_access_match, <<-PATTERN
          (send (send (send _receiver !:[]) :[] _) :[] _)
        PATTERN

        def on_send(node)
          nested_access_match(node) do
            match_node = node
            # walk to outermost access node
            match_node = match_node.parent while access_node?(match_node.parent)
            add_offense(match_node, :expression, MSG)
          end
        end

        def autocorrect(node)
          access_node = node
          source_args = [access_node.method_args.first.source]
          while access_node?(access_node.children.first)
            access_node = access_node.children.first
            source_args << access_node.method_args.first.source
          end
          root_node = access_node.children.first

          lambda do |corrector|
            range = Parser::Source::Range.new(node.source_range.source_buffer,
                                              root_node.source_range.end_pos,
                                              node.source_range.end_pos)
            corrector.replace(range, ".dig(#{source_args.reverse.join(', ')})")
          end
        end

        private

        def access_node?(node)
          node && node.send_type? && node.method_name == :[]
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
salsify_rubocop-0.47.1	lib/rubocop/cop/salsify/style_dig.rb
salsify_rubocop-0.47.1.rc0	lib/rubocop/cop/salsify/style_dig.rb