Add conditional for when formatting metric name symbol

[rayz]

Fixes an issue where {Symbol}.name breaks in RUBY_VERSION < 3.

Was not caught in CI since we didn't use symbols in our testing so I've added a new test.

[datadog-datadog-prod-us1]

⚪ Code Quality Violation

Suggested change

	if Symbol === metric_name && metric_name.respond_to?(:name)
	if metric_name.is_a?(Symbol) && metric_name.respond_to?(:name)

Do not use === (...read more)

The case equality operator === in Ruby is used to test equality within a when clause of a case statement. However, it's often considered a bad practice to use this operator explicitly outside of a case statement. This is because its behavior can be quite unpredictable and confusing, as it behaves differently for different classes.

The use of the === operator can lead to code that is harder to read and understand. It's also potentially prone to bugs, as it might not behave as expected with certain objects. Therefore, it's recommended to avoid the explicit use of the === operator.

Instead of using the === operator, it's better to use more explicit methods that clearly indicate what you're trying to achieve. For example, if you're trying to check if a string matches a regular expression, you can use the match? method. If you want to check if an object is an instance of a certain class, you can use the is_a? method. These methods are much more clear and straightforward, leading to better, more maintainable code.

    

[ivoanjo]

Minor: Since this if will always be true or false for a given Ruby version, it may be worth introducing a new method that's conditionally defined for that Ruby; e.g. something like

if RUBY_VERSION < '3'
  def metric_name_to_string(metric_name)
    Symbol === metric_name ? metric_name.name : metric_name.to_s
  end
else
  def metric_name_to_string(metric_name)
    metric_name.to_s
  end
end

...this way each Ruby gets its own correct version of the code and no need to keep checking.

[ivoanjo]

👍 LGTM

[DDuongNguyen]

LGTM 👍🏼

[datadog-datadog-prod-us1]

⚪ Code Quality Violation

Suggested change

	Symbol === metric_name ? metric_name.name : metric_name.to_s
	metric_name.is_a?(Symbol) ? metric_name.name : metric_name.to_s

Do not use === (...read more)

The case equality operator === in Ruby is used to test equality within a when clause of a case statement. However, it's often considered a bad practice to use this operator explicitly outside of a case statement. This is because its behavior can be quite unpredictable and confusing, as it behaves differently for different classes.

The use of the === operator can lead to code that is harder to read and understand. It's also potentially prone to bugs, as it might not behave as expected with certain objects. Therefore, it's recommended to avoid the explicit use of the === operator.

Instead of using the === operator, it's better to use more explicit methods that clearly indicate what you're trying to achieve. For example, if you're trying to check if a string matches a regular expression, you can use the match? method. If you want to check if an object is an instance of a certain class, you can use the is_a? method. These methods are much more clear and straightforward, leading to better, more maintainable code.