procession 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,16 @@
 # Procession
 
 Runs a [child process](https://github.com/jarib/childprocess) and blocks until it writes something specific to stdout. Terminates the child process at exit time.
+
+The following example blocks until __Server Started__ comes out of STDOUT as a result of executing __PORT=3455 /home/me/my\_project/bin/server__
+
+```ruby
+require 'procession'
+
+Procession::Process.new(
+  working_dir: '/home/me/my_project/bin',
+  command:     './server',
+  environment: { PORT: 3455 },
+  await:       /Server Started/
+).start
+```

data/lib/procession/process.rb

@@ -7,8 +7,9 @@ module Procession
       @await = options.delete(:await)
       @working_dir = options.delete(:working_dir)
       @environment = options.delete(:environment)
+      @inherit_output = options.delete(:inherit_output)
     end
-    
+
     def start
       args = @command.split(' ')
       @proc = ChildProcess.build(*args)
@@ -19,17 +20,17 @@ module Procession
       r, w = IO.pipe
 
       @proc.io.stdout = @proc.io.stderr = w
-    
+      @proc.leader = true
       @proc.start
       w.close
-    
+
       all_output = ""
-    
+
       begin
         started = false
         until started
           partial = r.readpartial(8192)
-          puts partial if ENV['CAPPIE_DEBUG']
+          puts partial if @inherit_output
           all_output << partial
           if (all_output =~ @await)
             started = true
@@ -38,20 +39,20 @@ module Procession
       rescue EOFError
         raise ProcessExitedError.new "The app process exited\nSTDOUT:\n#{all_output}"
       end
-      
+
       Thread.new do
         while true
           partial = r.readpartial(8192)
-          puts partial if ENV['CAPPIE_DEBUG']
+          puts partial if @inherit_output
         end
       end
-      
+
       at_exit do
         @proc.stop
       end
-      
+
       @proc.io.inherit!
-      
+
       @proc
     end
 
@@ -65,6 +66,6 @@ module Procession
       @proc.cwd = @working_dir unless @working_dir.nil?
     end
   end
-  
+
   class ProcessExitedError < RuntimeError; end
 end

data/lib/procession/version.rb

@@ -1,3 +1,3 @@
 module Procession
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/procession.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
 
   s.add_runtime_dependency 'childprocess', '>= 0.3.8'
-  
+
+  s.add_development_dependency 'rspec-core', '>= 3.1.0'
   s.add_development_dependency 'rspec-expectations', '>= 2.0.1'
   s.add_development_dependency 'rack', '>= 1.5.2'
 

data/spec/procession/example_app_with_child.rb

@@ -0,0 +1,4 @@
+child_app_path = File.expand_path("../example_child_app.rb", __FILE__)
+
+puts "Starting child app..."
+spawn("ruby", child_app_path)

data/spec/procession/example_child_app.rb

@@ -0,0 +1,10 @@
+# creates a file called delete_me.txt after 0.5s
+
+temp_filename = File.expand_path("../delete_me.txt", __FILE__)
+
+sleep 0.5
+
+File.open(temp_filename, 'w') do |f|
+  f.write("""This file is created by example_child_app.rb, which should
+             never actually happen, because the child process is killed.""")
+end

data/spec/procession/procession_spec.rb

@@ -3,23 +3,27 @@ require_relative '../../lib/procession/process'
 module Procession
 
   describe Process do
-  
+
     def example_app_path
       File.join(File.dirname(__FILE__), "example_app.rb")
     end
-    
+
+    def example_app_with_child_path
+      File.join(File.dirname(__FILE__), "example_app_with_child.rb")
+    end
+
     it 'runs a process and awaits some output' do
       process = Process.new(command: "ruby #{example_app_path}", await: /#{Dir.pwd}/).start
       process.should be_alive
       process.stop
     end
-    
+
     it 'sets environment variables' do
       process = Process.new(command: "ruby #{example_app_path}", environment: { FOO: 'omg' }, await: /omg/).start
       process.should be_alive
       process.stop
     end
-    
+
     it 'accepts a working directory' do
       dir = File.dirname(__FILE__)
       Dir.chdir dir do
@@ -29,14 +33,25 @@ module Procession
       end
     end
 
+    it 'kills the whole process tree' do
+      temp_path = File.join(File.dirname(__FILE__), "delete_me.txt")
+      File.delete(temp_path) if File.exist?(temp_path)
+      process = Process.new(command: "ruby #{example_app_with_child_path}",
+                              await: /Starting child app/).start
+      sleep 0.2
+      process.stop
+      sleep 0.4
+      expect(File.exist?(temp_path)).to be_false
+    end
+
     describe 'when the process exits' do
       it 'raises an exception with the stdout output' do
-        lambda {
+        expect(lambda {
           Process.new(command: 'pwd').start
-        }.should raise_error("The app process exited\nSTDOUT:\n#{Dir.pwd}\n")
+        }).to raise_error("The app process exited\nSTDOUT:\n#{Dir.pwd}\n")
       end
     end
-    
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: procession
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-28 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +88,8 @@ files:
 - lib/procession/version.rb
 - procession.gemspec
 - spec/procession/example_app.rb
+- spec/procession/example_app_with_child.rb
+- spec/procession/example_child_app.rb
 - spec/procession/procession_spec.rb
 homepage: http://github.com/featurist/procession
 licenses: []
@@ -97,5 +115,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: procession-0.0.1
+summary: procession-0.0.2
 test_files: []
+has_rdoc: