tty-process-ctl 0.4.0 → 0.5.0

data/Gemfile

@@ -1,10 +1,11 @@
 source "http://rubygems.org"
 
 group :development do
-  gem "rspec", "~> 2.8"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1"
-  gem "jeweler", "~> 1.8"
-  gem "simplecov", ">= 0"
-  gem "cli", "~> 1.0"
+	gem "rake", "~> 0.9"
+	gem "rspec", "~> 2.8"
+	gem "rdoc", "~> 3.12"
+	gem "bundler", "~> 1.1"
+	gem "jeweler", "~> 1.8"
+	gem "simplecov", ">= 0"
+	gem "cli", "~> 1.0"
 end

data/Gemfile.lock

@@ -11,6 +11,7 @@ GEM
       rdoc
     json (1.7.5)
     multi_json (1.3.6)
+    rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
     rspec (2.11.0)
@@ -33,6 +34,7 @@ DEPENDENCIES
   bundler (~> 1.1)
   cli (~> 1.0)
   jeweler (~> 1.8)
+  rake (~> 0.9)
   rdoc (~> 3.12)
   rspec (~> 2.8)
   simplecov

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/tty-process-ctl.rb

@@ -4,18 +4,43 @@ require 'pty'
 require 'io/console'
 
 class TTYProcessCtl
-	class Timeout < Timeout::Error
+	Timeout = Class.new(Timeout::Error)
+
+	class Listener
+		def initialize(&callback)
+			@callback = callback
+		end
+
+		def call(message)
+			@callback.call(message)
+		rescue LocalJumpError => error
+			# brake in listener
+			close if error.reason == :break
+		end
+
+		def on_close(&callback)
+			@on_close = callback unless closed?
+			self
+		end
+
+		def close
+			@on_close.call(self) if @on_close
+			@closed = true
+		end
+
+		def closed?
+			@closed
+		end
 	end
 
 	include Enumerable
 
 	def initialize(command, options = {})
-		@max_queue_length = options[:max_queue_length] || 4000
-		@max_messages = options[:max_messages] || 4000
+		@backlog_size = options[:backlog_size] || 4000
 		@command = command
 
+		@listeners = []
 		@out_queue = Queue.new
-		@messages = []
 
 		@r, @w, @pid = PTY.spawn(@command)
 		@w.echo = false # disable echoing of commands
@@ -47,18 +72,26 @@ class TTYProcessCtl
 		raise IOError.new("process '#{@command}' (pid: #{@pid}) not accepting input")
 	end
 
-	def messages
-		@messages
+	def on(regexp = nil, &callback)
+		# return listender to user so he can close it after use
+		listener do |message|
+			next if regexp and message !~ regexp
+			callback.call(message)
+		end
 	end
 
-	def each(options = {})
-		return enum_for(:each, options) unless block_given?
-		timeout(options[:timeout]) do
-			while !@out_queue.empty? or alive? do
-				yield (dequeue or break)
+	def each(options = {}, &block)
+		return enum_for(:each, options) unless block
+		listener = listener(&block)
+		begin
+			timeout(options[:timeout]) do
+				true while not listener.closed? and poll
 			end
+			self
+		ensure
+			# make sure we close the listener when each exits
+			listener.close
 		end
-		self
 	end
 
 	def each_until(pattern, options = {})
@@ -84,17 +117,25 @@ class TTYProcessCtl
 	end
 
 	def wait_exit(options = {})
-		each(options){}
+		poll!(options)
 		@thread.join
 		self
 	end
 
-	def flush
-		loop do
-			dequeue(true)
+	def poll(options = {})
+		timeout(options[:timeout]) do
+			return process_message
 		end
-		self
-	rescue ThreadError
+	end
+
+	def poll!(options = {})
+		timeout(options[:timeout]) do
+			true while process_message
+		end
+	end
+
+	def flush
+		true while process_message_no_block
 		self
 	end
 
@@ -108,17 +149,34 @@ class TTYProcessCtl
 		end
 	end
 
-	def dequeue(no_block = false)
+	def listener(&block)
+		listener = Listener.new(&block).on_close do |listener|
+			@listeners.delete(listener)
+		end
+		@listeners << listener
+		listener
+	end
+
+	def process_message_no_block
+		process_message(true)
+	rescue ThreadError
+		nil
+	end
+
+	def process_message(no_block = false)
+		return nil if not alive? and @out_queue.empty?
 		message = @out_queue.pop(no_block)
 		return nil unless message
