class

Ameba::Rule::Performance::ExcessiveAllocations

Inherits Ameba::AST::Util < YAML::Serializable < Ameba::Rule::Performance::Base < YAML::Serializable < Ameba::Rule::Base < Ameba::Config::RuleConfig < Reference < Object

This rule is used to identify excessive collection allocations, that can be avoided by using each_<member> instead of <collection>.each.

For example, this is considered inefficient:

"Alice".chars.each { |c| puts c }
"Alice\nBob".lines.each { |l| puts l }

And can be written as this:

"Alice".each_char { |c| puts c }
"Alice\nBob".each_line { |l| puts l }

YAML configuration example:

Performance/ExcessiveAllocations:
  Enabled: true
  CallNames:
    codepoints: each_codepoint
    graphemes: each_grapheme
    chars: each_char
    lines: each_line

Constants

MSG = "Use `%s {...}` instead of `%s.each {...}` to avoid excessive allocation"

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

This rule is used to identify excessive collection allocations, that can be avoided by using each_<member> instead of <collection>.each.

For example, this is considered inefficient:

"Alice".chars.each { |c| puts c }
"Alice\nBob".lines.each { |l| puts l }

And can be written as this:

"Alice".each_char { |c| puts c }
"Alice\nBob".each_line { |l| puts l }

YAML configuration example:

Performance/ExcessiveAllocations:
  Enabled: true
  CallNames:
    codepoints: each_codepoint
    graphemes: each_grapheme
    chars: each_char
    lines: each_line

new(config = nil)

This rule is used to identify excessive collection allocations, that can be avoided by using each_<member> instead of <collection>.each.

For example, this is considered inefficient:

"Alice".chars.each { |c| puts c }
"Alice\nBob".lines.each { |l| puts l }

And can be written as this:

"Alice".each_char { |c| puts c }
"Alice\nBob".each_line { |l| puts l }

YAML configuration example:

Performance/ExcessiveAllocations:
  Enabled: true
  CallNames:
    codepoints: each_codepoint
    graphemes: each_grapheme
    chars: each_char
    lines: each_line

Source

new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Class methods

deprecated?

Returns true if this rule is deprecated, false otherwise.

deprecation_reason

Returns the deprecation reason for this rule, if there is any.

documentation_url

Returns the documentation URL for this rule.

Ameba::Rule::Lint::Syntax.documentation_url
# => "https://crystal-ameba.org/api/master/Ameba/Rule/Lint/Syntax.html"

parsed_doc

Returns the documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class Rule::MyRule < Rule::Base
    def test(source)
    end
  end
end

Ameba::Rule::MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

to_json_schema(builder : JSON::Builder) : Nil

Source