simple_shell 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rcov (0.9.10)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Hartog C. de Mik
+
+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.rdoc

@@ -0,0 +1,19 @@
+= simple_shell
+
+Description goes here.
+
+== Contributing to simple_shell
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Hartog C. de Mik. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple_shell"
+  gem.homepage = "http://github.com/coffeeaddict/simple_shell"
+  gem.license = "MIT"
+  gem.summary = %Q{A very simple shell operations gem}
+  gem.description = %Q{A very simple, smart & elegant shell operations gem}
+  gem.email = "hartog@organisedminds.com"
+  gem.authors = ["Hartog C. de Mik"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_shell #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/simple_shell.rb

@@ -0,0 +1,145 @@
+require 'open3'
+
+# A very simple shell operations implementation
+#
+# == Synopsis
+#
+#  shell = SimpleShell.new
+#  res = shell.ls
+#  puts res.out
+#  puts res.err
+#  puts res.S?  (as $? wont work :->)
+#
+#  commands = shell.in("/other/path") do |sh|
+#    sh.ls
+#    sh.rm "-r", "bar"
+#  end
+#  puts commands.first.out
+#
+class SimpleShell
+  attr_reader :commands
+
+  def self.noisy
+    @noisy ||= false
+  end
+
+  def self.noisy=(noise)
+    @noisy = noise
+  end
+
+  # Create a new shell instance. This is tied to a base dir, which defaults to
+  # Dir.pwd
+  #
+  #   SimpleShell.new
+  #   SimpleShell.new("/path/to/base")
+  #
+  def initialize(base=Dir.pwd)
+    @base     = base
+    @commands = []
+  end
+
+  # open up a sub shell at another directory
+  #
+  #  shell.in("/path/to/other") do |sub_shell|
+  #    sub_shell.system("ls")
+  #    sub_shell.in("/path/to/third") do |sub_sub_shell|
+  #      ...
+  #   end
+  #
+  def in(dir, &block)
+    dir = File.join(@base, dir) if !File.exists?(dir) || dir !~ /^\//
+
+    shell = SimpleShell.new(dir)
+    yield shell
+    return shell.commands
+  end
+
+  # perform a command on the shell
+  #
+  #   shell.system("ls")
+  #   shell.do("ls")
+  #   shell.command("ls")
+  #
+  # It is expected that arguments are provided as an array for security/safety
+  # purposes:
+  #
+  #   shell.system("rm", "-r", "-f", "foo/")
+  #
+  # Returns a Command instance
+  #
+  def system(*args, &block)
+    command = nil
+    Dir.chdir(@base) do
+      command = Command.new(@base)
+      command.execute(*args, &block)
+    end
+
+    @commands << command
+
+    return command
+  end
+  alias_method :do, :system
+  alias_method :command, :system
+
+  # the S? of the last command
+  def S?
+    @commands.last.S?
+  end
+
+  # funkyness for neat little shell access
+  #
+  #   shell.ls              # = shell.system("ls")
+  #   shell.rm %w(-rf foo/) # = shell.system("rm", "-rf", "foo/")
+  #
+  def method_missing(name, *args, &block)
+    super
+  rescue NoMethodError => e
+    if args[0].is_a? Array
+      args = args[0]
+    end
+
+    self.do(name.to_s, *args, &block)
+  end
+
+  # A command and it's output
+  #
+  # stdout and stderr are
+  class Command
+    attr_reader :out, :err, :S
+
+    def initialize(base)
+      @base = base
+      @out = ""
+      @err = ""
+      @S   = -1
+    end
+
+    def execute(command, *args, &block)
+      $stderr.puts("#{command}, #{args}, #{@base}") if SimpleShell.noisy
+
+      Open3.popen3("#{command}", *(args.collect { |a| "#{a}" }) , :chdir => @base) do |stdin, stdout, stderr, thread|
+        if block_given?
+          yield stdin
+        end
+
+        stdin.close
+
+        # TODO : perhaps use blocks to put stuff into stdin
+
+        @out = stdout.read.chomp
+        @err = stderr.read.chomp
+        @S   = thread.value rescue 0
+      end
+    end
+
+    # cheap copy of $?
+    def S?
+      @S
+    end
+
+    # we just want to know the output of the command
+    def to_s
+      @out
+    end
+  end
+end

data/simple_shell.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "simple_shell"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hartog C. de Mik"]
+  s.date = "2012-02-01"
+  s.description = "A very simple, smart & elegant shell operations gem"
+  s.email = "hartog@organisedminds.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/simple_shell.rb",
+    "simple_shell.gemspec",
+    "spec/simple_shell_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/coffeeaddict/simple_shell"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A very simple shell operations gem"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/simple_shell_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SimpleShell do
+  let (:shell) { SimpleShell.new }
+
+  it "should keep track of perfomed commands" do
+    shell.ls
+    shell.ls
+
+    shell.commands.count.should == 2
+  end
+
+  it "should remember the last exit status" do
+    shell.ls "/path/non/existant"
+    shell.S?.to_i.should_not == 0
+
+    shell.ls
+    shell.S?.to_i.should == 0
+  end
+
+  it "should perform system commands" do
+    c = shell.system("ls -la")
+
+    c.out.should_not be_empty
+    c.err.should be_empty
+    c.S?.to_i.should == 0
+  end
+
+  it "should allow a sub shell" do
+    shell.ls
+    shell.ls
+
+    commands = shell.in("/tmp") do |sub|
+      sub.ls
+    end
+
+    commands.should be_kind_of(Array)
+    commands.count.should == 1
+
+    shell.commands.count.should == 2
+  end
+
+  it "should allow a sub shell with relative paths" do
+    shell.mkdir "-p", "here"
+    shell.in("here") do |sh|
+      sh.do :touch, "here_file"
+    end
+
+    shell.ls("here").out.split("\n").should include("here_file")
+    shell.rm "-rf", "here"
+  end
+
+
+  it "should use blocks to write on stdin" do
+    res = shell.wc("-w") do |pipe|
+      pipe.puts "I was echoed"
+    end
+
+    res.out.should == "3"
+  end
+
+  it "should be settable to noisy" do
+    SimpleShell.noisy = true
+    SimpleShell.noisy.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'simple_shell'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: simple_shell
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Hartog C. de Mik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &89298180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *89298180
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &89297920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *89297920
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &89297670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *89297670
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &89297410 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *89297410
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &89297110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *89297110
+description: A very simple, smart & elegant shell operations gem
+email: hartog@organisedminds.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple_shell.rb
+- simple_shell.gemspec
+- spec/simple_shell_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/coffeeaddict/simple_shell
+licenses:
+- MIT
+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: 701496477
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A very simple shell operations gem
+test_files: []