-		@messages << message
-		@messages.pop while @messages.length > @max_messages
+		message.freeze
+		@listeners.each do |listener|
+			listener.call(message)
+		end
 		message
 	end
 
 	def enqueue_message(message)
 		@out_queue << message
-		@out_queue.pop while @out_queue.length > @max_queue_length
+		@out_queue.pop while @out_queue.length > @backlog_size
 	end
 
 	def enqueue_end

data/spec/tty-process-ctl_spec.rb

@@ -5,31 +5,45 @@ describe TTYProcessCtl do
 		TTYProcessCtl.new('spec/stub')
 	end
 
-	describe 'process output enumeration' do
-		subject do
-			TTYProcessCtl.new('spec/stub --exit')
-		end
+	after :each do
+		subject.send_command 'stop' if subject.alive?
+		subject.wait_exit
+	end
+
+	it 'should be Enumerable' do
+		subject.should respond_to :take
+		subject.take(2).should == ["151 recipes", "16 achievements"]
+	end
+
+	it 'should skip oldest messages if backlog queue is full' do
+		subject = TTYProcessCtl.new('spec/stub', backlog_size: 2)
 
+		subject.each_until(/Done/).to_a
+		subject.send_command 'help'
+		subject.send_command 'stop'
+
+		# fait for backlog to overflow
+		sleep 0.2
+
+		subject.each.to_a.should == [
+			"2011-09-19 22:12:00 [INFO] Saving chunks", 
+			"2011-09-19 22:12:00 [INFO] Saving chunks"
+		]
+	end
+
+	describe 'process output enumeration' do
 		it 'should allow iterating the output lines' do
+			subject.send_command 'stop'
 			lines_count = 0
 			subject.each do |line|
 				lines_count += 1
 			end
-			lines_count.should == 20
+			lines_count.should == 23
 		end
 		
 		it 'should allow iterating the output lines with enumerator' do
-			subject.each.to_a.length.should == 20
-		end
-
-		it 'should be Enumerable' do
-			subject.should respond_to :take
-			subject.take(2).should == ["151 recipes", "16 achievements"]
-		end
-
-		it 'should return nothing if iterating on dead process' do
-			subject.each.to_a.length.should == 20
-			subject.each.to_a.should be_empty
+			subject.send_command 'stop'
+			subject.each.to_a.length.should == 23
 		end
 
 		it 'should allow iteration until pattern is found in message' do
@@ -42,8 +56,132 @@ describe TTYProcessCtl do
 
 		it 'should allow waiting for message matching pattern' do
 			subject.wait_until(/NOT ENOUGH RAM/)
+			subject.send_command 'stop'
 			subject.each.to_a.first.should == "2011-09-10 12:58:55 [WARNING] To start the server with more ram, launch it as \"java -Xmx1024M -Xms1024M -jar minecraft_server.jar\""
 		end
