sus 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1df466d84d494d20a673f838f968b1d89456928dfea7a9ca7b72f50d3675345
-  data.tar.gz: 0277ccbe0791b8c0e78e0301a9bd73704eb46177754710d516baf6e77a7fa125
+  metadata.gz: fd31357ac07052a2e6c93a7dc674d2245a567644434eaf8e1983dedd7f594be7
+  data.tar.gz: c33ba038edd7f9c22896a6e3c4b8fe7f8880d4c0e8361c3d44cbd74bba35939f
 SHA512:
-  metadata.gz: 16b55cb766a2ab965d0e5cf136d448b3bfb2978d72761ef39e78379f40cd947769c26208e831ed8ea6432e6d902e01a9e1b69b391074758f7341b921d2b66e12
-  data.tar.gz: c1e44c881562220f893067320d07f0a71f2906b8867bc6162a5618b534bbcc571cf693ead8152e854595141f6d7d93d4cb242c10b97de643f92be8bdc153b43f
+  metadata.gz: bfcd742a489b8ec128cd79ab6d631b1ba6bc45421563eeec51acb476648bc5bb821dc5fccbf0530032e5075879c8271a1be0981825e444d0893a407ca6ebb6fa
+  data.tar.gz: 6014eff61f90083dbf9210faf64d2c7fec25c67cc8e0afa1721f20d3d730f7d8feea22c36e0db308b5712fea9b5a75433bd01785c0bea5eeb20bdb9a3ac5d7e4

data/lib/sus/be.rb

@@ -11,7 +11,7 @@ module Sus
 		
 		def call(assertions, subject)
 			assertions.nested(self) do |assertions|
-				assertions.assert(subject.public_send(*@arguments), self)
+				assertions.assert(subject.public_send(*@arguments), subject)
 			end
 		end
 		

data/lib/sus/be_within.rb

@@ -0,0 +1,53 @@
+
+module Sus
+	class BeWithin
+		class Bounded
+			def initialize(range)
+				@range = range
+			end
+			
+			def print(output)
+				output.write("be within ", :variable, @range)
+			end
+			
+			def call(assertions, subject)
+				assertions.nested(self) do |assertions|
+					assertions.assert(@range.include?(subject), subject)
+				end
+			end
+		end
+		
+		def initialize(tolerance)
+			@tolerance = tolerance
+		end
+		
+		def of(value)
+			Bounded.new(Range.new(value - @tolerance, value + @tolerance))
+		end
+		
+		def percent_of(value)
+			of(value * Rational(@tolerance, 100))
+		end
+		
+		def print(output)
+			output.write("be within ", :variable, @tolerance)
+		end
+		
+		def call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				assertions.assert(subject < @tolerance, self)
+			end
+		end
+	end
+	
+	class Base
+		def be_within(value)
+			case value
+			when Range
+				BeWithin::Bounded.new(value)
+			else
+				BeWithin.new(value)
+			end
+		end
+	end
+end

data/lib/sus/describe.rb

@@ -11,12 +11,12 @@ module Sus
 			base.children = Hash.new
 		end
 		
-		def self.build(parent, subject, identity: nil, &block)
+		def self.build(parent, subject, unique: true, &block)
 			base = Class.new(parent)
 			base.extend(Describe)
 			base.subject = subject
-			base.description = subject.inspect
-			base.identity = identity || Identity.nested(parent.identity, base.description)
+			base.description = subject.to_s
+			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
 			base.define_method(:subject, ->{subject})
 			
 			if block_given?
@@ -35,8 +35,8 @@ module Sus
 	end
 	
 	module Context
-		def describe(...)
-			add Describe.build(self, ...)
+		def describe(subject, **options, &block)
+			add Describe.build(self, subject, **options, &block)
 		end
 	end
 end

data/lib/sus/expect.rb

@@ -30,59 +30,11 @@ module Sus
 			
 			return self
 		end
-		
-		def to_throw(...)
-			predicate = ThrowException.new(...)
-			
-			@assertions.nested(self, inverted: @inverted) do |assertions|
-				predicate.call(assertions, @subject)
-			end
-			
-			return self
-		end
 	end
 	
 	class Base
-		def expect(subject)
-			Expect.new(@assertions, subject)
-		end
-	end
-	
-	class ThrowException
-		def initialize(exception_class, message = nil)
-			@exception_class = exception_class
-			@message = message
-		end
-		
-		def call(assertions, value)
-			assertions.nested(self) do |assertions|
-				begin
-					value.call
-					
-					# 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
-					else
-						raise
-					end
-				end
-			end
-		end
-		
-		def print(output)
-			output << "throw exception " << output.style(@exception_class, :variable)
-			
-			if @message
-				output << "with message " << output.style(@message, :variable)
-			end
+		def expect(subject = nil, &block)
+			Expect.new(@assertions, subject || block)
 		end
 	end
 end

