class Ameba::Rule::Style::IsAFilter

• Ameba::Rule::Style::IsAFilter
• Ameba::Rule::Base
• Reference
• Object

Overview

This rule is used to identify usage of is_a?/nil? calls within filters.

For example, this is considered invalid:

matches = %w[Alice Bob].map(&.match(/^A./))

matches.any?(&.is_a?(Regex::MatchData)) # => true
matches.one?(&.nil?)                    # => true

typeof(matches.reject(&.nil?))                    # => Array(Regex::MatchData | Nil)
typeof(matches.select(&.is_a?(Regex::MatchData))) # => Array(Regex::MatchData | Nil)

And it should be written as this:

matches = %w[Alice Bob].map(&.match(/^A./))

matches.any?(Regex::MatchData) # => true
matches.one?(Nil)              # => true

typeof(matches.reject(Nil))              # => Array(Regex::MatchData)
typeof(matches.select(Regex::MatchData)) # => Array(Regex::MatchData)

YAML configuration example:

Style/IsAFilter:
  Enabled: true
  FilterNames:
    - select
    - reject
    - any?
    - all?
    - none?
    - one?

Included Modules

• Ameba::AST::Util
• YAML::Serializable
• YAML::Serializable::Strict

Defined in:

Constant Summary

MSG = "Use `%s` instead of `%s`"

NEW = "%s(%s)"

OLD = "%s {...}"

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(config = nil)

  This rule is used to identify usage of is_a?/nil? calls within filters.

Class Method Summary

• .parsed_doc : String | Nil

  Returns documentation for this rule, if there is any.

Instance Method Summary

• #description : String
• #description=(description : String)
• #enabled=(enabled : Bool)
• #enabled? : Bool
• #excluded : Array(String) | Nil
• #excluded=(excluded : Array(String) | Nil)
• #filter_names : Array(String)
• #filter_names=(filter_names : Array(String))
• #severity : Ameba::Severity
• #severity=(severity : Ameba::Severity)
• #since_version : SemanticVersion | Nil
• #since_version=(since_version : String)
• #test(source, node : Crystal::Call)
• #test(source)

Constructor Detail

matches = %w[Alice Bob].map(&.match(/^A./))

matches.any?(&.is_a?(Regex::MatchData)) # => true
matches.one?(&.nil?)                    # => true

typeof(matches.reject(&.nil?))                    # => Array(Regex::MatchData | Nil)
typeof(matches.select(&.is_a?(Regex::MatchData))) # => Array(Regex::MatchData | Nil)

matches = %w[Alice Bob].map(&.match(/^A./))

matches.any?(Regex::MatchData) # => true
matches.one?(Nil)              # => true

typeof(matches.reject(Nil))              # => Array(Regex::MatchData)
typeof(matches.select(Regex::MatchData)) # => Array(Regex::MatchData)

Style/IsAFilter:
  Enabled: true
  FilterNames:
    - select
    - reject
    - any?
    - all?
    - none?
    - one?

Class Method Detail

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