struct Ameba::Rule::Style::MethodNames

Overview

A rule that enforces method names to be in underscored case.

For example, these are considered valid:

class Person
  def first_name
  end

  def date_of_birth
  end

  def homepage_url
  end
end

And these are invalid method names:

class Person
  def firstName
  end

  def date_of_Birth
  end

  def homepageURL
  end
end

YAML configuration example:

Style/MethodNames:
  Enabled: true

Included Modules

YAML::Serializable
YAML::Serializable::Strict

Defined in:

Constant Summary

MSG = "Method name should be underscore-cased: %s, not %s"

Constructors

.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
.new(config = nil)
A rule that enforces method names to be in underscored case.

Instance Method Summary

#description : String
#description=(description : String)
#enabled : Bool
#enabled=(enabled)
#excluded : Array(String)?
#excluded=(excluded : Array(String)?)
#severity : Ameba::Severity
#severity=(severity)
#test(source, node : Crystal::Def)

Instance methods inherited from struct `Ameba::Rule::Base`

, , , , , , ,

Constructor methods inherited from struct `Ameba::Rule::Base`

Class methods inherited from struct `Ameba::Rule::Base`

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

A rule that enforces method names to be in underscored case.

For example, these are considered valid:

class Person
  def first_name
  end

  def date_of_birth
  end

  def homepage_url
  end
end

And these are invalid method names:

class Person
  def firstName
  end

  def date_of_Birth
  end

  def homepageURL
  end
end

YAML configuration example:

Style/MethodNames:
  Enabled: true

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled : Bool #

def enabled=(enabled) #

def excluded : Array(String)? #

def excluded=(excluded : Array(String)?) #

def severity : Ameba::Severity #

def severity=(severity) #

def test(source, node : Crystal::Def) #

ameba