Ruby：我可以编写没有连接的多行字符串吗？

Question

有没有办法让这个看起来好一点？

conn.exec 'select attr1, attr2, attr3, attr4, attr5, attr6, attr7 ' +
          'from table1, table2, table3, etc, etc, etc, etc, etc, ' +
          'where etc etc etc etc etc etc etc etc etc etc etc etc etc'

比如，有没有办法暗示串联？

Answer 1

这个答案的一些部分帮助我得到了我需要的东西（简单的多行串联，没有额外的空格），但由于没有一个实际的答案有它，我在这里编译它们：

str = 'this is a multi-line string'\
  ' using implicit concatenation'\
  ' to prevent spare \n\'s'

=> "this is a multi-line string using implicit concatenation to eliminate spare
\\n's"

作为奖励，这里有一个使用有趣的版本HEREDOC 语法（通过 此链接）：

p <<END_SQL.gsub(/\s+/, " ").strip
SELECT * FROM     users
         ORDER BY users.id DESC
END_SQL
# >> "SELECT * FROM users ORDER BY users.id DESC"

后者主要适用于情况这需要处理过程具有更大的灵活性。我个人不喜欢它，它把处理放在字符串的一个奇怪的地方（即在它前面，但使用通常在后面的实例方法），但它就在那里。请注意，如果您要缩进最后一个 END_SQL 标识符（这很常见，因为这可能位于函数或模块内部），则需要使用连字符语法（即 p < ;<-END_SQL 而不是 p <）。否则，缩进空格会导致标识符被解释为字符串的延续。

这并不能节省太多打字时间，但对我来说，它看起来比使用 + 符号更好。

另外（我在几年后的编辑中说过），如果您使用 Ruby 2.3+，则运算符 <<~ 也可用，它可以从最终字符串中删除额外的缩进。在这种情况下，您应该能够删除 .gsub 调用（尽管它可能取决于起始缩进和您的最终需求）。

编辑：再添加一个：

p %{
SELECT * FROM     users
         ORDER BY users.id DESC
}.gsub(/\s+/, " ").strip
# >> "SELECT * FROM users ORDER BY users.id DESC"

Answer 2

在 ruby​​ 2.0 中，您现在可以只使用 %

例如：

    SQL = %{
      SELECT user, name
      FROM users
      WHERE users.id = #{var}
      LIMIT #{var2}
    }

Answer 3

是的，如果您不介意插入额外的换行符：

 conn.exec 'select attr1, attr2, attr3, attr4, attr5, attr6, attr7
            from table1, table2, table3, etc, etc, etc, etc, etc,
            where etc etc etc etc etc etc etc etc etc etc etc etc etc'

或者您可以使用 heredoc：

conn.exec <<-eos
   select attr1, attr2, attr3, attr4, attr5, attr6, attr7
   from table1, table2, table3, etc, etc, etc, etc, etc,
   where etc etc etc etc etc etc etc etc etc etc etc etc etc
eos

Answer 4

这个问题让我深入了解 HEREDOC 的工作原理。如果答案太长，请原谅。

squiggly HEREDOC <<~ 是您想要定义多行字符串时要查找的内容带有换行符和适当的缩进（自 Ruby 2.3 起可用）：

conn.exec <<~EOS
            select attr1, attr2, attr3, attr4, attr5, attr6, attr7
            from table1, table2, table3, etc, etc, etc, etc, etc
            where etc etc etc etc etc etc etc etc etc etc etc etc etc
          EOS

# -> "select...\nfrom...\nwhere..."

如果不关心适当的缩进，那么单引号和双引号可以在 Ruby 中跨越多行：

conn.exec "select attr1, attr2, attr3, attr4, attr5, attr6, attr7 
           from table1, table2, table3, etc, etc, etc, etc, etc, 
           where etc etc etc etc etc etc etc etc etc etc etc etc etc"    

# -> "select...\n           from...\n           where..."
      

如果单引号或双引号很麻烦因为这需要大量转义，那么 百分比字符串文字表示法 % 是最灵活的解决方案：

conn.exec %(select attr1, attr2, attr3, attr4, attr5, attr6, attr7
            from table1, table2, table3, etc, etc, etc, etc, etc
            where (ProductLine = 'R' OR ProductLine = "S") AND Country = "...")
