class Ameba::Rule::Performance::ChainedCallWithNoBang

Overview

This rule is used to identify usage of chained calls not utilizing the bang method variants.

For example, this is considered inefficient:

names = %w[Alice Bob]
chars = names
  .flat_map(&.chars)
  .uniq
  .sort

And can be written as this:

names = %w[Alice Bob]
chars = names
  .flat_map(&.chars)
  .uniq!
  .sort!

YAML configuration example:

Performance/ChainedCallWithNoBang:
  Enabled: true
  CallNames:
    - uniq
    - sort
    - sort_by
    - shuffle
    - reverse

Included Modules

Defined in:

ameba/rule/performance/chained_call_with_no_bang.cr

Constant Summary

ALLOCATING_METHOD_NAMES = ["keys", "values", "values_at", "map", "map_with_index", "flat_map", "compact_map", "flatten", "compact", "select", "reject", "sample", "group_by", "chunks", "tally", "merge", "combinations", "repeated_combinations", "permutations", "repeated_permutations", "transpose", "invert", "chars", "captures", "named_captures", "clone"] of ::String

All these methods are allocating a new object

MSG = "Use bang method variant `%s!` after chained `%s` call"

Constructors

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

parsed_doc parsed_doc

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

This rule is used to identify usage of chained calls not utilizing the bang method variants.

For example, this is considered inefficient:

names = %w[Alice Bob]
chars = names
  .flat_map(&.chars)
  .uniq
  .sort

And can be written as this:

names = %w[Alice Bob]
chars = names
  .flat_map(&.chars)
  .uniq!
  .sort!

YAML configuration example:

Performance/ChainedCallWithNoBang:
  Enabled: true
  CallNames:
    - uniq
    - sort
    - sort_by
    - shuffle
    - reverse

[View source]

Instance Method Detail

def call_names : Array(String) #

def call_names=(call_names : Array(String)) #

def description : String #

def description=(description : String) #

def enabled : Bool #

def enabled=(enabled) #

def excluded : Array(String)? #

def excluded=(excluded : Array(String)?) #

def severity : Ameba::Severity #

def severity=(severity) #

def test(source, node : Crystal::Call) #

[View source]
def test(source) #

[View source]