ruby / Rails 布尔方法命名约定

Question

我有一个关于 ruby​​/rails 方法命名约定或良好实践的简短问题。 考虑以下方法：

# some methods performing some sort of 'action'
def action; end
def action!; end

# some methods checking if performing 'action' is permitted
def action?; end
def can_action?; end
def action_allowed?; end

所以我想知道，三种与方法中哪一种是请求权限的“最佳”方法。我会以某种方式选择第一个，但在某些情况下，我认为这可能会与 has_performed_action? 的含义相混淆。 因此，第二种方法可能会更清晰，但也更冗长一些。第三个实际上只是为了完整性。我不太喜欢那个。

那么有没有什么公认的良好实践呢？

Answer 1

我认为这取决于您想要执行的操作以及您正在检查的操作。我的目标是可读性和最少的混乱：

self.run
self.can_run? # can this object run?
self.running_allowed? # is running allowed here or by this user?

self.redeem!
self.redeemable? # is this object currently redeemable?

self.copy_to_clipboard
self.copy_to_dashboard
self.copyable? or self.can_be_copied? #can this object be copied
self.copy_allowed?(:clipboard) # is copying to the clipboard allowed by me?

Answer 2

我不会使用 action?，因为通常使用单字问号方法来指示值的存在（或不存在）。 Rails 允许您编写类似英语的代码，因此请选择一个使代码最具可读性的方法名称。

perform_action!("update") if action_allowed?("update")

对我来说似乎完全可读。

Answer 3

def can_action?; end

Answer 4

我会上升一级并重新考虑原始方法名称。如果这些方法执行一个动作，那么它们扮演的角色是动词，而不是名词：

# some methods performing some sort of 'action'
def act
def act!

这对您的问题有一个听起来更自然的答案的便利副作用：

# method checking if 'action' is permitted
def can_act?

...以及其他一些明显的变体：

# methods checking if 'action' was performed
def acted?
def did_act?

# method checking if 'action' is called for by other circumstances
def should_act?

# method putting 'action' into a work queue
def act_later(delay_seconds=0)

等等。