在 ruby​​ 中重构长字符串的最佳方法是什么？

Question

我有这样一行代码

"#{envelope_quantity} - envelope #{Budget::util_name(envelope_size)} #{Budget::util_name(envelope_paper)} #{Budget::util_name(envelope_color)} #{Budget::util_name(envelope_grammage)} #{Budget::util_name(envelope_model)} #{Budget::util_name(envelope_print)}"

太长了，读起来很糟糕，这就是 RuboCop 用 Metrics::LineLength 警告我的原因。

我想将它重构为不长线。

我知道很多方法可以做到这一点，但我想知道哪一种是红宝石风格专家所期望的。

当我需要一个空字符串（如果它是 nil）时，需要那个静态方法 util_name 来防止 nil。

def self.util_name(value)
  return '' if value.nil?
  value.name
end

Answer 1

你可以试试这个

str = "#{envelope_quantity} - envelope #{Budget::util_name(envelope_size)} "\
      "#{Budget::util_name(envelope_paper)} #{Budget::util_name(envelope_color)} "\
      "#{Budget::util_name(envelope_grammage)} #{Budget::util_name(envelope_model)} "\
      "#{Budget::util_name(envelope_print)}"

通过这种方式，您可以将字符串限制在最大行长度内，并且比使用join 更具可读性

Answer 2

您可能会尝试的一件事是不使用字符串插值，而是使用连接和join 构造字符串：

"#{envelope_quantity} - envelope " + 
[Budget::util_name(envelope_size), 
 Budget::util_name(envelope_paper),
 Budget::util_name(envelope_color),
 Budget::util_name(envelope_grammage),
 Budget::util_name(envelope_model),
 Budget::util_name(envelope_print)].join(' ')

更简洁，你可以使用map：

"#{envelope_quantity} - envelope " + 
[envelope_size, 
 envelope_paper,
 envelope_color,
 envelope_grammage,
 envelope_model,
 envelope_print].map{|x| Budget::util_name(x)}.join(' ')

通过以正确的顺序定义一个包含所有信封属性的数组并将map 应用于该数组，这可能会更简洁：

envelope_properties=[envelope_size, 
                     envelope_paper,
                     envelope_color,
                     envelope_grammage,
                     envelope_model,
                     envelope_print]

"#{envelope_quantity} - envelope " + 
envelope_properties.map{|x| Budget::util_name(x)}.join(' ')

当然，如果您碰巧有 envelope_properties 数组的其他用途，那会有所帮助。

Answer 3

当我需要一个空字符串（如果它为 nil）时，需要该静态方法 util_name 来防止出现 nil。

def self.util_name(value)
  return '' if value.nil?
  value.name
end

---

好的，考虑到这一点，您可以完全删除 Budget::util_name 方法，因为它没有做任何有用的事情。有两种方法可以有条件地调用可能是 nil 的对象上的方法，一种由框架提供，一种由语言提供。

如果您使用的是 Ruby 2.2 或更早版本，请使用 try method。

value.try(:name)

如果您使用的是 Ruby 2.3 或更高版本，您可以使用safe navigation operator

value&.name

在任何一种情况下，您都不需要专门测试nil，因为它会在插值时自动强制转换为空字符串。

"#{envelope_quantity&.name} - envelope #{envelope_size&.name} #{envelope_paper&.name} #{envelope_color&.name} #{envelope_grammage&.name} #{envelope_model&.name} #{envelope_print&.name}"

这更合理，但可能还是有点太长了。您可以使用字符串模板：

"%{quantity} - envelope %{size} %{paper} %{color} %{grammage} %{model} %{print}" % {
  quantity: envelope_quantity&.name,
  size:     envelope_size&.name,
  paper:    envelope_paper&.name,
  color:    envelope_color&.name,
  grammage: envelope_grammage&.name,
  model:    envelope_model&.name,
  print:    envelope_print&.name
}

但我想重点介绍一下我注意到的有关此代码示例的一些内容。每个方法都以envelope 开头，这可能意味着these methods are telling you they should be a separate object。如果将这些数据提取到value object 中，那么这个辅助方法的自然位置就变得显而易见了……

class Envelope < Struct.new(:quantity, :size, :paper, :color, :grammage, :model, :print)
  def to_s
    "#{quantity&.name} - envelope #{size&.name} #{paper&.name} #{color&.name} #{grammage&.name} #{model&.name} #{print&.name}"
  end
end

毫无疑问，真正的代码会比这更复杂，只是值得深思。