# -> "select...\n            from...\n            where..."

如果目标是避免换行符（即波浪形的 HEREDOC，引号和百分比字符串文字会导致），然后可以通过将反斜杠 \ 作为行中的最后一个非空白字符来使用行继续。这将继续该行，并导致 Ruby 将字符串背靠背连接（注意带引号的字符串内的空格）：

conn.exec 'select attr1, attr2, attr3, attr4, attr5, attr6, attr7 ' \
          'from table1, table2, table3, etc, etc, etc, etc, etc, ' \
          'where etc etc etc etc etc etc etc etc etc etc etc etc etc'

# -> "select...from...where..."

如果您使用 Rails，则 String.squish 将剥离字符串前导空格和尾随空格，并将所有连续空格（换行符、制表符等）折叠成一个空格：

conn.exec "select attr1, attr2, attr3, attr4, attr5, attr6, attr7 
           from table1, table2, table3, etc, etc, etc, etc, etc, 
           where etc etc etc etc etc etc etc etc etc etc etc etc etc".squish

# -> "select...attr7 from...etc, where..."

更多详细信息：

Ruby HEREDOC 语法

字符串的此处文档表示法 是一种指定长文本块的方法内联在代码中。它以 << 开头，后跟用户定义的字符串（字符串结尾终止符）。以下所有行都将连接起来，直到在行的最开头找到字符串结尾终止符：

puts <<HEREDOC 
Text Text Text Text
Bla Bla
HEREDOC
# -> "Text Text Text Text\nBlaBla"

字符串结尾终止符可以自由选择，但通常使用类似“EOS”（字符串结尾）或与字符串域匹配的内容，例如“SQL”。

HEREDOC 默认支持 插值 或当 EOS 终止符是双引号时：

price = 10
print <<"EOS"  # comments can be put here
1.) The price is #{price}.
EOS
# -> "1.) The price is 10."

如果 EOS 终止符是单引号，则可以禁用插值：

print <<'EOS' # Disabled interpolation
3.) The price is #{price}.
EOS
# -> "3.) The price is #{price}."

< 的一个重要限制是字符串结束符必须位于开头行的要点：

  puts <<EOS 
    def foo
      print "foo"
    end
  EOS
EOS
#-> "....def foo\n......print "foo"\n....end\n..EOS"

为了解决这个问题，创建了 <<- 语法。它允许 EOS 终止符缩进以使代码看起来更好。 <<- 和 EOS 终止符之间的线条仍然完整地使用，包括所有缩进：

def printExample
  puts <<-EOS # Use <<- to indent End of String terminator
    def foo
      print "foo"
    end
  EOS
end
# -> "....def foo\n......print "foo"\n....end"

从 Ruby 2.3 开始，我们现在有了波浪形的 HEREDOC <<~ 删除前导空格：

puts <<~EOS # Use the squiggly HEREDOC <<~ to remove leading whitespace (since Ruby 2.3!)
  def foo
    print "foo"
  end
EOS
# -> "def foo\n..print "foo"\nend"

<<~ 会忽略空行以及仅包含制表符和空格的行。

puts <<~EOS.inspect 
  Hello

    World!
EOS
#-> "Hello\n..World!"

如果同时使用制表符和空格，则制表符被视为等于 8 个空格。
如果缩进最少的行位于选项卡的中间，则不会删除该选项卡。

puts <<~EOS.inspect
<tab>One Tab
<space><space>Two Spaces
EOS
# -> "\tOne Tab\nTwoSpaces"

HEREDOC 可以做一些疯狂的事情，例如使用反引号执行命令：

puts <<`EOC`            
echo #{price}
echo #{price * 2}
EOC

HEREDOC 字符串定义可以“堆叠”，这意味着第一个 EOS 终止符（下面的 EOSFOO）将结束第一个字符串并开始第二个字符串（下面的 EOSBAR）：

print <<EOSFOO, <<EOSBAR    # you can stack them
I said foo.
EOSFOO
I said bar.
EOSBAR

我不'我认为没有人会这样使用它，但是 < 实际上只是一个字符串文字，可以放在通常可以放置字符串的任何位置：

def func(a,b,c)
  puts a
  puts b
  puts c
