shr 0.1.1 → 0.1.2

data/lib/shr/command.rb

@@ -0,0 +1,46 @@
+#command utf-8
+require 'open3'
+require 'shr/option'
+require 'shr/which'
+
+module Shr
+  class Command
+
+    def initialize(command, options=[])
+      @command = command.to_s
+      Option.indicator = '/' if OS.windows?
+      @options = Option.translate(options).join(' ')
+    end
+    attr_reader :command
+
+    def command
+      command = release? ? @command.chomp('!') : @command
+      Which::builtins?(command) ? "cmd /c #{command}" : command
+    end
+
+    def to_s
+      [command, @options].join(' ')
+    end
+
+    def exist?
+      Which::exist? @command.chomp('!')
+    end
+
+    def release?
+      @command.end_with? '!'
+    end
+
+    # xxx
+    def run(environment)
+      pid = spawn(self.to_s, environment)
+      watcher = Process.detach(pid)
+      environment[:out].close if environment[:out].kind_of?(IO)
+      watcher
+    end
+
+    # xxx
+    def run!
+      Open3.pipeline(self.to_s)
+    end
+  end
+end

data/lib/shr/option.rb

@@ -2,43 +2,43 @@
 
 module Shr
   class Option
-    def initialize
-      @options   = []
-      @indicator = '-'
-    end
-    attr_accessor :indicator
+    class << self
+      attr_accessor :indicator
+
+      def indicator
+        @indicator ||= '-'
+      end
 
-    def parse(options)
-      options.each do |opt|
-        case opt
-        when String
-          @options << opt
-        when Symbol
-          @options << translate_from(opt)
-        when Hash
-          opt.each do |k, v|
-            if v.eql?(true)
-              @options << translate_from(k)
-            else
-              if k.length > 1
-                @options << "#{translate_from(k)}=#{v}"
+      def translate(options)
+        result = []
+        options.each do |opt|
+          case opt
+          when String then result << opt
+          when Symbol then result << translate_from(opt)
+          when Fixnum then result << "#{indicator}#{opt}"
+          when Hash
+            opt.each do |k, v|
+              if v.eql?(true)
+                result << translate_from(k)
               else
-                @options << translate_from(k) << v
+                if k.length > 1
+                  result << "#{translate_from(k)}=#{v}"
+                else
+                  result << translate_from(k) << v
+                end
               end
             end
           end
-        when Fixnum
-          @options << "#{@indicator}#{opt}"
         end
+        result
       end
-      @options
-    end
 
-    private
+      private
 
-    def translate_from(opt)
-      s = opt.to_s
-      "#{@indicator}#{(s.length > 1 ? '-' : '') if @indicator == '-'}#{s}"
+      def translate_from(opt)
+        s = opt.to_s
+        "#{indicator}#{(s.length > 1 ? '-' : '') if indicator == '-'}#{s}"
+      end
     end
   end
 end

data/lib/shr/shell.rb

@@ -1,61 +1,48 @@
 #coding: utf-8
-require 'open3'
-require 'shr/option'
-require 'shr/which'
+require 'shr/command'
 
 module Shr
   class Shell
 
     def initialize
       @promise = []
-      @capture = false
-      @release = false
     end
 
     def method_missing(name, *args)
-      command = name.to_s.chomp('!')
-      unless Which.exist?(command)
+      command = Command.new(name, args)
+      unless command.exist?
         super
       else
-        delay(command, args)
-        release { force } if name.to_s.end_with?('!') || @release
+        delay command
+        force! if command.release?
         self
       end
     end
 
     def to_s
-      capture { force }
+      force
       @command_out.read if filled?
     end
 
-    # xxx
     def inspect
-      puts "#<Shr::Shell - #{@promise.join(' | ')}>"
-      capture { force }
-      @command_out.read if filled?
-    end
-
-    def capture(&block)
-      @capture = true
-      instance_exec(&block)
-      @capture = false
-    end
-
-    def release(&block)
-      @release = true
-      instance_exec(&block)
-      @release = false
+      command_line = @promise.join(' | ').strip
+      force
+      res =  "#<Shr::Shell>"
+      res << "<:command => #{command_line}>" if command_line.size > 0
+      res << "\n" if filled?
+      res << @command_out.read if filled?
+      res
     end
 
     def each
-      capture { force }
+      force
       if filled?
         block_given? ? @command_out.each { |ln| yield ln } : @command_out.each
       end
     end
 
     def exitstatus
-      capture { force }
+      force
       if @wait_thread
         proc = @wait_thread.value
         proc.exitstatus
