class Ameba::Rule::Lint::SelfInitializeDefinition

• Ameba::Rule::Lint::SelfInitializeDefinition
• Ameba::Rule::Base
• Reference
• Object

Overview

A rule that reports usage of initialize method definition with a self receiver. Such definitions are almost always a typo.

For example, this is considered invalid:

class Foo
  def self.initialize
  end
end

And should be written as:

class Foo
  def initialize
  end
end

YAML configuration example:

Lint/SelfInitializeDefinition:
  Enabled: true

Included Modules

• YAML::Serializable
• YAML::Serializable::Strict

Defined in:

Constant Summary

MSG = "`initialize` method definition should not have a receiver"

Constructors

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

  A rule that reports usage of initialize method definition with a self receiver.

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)
• #severity : Ameba::Severity
• #severity=(severity : Ameba::Severity)
• #since_version : SemanticVersion | Nil
• #since_version=(since_version : String)
• #test(source, node : Crystal::Def)
• #test(source : Source)

  This method is designed to test the source passed in.

Constructor Detail

class Foo
  def self.initialize
  end
end

class Foo
  def initialize
  end
end

Lint/SelfInitializeDefinition:
  Enabled: true

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