Methods

Method rules are name-based. They are useful for Rails boundary checks and project style conventions.

Forbid Calls

services.cannot_call :render, :redirect_to, :params, :session

Rule id: methods.forbid

This catches method sends from files assigned to the component.

By default a call matches whatever the receiver is, so queries.cannot_call :update flags user.update and cache.update alike. Pass receiver: :none to match only bare calls, where the receiver is implicit self:

services.cannot_call :render, :params, receiver: :none

pdf.render and client.params then pass, while a bare render or params fails. The :rails architectures use receiver: :none for the controller API. A bare call to a method the component defines, inherits, or generates with attr_*, Rails attribute, alias_attribute, enum, store_accessor, delegate, or an Active Record association macro is treated as a call to its own API and is not flagged. The association macros cover the reader and writer, plus the build_, create_, and reload_ helpers on belongs_to and has_one.

Pass a constant name to match a semantic class receiver and its descendants:

models.cannot_call :find_by_sql, receiver: "ActiveRecord::Base"

User.find_by_sql is caught when User descends from ActiveRecord::Base; connection.find_by_sql is not. ArchSpec resolves static constant receivers and refuses to guess the type of local variables. Calls through method aliases are matched to their target when the receiver can be resolved, so forbidding destroy_all also catches a resolved alias such as Store.wipe.

Forbid Definitions

library.cannot_define :call

Rule id: methods.define_forbid

This catches classes in the component that define the named method.

Use it when the method name itself is a design smell in that component.