Ameba::Rule::Lint::DuplicateMethodSignature - ameba 1.7.0

# class Ameba::Rule::Lint::DuplicateMethodSignature

- Ameba::Rule::Lint::DuplicateMethodSignature
- Ameba::Rule::Base
- Reference
- Object

##
Overview

Reports repeated class or module method signatures.

Only methods of the same signature are considered duplicates, regardless of their bodies, except for ones including `previous_def`.

    class Foo
      def greet(name)
        puts "Hello #{name}!"
      end

      def greet(name) # duplicated method signature
        puts "¡Hola! #{name}"
      end
    end

YAML configuration example:

    Lint/DuplicateMethodSignature:
      Enabled: true

##
Included Modules

- YAML::Serializable

##
Defined in:

ameba/rule/lint/duplicate_method_signature.cr

##
Constant Summary

MSG = `"Duplicate method signature detected"`

##
Constructors

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

  Reports repeated class or module method signatures.

- .new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

##
Class Method Summary

- .deprecated?

  Returns `true` if this rule is deprecated, `false` otherwise.

- .deprecation_reason : String | Nil

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

- .documentation_url : String

  Returns the documentation URL for this rule.

- .parsed_doc : String | Nil

  Returns the documentation for this rule, if there is any.

- .to_json_schema(builder : JSON::Builder) : Nil

##
Instance Method Summary

- #description : String
- #description=(description : String)
- #enabled=(enabled : Bool)
- #enabled? : Bool
- #excluded : Set(String) | Nil
- #excluded=(excluded : Set(String) | Nil)
- #severity : Ameba::Severity
- #severity=(severity : Ameba::Severity)
- #since_version : SemanticVersion | Nil
- #since_version=(since_version : String)
- #test(source, node : Crystal::ClassDef | Crystal::ModuleDef, scope : AST::Scope)
- #test(source)

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

Reports repeated class or module method signatures.

Only methods of the same signature are considered duplicates, regardless of their bodies, except for ones including `previous_def`.

    class Foo
      def greet(name)
        puts "Hello #{name}!"
      end

      def greet(name) # duplicated method signature
        puts "¡Hola! #{name}"
      end
    end

YAML configuration example:

    Lint/DuplicateMethodSignature:
      Enabled: true

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 excluded : Set(String) | Nil #
def excluded=(excluded : Set(String) | Nil) #
def severity : Ameba::Severity #
def severity=(severity : Ameba::Severity) #
def since_version : SemanticVersion | Nil #
def since_version=(since_version : String) #
def test(source, node : Crystal::ClassDef | Crystal::ModuleDef, scope : AST::Scope) #
def test(source) #