sus 0.6.2 → 0.8.1

data/lib/sus/mock.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Copyright, 2022, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'expect'
+
+module Sus
+	class Mock
+		def initialize(target)
+			@target = target
+			@interceptor = Module.new
+			
+			@target.singleton_class.prepend(@interceptor)
+		end
+		
+		attr :target
+		
+		def print(output)
+			output.write("mock ", :context, @target.inspect)
+		end
+		
+		def clear
+			@interceptor.instance_methods.each do |method_name|
+				@interceptor.remove_method(method_name)
+			end
+		end
+		
+		def replace(method, &hook)
+			execution_context = Thread.current
+
+			@interceptor.define_method(method) do |*arguments, **options, &block|
+				if execution_context == Thread.current
+					hook.call(*arguments, **options, &block)
+				else
+					super(*arguments, **options, &block)
+				end
+			end
+			
+			return self
+		end
+		
+		def before(method, &hook)
+			execution_context = Thread.current
+
+			@interceptor.define_method(method) do |*arguments, **options, &block|
+				hook.call(*arguments, **options, &block) if execution_context == Thread.current
+				super(*arguments, **options, &block)
+			end
+
+			return self
+		end
+
+		def after(method, &hook)
+			execution_context = Thread.current
+
+			@interceptor.define_method(method) do |*arguments, **options, &block|
+				result = super(*arguments, **options, &block)
+				hook.call(result, *arguments, **options, &block) if execution_context == Thread.current
+				return result
+			end
+
+			return self
+		end
+	end
+
+	module Mocks
+		def after
+			super
+			
+			@mocks&.each_value(&:clear)
+		end
+		
+		def mock(target)
+			validate_mock!(target)
+
+			mock = self.mocks[target]
+
+			if block_given?
+				yield mock
+			end
+
+			return mock
+		end
+		
+		private
+		
+		MockTargetError = Class.new(StandardError)
+
+		def validate_mock!(target)
+			if target.frozen?
+				raise MockTargetError, "Cannot mock frozen object #{target.inspect}!"
+			end
+		end
+
+		def mocks
+			@mocks ||= Hash.new{|h,k| h[k] = Mock.new(k)}.compare_by_identity
+		end
+	end
+
+	class Base
+		def mock(target, &block)
+			# Pull in the extra functionality:
+			self.singleton_class.prepend(Mocks)
+
+			# Redirect the method to the new functionality:
+			self.mock(target, &block)
+		end
+	end
+end

data/lib/sus/output/buffered.rb

@@ -27,34 +27,32 @@ module Sus
 	# Styled output output.
 	module Output
 		class Buffered
-			def initialize(output)
-				@output = output
-				@buffer = Array.new
+			def initialize
+				@output = Array.new
 			end
 			
 			attr :output
-			attr :buffer
 			
-			def append(output)
-				@buffer.each do |operation|
-					output.public_send(*operation)
-				end
+			def each(&block)
+				@output.each(&block)
+			end
+			
+			def append(buffer)
+				@output.concat(buffer.output)
 			end
 			
 			def string
 				io = StringIO.new
-				append(Text.new(io))
+				Text.new(io).append(@output)
 				return io.string
 			end
 			
 			def indent
-				@buffer << [:indent]
-				@output.indent
+				@output << [:indent]
 			end
 			
 			def outdent
-				@buffer << [:outdent]
-				@output.outdent
+				@output << [:outdent]
 			end
 			
 			def indented
@@ -65,13 +63,11 @@ module Sus
 			end
 			
 			def write(*arguments)
-				@output.write(*arguments)
-				@buffer << [:write, *arguments]
+				@output << [:write, *arguments]
 			end
 			
 			def puts(*arguments)
-				@output.puts(*arguments)
-				@buffer << [:puts, *arguments]
+				@output << [:puts, *arguments]
 			end
 		end
 	end

data/lib/sus/output/lines.rb

@@ -76,6 +76,7 @@ module Sus
 				offset = @current_count - index
 				
 				@output.write("\e[#{offset}F\e[K")
+				
 				soft_wrap do
 					line.print(@output)
 				end

data/lib/sus/output/null.rb

@@ -29,6 +29,9 @@ module Sus
 		class Null
 			def initialize
 			end
+			
+			def append(buffer)
+			end
 
 			def indent
 			end

