sfl 1.2 → 2.0

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# 2.0
+
+Version 2.0 is done completely by Bernard Lambeau. Thanks!
+
+* Enhancements
+
+  * Implemented :in redirection, i.e. spawn("...", :in => ...)
+  * Implemented :close redirection, i.e. spawn("...", :out/err/in => :close)
+  * Removed spawn override if ruby version is >= 1.9
+  * Project structure enhanced with Rakefile and SFL::VERSION
+  * Spec suite runs against Kernel.spawn to ensure comptability with native spawn in 1.9
+
+* Bugfixes
+
+  * Fix the spec suite for ruby version 1.9.2
+
+* Known bugs
+
+  * The spec suite may fail under ruby 1.9.1, due to ruby bugs on some spawn redirect options
+
+# 1.2
+
+* Enhancements
+
+  * Added support for quoted command arguments and spaces
+  * Defined spawn even if the ruby version is 1.9
+
+# 1.1
+
+* Enhancements
+
+  * Added Process.spawn in addition to Kernel.spawn
+  * Added support for Ruby 1.8.6
+
+# 1.0
+
+* Enhancements
+
+  * Birthday
+
+

data/README.md

@@ -32,6 +32,7 @@ If your ruby is 1.9, `require 'sfl'` doesn't do anything. If your ruby is 1.8, t
 
 ## Supports
 
+* (On MacOS) MRI 1.8.6, 1.8.7, 1.9.1, 1.9.2-rc2 
 * (On UNIX) MRI 1.8.6, 1.8.7, 1.9.1, 1.9.2pre
 * (On Windows) MRI 1.9.1, 1.9.2pre
 

data/Rakefile

@@ -0,0 +1,16 @@
+require "rspec/core/rake_task"
+require "rake/gempackagetask"
+
+task :default => :spec
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+	t.rspec_opts = %w[--color]
+	t.verbose = false
+end
+
+desc "Create the .gem package"
+$gemspec = eval("#{File.read('sfl.gemspec')}")
+Rake::GemPackageTask.new($gemspec) do |pkg|
+	pkg.need_tar = true
+end

data/lib/sfl.rb

@@ -1,4 +1,6 @@
 class SFL
+  VERSION = "2.0".freeze
+
   attr_reader :command, :environment, :argument, :option
 
   # SFL.new('ls', '-a') becomes
@@ -63,39 +65,62 @@ class SFL
   end
 
   class << self
+    REDIRECTION_MAPPING = {
+      :in  => STDIN,
+      :out => STDOUT,
+      :err => STDERR,
+    }
+
+    def redirection_ast(v, what_for = :out)
+      case v
+      when Integer
+        raise NotImplementedError, "Redirection to integer FD not yet implemented"
+      when :close
+        nil
+      when :in, :out, :err
+        REDIRECTION_MAPPING[v]
+      when String # filename
+        [File, :open, v, (what_for == :in ? 'r' : 'w')]
+      when Array # filename with option
+        [File, :open, v[0], v[1]]
+      when IO
+        v
+      end
+    end
+
     def option_parser(hash)
-      mapping = {
-        :out => STDOUT,
-        :err => STDERR,
-      }
       result = []
+
+      # changing dir has high priority
       chdir = hash.delete(:chdir)
       if chdir
         result[0] = [Dir, :chdir, chdir]
       end
+
+      # other options 
       result += hash.map {|k, v|
-        right =
-          case v
-          when Symbol # :out or :err
-            mapping[v]
-          when String # filename
-            [File, :open, v, 'w']
-          when Array # filename with option
-            [File, :open, v[0], v[1]]
-          when IO
-            v
+        case k
+        when :in, :out, :err
+          if right = redirection_ast(v, k)
+            [[REDIRECTION_MAPPING[k], :reopen, right]]    
+          else
+            [[REDIRECTION_MAPPING[k], :close]]    
           end
-
-        if Symbol === k
-          [[mapping[k], :reopen, right]]
-        else
+        when Array
           # assuming k is like [:out, :err]
-          raise if k.size > 2
-          left1, left2 = *k.map {|i| mapping[i] }
-          [
-            [left1, :reopen, right],
-            [left2, :reopen, left1],
-          ]
+          raise NotImplementedError if k.size > 2
+          left1, left2 = *k.map {|i| REDIRECTION_MAPPING[i] }
+          if right = redirection_ast(v)
+            [
+              [left1, :reopen, right],
+              [left2, :reopen, left1],
+            ]
+          else
+            [
+              [left1, :close],
+              [left2, :close],
+            ]
+          end
         end
       }.flatten(1)
       result
@@ -149,12 +174,14 @@ class SFL
   end
 end
 
-def spawn(*x)
-  SFL.new(*x).run
-end
+if RUBY_VERSION <= "1.9"
+  def Kernel.spawn(*x)
+    SFL.new(*x).run
+  end
 
-def Process.spawn(*x)
-  SFL.new(*x).run
+  def Process.spawn(*x)
+    SFL.new(*x).run
+  end
 end
 
 if RUBY_VERSION <= '1.8.6'

data/sfl.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('../lib/sfl', __FILE__)
+Gem::Specification.new do |s|
+  s.name = %q{sfl}
+  s.version = SFL::VERSION.dup
+  s.date = Time.now.strftime('%Y-%m-%d')  
+
+  s.summary = %q{Spawn For Ruby 1.8}
+  s.description = %q{Spawn For Ruby 1.8}
+  
+  s.author = 'ujihisa'
+  s.email  = %q{ujihisa at gmail.com}
+  
+  s.files = 
+    Dir['lib/**/*'] +
+    Dir['spec/**/*'] +
+    %w{ sfl.gemspec Rakefile README.md CHANGELOG.md }
+    
+  s.require_paths = ["lib"]
+  s.executables = []
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.homepage = %q{https://github.com/ujihisa/spawn-for-legacy}
+
+  s.extra_rdoc_files = %w< README.md >
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', ">= 2.4.0")
+end

data/spec/sfl_spec.rb

@@ -0,0 +1,177 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'sfl'
+require 'tempfile'
+
+describe 'SFL.new' do
+  context 'with argument "ls", "."' do
+    subject { SFL.new('ls', '.') }
+    it { should == SFL.new('ls', '.') }
+    it { should == SFL.new(['ls', 'ls'], '.') }
+    it { should_not == SFL.new('ls', 'aaaaa') }
+    it { should == SFL.new({}, 'ls', '.') }
+    it { should == SFL.new({}, 'ls', '.', {}) }
+    it { should_not == SFL.new({1=>2}, 'ls', '.', {}) }
+  end
+
+  context 'with argument {"A" => "1"}, ["ls", "dir"]' do
+    subject { SFL.new({"A" => "1"}, ['ls', 'dir']) }
+    it { should == SFL.new({"A" => "1"}, ['ls', 'dir']) }
+    it { should == SFL.new({"A" => "1"}, ['ls', 'dir'], {}) }
+    it { should_not == SFL.new({"A" => "1"}, 'ls', 'dir', {}) }
+    it { should_not == SFL.new(['ls', 'ls']) }
+  end
+
+  context 'with argument {"A" => "a"}, "ls", ".", {:out => :err}' do
+    subject { SFL.new({"A" => "a"}, "ls", ".", {:out => :err}) }
+    it { should == SFL.new({"A" => "a"}, ['ls', 'ls'], '.', {:out => :err}) }
+  end
+
+  context 'with argument "ls ."' do
+    subject { SFL.new('ls .') }
+    it { should == SFL.new('ls .') }
+    it { should == SFL.new('ls', '.') }
+    it { should == SFL.new(['ls', 'ls'], '.') }
+  end
+end
+
+describe 'Kernel.spawn' do
+  def mocker(code)
+    sfl_expanded = File.expand_path('../../lib/sfl', __FILE__)
+    rubyfile = File.expand_path('../mocker.rb', __FILE__) # Tempfile.new('-').path
+    File.open(rubyfile, 'w') {|io| io.puts <<-"EOF"
+        require '#{sfl_expanded}'
+      #{code}
+      EOF
+    }
+    resultfile = File.expand_path('../mocker_output.txt', __FILE__) # Tempfile.new('-').path
+    system "ruby #{rubyfile} > #{resultfile}"
+    File.read(resultfile)
+  end
+
+  context 'with command "ls", "."' do
+    it 'outputs the result of "ls ." on stdout' do
+      mocker(%q|
+        pid = Kernel.spawn('ls', '.')
+        Process.wait(pid)
+        |).should == `ls .`
+    end
+  end
+
+  # The following test is unsound and lead to spec
+  # failures under specific rubies...
+  #
+  # it 'is asynchronous' do
+  #   mocker(%q|
+  #     Kernel.spawn('sh', '-c', 'echo 1; sleep 1; echo 2')
+  #     sleep 0.1
+  #     |).should == "1\n"
+  # end
+
+  context 'with environment {"A" => "1"}' do
+    it 'outputs with given ENV "1"' do
+      mocker(%q|
+        pid = Kernel.spawn({'A' => 'a'}, 'ruby', '-e', 'p ENV["A"]')
+        Process.wait(pid)
+        |).should == "a".inspect + "\n"
+    end
+  end
+
+  context 'with option {:err => :out}' do
+    it 'outputs with given ENV "1"' do
+      mocker(
+        %q|
+        pid = Kernel.spawn('ls', 'nonexistfile', {:err => :out})
+        Process.wait(pid)
+        |).should =~ /^ls:/
+    end
+  end
+
+  context 'with option {:out => "/tmp/aaaaaaa.txt"}' do
+    it 'outputs with given ENV "1"' do
+      mocker(
+        %q|
+        pid = Kernel.spawn('echo', '123', {:out => "/tmp/aaaaaaa.txt"})
+        Process.wait(pid)
+        |).should == ""
+      File.read('/tmp/aaaaaaa.txt').should == "123\n"
+    end
+  end
+
+  context 'with option {:out => :close, :err => :close}' do
+    it 'outputs nothing at all' do
+      mocker(
+        %q|
+        pid = Kernel.spawn('echo', '123', {:out => :close, :err => :close})
+        Process.wait(pid)
+        |).should == ""
+    end
+  end
+
+  context 'with option {[:out, :err] => :close}' do
+    it 'outputs nothing at all' do
+      mocker(
+        %q|
+        pid = Kernel.spawn('echo', '123', {[:out, :err] => :close})
+        Process.wait(pid)
+        |).should == ""
+    end
+  end
+
+  context 'with option {:in => "README.md"}' do
+    it 'outputs README.md' do
+      mocker(
+        %q|
+        pid = Kernel.spawn('cat', {:in => File.expand_path('../../README.md', __FILE__)})
+        Process.wait(pid)
+        |).should =~ /Spawn for Legacy/
+    end
+  end
+end
+
+describe 'SFL.option_parser' do
+  it 'with symbol arguments' do
+    SFL.option_parser({:err => :out}).
+      should == [[STDERR, :reopen, STDOUT]]
+
+    SFL.option_parser({:err => 'filename'}).
+      should == [[STDERR, :reopen, [File, :open, 'filename', 'w']]]
+
+    o = File.open('/dev/null', 'w')
+    SFL.option_parser({:out => o}).
+      should == [[STDOUT, :reopen, o]]
+
+    SFL.option_parser({[:out, :err] => 'filename'}).
+      should == [
+        [STDOUT, :reopen, [File, :open, 'filename', 'w'] ],
+        [STDERR, :reopen, STDOUT]
+      ]
+
+    SFL.option_parser({:chdir => 'aaa'}).
+      should == [[Dir, :chdir, 'aaa']]
+
+    SFL.option_parser({:err => :out, :chdir => 'aaa'}).
+      should == [
+        [Dir, :chdir, 'aaa'],
+        [STDERR, :reopen, STDOUT]
+      ]
+  end
+end
+
+describe 'SFL.parse_command_with_arg' do
+  context 'ls .' do
+    subject { SFL.parse_command_with_arg('ls .') }
+    it { should == ['ls', '.'] }
+  end
+
+  context 'ls " "' do
+    subject { SFL.parse_command_with_arg('ls " "') }
+    it { should == ['ls', ' '] }
+  end
+end
+
+describe 'spawn()' do
+  it 'exists' do
+    Kernel.should be_respond_to(:spawn, true)
+    Process.should be_respond_to(:spawn, true)
+  end
+end

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: sfl
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: false
   segments: 
-  - 1
   - 2
-  version: "1.2"
+  - 0
+  version: "2.0"
 platform: ruby
 authors: 
 - ujihisa
@@ -14,10 +13,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 -08:00
+date: 2011-01-19 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
 description: Spawn For Ruby 1.8
 email: ujihisa at gmail.com
 executables: []
@@ -28,7 +54,11 @@ extra_rdoc_files:
 - README.md
 files: 
 - lib/sfl.rb
+- spec/sfl_spec.rb
+- sfl.gemspec
+- Rakefile
 - README.md
+- CHANGELOG.md
 has_rdoc: true
 homepage: https://github.com/ujihisa/spawn-for-legacy
 licenses: []
@@ -43,7 +73,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -52,7 +81,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"