+
+		it 'should return nothing if iterating on dead process' do
+			subject.send_command 'stop'
+			subject.each.to_a.length.should == 23
+			subject.should_not be_alive
+			subject.each.to_a.should be_empty
+		end
+
+		it 'should allow flushing backlog messages' do
+			subject.each_until(/SERVER IS RUNNING/).to_a
+			sleep 0.2
+
+			subject.flush
+
+			subject.send_command 'list'
+			subject.each_until(/Connected players/).to_a.should == ["2011-09-20 14:42:04 [INFO] Connected players: kazuya"]
+		end
+	end
+
+	describe 'on message callbacks' do
+		describe 'when enumerating' do
+			it 'should call on message callback' do
+				messages = []
+				subject.on do |message|
+					messages << message
+				end
+
+				subject.wait_until(/NOT ENOUGH RAM/)
+				messages.should == [
+					"151 recipes", 
+					"16 achievements", 
+					"2011-09-10 12:58:55 [INFO] Starting minecraft server version Beta 1.7.3", 
+					"2011-09-10 12:58:55 [WARNING] **** NOT ENOUGH RAM!"
+				]
+			end
+
+			it 'should call on message callback if given regexp matches the message' do
+				messages = []
+				subject.on(/recipes|achievements/) do |message|
+					messages << message
+				end
+
+				subject.wait_until(/NOT ENOUGH RAM/)
+				messages.should == [
+					"151 recipes", 
+					"16 achievements"
+				]
+			end
+		end
+
+		describe 'when polling' do
+			it 'should call on message callback' do
+				messages = []
+				subject.on do |message|
+					messages << message
+				end
+
+				subject.send_command 'stop'
+				subject.poll!(timeout: 1.0)
+
+				messages.length.should == 23
+			end
+
+			it 'should call on message callback if given regexp matches the message' do
+				messages = []
+				subject.on(/recipes|achievements/) do |message|
+					messages << message
+				end
+
+					subject.send_command 'stop'
+					subject.poll!(timeout: 1.0)
+
+				messages.should == [
+					"151 recipes", 
+					"16 achievements"
+				]
+			end
+		end
+
+		describe 'when flushing' do
+			it 'should call on message callback if given regexp matches the message' do
+				messages = []
+				subject.on(/recipes|achievements/) do |message|
+					messages << message
+				end
+
+				sleep 1.0
+				subject.flush
+
+				messages.should == [
+					"151 recipes", 
+					"16 achievements"
+				]
+			end
+		end
+
+		describe 'closing' do
+			it 'with close method on listener' do
+				counter = 0
+				listener = subject.on do
+					counter += 1
+				end
+
+				subject.poll
+				listener.close
+				subject.poll
+
+				counter.should == 1
+			end
+
+			it 'with break' do
+				counter = 0
+				subject.on do
+					counter += 1
+					break
+				end
+
+				subject.poll
+				subject.poll
+
+				counter.should == 1
+			end
+		end
 	end
 
 	describe 'sending commands' do
@@ -76,35 +214,6 @@ describe TTYProcessCtl do
 		end
 	end
 
-	describe 'messages' do
-		subject do
-			TTYProcessCtl.new('spec/stub --exit')
-		end
-
-		it 'should allow access to previously outputed messages' do
-			subject.each.to_a
-			subject.messages.length.should == 20
-		end
-
-		describe 'flushing' do
-			subject do
-				TTYProcessCtl.new('spec/stub')
-			end
-
-			it 'should allow flushing queued messages before iteration' do
-				subject.each_until(/SERVER IS RUNNING/).to_a
-				sleep 0.2
-
-				subject.flush
-
-				subject.send_command 'list'
-				subject.each_until(/Connected players/).to_a.should == ["2011-09-20 14:42:04 [INFO] Connected players: kazuya"]
-
-				subject.send_command 'stop'
-			end
-		end
-	end
-
 	describe 'process status query' do
 		it 'should allow querying if process is alive' do
 			subject.should be_alive
@@ -130,60 +239,34 @@ describe TTYProcessCtl do
 		end
 	end
 
-	describe 'limiting' do
-		it 'should allow defining maximum number of messages that can be queued' do
-			subject = TTYProcessCtl.new('spec/stub', max_queue_length: 2)
-
-			subject.each_until(/Done/).to_a
-			subject.send_command 'help'
-			subject.send_command 'stop'
-
-			sleep 0.2
-			subject.each.to_a.length.should == 2
-			subject.wait_exit
-		end
-
-		it 'should allow defining maximum number of messages that can be remembered' do
-			subject = TTYProcessCtl.new('spec/stub', max_messages: 2)
-
-			subject.each_until(/Done/).to_a
-			subject.send_command 'help'
-			subject.flush
-			subject.send_command 'stop'
-			subject.wait_exit
-
-			subject.messages.length.should == 2
-		end
-	end
-
 	describe 'timeout' do
