1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

* lib/shellwords.rb: proofreading documentation.

Browse Source 
[Bug #10155][ruby-core:64471]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47408 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
hsbt 2014-09-05 10:00:46 +00:00
parent 1ffb9ba0e5
commit 925ac7ade7
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
Fri Sep 5 19:00:40 2014 SHIBATA Hiroshi <shibata.hiroshi@gmail.com>
* lib/shellwords.rb: proofreading documentation.
[Bug #10155][ruby-core:64471]
Fri Sep 5 18:34:33 2014 Laurent Arnoud <laurent@spkdev.net> Fri Sep 5 18:34:33 2014 Laurent Arnoud <laurent@spkdev.net>
* test/csv/test_row.rb: Added some missing tests in CSV. * test/csv/test_row.rb: Added some missing tests in CSV.

18
lib/shellwords.rb
View File

@ -9,7 +9,7 @@
# #
# === Usage # === Usage
# #
# You can use shellwords to parse a string into a Bourne shell friendly Array. # You can use Shellwords to parse a string into a Bourne shell friendly Array.
# #
# require 'shellwords' # require 'shellwords'
# #
@ -27,7 +27,7 @@
# argv = "they all ran after the farmer's wife".shellsplit # argv = "they all ran after the farmer's wife".shellsplit
# #=> ArgumentError: Unmatched double quote: ... # #=> ArgumentError: Unmatched double quote: ...
# #
# In this case, you might want to use Shellwords.escape, or it's alias # In this case, you might want to use Shellwords.escape, or its alias
# String#shellescape. # String#shellescape.
# #
# This method will escape the String for you to safely use with a Bourne shell. # This method will escape the String for you to safely use with a Bourne shell.
@ -42,7 +42,7 @@
# system(argv.shelljoin) # system(argv.shelljoin)
# #
# You can use this method to create an escaped string out of an array of tokens # You can use this method to create an escaped string out of an array of tokens
# separated by a space. In this example we'll use the literal shortcut for # separated by a space. In this example we used the literal shortcut for
# Array.new. # Array.new.
# #
# === Authors # === Authors
@ -117,7 +117,7 @@ module Shellwords
# It is the caller's responsibility to encode the string in the right # It is the caller's responsibility to encode the string in the right
# encoding for the shell environment where this string is used. # encoding for the shell environment where this string is used.
# #
# Multibyte characters are treated as multibyte characters, not bytes. # Multibyte characters are treated as multibyte characters, not as bytes.
# #
# Returns an empty quoted String if +str+ has a length of zero. # Returns an empty quoted String if +str+ has a length of zero.
def shellescape(str) def shellescape(str)
@ -128,13 +128,13 @@ module Shellwords
str = str.dup str = str.dup
# Treat multibyte characters as is. It is caller's responsibility # Treat multibyte characters as is. It is the caller's responsibility
# to encode the string in the right encoding for the shell # to encode the string in the right encoding for the shell
# environment. # environment.
str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1") str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
# A LF cannot be escaped with a backslash because a backslash + LF # A LF cannot be escaped with a backslash because a backslash + LF
# combo is regarded as line continuation and simply ignored. # combo is regarded as a line continuation and simply ignored.
str.gsub!(/\n/, "'\n'") str.gsub!(/\n/, "'\n'")
return str return str
@ -149,8 +149,8 @@ module Shellwords
# Builds a command line string from an argument list, +array+. # Builds a command line string from an argument list, +array+.
# #
# All elements are joined into a single string with fields separated by a # All elements are joined into a single string with fields separated by a
# space, where each element is escaped for Bourne shell and stringified using # space, where each element is escaped for the Bourne shell and stringified
# +to_s+. # using +to_s+.
# #
# ary = ["There's", "a", "time", "and", "place", "for", "everything"] # ary = ["There's", "a", "time", "and", "place", "for", "everything"]
# argv = Shellwords.join(ary) # argv = Shellwords.join(ary)
@ -206,7 +206,7 @@ class Array
# array.shelljoin => string # array.shelljoin => string
# #
# Builds a command line string from an argument list +array+ joining # Builds a command line string from an argument list +array+ joining
# all elements escaped for Bourne shell and separated by a space. # all elements escaped for the Bourne shell and separated by a space.
# #
# See Shellwords.shelljoin for details. # See Shellwords.shelljoin for details.
def shelljoin def shelljoin