class Ameba::Rule::Style::CallParentheses

Overview

A rule that enforces usage of parentheses in method or macro calls.

For example, this (and all of its variants) is considered invalid:

user.update name: "John", age: 30

And should be replaced by the following:

user.update(name: "John", age: 30)

Options

YAML configuration example:

Style/CallParentheses:
  Enabled: true
  ExcludeMultilineCalls: true
  ExcludeTypeDeclarations: true
  ExcludeHeredocs: true
  ExcludedToplevelCallNames: [spawn, raise, super, previous_def, exit, abort, sleep, print, printf, puts, p, p!, pp, pp!, record, class_getter, class_getter?, class_getter!, class_property, class_property?, class_property!, class_setter, getter, getter?, getter!, property, property?, property!, setter, def_equals_and_hash, def_equals, def_hash, delegate, forward_missing_to, describe, context, it, pending, pending!, fail, eq, be, be_a, be_close, contain, start_with, end_with, match, use_json_discriminator]
  ExcludedCallNames: [should, should_not]
  ExcludedDslCallNames: []

Included Modules

Defined in:

ameba/rule/style/call_parentheses.cr

Constant Summary

CALL_NAMES_SEPARATOR = " > "
MSG = "Missing parentheses in method 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?, each_inline_directive(source, &block : Crystal::Token, String, Array(String) -> _) each_inline_directive, exit?(node) exit?, flow_command?(node, in_loop) flow_command?, flow_expression?(node, in_loop = false) flow_expression?, has_arguments?(node) : Bool has_arguments?, has_block?(node) : Bool has_block?, has_short_block?(node, code_lines) has_short_block?, heredoc?(node : Crystal::ASTNode, source : Source) heredoc?, 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?, operator_method?(node) operator_method?, operator_method_name?(name : String) operator_method_name?, path_name(node : Crystal::Path, *, include_global = true) : String path_name, path_named?(node, *names : String) : Bool path_named?, raise?(node) raise?, setter_method?(node) setter_method?, setter_method_name?(name : String) setter_method_name?, short_block?(node, code_lines) short_block?, source_between(loc, end_loc, code_lines) : String | Nil source_between, static_literal?(node) : Bool static_literal?, suffix?(node) suffix?, takes_arguments?(node) : Bool takes_arguments?

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

==(other : self) ==, catch(source : Source) catch, excluded?(source, root = Dir.current) 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, group_name group_name, rule_name rule_name

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) #

def self.new(config = nil) #

A rule that enforces usage of parentheses in method or macro calls.

For example, this (and all of its variants) is considered invalid:

user.update name: "John", age: 30

And should be replaced by the following:

user.update(name: "John", age: 30)

Options

  • ExcludeMultilineCalls — controls whether multiline calls should be checked.

  • ExcludeTypeDeclarations — controls whether calls with type declarations should be checked.

  • ExcludeHeredocs — controls whether calls with heredoc arguments should be checked.

  • ExcludedToplevelCallNames — contains a list of top-level method names that should not be checked.

  • ExcludedCallNames — contains a list of non-top-level method names that should not be checked.

  • ExcludedDslCallNames — contains a list of DSL method names that should not be checked.

    Each entry should contain a full call chain path, with method names separated by >, e.g. properties > where, or builder > properties > query.

    Only calls with a block and no receiver are taken into account, e.g.:

      class UserQuery
    builder do
      scope :default do
        where { deleted_at.nil? } # UserQuery > builder > scope > where
      end

      organizations.each do |org|
        scope "org_#{org.name.camelcase}" do
          where { id == org.id } # UserQuery > builder > scope > where
        end
      end
    end
  end

    You can use * as a wildcard to match any method name and ** to match any method name at any depth, e.g. ** > where, or ** > where > *.

YAML configuration example:

Style/CallParentheses:
  Enabled: true
  ExcludeMultilineCalls: true
  ExcludeTypeDeclarations: true
  ExcludeHeredocs: true
  ExcludedToplevelCallNames: [spawn, raise, super, previous_def, exit, abort, sleep, print, printf, puts, p, p!, pp, pp!, record, class_getter, class_getter?, class_getter!, class_property, class_property?, class_property!, class_setter, getter, getter?, getter!, property, property?, property!, setter, def_equals_and_hash, def_equals, def_hash, delegate, forward_missing_to, describe, context, it, pending, pending!, fail, eq, be, be_a, be_close, contain, start_with, end_with, match, use_json_discriminator]
  ExcludedCallNames: [should, should_not]
  ExcludedDslCallNames: []

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

Class Method Detail

def self.deprecated? #

Returns true if this rule is deprecated, false otherwise.


def self.deprecation_reason : String | Nil #

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


def self.documentation_url : String #

Returns the documentation URL for this rule.

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

def self.parsed_doc : String | Nil #

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."

def self.to_json_schema(builder : JSON::Builder) : Nil #

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def exclude_heredocs=(exclude_heredocs : Bool) #

def exclude_heredocs? : Bool #

def exclude_multiline_calls=(exclude_multiline_calls : Bool) #

def exclude_multiline_calls? : Bool #

def exclude_type_declarations=(exclude_type_declarations : Bool) #

def exclude_type_declarations? : Bool #

def excluded : Set(String) | Nil #

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

def excluded_call_names : Array(String) #

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

def excluded_dsl_call_names : Array(String) #

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

def excluded_toplevel_call_names : Array(String) #

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

def severity : Ameba::Severity #

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

def since_version : SemanticVersion | Nil #

def since_version=(since_version : String) #

def test(source) #