class Ameba::Rule::Typing::MacroCallArgumentTypeRestriction

Overview

A rule that enforces call arguments to specific macros have a type restriction. By default these macros are: (class_)getter/setter/property(?/!) and record.

For example, these are considered invalid:

class Greeter
  getter name
  getter age = 0.days
  getter :height
end

record Task,
  cmd = "",
  args = %w[]

And these are considered valid:

class Greeter
  getter name : String?
  getter age : Time::Span = 0.days
  getter height : Float64?
end

record Task,
  cmd : String = "",
  args : Array(String) = %w[]

The DefaultValue configuration option controls whether this rule applies to call arguments that have a default value.

YAML configuration example:

Typing/MacroCallArgumentTypeRestriction:
  Enabled: true
  DefaultValue: false
  MacroNames:
   - getter
   - getter?
   - getter!
   - class_getter
   - class_getter?
   - class_getter!
   - setter
   - setter?
   - setter!
   - class_setter
   - class_setter?
   - class_setter!
   - property
   - property?
   - property!
   - class_property
   - class_property?
   - class_property!
   - record

Included Modules

Defined in:

ameba/rule/typing/macro_call_argument_type_restriction.cr

Constant Summary

MSG = "Argument should have a type restriction"

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) 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

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

A rule that enforces call arguments to specific macros have a type restriction. By default these macros are: (class_)getter/setter/property(?/!) and record.

For example, these are considered invalid:

class Greeter
  getter name
  getter age = 0.days
  getter :height
end

record Task,
  cmd = "",
  args = %w[]

And these are considered valid:

class Greeter
  getter name : String?
  getter age : Time::Span = 0.days
  getter height : Float64?
end

record Task,
  cmd : String = "",
  args : Array(String) = %w[]

The DefaultValue configuration option controls whether this rule applies to call arguments that have a default value.

YAML configuration example:

Typing/MacroCallArgumentTypeRestriction:
  Enabled: true
  DefaultValue: false
  MacroNames:
   - getter
   - getter?
   - getter!
   - class_getter
   - class_getter?
   - class_getter!
   - setter
   - setter?
   - setter!
   - class_setter
   - class_setter?
   - class_setter!
   - property
   - property?
   - property!
   - class_property
   - class_property?
   - class_property!
   - record

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

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

def default_value=(default_value : Bool) #

def default_value? : Bool #

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def macro_names : Array(String) #

def macro_names=(macro_names : Array(String)) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

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

[View source]