* lib/shellwords.rb: Embed rdoc style comments.

* lib/shellwords.rb (shellwords): Use String#lstrip!.

* lib/shellwords.rb (shellwords): Recognize an object that
  responds to to_str() by using String.new().


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@3413 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

lib/shellwords.rb

@@ -1,41 +1,52 @@
-# shellwords.rb
-# original is shellwords.pl
 #
-# Usage:
+# shellwords.rb: Split text into an array of tokens a la UNIX shell
-#       require 'shellwords'
-#       words = Shellwords.shellwords(line)
 #
-#	   or
-#
-#       require 'shellwords'
-#       include Shellwords
-#       words = shellwords(line)
 
+#
+# This module is originally a port of shellwords.pl, but modified to
+# conform to POSIX / SUSv3 (IEEE Std 1003.1-2001).
+#
+# Examples:
+#
+#   require 'shellwords'
+#   words = Shellwords.shellwords(line)
+#
+# or
+#
+#   require 'shellwords'
+#   include Shellwords
+#   words = shellwords(line)
+#
 module Shellwords
+
+  #
+  # Split text into an array of tokens in the same way the UNIX Bourne
+  # shell does.
+  #
+  # See the +Shellwords+ module documentation for an example.
+  #
   def shellwords(line)
-    unless line.kind_of?(String)
+    line = String.new(line) rescue
-      raise ArgumentError, "Argument must be String class object."
+      raise(ArgumentError, "Argument must be a string")
-    end
+    line.lstrip!
-    line = line.sub(/\A\s+/, '')
     words = []
-    while line != ''
+    until line.empty?
       field = ''
-      while true
+      loop do
-	if line.sub!(/\A"(([^"\\]|\\.)*)"/, '') then #"
+	if line.sub!(/\A"(([^"\\]|\\.)*)"/, '') then
-	  snippet = $1
+	  snippet = $1.gsub(/\\(.)/, '\1')
-	  snippet.gsub!(/\\(.)/, '\1')
+	elsif line =~ /\A"/ then
-	elsif line =~ /\A"/ then #"
 	  raise ArgumentError, "Unmatched double quote: #{line}"
-	elsif line.sub!(/\A'([^']*)'/, '') then #'
+	elsif line.sub!(/\A'([^']*)'/, '') then
 	  snippet = $1
-	elsif line =~ /\A'/ then #'
+	elsif line =~ /\A'/ then
 	  raise ArgumentError, "Unmatched single quote: #{line}"
 	elsif line.sub!(/\A\\(.)/, '') then
 	  snippet = $1
-	elsif line.sub!(/\A([^\s\\'"]+)/, '') then #'
+	elsif line.sub!(/\A([^\s\\'"]+)/, '') then
 	  snippet = $1
 	else
-	  line.sub!(/\A\s+/, '')
+	  line.lstrip!
 	  break
 	end
 	field.concat(snippet)
@@ -44,5 +55,6 @@ module Shellwords
     end
     words
   end
+
   module_function :shellwords
 end