rubysl-shellwords 0.0.1 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7218a87d72d7ebbf3905a49f386ca8e8ff85b3d3
+  data.tar.gz: 1bf9fa5994639347dc7f5ea40c7fc3e5ce4b5aa9
+SHA512:
+  metadata.gz: 0be3c1d16ecb39bb9a64ace53f6156f953b754c41579471752bbfdc2164b55d082715697a4df271d18c3627be530bf5be999a55a40a7e27dd9ab06f40f730db9
+  data.tar.gz: 29b72f1bbc93adcdf7011f757fceded2e35fd49e464052bb6dd3d7203488db7dc7362be297cb9a057edb2acf14d422fb4fdebbe6d890f9ad6b4ff7acc9719775

data/.gitignore

@@ -15,4 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rbx

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+env:
+  - RUBYLIB=lib
+script: bundle exec mspec
+rvm:
+  - 1.8.7
+  - rbx-nightly-18mode

data/README.md

@@ -1,4 +1,4 @@
-# RubySL::Shellwords
+# Rubysl::Shellwords
 
 TODO: Write a gem description
 
@@ -24,6 +24,6 @@ TODO: Write usage instructions here
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/Rakefile

@@ -1,2 +1 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"

data/lib/rubysl/shellwords.rb

@@ -0,0 +1,2 @@
+require "rubysl/shellwords/version"
+require "rubysl/shellwords/shellwords"

data/lib/rubysl/shellwords/shellwords.rb

