class

Ameba::Rule::Style::VerboseBlock

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

This rule is used to identify usage of single expression blocks with argument as a receiver, that can be collapsed into a short form.

For example, this is considered invalid:

(1..3).any? { |i| i.odd? }

And it should be written as this:

(1..3).any?(&.odd?)

YAML configuration example:

Style/VerboseBlock:
  Enabled: true
  ExcludeMultipleLineBlocks: true
  ExcludeCallsWithBlock: true
  ExcludePrefixOperators: true
  ExcludeOperators: true
  ExcludeSetters: false
  MaxLineLength: ~
  MaxLength: 50 # use ~ to disable

Constants

CALL_PATTERN = "%s(%s&.%s)"

MSG = "Use short block notation instead: `%s`"

Constructors

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

new(config = nil)

This rule is used to identify usage of single expression blocks with argument as a receiver, that can be collapsed into a short form.

For example, this is considered invalid:

(1..3).any? { |i| i.odd? }

And it should be written as this:

(1..3).any?(&.odd?)

YAML configuration example:

Style/VerboseBlock:
  Enabled: true
  ExcludeMultipleLineBlocks: true
  ExcludeCallsWithBlock: true
  ExcludePrefixOperators: true
  ExcludeOperators: true
  ExcludeSetters: false
  MaxLineLength: ~
  MaxLength: 50 # use ~ to disable

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

Instance methods

description

description=(description : String)

enabled=(enabled : Bool)

enabled?

exclude_calls_with_block=(exclude_calls_with_block : Bool)

exclude_calls_with_block?

exclude_multiple_line_blocks=(exclude_multiple_line_blocks : Bool)

exclude_multiple_line_blocks?

exclude_operators=(exclude_operators : Bool)

exclude_operators?

exclude_prefix_operators=(exclude_prefix_operators : Bool)

exclude_prefix_operators?

exclude_setters=(exclude_setters : Bool)

exclude_setters?

excluded

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

max_length

max_length=(max_length : Union(Int32, Nil))

max_line_length

max_line_length=(max_line_length : Union(Int32, Nil))

severity

severity=(severity : Ameba::Severity)

since_version

Source

since_version=(since_version : String)

test(source, node : Crystal::Call)

Source