@@ -63,53 +50,52 @@ module Shr
     end
 
     def redirect_from(src)
-      capture { force(:redirect => { :in => src }) }
+      force(:in => src)
       self
     end
 
     def redirect_to(dest)
-      release { force(:redirect => { :out => dest }) }
+      force(:out => dest)
     end
 
     alias_method :<, :redirect_from
     alias_method :>, :redirect_to
 
+    private
+
     def filled?
       @command_out && !@command_out.closed?
     end
 
-    # xxx
-    def command_line(name, args)
-      option = Option.new
-      option.indicator = '/' if OS.windows?
-      options = option.parse(args).join(' ')
-
-      if OS.windows?
-        "cmd /c #{name} #{options}".strip
-      else
-        "#{name} #{options}".strip
-      end
-    end
-
-    def delay(name, args)
-      @promise << command_line(name, args)
+    def delay(command)
+      @promise << command
     end
 
+    # xxx
     def force(args={})
-      args = { :redirect => {} }.merge(args)
       return if @promise.empty?
 
-      if @release
-        Open3.pipeline(*@promise, args[:redirect])
-      elsif @capture
-        out, thr = Open3.pipeline_r(*@promise, args[:redirect])
-        @command_out = out
-        @wait_thread = thr[-1]
+      @promise.each do |promise|
+        io_r, io_w = IO.pipe
+        environment = { :out => io_w }
+        environment[:in] = @command_out if @command_out
+        environment.merge!(args)
+
+        watcher = promise.run(environment)
+
+        @command_out = io_r
+        @wait_thread = watcher
       end
 
       @promise.clear
     end
 
-    private :filled?, :command_line, :delay, :force
+    # xxx
+    def force!
+      return if @promise.empty?
+
+      @promise[-1].run!
+      @promise.clear
+    end
   end
 end

data/lib/shr/version.rb

@@ -1,3 +1,3 @@
 module Shr
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/shr/which.rb

@@ -5,7 +5,7 @@ require 'os'
 # whichr - https://github.com/rdp/whichr
 
 module Shr
-  class Which
+  module Which
     @@path = ENV['PATH']
     if OS.windows?
       cwd = File::PATH_SEPARATOR + '.'
@@ -19,6 +19,7 @@ module Shr
         cd chdir
         cls
         color
+        copy
         date
         del erace
         dir
@@ -39,46 +40,49 @@ module Shr
         start
         time
         title
+        type
         var
         verify
         vol
       }
     end
 
-    def self.exist?(program)
-      programs = add_extensions(program)
+    class << self
+      def exist?(program)
+        programs = add_extensions(program)
 
-      entries = paths.product(programs).map { |list| list.join '/' }
-      result = entries.find do |exe|
-        File.executable?(exe) && !File.directory?(exe)
-      end
+        entries = paths.product(programs).map { |list| list.join '/' }
+        result = entries.find do |exe|
+          File.executable?(exe) && !File.directory?(exe)
+        end
 
-      if OS.windows?
-        result = program.to_s if @@builtins.include? program.to_s
+        result = program.to_s if builtins?(program.to_s)
+        result
       end
 
-      result
-    end
-    class << self
       alias :exists? :exist?
-    end
 
-    def self.add_extensions(program)
-      if OS.windows?
-        # add .bat, .exe, etc.
-        extensions = ENV['PATHEXT'].split(';')
-        [program].product(extensions).map(&:join)
-      else
-        [program]
+      def builtins?(program)
+        @@builtins.include? program.to_s if OS.windows?
       end
-    end
 
-    def self.paths
-      @@path.split(File::PATH_SEPARATOR).map! do |path|
-        OS.windows? ? path.gsub('\\', '/') : path
+      def add_extensions(program)
+        if OS.windows?
+          # add .bat, .exe, etc.
+          extensions = ENV['PATHEXT'].split(';')
+          [program].product(extensions).map(&:join)
+        else
+          [program]
+        end
       end
-    end
 
-    private_class_method :add_extensions, :paths
+      def paths
+        @@path.split(File::PATH_SEPARATOR).map! do |path|
+          OS.windows? ? path.gsub('\\', '/') : path
+        end
+      end
+
+      private :add_extensions, :paths
+    end
   end
 end

data/spec/lib/shr/command_spec.rb