@@ -0,0 +1,172 @@
+#
+# shellwords.rb: Manipulates strings a la UNIX Bourne shell
+#
+
+#
+# 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 POSIX / SUSv3 (IEEE Std 1003.1-2001).
+#
+# Authors:
+#   - Wakou Aoyama
+#   - Akinori MUSHA <knu@iDaemons.org>
+#
+# Contact:
+#   - Akinori MUSHA <knu@iDaemons.org> (current maintainer)
+#
+module Shellwords
+  #
+  # Splits a string into an array of tokens in the same way the UNIX
+  # Bourne shell does.
+  #
+  #   argv = Shellwords.split('here are "two words"')
+  #   argv #=> ["here", "are", "two words"]
+  #
+  # +String#shellsplit+ is a shorthand for this function.
+  #
+  #   argv = 'here are "two words"'.shellsplit
+  #   argv #=> ["here", "are", "two words"]
+  #
+  def shellsplit(line)
+    line = String.new(line) rescue
+      raise(ArgumentError, "Argument must be a string")
+    line.lstrip!
+    words = []
+    until line.empty?
+      field = ''
+      loop do
+	if line.sub!(/\A"(([^"\\]|\\.)*)"/, '') then
+	  snippet = $1.gsub(/\\(.)/, '\1')
+	elsif line =~ /\A"/ then
+	  raise ArgumentError, "Unmatched double quote: #{line}"
+	elsif line.sub!(/\A'([^']*)'/, '') then
+	  snippet = $1
+	elsif line =~ /\A'/ then
+	  raise ArgumentError, "Unmatched single quote: #{line}"
+	elsif line.sub!(/\A\\(.)?/, '') then
+	  snippet = $1 || '\\'
+	elsif line.sub!(/\A([^\s\\'"]+)/, '') then
+	  snippet = $1
+	else
+	  line.lstrip!
+	  break
+	end
+	field.concat(snippet)
+      end
+      words.push(field)
+    end
+    words
+  end
+
+  alias shellwords shellsplit
+
+  module_function :shellsplit, :shellwords
+
+  class << self
+    alias split shellsplit
+  end
+
+  #
+  # Escapes a string so that it can be safely used in a Bourne shell
+  # command line.
+  #
+  # Note that a resulted string should be used unquoted and is not
+  # intended for use in double quotes nor in single quotes.
+  #
+  #   open("| grep #{Shellwords.escape(pattern)} file") { |pipe|
+  #     # ...
+  #   }
+  #
+  # +String#shellescape+ is a shorthand for this function.
+  #
+  #   open("| grep #{pattern.shellescape} file") { |pipe|
+  #     # ...
+  #   }
+  #
+  def shellescape(str)
+    # An empty argument will be skipped, so return empty quotes.
+    return "''" if str.empty?
+
+    str = str.dup
+
+    # Process as a single byte sequence because not all shell
+    # implementations are multibyte aware.
+    str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
+
+    # A LF cannot be escaped with a backslash because a backslash + LF
+    # combo is regarded as line continuation and simply ignored.
+    str.gsub!(/\n/, "'\n'")
+
+    return str
+  end
+
+  module_function :shellescape
+
+  class << self
+    alias escape shellescape
+  end
+
+  #
+  # Builds a command line string from an argument list +array+ joining
+  # all elements escaped for Bourne shell and separated by a space.
+  #
+  #   open('|' + Shellwords.join(['grep', pattern, *files])) { |pipe|
+  #     # ...
+  #   }
+  #
+  # +Array#shelljoin+ is a shorthand for this function.
+  #
+  #   open('|' + ['grep', pattern, *files].shelljoin) { |pipe|
+  #     # ...
+  #   }
+  #
+  def shelljoin(array)
+    array.map { |arg| shellescape(arg) }.join(' ')
+  end
+
+  module_function :shelljoin
+
+  class << self
+    alias join shelljoin
+  end
+end
+
+class String
+  #
+  # call-seq:
+  #   str.shellsplit => array
+  #
+  # Splits +str+ into an array of tokens in the same way the UNIX
+  # Bourne shell does.  See +Shellwords::shellsplit+ for details.
+  #
+  def shellsplit
+    Shellwords.split(self)
+  end
+
+  #
+  # call-seq:
+  #   str.shellescape => string
+  #
+  # Escapes +str+ so that it can be safely used in a Bourne shell
+  # command line.  See +Shellwords::shellescape+ for details.
+  #
+  def shellescape
+    Shellwords.escape(self)
+  end
+end
+
+class Array
+  #
+  # call-seq:
+  #   array.shelljoin => string
+  #
+  # Builds a command line string from an argument list +array+ joining
+  # all elements escaped for Bourne shell and separated by a space.
+  # See +Shellwords::shelljoin+ for details.
+  #
+  def shelljoin
+    Shellwords.join(self)
+  end
+end

data/lib/{rubysl-shellwords → rubysl/shellwords}/version.rb

@@ -1,5 +1,5 @@
 module RubySL
   module Shellwords
-    VERSION = "0.0.1"
+    VERSION = "1.0.1"
   end
 end

data/lib/shellwords.rb

@@ -0,0 +1 @@
+require "rubysl/shellwords"

data/rubysl-shellwords.gemspec

@@ -1,22 +1,22 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/rubysl-shellwords/version', __FILE__)
+# coding: utf-8
+require './lib/rubysl/shellwords/version'
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Brian Shirai"]
-  gem.email         = ["brixen@gmail.com"]
-  gem.description   = %q{Ruby Standard Library - shellwords}
-  gem.summary       = %q{Ruby Standard Library - shellwords}
-  gem.homepage      = ""
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-shellwords"
+  spec.version       = RubySL::Shellwords::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library shellwords.}
+  spec.summary       = %q{Ruby standard library shellwords.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-shellwords"
+  spec.license       = "BSD"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "rubysl-shellwords"
-  gem.require_paths = ["lib"]
-  gem.version       = RubySL::Shellwords::VERSION
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "redcard", "~> 1.0"
-
-  gem.add_development_dependency "rake",  "~> 10.0"
-  gem.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
 end

data/spec/shellwords_spec.rb

@@ -0,0 +1,28 @@
+require 'shellwords'
+include Shellwords
+
+describe "Shellwords#shellwords" do
+  it "honors quoted strings" do
+    shellwords('a "b b" a').should == ['a', 'b b', 'a']
+  end
+
+  it "honors escaped double quotes" do
+    shellwords('a "\"b\" c" d').should == ['a', '"b" c', 'd']
+  end
+
+  it "honors escaped single quotes" do
+    shellwords("a \"'b' c\" d").should == ['a', "'b' c", 'd']
+  end
+
+  it "honors escaped spaces" do
+    shellwords('a b\ c d').should == ['a', 'b c', 'd']
+  end
+
+  it "raises ArgumentError when double quoted strings are misquoted" do
+    lambda { shellwords('a "b c d e') }.should raise_error(ArgumentError)
+  end
+
+  it "raises ArgumentError when single quoted strings are misquoted" do
+    lambda { shellwords("a 'b c d e") }.should raise_error(ArgumentError)
+  end
+end

metadata

@@ -1,118 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rubysl-shellwords
-version: !ruby/object:Gem::Version 
-  hash: 856480538658449761
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: redcard
+date: 2013-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 4428665182548103036
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1510892033553700768
-        segments: 
-        - 10
-        - 0
-        version: "10.0"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1660815245844205030
-        segments: 
-        - 1
-        - 5
-        version: "1.5"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
-  version_requirements: *id003
-description: Ruby Standard Library - shellwords
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Ruby standard library shellwords.
+email:
 - brixen@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- lib/rubysl-shellwords.rb
-- lib/rubysl-shellwords/version.rb
+- lib/rubysl/shellwords.rb
+- lib/rubysl/shellwords/shellwords.rb
+- lib/rubysl/shellwords/version.rb
+- lib/shellwords.rb
 - rubysl-shellwords.gemspec
-homepage: ""
-licenses: []
-
+- spec/shellwords_spec.rb
+homepage: https://github.com/rubysl/rubysl-shellwords
+licenses:
+- BSD
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
-summary: Ruby Standard Library - shellwords
-test_files: []
-
-has_rdoc: 
+specification_version: 4
+summary: Ruby standard library shellwords.
+test_files:
+- spec/shellwords_spec.rb

data/lib/rubysl-shellwords.rb

@@ -1,7 +0,0 @@
-require "rubysl-shellwords/version"
-
-module RubySL
-  module Shellwords
-    # Your code goes here...
-  end
-end