shr 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+TODO

data/Gemfile

@@ -0,0 +1,16 @@
+# -*- coding: utf-8; mode: ruby; -*-
+source "http://rubygems.org"
+
+def darwin_only(require_as)
+  RUBY_PLATFORM.include?('darwin') && require_as
+end
+
+group :development do
+  gem 'growl', :require => darwin_only('growl')
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9.1', :require => darwin_only('rb-fsevent')
+  gem 'rspec'
+end
+
+gem 'os'

data/Guardfile

@@ -0,0 +1,7 @@
+# -*- coding: utf-8; mode: ruby; -*-
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kukenko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+Shr
+====
+
+Description
+-----------
+Shr tries to make controlling subprocess easier in Ruby. It can be write
+a shell command as like a Ruby's method and captures subprocess's output.
+
+This is a port of Python's [sh](https://github.com/amoffat/sh).
+
+Installation
+------------
+TODO: Write installation here
+
+Usage
+-----
+TODO: Write usage instructions here
+
+License
+-------
+Released under the MIT License. See the [LICENCE][licence] file for further details.
+[license]: https://github.com/kukenko/shr/LICENSE.md

data/Rakefile

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

data/lib/shr.rb

@@ -0,0 +1,11 @@
+#coding: utf-8
+require 'shr/version'
+require 'shr/shell'
+
+module Shr
+  class << self
+    def shell
+      Shr::Shell.new
+    end
+  end
+end

data/lib/shr/option.rb

@@ -0,0 +1,46 @@
+#coding: utf-8
+
+module Shr
+  class Option
+    # xxx
+    def initialize
+      @stack = []
+    end
+
+    # xxx
+    # This method has not support Windows yet.
+    def parse(options)
+      options.each do |opt|
+        case opt
+        when String
+          unless opt.start_with? '-'
+            if @stack.last && @stack.last.start_with?('--')
+              @stack.push "#{@stack.pop}=#{opt}"
+            else
+              @stack.push opt
+            end
+          else
+            @stack.push opt
+          end
+        when Symbol
+          @stack.push << "-#{opt.length > 1 ? '-' : ''}#{opt}"
+        when Hash
+          opt.each do |k, v|
+            if v.eql?(true)
+              @stack.push << "-#{k.length > 1 ? '-' : ''}#{k}"
+            else
+              if k.length > 1
+                @stack << "--#{k}=#{v}"
+              else
+                @stack << "-#{k.length > 1 ? '-' : ''}#{k}" << v
+              end
+            end
+          end
+        when Fixnum
+          @stack.push << "-#{opt}"
+        end
+      end
+      @stack
+    end
+  end
+end

data/lib/shr/shell.rb

@@ -0,0 +1,107 @@
+#coding: utf-8
+require 'open3'
+require 'shr/option'
+require 'shr/which'
+
+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)
+        super
+      else
+        delay(command, args)
+        release { force } if name.to_s.end_with?('!') || @release
+        self
+      end
+    end
+
+    def to_s
+      capture { 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
+    end
+
+    def each
+      capture { force }
+      if filled?
+        block_given? ? @command_out.each { |ln| yield ln } : @command_out.each
+      end
+    end
+
+    def exitstatus
+      capture { force }
+      if @wait_thread
+        proc = @wait_thread.value
+        proc.exitstatus
+      end
+    end
+
+    def redirect_from(src)
+      capture { force(:redirect => { :in => src }) }
+      self
+    end
+
+    def redirect_to(dest)
+      release { force(:redirect => { :out => dest }) }
+    end
+
+    alias_method :<, :redirect_from
+    alias_method :>, :redirect_to
+
+    def filled?
+      @command_out && !@command_out.closed?
+    end
+
+    def command_line(name, args)
+      options = Option.new.parse(args).join(' ')
+      "#{name} #{options}".strip
+    end
+
+    def delay(name, args)
+      @promise << command_line(name, args)
+    end
+
+    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]
+      end
+
+      @promise.clear
+    end
+
+    private :filled?, :command_line, :delay, :force
+  end
+end

data/lib/shr/version.rb

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

data/lib/shr/which.rb

@@ -0,0 +1,45 @@
+#coding: utf-8
+require 'os'
+
+# The following code was referring to whichr.
+# whichr - https://github.com/rdp/whichr
+
+module Shr
+  class Which
+    @@path = ENV['PATH']
+    if OS.windows?
+      cwd = File::PATH_SEPARATOR + '.'
+      @@path += cwd
+    end
+
+    def self.exist?(program)
+      programs = add_extensions(program)
+
+      entries = paths.product(programs).map { |list| list.join '/' }
+      entries.find do |exe|
+        File.executable?(exe) && !File.directory?(exe)
+      end
+    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]
+      end
+    end
+
+    def self.paths
+      @@path.split(File::PATH_SEPARATOR).map! do |path|
+        OS.windows? ? path.gsub('\\', '/') : path
+      end
+    end
+
+    private_class_method :add_extensions, :paths
+  end
+end