@@ -0,0 +1,52 @@
+#command utf-8
+require 'spec_helper'
+
+module Shr
+  describe Command do
+    let(:cmd) { Command.new(:ls, [:l, :t, :r]) }
+
+    it 'has the following methods' do
+      m = cmd.methods
+      m.should include(:command)
+      m.should include(:to_s)
+      m.should include(:exist?)
+      m.should include(:release?)
+      m.should include(:run)
+    end
+
+    describe '#command' do
+      it 'returns the command name that passed in initializing' do
+        cmd.command.should eq('ls')
+      end
+
+      context "when passed command end with '!'" do
+        it "returns the command name without '!'" do
+          Command.new(:ls!).command.should eq('ls')
+        end
+      end
+    end
+
+    describe '#to_s' do
+      it 'returns the command and parsed options' do
+        cmd.to_s.should eq('ls -l -t -r')
+      end
+    end
+
+    describe '#exist?' do
+      it "returns the command's existence" do
+        Command.new(:echo).exist?.should be_true
+        Command.new(:ohce).exist?.should be_false
+      end
+    end
+
+    describe '#release?' do
+      context "when passed command without '!'" do
+        it { Command.new(:ls!).release?.should be_true }
+      end
+
+      context "when passed command with '!'" do
+        it { Command.new(:ls).release?.should be_false }
+      end
+    end
+  end
+end

data/spec/lib/shr/option_spec.rb

@@ -10,62 +10,73 @@ module Shr
     MIXED_FORM = SHORT_FORM + LONG_FORM
 
     it 'has the following methods' do
-      o = opt.methods
-      o.should include(:parse)
+      o = Option.methods
+      o.should include(:translate)
     end
 
-    describe '#parse' do
+    describe '#translate' do
       describe String do
         it 'remains argument unchanged' do
-          opt.parse(MIXED_FORM).should eq(MIXED_FORM)
+          Option.indicator = '-'
+          Option.translate(MIXED_FORM).should eq(MIXED_FORM)
         end
       end
 
       describe Symbol do
         context 'with a character' do
           it 'tranlate argument to short-form' do
-            opt.parse([:o]).should eq(['-o'])
+            Option.indicator = '-'
+            Option.translate([:o]).should eq(['-o'])
           end
 
           it 'may be indicated by @indicator' do
-            opt.indicator = '/'
-            opt.parse([:o]).should eq(['/o'])
+            Option.indicator = '/'
+            Option.translate([:o]).should eq(['/o'])
           end
         end
 
         context 'with some characters' do
           it 'translates argument to long-form' do
-            opt.parse([:silent]).should eq(['--silent'])
+            Option.indicator = '-'
+            Option.translate([:silent]).should eq(['--silent'])
           end
 
           it 'may be indicated by @indicator' do
-            opt.indicator = '/'
-            opt.parse([:silent]).should eq(['/silent'])
+            Option.indicator = '/'
+            Option.translate([:silent]).should eq(['/silent'])
           end
         end
       end
 
       describe Hash do
-        it { opt.parse([{ :o => 'page.html' }]).should eq(SHORT_FORM) }
-        it { opt.parse([{ :shell => '/bin/sh', :silent => true }]).should eq(LONG_FORM) }
+        it {
+          Option.indicator = '-'
+          Option.translate([{ :o => 'page.html' }]).should eq(SHORT_FORM)
+        }
+
+        it {
+          Option.indicator = '-'
+          Option.translate([{ :shell => '/bin/sh', :silent => true }]).should eq(LONG_FORM)
+        }
 
         context 'with indicator' do
           it 'may be indicated by @indicator' do
-            opt.indicator = '/'
-            opt.parse([{ :o => 'page.html' }]).should eq(['/o', 'page.html'])
+            Option.indicator = '/'
+            Option.translate([{ :o => 'page.html' }]).should eq(['/o', 'page.html'])
           end
         end
       end
 
       describe Fixnum do
         it 'translates argument to short-form' do
-          opt.parse([1, 2, 3]).should eq(['-1', '-2', '-3'])
+          Option.indicator = '-'
+          Option.translate([1, 2, 3]).should eq(['-1', '-2', '-3'])
         end
 
         context 'with indicator' do
           it 'may be indicated by @indicator' do
-            opt.indicator = '/'
-            opt.parse([1, 2, 3]).should eq(['/1', '/2', '/3'])
+            Option.indicator = '/'
+            Option.translate([1, 2, 3]).should eq(['/1', '/2', '/3'])
           end
         end
       end

data/spec/lib/shr/shell_spec.rb

@@ -8,18 +8,8 @@ module Shr
   describe Shell do
     let(:sh) { Shell.new }
 
