Contents

module RuboCop
  module Cop
    module Ipepe
      class AlphabeticalHashKeys < ::RuboCop::Cop::Base
        extend AutoCorrector
        MSG = "Ensure that keys in hash are in alphabetical order".freeze

        def on_hash(node)
          keys = node.children.select(&:pair_type?).map(&:key)
          sorted_keys = keys.sort_by(&:value)
          return if cop_not_applicable?(keys, sorted_keys)

          add_offense(node) do |corrector|
            join_keys_with = " "
            join_keys_with = "\n " if node.source.include?("\n")

            corrector.replace(
              node,
              [
                "{",
                sorted_keypairs(node, sorted_keys).join(",#{join_keys_with}"),
                "}"
              ].join(join_keys_with)
            )
          end
        end

        private

        def cop_not_applicable?(keys, sorted_keys)
          keys.empty? ||
            keys.one? ||
            (keys.none?(&:str_type?) && keys.none?(&:sym_type?)) ||
            keys == sorted_keys
        end

        def sorted_keypairs(node, sorted_keys)
          sorted_keys.map do |k|
            keypair = node.children.find { |n| n.key == k }
            if keypair.key.str_type?
              "#{keypair.key.source} => #{keypair.value.source}"
            elsif keypair.key.sym_type?
              "#{keypair.key.source}: #{keypair.value.source}"
            end
          end
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rubocop-ipepe-0.2.0	lib/rubocop/cop/ipepe/alphabetical_hash_keys.rb