sus 0.1.0

data/lib/sus/output/null.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright, 2019, 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 'io/console'
+require 'stringio'
+
+module Sus
+	# Styled output output.
+	module Output
+		class Null
+			def initialize
+			end
+
+			def indent
+			end
+			
+			def outdent
+			end
+
+			def indented
+				yield
+			end
+			
+			def write(*arguments)
+				# Do nothing.
+			end
+			
+			def puts(*arguments)
+				# Do nothing.
+			end
+		end
+	end
+end

data/lib/sus/output/status.rb

@@ -0,0 +1,68 @@
+# 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.
+
+module Sus
+	module Output
+		class Status
+			def self.register(output)
+				output[:free] ||= output.style(:blue)
+				output[:busy] ||= output.style(:orange)
+			end
+			
+			def initialize(state = :free, context = nil)
+				@state = state
+				@context = context
+				@index = 0
+			end
+			
+			INDICATORS = {
+				busy: ['◑', '◒', '◐', '◓'],
+				free: ['◌']
+			}
+			
+			def update(state, context = nil)
+				@state = state
+				@context = context
+			end
+			
+			def indicator
+				if indicators = INDICATORS[@state]
+					return indicators[(Time.now.to_f * 10) % indicators.size]
+				end
+				
+				return " "
+			end
+			
+			def print(output)
+				message = @message
+				
+				output.write(
+					@state, self.indicator, " "
+				)
+				
+				output.write(@context)
+				
+				output.puts
+			end
+		end
+	end
+end

data/lib/sus/output/text.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# Copyright, 2019, 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 'io/console'
+require_relative 'buffered'
+
+module Sus
+	# Styled io io.
+	module Output
+		class Text
+			def initialize(io)
+				@io = io
+				@styles = {reset: self.reset}
+				
+				@indent = String.new
+				@styles[:indent] = @indent
+			end
+			
+			INDENTATION = "\t"
+			
+			def indent
+				@indent << INDENTATION
+			end
+			
+			def outdent
+				@indent.slice!(INDENTATION)
+			end
+			
+			def indented
+				self.indent
+				yield
+			ensure
+				self.outdent
+			end
+			
+			def interactive?
+				@io.tty?
+			end
+			
+			attr :io
+			
+			def [] key
+				@styles[key]
+			end
+			
+			def []= key, value
+				@styles[key] = value
+			end
+			
+			def size
+				[24, 80]
+			end
+			
+			def width
+				size.last
+			end
+			
+			def colors?
+				false
+			end
+			
+			def style(foreground, background = nil, *attributes)
+			end
+			
+			def reset
+			end
+			
+			# Print out the given arguments.
+			# When the argument is a symbol, look up the style and inject it into the io stream.
+			# When the argument is a proc/lambda, call it with self as the argument.
+			# When the argument is anything else, write it directly to the io.
+			def write(*arguments)
+				arguments.each do |argument|
+					case argument
+					when Symbol
+						@io.write(self[argument])
+					when Proc
+						argument.call(self)
+					else
+						if argument.respond_to?(:print)
+							argument.print(self)
+						else
+							@io.write(argument)
+						end
+					end
+				end
+			end
+			
+			# Print out the arguments as per {#print}, followed by the reset sequence and a newline.
+			def puts(*arguments)
+				write(*arguments)
+				@io.puts(self.reset)
+			end
+		end
+	end
+end

data/lib/sus/output/xterm.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Copyright, 2019, 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 'io/console'
+
+require_relative 'text'
+
+module Sus
+	# Styled output output.
+	module Output
+		class XTerm < Text
+			COLORS = {
+				black: 0,
+				red: 1,
+				green: 2,
+				yellow: 3,
+				blue: 4,
+				magenta: 5,
+				cyan: 6,
+				white: 7,
+				default: 9,
+			}
+			
+			ATTRIBUTES = {
+				normal: 0,
+				bold: 1,
+				bright: 1,
+				faint: 2,
+				italic: 3,
+				underline: 4,
+				blink: 5,
+				reverse: 7,
+				hidden: 8,
+			}
+			
+			def colors?
+				true
+			end
+			
+			def size
+				@io.winsize
+			end
+			
+			def style(foreground, background = nil, *attributes)
+				tokens = []
+				
+				if foreground
+					tokens << 30 + COLORS.fetch(foreground)
+				end
+				
+				if background
+					tokens << 40 + COLORS.fetch(background)
+				end
+				
+				attributes.each do |attribute|
+					tokens << ATTRIBUTES.fetch(attribute){attribute.to_i}
+				end
+				
+				return "\e[#{tokens.join(';')}m"
+			end
+			
+			def reset
+				"\e[0m"
+			end
+		end
+	end
+end

