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
    - unstable_sort
    - 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", "split", "chars", "lines", "captures", "named_captures", "clone"] of ::String

All these methods allocate a new object

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

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Ameba::AST::Util

abort?(node) abort?, control_exp_code(node : Crystal::ControlExpression, code_lines) control_exp_code, dynamic_literal?(node) : Bool dynamic_literal?, exit?(node) exit?, flow_command?(node, in_loop) flow_command?, flow_expression?(node, in_loop = false) flow_expression?, has_block?(node) : Bool has_block?, literal?(node) : Bool literal?, loop?(node) loop?, name_end_location(node) name_end_location, name_location(node) name_location, name_location_or(token : Crystal::Token, name, *, adjust_location_column_number = nil)
name_location_or(node : Crystal::ASTNode, *, adjust_location_column_number = nil) name_location_or, name_size(node) name_size, node_source(node, code_lines) node_source, nodoc?(node) nodoc?, path_named?(node, *names : String) : Bool path_named?, raise?(node) raise?, source_between(loc, end_loc, code_lines) : String | Nil source_between, static_literal?(node) : Bool static_literal?

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

catch(source : Source) catch

Constructor methods inherited from class Ameba::Rule::Performance::Base

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

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

parsed_doc : String | Nil parsed_doc

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

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

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

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

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

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
    - unstable_sort
    - sort
    - sort_by
    - shuffle
    - reverse

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
    - unstable_sort
    - sort
    - sort_by
    - shuffle
    - reverse

[View source]
def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

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

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

Instance Method Detail

def call_names : Array(String) #

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

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

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

[View source]
def test(source) #

[View source]