shellwords 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e221d4a4dfd65b01ce8fefcff226e75c20a50e4c80a8df1c4598b312bad28799
-  data.tar.gz: 22a1c6b889c1cbc8cb18b74804c92eb5697ef85c046c03e2cd3a8037c77c8992
+  metadata.gz: ccc635a3993667e34ee88b0e3122d3aa1f67776c36cc69fcc68288e85cfe6f2a
+  data.tar.gz: b64c7a5c30cc77284e49fa4cc8663369e3d90cd32b782443f1b5a955346f533a
 SHA512:
-  metadata.gz: f76872d1bdcc53a155dbab7cdc356ad85c570f8d67c2b82c22d148581bd5ec1072bdc7d6a22aa1f5625640bfff900d4906569a66b866854523cf82807169992c
-  data.tar.gz: 85f44a10ae9aece86aa1890588882cddbf1d54d709a6456d766c3f53511ee781c9ac0b84bc6cb784ea195e1c5ca9a56c2f6f730e4c6abf780b6585b6f222464f
+  metadata.gz: 8b81ed293a4dd49fe6cf0be82b1ad0d98efdecc3a549c13451ac638fdf546e067c5a556677fc4a2d3601772e4a9a03fba62ce29b786127f473b9d1b936175b19
+  data.tar.gz: 1d91518f6df2b52b629bad0b7659006376e6667a4c2dc5c406649a221c65fbeffd5087146ac4fa58f9af9789ecf8119ae86ba32467061c019a61d8b8486f24cd

data/.builtins.rb

@@ -0,0 +1,4 @@
+# :stopdoc:
+class Array end
+class String end
+# :startdoc:

data/.document

@@ -0,0 +1,4 @@
+LICENSE.txt
+README.md
+.builtins.rb
+lib/

data/.rdoc_options

@@ -0,0 +1,2 @@
+---
+main_page: README.md

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/README.md

@@ -3,11 +3,11 @@
 This module manipulates strings according to the word parsing rules
 of the UNIX Bourne shell.
 
-The shellwords() function was originally a port of shellwords.pl,
-but modified to conform to the Shell & Utilities volume of the IEEE
-Std 1003.1-2008, 2016 Edition [1].
+The `shellwords()` function was originally a port of shellwords.pl,
+but modified to conform to [the Shell & Utilities volume of the IEEE
+Std 1003.1-2008, 2016 Edition].
 
-[1] [IEEE Std 1003.1-2008, 2016 Edition, the Shell & Utilities volume](http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html)
+[the Shell & Utilities volume of the IEEE Std 1003.1-2008, 2016 Edition]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html
 
 ## Installation
 
@@ -43,4 +43,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/shellwords.
-

data/lib/shellwords.rb

@@ -5,9 +5,9 @@
 # This module manipulates strings according to the word parsing rules
 # of the UNIX Bourne shell.
 #
-# The shellwords() function was originally a port of shellwords.pl,
-# but modified to conform to the Shell & Utilities volume of the IEEE
-# Std 1003.1-2008, 2016 Edition [1].
+# The <tt>shellwords()</tt> function was originally a port of shellwords.pl, but
+# modified to conform to {the Shell & Utilities volume of the IEEE Std 1003.1-2008, 2016
+# Edition}[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html]
 #
 # === Usage
 #
@@ -62,13 +62,10 @@
 #
 # === Contact
 # * Akinori MUSHA <knu@iDaemons.org> (current maintainer)
-#
-# === Resources
-#
-# 1: {IEEE Std 1003.1-2008, 2016 Edition, the Shell & Utilities volume}[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html]
 
 module Shellwords
-  VERSION = "0.2.0"
+  # The version number string.
+  VERSION = "0.2.2"
 
   # Splits a string into an array of tokens in the same way the UNIX
   # Bourne shell does.
@@ -76,6 +73,9 @@ module Shellwords
   #   argv = Shellwords.split('here are "two words"')
   #   argv #=> ["here", "are", "two words"]
   #
+  # +line+ must not contain NUL characters because of nature of
+  # +exec+ system call.
+  #
   # Note, however, that this is not a command line parser.  Shell
   # metacharacters except for the single and double quotes and
   # backslash are not treated as such.
