shell 0.0.1 → 0.7

data/lib/shell/system-command.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: false
+#
+#   shell/system-command.rb -
+#       $Release Version: 0.7 $
+#       $Revision$
+#       by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+# --
+#
+#
+#
+
+require_relative "filter"
+
+class Shell
+  class SystemCommand < Filter
+    def initialize(sh, command, *opts)
+      if t = opts.find{|opt| !opt.kind_of?(String) && opt.class}
+        Shell.Fail TypeError, t.class, "String"
+      end
+      super(sh)
+      @command = command
+      @opts = opts
+
+      @input_queue = Thread::Queue.new
+      @pid = nil
+
+      sh.process_controller.add_schedule(self)
+    end
+
+    attr_reader :command
+    alias name command
+
+    def wait?
+      @shell.process_controller.waiting_job?(self)
+    end
+
+    def active?
+      @shell.process_controller.active_job?(self)
+    end
+
+    def input=(inp)
+      super
+      if active?
+        start_export
+      end
+    end
+
+    def start
+      notify([@command, *@opts].join(" "))
+
+      @pid, @pipe_in, @pipe_out = @shell.process_controller.sfork(self) {
+        Dir.chdir @shell.pwd
+        $0 = @command
+        exec(@command, *@opts)
+      }
+      if @input
+        start_export
+      end
+      start_import
+    end
+
+    def flush
+      @pipe_out.flush if @pipe_out and !@pipe_out.closed?
+    end
+
+    def terminate
+      begin
+        @pipe_in.close
+      rescue IOError
+      end
+      begin
+        @pipe_out.close
+      rescue IOError
+      end
+    end
+
+    def kill(sig)
+      if @pid
+        Process.kill(sig, @pid)
+      end
+    end
+
+    def start_import
+      notify "Job(%id) start imp-pipe.", @shell.debug?
+      _eop = true
+      Thread.start {
+        begin
+          while l = @pipe_in.gets
+            @input_queue.push l
+          end
+          _eop = false
+        rescue Errno::EPIPE
+          _eop = false
+        ensure
+          if !ProcessController::USING_AT_EXIT_WHEN_PROCESS_EXIT and _eop
+            notify("warn: Process finishing...",
+                   "wait for Job[%id] to finish pipe importing.",
+                   "You can use Shell#transact or Shell#check_point for more safe execution.")
+            redo
+          end
+          notify "job(%id}) close imp-pipe.", @shell.debug?
+          @input_queue.push :EOF
+          @pipe_in.close
+        end
+      }
+    end
+
+    def start_export
+      notify "job(%id) start exp-pipe.", @shell.debug?
+      _eop = true
+      Thread.start{
+        begin
+          @input.each do |l|
+            ProcessController::block_output_synchronize do
+              @pipe_out.print l
+            end
+          end
+          _eop = false
+        rescue Errno::EPIPE, Errno::EIO
+          _eop = false
+        ensure
+          if !ProcessController::USING_AT_EXIT_WHEN_PROCESS_EXIT and _eop
+            notify("shell: warn: Process finishing...",
+                   "wait for Job(%id) to finish pipe exporting.",
+                   "You can use Shell#transact or Shell#check_point for more safe execution.")
+            redo
+          end
+          notify "job(%id) close exp-pipe.", @shell.debug?
+          @pipe_out.close
+        end
+      }
+    end
+
+    alias super_each each
+    def each(rs = nil)
+      while (l = @input_queue.pop) != :EOF
+        yield l
+      end
+    end
+
+    # ex)
+    #    if you wish to output:
+    #       "shell: job(#{@command}:#{@pid}) close pipe-out."
+    #    then
+    #       mes: "job(%id) close pipe-out."
+    #    yorn: Boolean(@shell.debug? or @shell.verbose?)
+    def notify(*opts)
+      @shell.notify(*opts) do |mes|
+        yield mes if iterator?
+
+        mes.gsub!("%id", "#{@command}:##{@pid}")
+        mes.gsub!("%name", "#{@command}")
+        mes.gsub!("%pid", "#{@pid}")
+        mes
+      end
+    end
+  end
+end

data/lib/shell/version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: false
+#
+#   version.rb - shell version definition file
+#       $Release Version: 0.7$
+#       $Revision$
+#       by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+# --
+#
+#
+#
+
+class Shell # :nodoc:
+  VERSION = "0.7"
+  @RELEASE_VERSION = VERSION
+  @LAST_UPDATE_DATE = "07/03/20"
+end

data/shell.gemspec

@@ -1,25 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "shell_utils/version"
+begin
+  require_relative "lib/shell/version"
+rescue LoadError
+  # for Ruby core repository
+  require_relative "version"
+end
 