-    before(:all) do
-      @tmpdir = Dir.mktmpdir
-      ['perl.pl', 'python.py', 'ruby.rb'].each do |file|
-        FileUtils.touch File.join(@tmpdir, file)
-      end
-      @tmpfile = File.join(@tmpdir, 'ruby.rb.back')
-    end
-
     it 'has the following methods' do
       m = sh.methods
-      m.should include(:capture)
-      m.should include(:release)
       m.should include(:exitstatus)
       m.should include(:each)
       m.should include(:redirect_from)
@@ -28,77 +18,80 @@ module Shr
       m.should include(:>)
     end
 
-    it 'executes OS commands' do
-      cmd_result = `pwd`
-      sh_result = sh.pwd.to_s
-      sh_result.should eq(cmd_result)
-    end
+    unless OS.windows?
+      before(:all) do
+        Option.indicator = '-'
+        @tmpdir = Dir.mktmpdir
+        ['perl.pl', 'python.py', 'ruby.rb'].each do |file|
+          FileUtils.touch File.join(@tmpdir, file)
+        end
+        @tmpfile = File.join(@tmpdir, 'ruby.rb.back')
+      end
 
-    context "command end with '!'" do
       it 'executes OS commands' do
-        sh.touch! @tmpfile
-        File.should exist(@tmpfile)
-        FileUtils.rm @tmpfile
+        cmd_result = `pwd`
+        sh_result  = sh.pwd.to_s
+        sh_result.should eq(cmd_result)
       end
-    end
-
-    describe '#capture' do
-      it 'captures output of commands'
-    end
 
-    describe '#release' do
-      it 'releases output of commands'
-    end
-
-    describe '#each' do
-      it 'yields each line (result of command) to the block' do
-        files = []
-        sh.ls(@tmpdir).sort(:r).each do |file|
-          files << file.strip
+      context "command end with '!'" do
+        it 'executes OS commands' do
+          sh.touch! @tmpfile
+          File.should exist(@tmpfile)
+          FileUtils.rm @tmpfile
         end
-        files.should eq(['ruby.rb', 'python.py', 'perl.pl'])
       end
 
-      context 'without block' do
-        it 'returns Enumerator' do
-          sh.ls.each.should be_kind_of(Enumerator)
+      describe '#each' do
+        it 'yields each line (result of command) to the block' do
+          files = []
+          sh.ls(@tmpdir).sort(:r).each do |file|
+            files << file.strip
+          end
+          files.should eq(['ruby.rb', 'python.py', 'perl.pl'])
+        end
+
+        context 'without block' do
+          it 'returns Enumerator' do
+            sh.ls.each.should be_kind_of(Enumerator)
+          end
         end
       end
-    end
 
-    it "emulates the shell pipe operator by method chaining" do
-      cmd_result = `pwd | tr '[:lower:]' '[:upper:]'`
-      sh_result = sh.pwd.tr("'[:lower:]'", "'[:upper:]'").to_s
-      sh_result.should eq(cmd_result)
-    end
+      it "emulates the shell pipe operator by method chaining" do
+        cmd_result = `pwd | tr '[:lower:]' '[:upper:]'`
+        sh_result = sh.pwd.tr("'[:lower:]'", "'[:upper:]'").to_s
+        sh_result.should eq(cmd_result)
+      end
 
-    describe '#exitstatus' do
-      it "shows an exit status of process" do
-        sh.ruby('-e', "'exit 0'").exitstatus.should eq(0)
-        sh.ruby('-e', "'exit 1'").exitstatus.should eq(1)
+      describe '#exitstatus' do
+        it "shows an exit status of process" do
+          sh.ruby('-e', "'exit 0'").exitstatus.should eq(0)
+          sh.ruby('-e', "'exit 1'").exitstatus.should eq(1)
+        end
       end
-    end
 
-    describe '#redirect_from' do
-      it 'redirect from file to command' do
-        tempfile = Tempfile.new('temp')
-        sh.pwd.redirect_to(tempfile.path)
-        sh.cat.redirect_from(tempfile.path).to_s.should eq(`pwd`)
-        tempfile.close!
+      describe '#redirect_from' do
+        it 'redirect from file to command' do
+          tempfile = Tempfile.new('temp')
+          sh.pwd.redirect_to(tempfile.path)
+          sh.cat.redirect_from(tempfile.path).to_s.should eq(`pwd`)
+          tempfile.close!
+        end
       end
-    end
 