data/shr.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["kukenko"]
+  gem.email         = ["m.kukenko@gmail.com"]
+  gem.description   = %q{Make controlling subprocess easier in Ruby.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/kukenko/shr"
+
+  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          = "shr"
+  gem.require_paths = ["lib"]
+  gem.version       = Shr::VERSION
+
+  gem.add_dependency "os"
+end

data/spec/lib/shr/option_spec.rb

@@ -0,0 +1,82 @@
+#coding: utf-8
+require 'spec_helper'
+
+module Shr
+  describe Option do
+    let(:opt) { Option.new }
+
+    it 'has the following methods' do
+      o = opt.methods
+      o.should include(:parse)
+    end
+
+    describe '#parse' do
+      shared_examples 'with short-form options' do
+        it 'parses correctly' do
+          opt.parse(options).should eq(['-o', 'page.html'])
+        end
+      end
+
+      shared_examples 'with long-form options' do
+        it 'parses correctly' do
+          opt.parse(options).should eq(['--shell=/bin/sh', '--silent'])
+        end
+      end
+
+      shared_examples 'with mixed options' do
+        it 'parses correctly' do
+          opt.parse(options).should eq(['-o', 'page.html', '--shell=/bin/sh', '--silent'])
+        end
+      end
+
+      describe String do
+        it_behaves_like 'with short-form options' do
+          let(:options) { ['-o', 'page.html'] }
+        end
+
+        it_behaves_like 'with long-form options' do
+          let(:options) { ['--shell', '/bin/sh', '--silent'] }
+        end
+
+        it_behaves_like 'with mixed options' do
+          let(:options) { ['-o', 'page.html', '--shell', '/bin/sh', '--silent'] }
+        end
+      end
+
+      describe Symbol do
+        it_behaves_like 'with short-form options' do
+          let(:options) { [:o, 'page.html'] }
+        end
+
+        it_behaves_like 'with long-form options' do
+          let(:options) { [:shell, '/bin/sh', :silent] }
+        end
+
+        it_behaves_like 'with mixed options' do
+          let(:options) { [:o, 'page.html', :shell, '/bin/sh', :silent] }
+        end
+      end
+
+      describe Hash do
+        it_behaves_like 'with short-form options' do
+          let(:options) { [{ :o => 'page.html' }] }
+        end
+
+        it_behaves_like 'with long-form options' do
+          let(:options) { [{ :shell => '/bin/sh', :silent => true }] }
+        end
+
+        it_behaves_like 'with mixed options' do
+          let(:options) { [{ :o => 'page.html', :shell => '/bin/sh', :silent => true }] }
+        end
+      end
+
+      describe Fixnum do
+        it 'parses short-form options' do
+          options = [1, 2, 3]
+          opt.parse(options).should eq(['-1', '-2', '-3'])
+        end
+      end
+    end
+  end
+end

data/spec/lib/shr/shell_spec.rb

@@ -0,0 +1,104 @@
+#coding: utf-8
+require 'spec_helper'
+require 'fileutils'
+require 'tempfile'
+require 'tmpdir'
+
+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)
+      m.should include(:<)
+      m.should include(:redirect_to)
+      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
+
+    context "command end with '!'" do
+      it 'executes OS commands' do
+        sh.touch! @tmpfile
+        File.should exist(@tmpfile)
+        FileUtils.rm @tmpfile
+      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
+        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
+
+    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)
+      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!
+      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!
+      end
+    end
+
+    after(:all) do
+      FileUtils.remove_entry_secure @tmpdir
+    end
+  end
+end

data/spec/lib/shr/which_spec.rb

@@ -0,0 +1,28 @@
+#coding: utf-8
+require 'spec_helper'
+
+module Shr
+  describe Which do
+    it 'has the following methods' do
+      m = Which.methods
+      m.should include(:exist?)
+      m.should include(:exists?)
+    end
+
+    describe '#exist?' do
+      it 'returns true if any of executables are found' do
+        Which.exist?(:pwd).should be_true
+      end
+
+      it 'returns false if any of executables are not found' do
+        Which.exist?(:not_found).should be_false
+      end
+
+      context 'with argument String' do
+        it 'returns true if any of executables are found' do
+          Which.exist?('pwd').should be_true
+        end
+      end
+    end
+  end
+end

data/spec/lib/shr_spec.rb

@@ -0,0 +1,15 @@
+#coding: utf-8
+require 'spec_helper'
+
+describe Shr do
+  it 'has the following methods' do
+    m = Shr.methods
+    m.should include(:shell)
+  end
+
+  describe '#shell' do
+    it 'returns an instance of Shr::Shell' do
+      Shr.shell.should be_kind_of(Shr::Shell)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+#coding: utf-8
+require 'shr'
+require 'shr/option'
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: shr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- kukenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: &70190202007440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70190202007440
+description: Make controlling subprocess easier in Ruby.
+email:
+- m.kukenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/shr.rb
+- lib/shr/option.rb
+- lib/shr/shell.rb
+- lib/shr/version.rb
+- lib/shr/which.rb
+- shr.gemspec
+- spec/lib/shr/option_spec.rb
+- spec/lib/shr/shell_spec.rb
+- spec/lib/shr/which_spec.rb
+- spec/lib/shr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kukenko/shr
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Make controlling subprocess easier in Ruby.
+test_files:
+- spec/lib/shr/option_spec.rb
+- spec/lib/shr/shell_spec.rb
+- spec/lib/shr/which_spec.rb
+- spec/lib/shr_spec.rb
+- spec/spec_helper.rb
+has_rdoc: