shard-ameba/src/ameba/rule/naming/constant_names.cr

module Ameba::Rule::Naming
  # A rule that enforces constant names to be in screaming case.
  #
  # For example, these constant names are considered valid:
  #
  # ```
  # LUCKY_NUMBERS     = [3, 7, 11]
  # DOCUMENTATION_URL = "http://crystal-lang.org/docs"
  # ```
  #
  # And these are invalid names:
  #
  # ```
  # myBadConstant = 1
  # Wrong_NAME = 2
  # ```
  #
  # YAML configuration example:
  #
  # ```
  # Naming/ConstantNames:
  #   Enabled: true
  # ```
  class ConstantNames < Base
    properties do
      description "Enforces constant names to be in screaming case"
    end

    MSG = "Constant name should be screaming-cased: %s, not %s"

    def test(source, node : Crystal::Assign)
      return unless (target = node.target).is_a?(Crystal::Path)
      name = target.names.first
      expected = name.upcase

      return if name.in?(expected, name.camelcase)

      issue_for target, MSG % {expected, name}
    end
  end
end