data/lib/sus/file.rb

@@ -0,0 +1,34 @@
+
+require_relative 'context'
+
+# This has to be done at the top level. It allows us to define constants within the given class while still retaining top-level constant resolution.
+Sus::TOPLEVEL_CLASS_EVAL = ->(klass, path){klass.class_eval(::File.read(path), path)}
+
+module Sus
+	module File
+		extend Context
+		
+		attr_accessor :path
+		
+		def self.extended(base)
+			base.children = Hash.new
+		end
+		
+		def self.build(parent, path)
+			base = Class.new(parent)
+			base.extend(File)
+			base.description = path
+			base.identity = Identity.new(path)
+			
+			TOPLEVEL_CLASS_EVAL.call(base, path)
+			
+			return base
+		end
+	end
+	
+	module Context
+		def file(path)
+			add File.build(self, path)
+		end
+	end
+end

data/lib/sus/filter.rb

@@ -16,7 +16,13 @@ module Sus
 			end
 			
 			def insert(identity, context)
-				@contexts[identity.key] = context
+				key = identity.key
+				
+				if @contexts[key]
+					raise KeyError, "Assigning context to existing key: #{key.inspect}!"
+				else
+					@contexts[key] = context
+				end
 			end
 			
 			def [] key

data/lib/sus/have_duration.rb

@@ -0,0 +1,41 @@
+
+module Sus
+	class HaveDuration
+		def initialize(predicate)
+			@predicate = predicate
+		end
+		
+		def print(output)
+			output.write("have duration ")
+			@predicate.print(output)
+		end
+		
+		def call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				duration = measure(subject)
+				
+				@predicate.call(assertions, duration)
+			end
+		end
+		
+		private
+		
+		def measure(subject)
+			start_time = now
+			
+			subject.call
+			
+			return now - start_time
+		end
+		
+		def now
+			::Process.clock_gettime(Process::CLOCK_MONOTONIC)
+		end
+	end
+	
+	class Base
+		def have_duration(...)
+			HaveDuration.new(...)
+		end
+	end
+end

data/lib/sus/identity.rb

@@ -7,6 +7,7 @@ module Sus
 			self.new(location.path, name, location.lineno, parent, **options)
 		end
 		
+		# @parameter unique [Boolean | Symbol] Whether this identity is unique or needs a unique key/line number suffix.
 		def initialize(path, name = nil, line = nil, parent = nil, unique: true)
 			@path = path
 			@name = name
@@ -55,7 +56,7 @@ module Sus
 			unless @key
 				key = Array.new
 				
-				append_unique_key(key, false)
+				append_unique_key(key)
 				
 				@key = key.join(':')
 			end
@@ -65,15 +66,21 @@ module Sus
 		
 		protected
 		
-		def append_unique_key(key, unique = @unique)
+		def append_unique_key(key)
 			if @parent
 				@parent.append_unique_key(key)
 			else
 				key << @path
 			end
 			
-			if @line
-				key << @line unless unique
+			if @unique == true
+				# No key is needed because this identity is unique.
+			else
+				if @unique
+					key << @unique
+				elsif @line
+					key << @line
+				end
 			end
 		end
 	end

data/lib/sus/it.rb

@@ -7,7 +7,7 @@ module Sus
 			base = Class.new(parent)
 			base.extend(It)
 			base.description = description
-			base.identity = Identity.nested(parent.identity, base.description)
+			base.identity = Identity.nested(parent.identity, base.description, unique: false)
 			
 			if block_given?
 				base.define_method(:call, &block)

data/lib/sus/it_behaves_like.rb

@@ -11,11 +11,11 @@ module Sus
 			base.children = Hash.new
 		end
 		
-		def self.build(parent, shared)
+		def self.build(parent, shared, unique: false)
 			base = Class.new(parent)
 			base.extend(ItBehavesLike)
 			base.description = shared.name
-			base.identity = Identity.nested(parent.identity, base.description, unique: false)
+			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
 			base.class_exec(&shared.block)
 			return base
 		end
@@ -27,8 +27,8 @@ module Sus
 	end
 	
 	module Context
-		def it_behaves_like(shared)
-			add ItBehavesLike.build(self, shared)
+		def it_behaves_like(shared, **options)
+			add ItBehavesLike.build(self, shared, **options)
 		end
 	end
 end

data/lib/sus/progress.rb

@@ -78,8 +78,8 @@ module Sus
 		def increment(amount = 1)
 			@current += amount
 			
-			@bar.update(@current, @total, self.to_s)
-			@lines.redraw(0)
+			@bar&.update(@current, @total, self.to_s)
+			@lines&.redraw(0)
 			
 			return self
 		end
@@ -88,20 +88,20 @@ module Sus
 		def expand(amount = 1)
 			@total += amount
 			
-			@bar.update(@current, @total, self.to_s)
-			@lines.redraw(0)
+			@bar&.update(@current, @total, self.to_s)
+			@lines&.redraw(0)
 			
 			return self
 		end
 		
 		def report(index, context, state)
-			@lines[index+1] = Output::Status.new(state, context)
+			@lines&.[]=(index+1, Output::Status.new(state, context))
 			
 			return self
 		end
 		
 		def clear
-			@lines.clear
+			@lines&.clear
 		end
 		
 		def to_s

data/lib/sus/raise_exception.rb

@@ -0,0 +1,49 @@
+module Sus
+	class RaiseException
+		def initialize(exception_class = nil, message: nil)
+			@exception_class = exception_class
+			@message = message
+		end
+		
+		def call(assertions, subject)
+			assertions.nested(self) do |assertions|
+				begin
+					subject.call
+					
+					# 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
+					else
+						raise
+					end
+				end
+			end
+		end
+		
+		def print(output)
+			output.write("raise exception")
+			
+			if @exception_class
+				output.write(" ", :variable, @exception_class, :reset)
+			end
+			
+			if @message
+				output.write(" with message ", :variable, @message, :reset)
+			end
+		end
+	end
+	
+	class Base
+		def raise_exception(...)
+			RaiseException.new(...)
+		end
+	end
+end

data/lib/sus/registry.rb

@@ -1,6 +1,7 @@
 
 require_relative 'base'
 
+require_relative 'file'
 require_relative 'describe'
 require_relative 'with'
 
@@ -12,9 +13,6 @@ require_relative 'include_context'
 
 require_relative 'let'
 
-# This has to be done at the top level. It allows us to define constants within the given class while still retaining top-level constant resolution.
-TOPLEVEL_CLASS_EVAL = ->(klass, path){klass.class_eval(File.read(path), path)}
-
 module Sus
 	class Registry
 		# Create a top level scope with self as the instance:
@@ -25,9 +23,7 @@ module Sus
 		attr :base
 		
 		def load(path)
-			@base.describe(path, identity: Identity.new(path)) do
-				TOPLEVEL_CLASS_EVAL.call(self, path)
-			end
+			@base.file(path)
 		end
 		
 		def call(assertions = Assertions.default)

data/lib/sus/version.rb

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

data/lib/sus/with.rb

@@ -12,12 +12,12 @@ module Sus
 			base.children = Hash.new
 		end
 		
-		def self.build(parent, subject, variables, &block)
+		def self.build(parent, subject, variables, unique: true, &block)
 			base = Class.new(parent)
 			base.extend(With)
 			base.subject = subject
 			base.description = subject
-			base.identity = Identity.nested(parent.identity, base.description)
+			base.identity = Identity.nested(parent.identity, base.description, unique: unique)
 			base.variables = variables
 			
 			variables.each do |key, value|

data/lib/sus.rb

@@ -6,5 +6,9 @@ require_relative 'sus/assertions'
 
 require_relative 'sus/expect'
 require_relative 'sus/be'
+require_relative 'sus/be_within'
+
+require_relative 'sus/raise_exception'
+require_relative 'sus/have_duration'
 
 require_relative 'sus/filter'

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: sus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
 executables:
 - sus
+- sus-parallel
 extensions: []
 extra_rdoc_files: []
 files:
@@ -23,10 +24,13 @@ files:
 - lib/sus/assertions.rb
 - lib/sus/base.rb
 - lib/sus/be.rb
+- lib/sus/be_within.rb
 - lib/sus/context.rb
 - lib/sus/describe.rb
 - lib/sus/expect.rb
+- lib/sus/file.rb
 - lib/sus/filter.rb
+- lib/sus/have_duration.rb
 - lib/sus/identity.rb
 - lib/sus/include_context.rb
 - lib/sus/it.rb
@@ -41,6 +45,7 @@ files:
 - lib/sus/output/text.rb
 - lib/sus/output/xterm.rb
 - lib/sus/progress.rb
+- lib/sus/raise_exception.rb
 - lib/sus/registry.rb
 - lib/sus/shared.rb
 - lib/sus/version.rb
@@ -65,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.0.dev
 signing_key:
 specification_version: 4
 summary: A fast and scalable test runner.