data/lib/sus/output/progress.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'bar'
+require_relative 'status'
+require_relative 'lines'
+
+module Sus
+	module Output
+		class Progress
+			def self.now
+				::Process.clock_gettime(Process::CLOCK_MONOTONIC)
+			end
+			
+			def initialize(output, total = 0, minimum_output_duration: 1.0)
+				@output = output
+				@subject = subject
+				
+				@start_time = Progress.now
+				
+				if @output.interactive?
+					@bar = Bar.new
+					@lines = Lines.new(@output)
+					@lines[0] = @bar
+				end
+				
+				@current = 0
+				@total = total
+			end
+			
+			attr :subject
+			attr :current
+			attr :total
+			
+			def duration
+				Progress.now - @start_time
+			end
+			
+			def progress
+				@current.to_f / @total.to_f
+			end
+			
+			def remaining
+				@total - @current
+			end
+			
+			def average_duration
+				if @current > 0
+					duration / @current
+				end
+			end
+			
+			def estimated_remaining_time
+				if average_duration = self.average_duration
+					average_duration * remaining
+				end
+			end
+			
+			# Increase the amont of work done.
+			def increment(amount = 1)
+				@current += amount
+				
+				@bar&.update(@current, @total, self.to_s)
+				@lines&.redraw(0)
+				
+				return self
+			end
+			
+			# Increase the total size of the progress.
+			def expand(amount = 1)
+				@total += amount
+				
+				@bar&.update(@current, @total, self.to_s)
+				@lines&.redraw(0)
+				
+				return self
+			end
+			
+			def report(index, context, state)
+				@lines&.[]=(index+1, Status.new(state, context))
+				
+				return self
+			end
+			
+			def clear
+				@lines&.clear
+			end
+			
+			def to_s
+				if estimated_remaining_time = self.estimated_remaining_time
+					"#{@current}/#{@total} completed in #{formatted_duration(self.duration)}, #{formatted_duration(estimated_remaining_time)} remaining"
+				else
+					"#{@current}/#{@total} completed"
+				end
+			end
+			
+			private
+			
+			def formatted_duration(duration)
+				seconds = duration.floor
+				
+				if seconds < 60.0
+					return "#{seconds}s"
+				end
+				
+				minutes = (duration / 60.0).floor
+				seconds = (seconds - (minutes * 60)).round
+				
+				if minutes < 60.0
+					return "#{minutes}m#{seconds}s"
+				end
+				
+				hours = (minutes / 60.0).floor
+				minutes = (minutes - (hours * 60)).round
+				
+				if hours < 24.0
+					return "#{hours}h#{minutes}m"
+				end
+				
+				days = (hours / 24.0).floor
+				hours = (hours - (days * 24)).round
+				
+				return "#{days}d#{hours}h"
+			end
+		end
+	end
+end

data/lib/sus/output/text.rb

@@ -35,6 +35,14 @@ module Sus
 				@styles[:indent] = @indent
 			end
 			
+			def append(buffer)
+				buffer.each do |operation|
+					self.public_send(*operation)
+				end
+			end
+			
+			attr :io
+			
 			INDENTATION = "\t"
 			
 			def indent

data/lib/sus/output.rb

@@ -4,6 +4,7 @@ require_relative 'output/text'
 require_relative 'output/xterm'
 
 require_relative 'output/null'
+require_relative 'output/progress'
 
 module Sus
 	module Output
@@ -35,7 +36,7 @@ module Sus
 		end
 		
 		def self.buffered
-			Buffered.new(Null.new)
+			Buffered.new
 		end
 	end
 end

data/lib/sus/raise_exception.rb

@@ -12,17 +12,12 @@ module Sus
 					
 					# Didn't throw any exception, so the expectation failed:
 					assertions.assert(false, self)
-				rescue => exception
-					# Did we throw the right kind of exception?
-					if exception.is_a?(@exception_class)
-						# Did it have the right message?
-						if @message
-							assertions.assert(@message === exception.message)
-						else
-							assertions.assert(true, self)
-						end
+				rescue @exception_class => exception
+					# Did it have the right message?
+					if @message
+						assertions.assert(@message === exception.message)
 					else
-						raise
+						assertions.assert(true, self)
 					end
 				end
 			end

data/lib/sus/receive.rb