data/lib/sus/output.rb

@@ -0,0 +1,41 @@
+
+require_relative 'output/bar'
+require_relative 'output/text'
+require_relative 'output/xterm'
+
+require_relative 'output/null'
+
+module Sus
+	module Output
+		def self.for(io)
+			if io.isatty
+				XTerm.new(io)
+			else
+				Text.new(io)
+			end
+		end
+		
+		def self.default(io = $stderr)
+			output = self.for(io)
+			
+			Output::Bar.register(output)
+			
+			output[:context] = output.style(nil, nil, :bold)
+			
+			output[:describe] = output.style(:cyan, nil, :bold)
+			output[:it] = output.style(:cyan)
+			output[:with] = output.style(:cyan)
+			
+			output[:variable] = output.style(:blue, nil, :bold)
+			
+			output[:passed] = output.style(:green, nil, :bold)
+			output[:failed] = output.style(:red, nil, :bold)
+			
+			return output
+		end
+		
+		def self.buffered
+			Buffered.new(Null.new)
+		end
+	end
+end

data/lib/sus/progress.rb

@@ -0,0 +1,144 @@
+# 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 'output/bar'
+require_relative 'output/status'
+require_relative 'output/lines'
+
+module Sus
+	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 = Output::Bar.new
+				@lines = Output::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] = Output::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

data/lib/sus/registry.rb

@@ -0,0 +1,47 @@
+
+require_relative 'base'
+
+require_relative 'describe'
+require_relative 'with'
+
+require_relative 'it'
+
+require_relative 'shared'
+require_relative 'it_behaves_like'
+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:
+		def initialize(base = Sus.base("test registry"))
+			@base = base
+		end
+		
+		attr :base
+		
+		def load(path)
+			@base.describe(path, identity: Identity.new(path)) do
+				TOPLEVEL_CLASS_EVAL.call(self, path)
+			end
+		end
+		
+		def call(assertions = Assertions.default)
+			@base.call(assertions)
+			
+			return assertions
+		end
+		
+		def each(...)
+			@base.each(...)
+		end
+		
+		def children
+			@base.children
+		end
+	end
+end

data/lib/sus/shared.rb

@@ -0,0 +1,22 @@
+
+require_relative 'context'
+
+module Sus
+	module Shared
+		attr_accessor :name
+		attr_accessor :block
+		
+		def self.build(name, block)
+			base = Class.new
+			base.extend(Shared)
+			base.name = name
+			base.block = block
+			
+			return base
+		end
+	end
+	
+	def self.Shared(name, &block)
+		Shared.build(name, block)
+	end
+end

data/lib/sus/version.rb

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

data/lib/sus/with.rb

@@ -0,0 +1,48 @@
+
+require_relative 'context'
+
+module Sus
+	module With
+		extend Context
+		
+		attr_accessor :subject
+		attr_accessor :variables
+		
+		def self.extended(base)
+			base.children = Hash.new
+		end
+		
+		def self.build(parent, subject, variables, &block)
+			base = Class.new(parent)
+			base.extend(With)
+			base.subject = subject
+			base.description = subject
+			base.identity = Identity.nested(parent.identity, base.description)
+			base.variables = variables
+			
+			variables.each do |key, value|
+				base.define_method(key, ->{value})
+			end
+			
+			if block_given?
+				base.class_exec(&block)
+			end
+			
+			return base
+		end
+		
+		def print(output)
+			self.superclass.print(output)
+			output.write(
+				" with ", :with, self.description, :reset,
+				# " ", :variables, self.variables.inspect
+			)
+		end
+	end
+	
+	module Context
+		def with(subject, **variables, &block)
+			add With.build(self, subject, variables, &block)
+		end
+	end
+end

data/lib/sus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'sus/version'
+require_relative 'sus/registry'
+require_relative 'sus/assertions'
+
+require_relative 'sus/expect'
+require_relative 'sus/be'
+
+require_relative 'sus/filter'