-		after :each do
-			subject.send_command 'stop' if subject.alive?
-			subject.wait_exit
+		subject do
+			# wait for process to be ready and delay each message printout by 0.1 second
+			TTYProcessCtl.new('spec/stub --delay 0.01').wait_until(/151 recipes/, timeout: 1)
 		end
 
 		describe 'each calls with block' do
 			it 'should raise TTYProcessCtl::Timeout on timieout' do
 				expect {
-					subject.each(timeout: 0.1) {}
+					subject.each(timeout: 0.1){}
 				}.to raise_error TTYProcessCtl::Timeout
 
 				expect {
-					subject.each_until(/bogous/, timeout: 0.1) {}
+					subject.each_until(/bogous/, timeout: 0.1){}
 				}.to raise_error TTYProcessCtl::Timeout
 
 				expect {
-					subject.each_until_exclude(/bogous/, timeout: 0.1) {}
+					subject.each_until_exclude(/bogous/, timeout: 0.1){}
 				}.to raise_error TTYProcessCtl::Timeout
 			end
 
 			it 'should not raise error if they return before timeout' do
 				expect {
-					subject.each_until(/recipes/, timeout: 1) {}
+					subject.each_until(/achievements/, timeout: 1){}
 				}.to_not raise_error TTYProcessCtl::Timeout
 
 				expect {
-					subject.each_until_exclude(/achievements/, timeout: 1) {}
+					subject.each_until_exclude(/NOT ENOUGH RAM/, timeout: 1){}
 				}.to_not raise_error TTYProcessCtl::Timeout
 
 				expect {
@@ -209,11 +292,11 @@ describe TTYProcessCtl do
 
 			it 'should not raise error if they return before timeout' do
 				expect {
-					subject.each_until(/recipes/, timeout: 1).to_a
+					subject.each_until(/achievements/, timeout: 1).to_a
 				}.to_not raise_error TTYProcessCtl::Timeout
 
 				expect {
-					subject.each_until_exclude(/achievements/, timeout: 1).to_a
+					subject.each_until_exclude(/NOT ENOUGH RAM/, timeout: 1).to_a
 				}.to_not raise_error TTYProcessCtl::Timeout
 
 				expect {
@@ -248,17 +331,15 @@ describe TTYProcessCtl do
 	end
 
 	describe 'chaining' do
-		subject do
-			TTYProcessCtl.new('spec/stub --exit')
-		end
-
 		it 'should work with each methods' do
+			subject.send_command 'stop'
 			subject.each_until(/recipes/){}.should == subject
 			subject.each_until_exclude(/achievements/){}.should == subject
 			subject.each{}.should == subject
 		end
 		
 		it 'should work with wait methods' do
+			subject.send_command 'stop'
 			subject.wait_until(/Done/){}.should == subject
 			subject.wait_exit{}.should == subject
 		end

data/tty-process-ctl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "tty-process-ctl"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2012-11-18"
+  s.date = "2012-11-24"
   s.description = "This gem was created to enable control of interactive terminal applications. It is using pseudo tty to communicate with the process via simple API."
   s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [
@@ -44,6 +44,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["~> 0.9"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1"])
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<cli>, ["~> 1.0"])
     else
+      s.add_dependency(%q<rake>, ["~> 0.9"])
       s.add_dependency(%q<rspec>, ["~> 2.8"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.1"])
@@ -59,6 +61,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<cli>, ["~> 1.0"])
     end
   else
+    s.add_dependency(%q<rake>, ["~> 0.9"])
     s.add_dependency(%q<rspec>, ["~> 2.8"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.1"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tty-process-ctl
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70125546618580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70125546618580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70168846879920 !ruby/object:Gem::Requirement
+  requirement: &70125546616420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +32,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70168846879920
+  version_requirements: *70125546616420
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70168846879440 !ruby/object:Gem::Requirement
+  requirement: &70125546629980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70168846879440
+  version_requirements: *70125546629980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70168846878880 !ruby/object:Gem::Requirement
+  requirement: &70125546627680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70168846878880
+  version_requirements: *70125546627680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70168846878320 !ruby/object:Gem::Requirement
+  requirement: &70125546623080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: '1.8'
   type: :development
   prerelease: false
-  version_requirements: *70168846878320
+  version_requirements: *70125546623080
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70168846877760 !ruby/object:Gem::Requirement
+  requirement: &70125546577740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70168846877760
+  version_requirements: *70125546577740
 - !ruby/object:Gem::Dependency
   name: cli
-  requirement: &70168846877040 !ruby/object:Gem::Requirement
+  requirement: &70125546572940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +87,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70168846877040
+  version_requirements: *70125546572940
 description: This gem was created to enable control of interactive terminal applications.
   It is using pseudo tty to communicate with the process via simple API.
 email: jpastuszek@gmail.com
@@ -117,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1843831823515240226
+      hash: -3155130806959499412
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: