我总是在我的 Rails models 顶部看到大行代码。我正在寻找用标准 Ruby 风格分解它们的最佳方法的建议。例如，我现在看到的一行是这样的:

delegate :occupation, :location, :picture_url, :homepage_url, :headline, :full_name, :to => :profile, :prefix => true, :allow_nil => true

打破这些长方法调用行的传统风格是什么？

最佳答案

简短的回答是视情况。

基础知识

首先，您可以使用“新的”Ruby 哈希语法保存几个字符:

result = very_long_method_name(something: 1, user: user, flange_factor: 1.34)

对比

result = very_long_method_name(:something => 1, :user => user, :flange_factor => 1.34)

哈希/数组

有时你需要初始化一个数组或散列，特别是对于散列，这样写它们很好:

args = {
  first_name: "Aldo",
  email: "nospam@mail.example.com",
  age: Float::INFINITY
}

同一行上的相同散列将是(不太好):

args = {first_name: "Aldo", email: "nospam@mail.example.com", age: Float::INFINITY}

各种方法调用

有些方法需要很多参数或者这些参数的名字很长:

%table
  %thead
    %th
      %td= t("first_name", scope: "activemodel.lazy_model.not_so_active_model", some_interpolation_argument: "Mr.", suffix: "(Jr.)")

在这种情况下我可能会这样写:

%table
  %thead
    %th
      %td= t("first_name",
             scope: "activemodel.lazy_model.not_so_active_model",
             some_interpolation_argument: "Mr.",
             suffix: "(Jr.)")

它仍然不是很漂亮，但我想不那么丑了。

class person < ActiveRecord::Base
  validates :n_cars, numericality: {
                       only_integer: true,
                       greater_than: 2,
                       odd: true,
                       message: t("greater_than_2_and_odd",
                                  scope: "activerecord.errors.messages")
                     }
end

同样，这不是地球上最漂亮的代码，但它具有某种结构。

此外，有时您可以使用变量来拆分行。这只是一个例子，但基本上你命名了一些东西(有时在这之后你意识到你实际上可以在一个方法中移动那个 block )

class person < ActiveRecord::Base
  NUMERICALITY_OPTS = {
    only_integer: true,
    greater_than: 2,
    odd: true,
    message: t("greater_than_2_and_odd", scope: "activerecord.errors.messages")
  }
  validates :n_cars, numericality: NUMERICALITY_OPTS
end

积木

说到 block (闭包):

User.all.map { |user| user.method_name }

可以这样写:

User.all.map(&:method_name)

如果您有合适的 block ，请尝试使用 do-end 而不是花括号:

nicotine_level = User.all.map do |user|
  user.smoker? ? (user.age * 12.34) : 0.1234
end

有条件的

不要对复杂的事情使用三元 if 运算符:

nicotine_level = user.smoker? ? (user.age * 1.234 + user.other_method) : ((user.age - 123 + user.flange_factor) * 0)

if user.smoker?
  nicotine_level = user.age * 1.234 + user.other_method
else
  nicotine_level = (user.age - 123 + user.flange_factor) * 0
end

如果你有像这样的复杂 if 语句:

if user.vegetarian? && !user.smoker? && (user.age < 25) && (user.n_girlfriends == 0) && (user.first_name =~ /(A|Z)[0-1]+/)
end

在方法中移动事物并使事物不仅更短而且更易读可能会更好:

if user.healthy? && user.has_a_weird_name?
  # Do something
end

# in User
def healthy?
  vegetarian? && !smoker? && (age < 25) && (n_girlfriends == 0)
end

def user.has_a_weird_name?
  user.first_name =~ /(A|Z)[0-1]+/
end

长字符串

Heredoc 是你的 friend ......我总是需要谷歌来获得正确的语法，但是一旦你获得正确的语法，就会让某些东西更容易阅读:

execute <<-SQL
  UPDATE people
  SET smoker = 0
  OK, this is a very bad example.
SQL

查询

对于简单的情况，我倾向于这样做:

# Totally random example, it's just to give you an idea
def cars_older_than_n_days(days)
  Car.select("cars.*, DATEDIFF(NOW(), release_date) AS age")
     .joins(:brand)
     .where(brand: {country: "German"})
     .having("age > ?", days)
end

有时查询甚至更糟糕。如果我使用 squeel并且查询非常大，我倾向于使用这样的括号:

# Again, non-sense query
Person.where {
  first_name = "Aldo" |
  last_name = "McFlange" |
  (
    age = "18" &
    first_name = "Mike" &
    email =~ "%@hotmail.co.uk"
  ) |
  (
    person.n_girlfriends > 1 &
    (
      country = "Italy" |
      salary > 1_234_567 |
      very_beautiful = true |
      (
        whatever > 123 &
        you_get_the_idea = true 
      )
    )
  )
}

我想说的是，如果可能的话尽量避免复杂的查询并将它们拆分到更小的范围或其他范围内:

scope :healthy_users, lambda {
  younger_than(25).
  without_car.
  non_smoking.
  no_girlfriend
}

scope :younger_than, lambda { |age|
  where("users.age < ?", age)
}

scope :without_car, lambda {
  where(car_id: nil)
}

scope :non_smoking, lambda {
  where(smoker: false)
}

scope :no_girlfriend, lambda {
  where(n_girlfriends: 0)
}

这可能是最好的方法。

现实

不幸的是，人们倾向于写长行，这很糟糕:

• 长行难以阅读(打印书籍没有超大页是有原因的)
• 的确，我们主要使用 2 个屏幕，但是当从控制台使用诸如 git diff 之类的东西时，排长队会很痛苦
• 有时您在屏幕面积较小的 13 英寸笔记本电脑上工作
• 即使我喜欢使用 2 个屏幕工作，我也喜欢拆分我的编辑器以同时编辑 2 个文件 - 长行迫使我使用水平滚动条(地球上最讨厌的东西)
• 是的，您可以在编辑器中启用自动换行，但它仍然不是很好(恕我直言)

我的编辑器中有一个标尺，这样我就可以知道何时要越过该行的第 80 个字符。 但很少越线几个字符，它实际上比拆分它更好。

结论

将线保持在 80 年代以下的方法有多种，通常视情况而定。 长行的问题不仅仅是糟糕的风格，长行通常是过于复杂的症状。

关于ruby-on-rails - 如何分解长行的 Ruby，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/12083011/