@@ -0,0 +1,147 @@
+
+require_relative 'respond_to'
+
+module Sus
+	class Receive
+		CALL_ORIGINAL = Object.new
+
+		def initialize(base, method)
+			@base = base
+			@method = method
+			
+			@times = Once.new
+			@arguments = nil
+			@options = nil
+			@block = nil
+			@returning = CALL_ORIGINAL
+		end
+		
+		def print(output)
+			output.write("receive ", :variable, @method.to_s, :reset, " ")
+		end
+		
+		def with_arguments(*arguments)
+			@arguments = WithArguments.new(arguments)
+			return self
+		end
+
+		def with_options(*options)
+			@options = WithOptions.new(options)
+			return self
+		end
+
+		def with_block
+			@block = WithBlock.new
+			return self
+		end
+
+		def and_return(*returning)
+			if returning.size == 1
+				@returning = returning.first
+			else
+				@returning = returning
+			end
+			return self
+		end
+		
+		def validate(mock, assertions, arguments, options, block)
+			@arguments.call(assertions, arguments) if @arguments
+			@options.call(assertions, options) if @options
+			@block.call(assertions, block) if @block
+		end
+		
+		def call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				mock = @base.mock(subject)
+			
+				called = 0
+
+				if call_original?
+					mock.before(@method) do |*arguments, **options, &block|
+						called += 1
+
+						validate(mock, assertions, arguments, options, block)
+					end
+				else
+					mock.replace(@method) do |*arguments, **options, &block|
+						called += 1
+
+						validate(mock, assertions, arguments, options, block)
+
+						next @returning
+					end
+				end
+
+				assertions.defer do
+					@times.call(assertions, called)
+				end
+			end
+		end
+		
+		def call_original?
+			@returning == CALL_ORIGINAL
+		end
+		
+		class WithArguments
+			def initialize(arguments)
+				@arguments = arguments
+			end
+			
+			def print(output)
+				output.write("with arguments ", :variable, @arguments.inspect)
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					Expect.new(assertions, subject).to(Be == @arguments)
+				end
+			end
+		end
+
+		class WithOptions
+			def initialize(options)
+				@options = options
+			end
+			
+			def print(output)
+				output.write("with options ", :variable, @options.inspect)
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					Expect.new(assertions, subject).to(Be.new(:include?, @options))
+				end
+			end
+		end
+		
+		class WithBlock
+			def print(output)
+				output.write("with block")
+			end
+
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					Expect.new(assertions, subject).not.to(Be == nil)
+				end
+			end
+		end
+
+		class Once
+			def print(output)
+				output.write("once")
+			end
+
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					Expect.new(assertions, subject).to(Be == 1)
+				end
+			end
+		end
+	end
+	
+	class Base
+		def receive(method)
+			Receive.new(self, method)
+		end
+	end
+end

data/lib/sus/respond_to.rb

@@ -0,0 +1,89 @@
+module Sus
+	class RespondTo
+		class WithParameters
+			# @parameter [Array(Symbol)] List of method parameters in the expected order, must include at least all required parameters but can also list optional parameters.
+			def initialize(parameters)
+				@parameters = parameters
+			end
+			
+			def call(assertions, subject)
+				parameters = @parameters.dup
+				
+				assertions.nested(self) do |assertions|
+					expected_name = parameters.shift
+					
+					subject.each do |type, name|
+						case type
+						when :req
+							assertions.assert(name == expected_name, "parameter #{expected_name} is required, but was #{name}")
+						when :opt
+							break if expected_name.nil?
+							assertions.assert(name == expected_name, "parameter #{expected_name} is specified, but was #{name}")
+						else
+							break
+						end
+					end
+				end
+			end
+		end
+		
+		class WithOptions
+			def initialize(options)
+				@options = options
+			end
+						
+			def print(output)
+				output.write("with options ", :variable, @options.inspect)
+			end
+			
+			def call(assertions, subject)
+				options = {}
+				@options.each{|name| options[name] = nil}
+				
+				subject.each do |type, name|
+					options[name] = type					
+				end
+				
+				assertions.nested(self) do |assertions|
+					options.each do |name, type|
+						assertions.assert(type != nil, "option #{name}: is required")
+					end
+				end
+			end
+		end
+		
+		def initialize(method)
+			@method = method
+			@parameters = nil
+			@options = nil
+		end
+		
+		def with_options(*options)
+			@options = WithOptions.new(options)
+			return self
+		end
+		
+		def print(output)
+			output.write("respond to ", :variable, @method.to_s)
+		end
+		
+		def call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				condition = subject.respond_to?(@method)
+				assertions.assert(condition, self)
+				
+				if condition and (@parameters or @options)
+					parameters = subject.method(@method).parameters
+					@parameters.call(assertions, parameters) if @parameters
+					@options.call(assertions, parameters) if @options
+				end
+			end
+		end
+	end
+	
+	class Base
+		def respond_to(method)
+			RespondTo.new(method)
+		end
+	end
+end

data/lib/sus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sus
-	VERSION = "0.6.2"
+	VERSION = "0.8.1"
 end

data/lib/sus.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'sus/version'
+require_relative 'sus/config'
 require_relative 'sus/registry'
 require_relative 'sus/assertions'
 
@@ -8,6 +9,9 @@ require_relative 'sus/expect'
 require_relative 'sus/be'
 require_relative 'sus/be_within'
 
+require_relative 'sus/mock'
+require_relative 'sus/receive'
+
 require_relative 'sus/raise_exception'
 require_relative 'sus/have_duration'