-Gem::Specification.new do |s|
-  s.name        = "shell"
-  s.version     = ShellUtils::VERSION
-  s.authors     = ["Josh Hull"]
-  s.email       = ["joshbuddy@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{Some common shell utils}
-  s.description = %q{Some common shell utils.}
+Gem::Specification.new do |spec|
+  spec.name          = "shell"
+  spec.version       = Shell::VERSION
+  spec.authors       = ["Keiju ISHITSUKA"]
+  spec.email         = ["keiju@ruby-lang.org"]
 
-  s.rubyforge_project = "shell_utils"
+  spec.summary       = %q{An idiomatic Ruby interface for common UNIX shell commands.}
+  spec.description   = %q{An idiomatic Ruby interface for common UNIX shell commands.}
+  spec.homepage      = "https://github.com/ruby/shell"
+  spec.license       = "BSD-2-Clause"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/shell.rb", "lib/shell/builtin-command.rb", "lib/shell/command-processor.rb", "lib/shell/error.rb", "lib/shell/filter.rb", "lib/shell/process-controller.rb", "lib/shell/system-command.rb", "lib/shell/version.rb", "shell.gemspec"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

metadata

@@ -1,84 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: shell
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: '0.7'
 platform: ruby
 authors:
-- Josh Hull
+- Keiju ISHITSUKA
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70239653287620 !ruby/object:Gem::Requirement
-    none: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239653287620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &70239653286540 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70239653286540
-description: Some common shell utils.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An idiomatic Ruby interface for common UNIX shell commands.
 email:
-- joshbuddy@gmail.com
+- keiju@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
-- lib/shell_utils.rb
-- lib/shell_utils/version.rb
+- bin/console
+- bin/setup
+- lib/shell.rb
+- lib/shell/builtin-command.rb
+- lib/shell/command-processor.rb
+- lib/shell/error.rb
+- lib/shell/filter.rb
+- lib/shell/process-controller.rb
+- lib/shell/system-command.rb
+- lib/shell/version.rb
 - shell.gemspec
-- test/shell_utils_test.rb
-- test/test_helper.rb
-homepage: ''
-licenses: []
+homepage: https://github.com/ruby/shell
+licenses:
+- BSD-2-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2267396776853077093
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2267396776853077093
 requirements: []
-rubyforge_project: shell_utils
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
-summary: Some common shell utils
-test_files:
-- test/shell_utils_test.rb
-- test/test_helper.rb
+specification_version: 4
+summary: An idiomatic Ruby interface for common UNIX shell commands.
+test_files: []

data/lib/shell_utils.rb

@@ -1,58 +0,0 @@
-require "shell_utils/version"
-
-module ShellUtils
-  extend self
-  
-  def sh(cmd, base = nil)
-    out, code = sh_with_code(cmd)
-    code == 0 ? out : raise(out.empty? ? "Running `#{cmd}' failed. Run this command directly for more detailed output." : out)
-  end
-
-  # Run in shell, return both status and output
-  # @see #sh
-  def sh_with_code(cmd, base = nil)
-    cmd << " 2>&1"
-    outbuf = ''
-    outbuf = `#{base && "cd '#{base}' && "}#{cmd}`
-    [outbuf, $?]
-  end
-
-  def escape(*command)
-    command.flatten.map {|word| escape_word(word) }.join(' ')
-  end
-
-  def escape_word(str)
-    if str.empty?
-      "''"
-    elsif %r{\A[0-9A-Za-z+,./:=@_-]+\z} =~ str
-      str
-    else
-      result = ''
-      str.scan(/('+)|[^']+/) {
-        if $1
-          result << %q{\'} * $1.length
-        else
-          result << "'#{$&}'"
-        end
-      }
-      result
-    end
-  end
-
-  def capture
-    old_out, old_err = STDOUT.dup, STDERR.dup
-    stdout_read, stdout_write = IO.pipe
-    stderr_read, stderr_write = IO.pipe
-    $stdout.reopen(stdout_write)
-    $stderr.reopen(stderr_write)
-    yield
-    stdout_write.close
-    stderr_write.close
-    out = stdout_read.rewind && stdout_read.read rescue nil
-    err = stderr_read.rewind && stderr_read.read rescue nil
-    [out, err]
-  ensure
-    $stdout.reopen(old_out)
-    $stderr.reopen(old_err)
-  end
-end

data/lib/shell_utils/version.rb

@@ -1,3 +0,0 @@
-module ShellUtils
-  VERSION = "0.0.1"
-end

data/test/shell_utils_test.rb

@@ -1,25 +0,0 @@
-require File.expand_path('../test_helper', __FILE__)
-
-describe "ShellUtils" do
-  it "should sh" do
-    assert_equal Time.new.to_i.to_s, ShellUtils.sh("date +%s").strip
-  end
-
-  it "should sh and raise" do
-    assert_raises RuntimeError do
-      ShellUtils.sh("mymilkshakebringsvariousboystotheYARD")
-    end
-  end
-
-  it "should sh_with_code" do
-    out, status = ShellUtils.sh_with_code("date +%s")
-    assert_equal Time.new.to_i.to_s, out.strip
-    assert_equal 0, status.to_i
-  end
-
-  it "should sh_with_code and fail" do
-    out, status = ShellUtils.sh_with_code("mymilkshakebringsvariousboystotheYARD")
-    assert_equal "sh: mymilkshakebringsvariousboystotheYARD: command not found", out.strip
-    refute_equal 0, status.to_i
-  end
-end

data/test/test_helper.rb

@@ -1,4 +0,0 @@
-require 'rubygems'
-require 'minitest/autorun'
-$:.unshift File.expand_path("../../lib")
-require 'shell_utils'