CriticalFile-scopeRuby Plug & play

Avoid Empty Methods

Detect methods that have an empty body. If a method is empty, ensure that a comment is present explaining why it remains unimplemented.

Add to Mesrai Open workspace

Why this matters

Empty methods can be misleading, making it unclear whether they are unfinished, redundant, or intentionally blank. If an empty method is necessary, include a comment explaining why.

Bad vs. good

Side-by-side examples engineers can pattern-match during review.

Avoid

def shouldNotBeEmpty()  # Noncompliant - method is empty
end

def notImplemented()  # Noncompliant - method is empty
end

def emptyOnPurpose()  # Noncompliant - method is empty
end

Prefer

def shouldNotBeEmpty()
  doSomething()
end

def notImplemented()
  raise NotImplementedError, 'notImplemented() cannot be performed because ...'
end

def emptyOnPurpose()
  # comment explaining why the method is empty
end

More snippets

Bad

def shouldNotBeEmpty()  # Noncompliant - method is empty
end

def notImplemented()  # Noncompliant - method is empty
end

def emptyOnPurpose()  # Noncompliant - method is empty
end

Good

def shouldNotBeEmpty()
  doSomething()
end

def notImplemented()
  raise NotImplementedError, 'notImplemented() cannot be performed because ...'
end

def emptyOnPurpose()
  # comment explaining why the method is empty
end

Related rules

From the same buckets as this rule.

Critical
Avoid Duplicating String Literals
Store repeated string literals in constants or variables to improve maintainability and reduce redundancy.
duplication-complexitymaintainability
Critical
Avoid modifying built-in prototypes
Detect modifications to built-in prototypes. Modifying built-in objects can lead to compatibility issues and unexpected behavior. Recommend creating helper functions instead.
maintainabilitysecurity-hardening
Critical
Encrypt ePHI at rest with KMS-managed AES-256 and envelope keys
Before persisting ePHI, encrypt using a data key protected by a Key Management Service (KMS). Use authenticated encryption (AES-256-GCM or equivalent), rotate keys, and store the key id and algorithm with the record.
compliance-hipaasecurity-hardening+2

Bad vs. good

Side-by-side examples engineers can pattern-match during review.

Avoid

def shouldNotBeEmpty()  # Noncompliant - method is empty
end

def notImplemented()  # Noncompliant - method is empty
end

def emptyOnPurpose()  # Noncompliant - method is empty
end

Prefer

def shouldNotBeEmpty()
  doSomething()
end

def notImplemented()
  raise NotImplementedError, 'notImplemented() cannot be performed because ...'
end

def emptyOnPurpose()
  # comment explaining why the method is empty
end

More snippets

Bad

def shouldNotBeEmpty()  # Noncompliant - method is empty
end

def notImplemented()  # Noncompliant - method is empty
end

def emptyOnPurpose()  # Noncompliant - method is empty
end

Good

def shouldNotBeEmpty()
  doSomething()
end

def notImplemented()
  raise NotImplementedError, 'notImplemented() cannot be performed because ...'
end

def emptyOnPurpose()
  # comment explaining why the method is empty
end

Related rules

From the same buckets as this rule.

Critical

Avoid Duplicating String Literals

Store repeated string literals in constants or variables to improve maintainability and reduce redundancy.

duplication-complexitymaintainability

Critical

Avoid modifying built-in prototypes

Detect modifications to built-in prototypes. Modifying built-in objects can lead to compatibility issues and unexpected behavior. Recommend creating helper functions instead.

maintainabilitysecurity-hardening

Critical

Encrypt ePHI at rest with KMS-managed AES-256 and envelope keys

Before persisting ePHI, encrypt using a data key protected by a Key Management Service (KMS). Use authenticated encryption (AES-256-GCM or equivalent), rotate keys, and store the key id and algorithm with the record.

compliance-hipaasecurity-hardening+2