@@ -90,9 +90,14 @@ module Shellwords
   def shellsplit(line)
     words = []
     field = String.new
-    line.scan(/\G\s*(?>([^\s\\\'\"]+)|'([^\']*)'|"((?:[^\"\\]|\\.)*)"|(\\.?)|(\S))(\s|\z)?/m) do
+    line.scan(/\G\s*(?>([^\0\s\\\'\"]+)|'([^\0\']*)'|"((?:[^\0\"\\]|\\[^\0])*)"|(\\[^\0]?)|(\S))(\s|\z)?/m) do
       |word, sq, dq, esc, garbage, sep|
-      raise ArgumentError, "Unmatched quote: #{line.inspect}" if garbage
+      if garbage
+        b = $~.begin(0)
+        line = $~[0]
+        line = "..." + line if b > 0
+        raise ArgumentError, "#{garbage == "\0" ? 'Nul character' : 'Unmatched quote'} at #{b}: #{line}"
+      end
       # 2.2.3 Double-Quotes:
       #
       #   The <backslash> shall retain its special meaning as an
@@ -121,6 +126,9 @@ module Shellwords
   # command line.  +str+ can be a non-string object that responds to
   # +to_s+.
   #
+  # +str+ must not contain NUL characters because of nature of +exec+
+  # system call.
+  #
   # Note that a resulted string should be used unquoted and is not
   # intended for use in double quotes nor in single quotes.
   #
@@ -153,6 +161,9 @@ module Shellwords
     # An empty argument will be skipped, so return empty quotes.
     return "''".dup if str.empty?
 
+    # Shellwords cannot contain NUL characters.
+    raise ArgumentError, "NUL character" if str.index("\0")
+
     str = str.dup
 
     # Treat multibyte characters as is.  It is the caller's responsibility
@@ -178,6 +189,7 @@ module Shellwords
   # All elements are joined into a single string with fields separated by a
   # space, where each element is escaped for the Bourne shell and stringified
   # using +to_s+.
+  # See also Shellwords.shellescape.
   #
   #   ary = ["There's", "a", "time", "and", "place", "for", "everything"]
   #   argv = Shellwords.join(ary)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellwords
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Akinori MUSHA
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies: []
 description: Manipulates strings with word parsing rules of UNIX Bourne shell.
 email:
@@ -17,18 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/dependabot.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
+- ".builtins.rb"
+- ".document"
+- ".rdoc_options"
+- BSDL
+- COPYING
 - Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/shellwords.rb
-- shellwords.gemspec
 homepage: https://github.com/ruby/shellwords
 licenses:
 - Ruby
@@ -51,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Manipulates strings with word parsing rules of UNIX Bourne shell.

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @knu

data/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      interval: 'weekly'

data/.github/workflows/test.yml

@@ -1,31 +0,0 @@
-name: test
-
-on: [push, pull_request]
-
-jobs:
-  ruby-versions:
-    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
-    with:
-      min_version: 2.5
-
-  test:
-    needs: ruby-versions
-    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
-    strategy:
-      matrix:
-        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        exclude:
-          - { os: windows-latest, ruby: truffleruby-head }
-          - { os: windows-latest, ruby: truffleruby }
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run test
-      run: rake test

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task :default => :test

data/shellwords.gemspec

@@ -1,30 +0,0 @@
-name = File.basename(__FILE__, ".gemspec")
-version = ["lib", Array.new(name.count("-")+1).join("/")].find do |dir|
-  break File.foreach(File.join(__dir__, dir, "#{name.tr('-', '/')}.rb")) do |line|
-    /^\s*VERSION\s*=\s*"(.*)"/ =~ line and break $1
-  end rescue nil
-end
-
-
-Gem::Specification.new do |spec|
-  spec.name          = name
-  spec.version       = version
-  spec.authors       = ["Akinori MUSHA"]
-  spec.email         = ["knu@idaemons.org"]
-
-  spec.summary       = %q{Manipulates strings with word parsing rules of UNIX Bourne shell.}
-  spec.description   = %q{Manipulates strings with word parsing rules of UNIX Bourne shell.}
-  spec.homepage      = "https://github.com/ruby/shellwords"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end