class Ameba::Rule::Style::RedundantSelf

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

Overview

A rule that disallows redundant uses of self.

This is considered bad:

class Greeter
  getter name : String

  def self.init
    self.new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{self.name}"
  end

  self.init
end

And needs to be written as:

class Greeter
  getter name : String

  def self.init
    new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{name}"
  end

  init
end

YAML configuration example:

Style/RedundantSelf:
  Enabled: true
  AllowedMethodNames:
    - in?
    - inspect
    - not_nil!

Included Modules

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

Defined in:

Constant Summary

CRYSTAL_KEYWORDS = Crystal::Keyword.values.map(&.to_s)

MSG = "Redundant `self` detected"

Constructors

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

  A rule that disallows redundant uses of self.

Class Method Summary

• .parsed_doc : String | Nil

  Returns documentation for this rule, if there is any.

Instance Method Summary

• #allowed_method_names : Array(String)
• #allowed_method_names=(allowed_method_names : Array(String))
• #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::Call, scope : AST::Scope)
• #test(source)

Constructor Detail

class Greeter
  getter name : String

  def self.init
    self.new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{self.name}"
  end

  self.init
end

class Greeter
  getter name : String

  def self.init
    new("Crystal").greet
  end

  def initialize(@name)
  end

  def greet
    puts "Hello, my name is #{name}"
  end

  init
end

Style/RedundantSelf:
  Enabled: true
  AllowedMethodNames:
    - in?
    - inspect
    - not_nil!

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