-    describe '#redirect_to' do
-      it 'redirecs result of command to file' do
-        tempfile = Tempfile.new('temp')
-        sh.pwd.redirect_to(tempfile.path)
-        File.read(tempfile.path).should eq(`pwd`)
-        tempfile.close!
+      describe '#redirect_to' do
+        it 'redirecs result of command to file' do
+          tempfile = Tempfile.new('temp')
+          sh.pwd.redirect_to(tempfile.path)
+          sh.cat(tempfile.path).to_s.should eq(`pwd`)
+          tempfile.close!
+        end
       end
-    end
 
-    after(:all) do
-      FileUtils.remove_entry_secure @tmpdir
+      after(:all) do
+        FileUtils.remove_entry_secure @tmpdir
+      end
     end
   end
 end

data/spec/lib/shr/shell_win_spec.rb

@@ -0,0 +1,80 @@
+#coding: utf-8
+require 'spec_helper'
+require 'fileutils'
+require 'tempfile'
+require 'tmpdir'
+
+module Shr
+  if OS.windows?
+    describe Shell do
+      let(:sh) { Shell.new }
+
+      before(:all) do
+        Option.indicator = '/'
+        @tmpdir = Dir.mktmpdir
+        ['perl.pl', 'python.py', 'ruby.rb'].each do |file|
+          FileUtils.touch File.join(@tmpdir, file)
+        end
+        @tmpfile = File.join(@tmpdir, 'ruby.rb.back')
+      end
+
+      it 'executes OS commands' do
+        cmd_result = `chdir`
+        sh_result  = sh.chdir.to_s
+        sh_result.should eq(cmd_result)
+      end
+
+      context "command end with '!'" do
+        it 'executes OS commands' do
+          sh.copy!('nul', @tmpfile.gsub('/', '\\'))
+          File.should exist(@tmpfile)
+          FileUtils.rm @tmpfile
+        end
+      end
+
+      describe '#each' do
+        it 'yields each line (result of command) to the block' do
+          files = []
+          sh.dir(:B, @tmpdir.gsub('/', '\\')).sort(:R).each do |file|
+            files << file.strip
+          end
+          files.should eq(['ruby.rb', 'python.py', 'perl.pl'])
+        end
+
+        context 'without block' do
+          it 'returns Enumerator' do
+            sh.dir.each.should be_kind_of(Enumerator)
+          end
+        end
+      end
+
+      it "emulates the shell pipe operator by method chaining" do
+        cmd_result = `chdir | ruby -ne 'puts $_.tr("a-z", "A-Z")'`
+        sh_result = sh.chdir.ruby('-ne', %q{'puts $_.tr("a-z", "A-Z")'}).to_s
+        sh_result.should eq(cmd_result)
+      end
+
+      describe '#redirect_from' do
+        it 'redirect from file to command' do
+          tempfile = Tempfile.new('temp')
+          sh.chdir.redirect_to(tempfile.path)
+          sh.more.redirect_from(tempfile.path).to_s.should eq(`chdir`)
+          tempfile.close!
+        end
+      end
+
+      describe '#redirect_to' do
+        it 'redirecs result of command to file' do
+          tempfile = Tempfile.new('temp')
+          sh.chdir.redirect_to(tempfile.path)
+          sh.type(tempfile.path.gsub('/', '\\')).to_s.should eq(`chdir`)
+          tempfile.close!
+        end
+      end
+
+      after(:all) do
+        FileUtils.remove_entry_secure @tmpdir
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-09 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -35,19 +35,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .swp
 - Gemfile
 - Guardfile
 - LICENSE.md
 - README.md
 - Rakefile
 - lib/shr.rb
+- lib/shr/command.rb
 - lib/shr/option.rb
 - lib/shr/shell.rb
 - lib/shr/version.rb
 - lib/shr/which.rb
 - shr.gemspec
+- spec/lib/shr/command_spec.rb
 - spec/lib/shr/option_spec.rb
 - spec/lib/shr/shell_spec.rb
+- spec/lib/shr/shell_win_spec.rb
 - spec/lib/shr/which_spec.rb
 - spec/lib/shr_spec.rb
 - spec/spec_helper.rb
@@ -76,8 +80,10 @@ signing_key:
 specification_version: 3
 summary: Make controlling subprocess easier in Ruby.
 test_files:
+- spec/lib/shr/command_spec.rb
 - spec/lib/shr/option_spec.rb
 - spec/lib/shr/shell_spec.rb
+- spec/lib/shr/shell_win_spec.rb
 - spec/lib/shr/which_spec.rb
 - spec/lib/shr_spec.rb
 - spec/spec_helper.rb