end

func(<<THIS, 23, <<THAT) 
Here's a line
or two.
THIS
and here's another.
THAT

如果您没有 Ruby 2.3 ，但 Rails >= 3.0 则可以使用 String.strip_heredoc ，其作用与 <<~

# File activesupport/lib/active_support/core_ext/string/strip.rb, line 22
class String
  def strip_heredoc
    gsub(/^#{scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
  end
end

puts <<-USAGE.strip_heredoc # If no Ruby 2.3, but Rails >= 3.0
  This command does such and such.

  Supported options are:
    -h         This message
    ...
USAGE

故障排除

如果您看到错误当 Ruby 解析您的文件时，很可能您在 HEREDOC 中存在额外的前导或尾随空格，或者在波形 HEREDOC 中存在额外的尾随空格。例如：

您看到的内容：

    database_yml = <<~EOS
      production:
        database: #{fetch(:user)}
        adapter: postgresql
        pool: 5
        timeout: 5000
    EOS  

Ruby 告诉您的内容：

SyntaxError: .../sample.rb:xx: can't find string "EOS" anywhere before EOF
...sample.rb:xx: syntax error, unexpected end-of-input, expecting `end'

问题所在：

发现终止 EOS 后的多余空格。

百分比字符串文字

请参阅 RubyDoc 了解如何使用百分比字符串文字。百分比字符串文字以百分号 % 开头，后跟左括号或任何非字母数字字符。然后，输入字符串并以关联的右括号符号或非字母数字字符结束字符串文字。

因此，您可以使用 %(...)、%[...]、%{...} 或例如 %+...+。

无论使用哪种符号或括号（圆形、方形、花形），结果始终相同：只是一个字符串文字。

您只需选择内部字符串中最不可能使用的终止符，从而减少转义的需要。例如，在 SPARQL 查询中 {} 和 () 以及 [] 都被使用，因此使用 % 可能是有意义的$...$。在 SQL 中，[] 和 () 很常见，因此 %{} 可能是一个不错的选择。

最后的话

最后，为了得到最初问题“有没有办法暗示串联？”的答案。
回答：如果两个字符串（单引号和双引号）被发现背对背，Ruby 总是意味着串联：

puts "select..." 'from table...' "where..."
# -> "select...from table...where..."

需要注意的是，这不能跨换行符工作，因为 Ruby 正在解释语句的结尾以及仅由字符串组成的后续行在线上没有做任何事情。

Answer 5

正如您已经阅读过的，多行字符串有多种语法。我最喜欢的是 Perl 风格：

conn.exec %q{select attr1, attr2, attr3, attr4, attr5, attr6, attr7
      from table1, table2, table3, etc, etc, etc, etc, etc,
      where etc etc etc etc etc etc etc etc etc etc etc etc etc}

多行字符串以 %q 开头，后跟 {、[ 或 (，然后以相应的反转字符终止。%q 不允许插值；%Q 允许插值，因此您可以编写内容像这样：

conn.exec %Q{select attr1, attr2, attr3, attr4, attr5, attr6, attr7
      from #{table_names},
      where etc etc etc etc etc etc etc etc etc etc etc etc etc}

我实际上不知道如何调用这些类型的多行字符串，所以我们将它们称为 Perl 多行。

但是请注意，无论您使用 Perl 多行还是 Mark 和 Peter 建议的heredocs，您最终都会得到潜在的结果。不必要的空格。在我的示例和它们的示例中，“from”和“where”行都包含前导空格，因为它们在代码中缩进。如果不需要此空格，则必须像现在一样使用连接字符串。

Answer 6

有时值得删除换行符 \n 例如：

conn.exec <<-eos.squish
 select attr1, attr2, attr3, attr4, attr5, attr6, attr7
 from table1, table2, table3, etc, etc, etc, etc, etc,
 where etc etc etc etc etc etc etc etc etc etc etc etc etc
eos

Answer 7

您还可以使用双引号

x = """
this is 
a multiline
string
"""

2.3.3 :012 > x
 => "\nthis is\na multiline\nstring\n"

如果需要删除换行符“\n”，请在每行末尾使用反斜杠“\”

Answer 8

其他选项：

#multi line string
multiline_string = <<EOM
This is a very long string
that contains interpolation
like #{4 + 5} \n\n
EOM

puts multiline_string

#another option for multiline string
message = <<-EOF
asdfasdfsador #{2+2} this month.
asdfadsfasdfadsfad.
EOF

puts message

Answer 9

最近，随着 Ruby 2.3 中的新功能的出现，新的 squiggly HEREDOC 可以让您以最小的更改以良好的方式编写多行字符串，因此将其与 .squish 结合使用（如果您使用的是 Rails）将让您以一种很好的方式编写多行！
如果仅使用 ruby​​，您可以执行<<~SQL.split.join(" ")，这几乎相同的

[1] pry(main)> <<~SQL.squish
[1] pry(main)*   select attr1, attr2, attr3, attr4, attr5, attr6, attr7
[1] pry(main)*   from table1, table2, table3, etc, etc, etc, etc, etc,
[1] pry(main)*   where etc etc etc etc etc etc etc etc etc etc etc etc etc
[1] pry(main)* SQL
=> "select attr1, attr2, attr3, attr4, attr5, attr6, attr7 from table1, table2, table3, etc, etc, etc, etc, etc, where etc etc etc etc etc etc etc etc etc etc etc etc etc"

参考： https:// infinum.co/the-capsized-8/multiline-strings-ruby-2-3-0-the-squiggly-heredoc

Answer 10

conn.exec = <<eos
  select attr1, attr2, attr3, attr4, attr5, attr6, attr7
  from table1, table2, table3, etc, etc, etc, etc, etc,
  where etc etc etc etc etc etc etc etc etc etc etc etc etc
eos

Answer 11

为了避免关闭每行的括号，您可以简单地使用带反斜杠的双引号来转义换行符：

"select attr1, attr2, attr3, attr4, attr5, attr6, attr7 \
from table1, table2, table3, etc, etc, etc, etc, etc, \
where etc etc etc etc etc etc etc etc etc etc etc etc etc"

Answer 12

今天的优雅答案：

<<~TEXT
Hi #{user.name}, 

Thanks for raising the flag, we're always happy to help you.
Your issue will be resolved within 2 hours.
Please be patient!

Thanks again,
Team #{user.organization.name}
TEXT

<<-TEXT 和 <<~TEXT 之间有区别，前者保留块内的间距，后者则不保留。

还有其他选择。
就像串联等一样，但这通常更有意义。

如果我在这里错了，请告诉我如何......

Answer 13

conn.exec 'select attr1, attr2, attr3, attr4, attr5, attr6, attr7 ' <<
        'from table1, table2, table3, etc, etc, etc, etc, etc, ' <<
        'where etc etc etc etc etc etc etc etc etc etc etc etc etc'

<<是字符串的连接运算符

Answer 14

如果您确实介意额外的空格和换行符，您可以使用

conn.exec %w{select attr1, attr2, attr3, attr4, attr5, attr6, attr7
  from table1, table2, table3, etc, etc, etc, etc, etc,
  where etc etc etc etc etc etc etc etc etc etc etc etc etc} * ' '

（使用 %W 来插入字符串）

Answer 15

conn.exec [
  "select attr1, attr2, attr3, ...",
  "from table1, table2, table3, ...",
  "where ..."
].join(' ')

与此处文档和长字符串相比，此建议的优点是自动缩进器可以适当缩进字符串的每个部分。但这是以效率为代价的。

Answer 16

和您一样，我也在寻找不包含换行符的解决方案。 （虽然它们在 SQL 中可能是安全的，但在我的情况下并不安全，而且我有一大段文本要处理）

这可以说是同样丑陋，但您可以在定界文档中使用反斜杠转义换行符来省略它们结果字符串：

conn.exec <<~END_OF_INPUT
    select attr1, attr2, attr3, attr4, attr5, attr6, attr7 \
    from table1, table2, table3, etc, etc, etc, etc, etc, \
    where etc etc etc etc etc etc etc etc etc etc etc etc etc
  END_OF_INPUT

请注意，如果没有插值，则无法得出此结果（IE <<~'END_OF_INPUT'），因此请小心。 #{expressions} 将在此处进行计算，而它们不会在您的原始代码中进行计算。 A.由于这个原因，威尔逊的答案可能更好。