问题描述
我有一个连接到Codeclimate的应用程序,它显示了一个错误Method upstream_transactions has a Cognitive Complexity of 6 (exceeds 5 allowed)
,并带有下面的代码:
def upstream_transactions(bank_account:,external_account:,external_transactions:)
external_transactions.each do |transaction|
next if transaction.currency != 'USD'
transfer = BankTransfer.unscoped.find_or_create_by(
我添加了行next if transaction.currency != 'USD'
后出现了此错误。
def upstream_transactions(bank_account:,external_transactions:)
external_transactions.each do |transaction|
next if transaction.currency != 'USD'
transfer = BankTransfer.unscoped.find_or_create_by(
customer_id: customer.id,transaction_identifier: transaction.transaction_id
)
next if transfer.deleted_at?
transfer.update(
date: transaction.booked_at,# (...) some other params
)
end
Success(bank_account: bank_account,external_account: external_account)
end
如何避免此类错误?
解决方法
您可以通过创建一些可以调用的辅助方法来降低复杂性。也许
def obtain_transfer(transaction)
BankTransfer.unscoped.find_or_create_by(
customer_id: customer.id,transaction_identifier: transaction.transaction_id)
end
其中的“ nots”较少
next unless transaction.currency == 'USD'
尽管你甚至可以
external_transactions.select { |t| t.currency == 'USD' }.each do |transaction|
该方法应改为upstream_USD_transactions
吗?准来电者以某种方式知道它将丢弃所有非美元转账是否合理?
这不是错误,cognitive complexity是:
衡量一个代码单元直观理解的难易程度
因此,当您添加额外的流控制语句next if transaction.currency != 'USD'
时,这增加了代码测试的复杂性。添加诸如if
,unless
,&&
之类的语句以及任何添加附加逻辑流控制的内容(例如switch语句)都会增加复杂性。
您可以采用两种方法来尽量减少这种复杂性:
- 修改您添加的语句
- 修改现有方法
如果在已经很复杂的方法中添加了一条小语句,则尝试看看该现有方法中可以简化的内容。就像@nullTerminator在他们的答案中建议的那样,将逻辑划分为不同的辅助方法可以降低复杂性。较小的方法将更易于测试,并且每个方法都应具有较小的认知复杂性。