simple_shell 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,9 +1,65 @@
-= simple_shell
+= SimpleShell
 
-Description goes here.
+A very simple, yet safe and sturdy wrapper around your shell.
+
+gives you stdout
+
+  shell = SimpleShell.new()
+  res = shell.ls
+  res.out
+  => a_file
+  b_file
+  c_file
+
+gives you stderr
+
+  res = shell.ls("/path/not/exists")
+  res.err
+  => "ls: cannot access /path/not/exists: No such file or directory"
+
+gives you exit value
+
+  res.S?
+  => #<Process::Status: pid 20743 exit 2>
+  shell.S?
+  => #<Process::Status: pid 20743 exit 2>
+
+gives you stdin
+
+  res = shell.sendmail("you@yourdomain.com") do |pipe|
+    pipe.puts message
+  end
+
+is tied to it's location
+
+  shell = SimpleShell.new("/tmp")
+  shell.ls
+  => # ... contents of tmp
+  shell.chdir "/home"
+  Errno::ENOENT:
+  Dir.chdir("/home")
+  shell.ls
+  => # ... still, contents of tmp
+
+provides you with a sub shell for location shifts
+
+  commands = shell.in("/home") do |sub|
+    sub.ls
+    sub.mkdir("joe")
+  end
+  commands.count
+  => 2
+  commands.last.S?
+  => #<Process::Status: pid 20760 exit 1>
+
+lets you specify the environment
+
+  shell = SimpleShell.new(Dir.pwd, { 'MY_ENV' => 'my env' })
+  shell.echo '${MY_ENV}'
+  => 'my env'
+
+== Contributing to SimpleShell
 
-== 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.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/simple_shell.rb

@@ -33,8 +33,14 @@ class SimpleShell
   #   SimpleShell.new
   #   SimpleShell.new("/path/to/base")
   #
-  def initialize(base=Dir.pwd)
+  def initialize(base=Dir.pwd, env={})
+    if base.is_a?(Hash)
+      env  = base
+      base = Dir.pwd
+    end
+
     @base     = base
+    @env      = env
     @commands = []
   end
 
@@ -49,7 +55,7 @@ class SimpleShell
   def in(dir, &block)
     dir = File.join(@base, dir) if !File.exists?(dir) || dir !~ /^\//
 
-    shell = SimpleShell.new(dir)
+    shell = SimpleShell.new(dir, @env)
     yield shell
     return shell.commands
   end
@@ -70,7 +76,7 @@ class SimpleShell
   def system(*args, &block)
     command = nil
     Dir.chdir(@base) do
-      command = Command.new(@base)
+      command = Command.new(@base, @env)
       command.execute(*args, &block)
     end
 
@@ -107,17 +113,19 @@ class SimpleShell
   class Command
     attr_reader :out, :err, :S
 
-    def initialize(base)
+    def initialize(base, env={})
       @base = base
+      @env  = env
+
       @out = ""
       @err = ""
       @S   = -1
     end
 
     def execute(command, *args, &block)
-      $stderr.puts("#{command}, #{args}, #{@base}") if SimpleShell.noisy
+      $stderr.puts("#{@env} #{command}, #{args}, #{@base}") if SimpleShell.noisy
 
-      Open3.popen3("#{command}", *(args.collect { |a| "#{a}" }) , :chdir => @base) do |stdin, stdout, stderr, thread|
+      Open3.popen3(@env, "#{command}", *(args.collect { |a| "#{a}" }) , :chdir => @base) do |stdin, stdout, stderr, thread|
         if block_given?
           yield stdin
         end

data/simple_shell.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "simple_shell"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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.date = "2012-02-06"
   s.description = "A very simple, smart & elegant shell operations gem"
   s.email = "hartog@organisedminds.com"
   s.extra_rdoc_files = [

data/spec/simple_shell_spec.rb

@@ -63,4 +63,12 @@ describe SimpleShell do
     SimpleShell.noisy = true
     SimpleShell.noisy.should be_true
   end
+
+  it "should allow for environment setting" do
+    shell = SimpleShell.new({ 'MY_ENV' => 'my environment' })
+    shell.printenv.out.should =~ /my environment/
+
+    shell = SimpleShell.new()
+    shell.printenv.out.should_not =~ /my environment/
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_shell
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-01 00:00:00.000000000Z
+date: 2012-02-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &89298180 !ruby/object:Gem::Requirement
+  requirement: &89359440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *89298180
+  version_requirements: *89359440
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &89297920 !ruby/object:Gem::Requirement
+  requirement: &89359170 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *89297920
+  version_requirements: *89359170
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &89297670 !ruby/object:Gem::Requirement
+  requirement: &89358920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *89297670
+  version_requirements: *89358920
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &89297410 !ruby/object:Gem::Requirement
+  requirement: &89358670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *89297410
+  version_requirements: *89358670
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &89297110 !ruby/object:Gem::Requirement
+  requirement: &89358390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *89297110
+  version_requirements: *89358390
 description: A very simple, smart & elegant shell operations gem
 email: hartog@organisedminds.com
 executables: []
@@ -101,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 701496477
+      hash: 737581693
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: