spectre-core 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2343f54b9e9837df93c730210d5652256643d8514b0456670292b492dc7f770e
-  data.tar.gz: 6d934a08ecee932b5346a3d9e98fcd96bc27384f5b9f17cd01b9c08b430c0ff2
+  metadata.gz: 0c4d07c24a6be8fbf1ed1ff1b4ec52860294be4b4c2d8580facf183231a3c4ed
+  data.tar.gz: 576889b489206a424462b087bc75590aa17339b918c4bc1076f072ceab2c29af
 SHA512:
-  metadata.gz: 137d6c2c7012d535ba7a93072b67f0cd471ca6b9c5b83225ccb9eb06a433645f078a9928a21c61598059e299c476fe2cbad9f6a4112fd5a0d2d86ed7c2f392e2
-  data.tar.gz: ab497f00a4ef0a3ca453f304a6a7e2ac30e0ecdd4910bc27c14c533079638866a2e609e6f618641cdd0ffa337e9575a340a658b1079f2fb18b38cf9cf6adadf4
+  metadata.gz: 2a8c17b521b0e391942bf99a2ecd41d18349b5c79b63e5e71bdd1365284d347c1c31c0315f9b62976ff0068c29248f1a009a4e6eac8e53198ce4e41a8173f8a7
+  data.tar.gz: af4a92361d63d56b269a61b088635801b158dd217c4f9bd3400b5b19a0f0e20bad314589a488be101e5204935a6ed68e7d48c771ab257e450cdb6d166edd1df5

data/lib/spectre/version.rb

@@ -1,3 +1,3 @@
 module Spectre
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.1.4'.freeze
 end

data/lib/spectre.rb

@@ -20,7 +20,7 @@ def get_call_location call_stack
     .find { |x| x.label.include? 'Spectre::Engine#load_files' or x.base_label == '<top (required)>' }
 
   [
-    loc.path.sub(Spectre.pwd, '.'),
+    loc.path.sub(Dir.pwd, '.'),
     loc.lineno
   ]
 end
@@ -78,13 +78,6 @@ end
 # The main module containing all logic for the framework
 #
 module Spectre
-  # Cache Dir.pwd to avoid repeated system calls
-  @pwd = Dir.pwd
-
-  def self.pwd
-    @pwd
-  end
-
   ##
   # Exception to throw in order to abort a spec run
   #
@@ -265,13 +258,14 @@ module Spectre
       counter = 0
 
       specs
-        .group_by { |x| x.parent.root }
+        .group_by { |x| x.parent.root.name }
         .each_value do |spec_group|
-          spec_group.sort_by!(&:name)
-          spec_group.each do |spec|
-            spec_id = "[#{spec.name}]".send(@colors[counter % @colors.length])
-            @out.puts "#{spec_id} #{spec.full_desc} #{spec.tags.map { |x| "##{x}" }.join(' ').cyan}"
-          end
+          spec_group
+            .sort
+            .each do |spec|
+              spec_id = "[#{spec.name}]".send(@colors[counter % @colors.length])
+              @out.puts "#{spec_id} #{spec.full_desc} #{spec.tags.map { |x| "##{x}" }.join(' ').cyan}"
+            end
 
           counter += 1
         end
@@ -280,15 +274,15 @@ module Spectre
     ##
     # Outputs all the specs for all contexts
     #
-    def describe contexts, level = 0
-      contexts.each do |context|
+    def describe contexts, level = 0, parent: nil
+      contexts.select { |x| x.parent == parent }.each do |context|
         @out.puts("#{'  ' * level}#{context.desc.send(level.positive? ? :magenta : :blue)}")
 
         context.specs.each do |spec|
           @out.puts("#{'  ' * (level + 1)}#{spec.desc}")
         end
 
-        describe(context.children, level + 1)
+        describe(contexts, level + 1, parent: context)
       end
     end
 
@@ -327,7 +321,7 @@ module Spectre
       mixins.each_value do |mixin|
         output  = "#{mixin.desc.yellow}\n"
         output += "  params.....: #{mixin.params.join ', '}\n" if mixin.params.any?
-        output += "  location...: #{mixin.file.sub(Spectre.pwd, '.')}:#{mixin.line}"
+        output += "  location...: #{mixin.file.sub(Dir.pwd, '.')}:#{mixin.line}"
         paragraphs << output
       end
 
@@ -781,6 +775,10 @@ module Spectre
     end
   end
 
+  ##
+  # The run context is passed to all specs and provides the
+  # DSL for assertions, expectations, logging, etc.
+  #
   class RunContext
     include Delegate
 
@@ -1164,7 +1162,7 @@ module Spectre
     # Skip the run for this spec. This can be used to skip spec runs when a certain
     # condition occurs.
     #
-    #   skip 'subject is not yet ready to be tests' unless service_is_ready()
+    #   skip 'subject is not yet ready to be tested' unless service_is_ready()
     #
     def skip message
       @skipped = true
@@ -1174,7 +1172,7 @@ module Spectre
   end
 
   class Specification
-    attr_reader :id, :name, :desc, :full_desc, :parent, :root, :tags, :data, :file
+    attr_reader :id, :name, :desc, :full_desc, :parent, :root, :tags, :data, :file, :block
 
     def initialize parent, name, desc, tags, data, file, block
       @parent = parent
@@ -1189,10 +1187,25 @@ module Spectre
     end
 
     ##
-    # Creates a new +RunContext+ and executes the spec,
-    # +before+ and +after+ blocks
+    # Natural sort comparison for spec names respecting numeric parts.
     #
-    def run engine, befores, afters, bag
+    def <=>(other)
+      # Split on dash: text part and numeric part
+      self_parts = @name.split('-')
+      other_parts = other.name.split('-')
+
+      text_compare = self_parts[0] <=> other_parts[0]
+
+      # If the text parts are already different, we can return here
+      return text_compare unless text_compare.zero?
+
+      self_parts[1].to_i <=> other_parts[1].to_i
+    end
+
+    ##
+    # Execute this specification with its before/after blocks
+    #
+    def run(engine, befores, afters, bag)
       RunContext.new(engine, self, :spec, bag) do |run_context|
         engine.formatter.scope(@desc, self) do
           befores.each do |block|
@@ -1220,13 +1233,14 @@ module Spectre
   class DefinitionContext
     include Delegate
 
-    attr_reader :id, :name, :desc, :parent, :full_desc, :children, :specs, :file
+    attr_reader :id, :name, :desc, :parent, :full_desc, :specs, :file,
+                :setups, :teardowns, :befores, :afters
 
-    def initialize desc, file, parent = nil
+    def initialize desc, file, engine, parent = nil
+      @engine = engine
       @parent = parent
       @desc = desc
       @file = file
-      @children = []
       @specs = []
 
       @setups = []
@@ -1239,6 +1253,8 @@ module Spectre
       @name = @parent.name + '-' + @name unless @parent.nil?
 
       @full_desc = @parent.nil? ? @desc : "#{@parent.full_desc} #{@desc}"
+
+      @engine.contexts << self
     end
 
     ##
@@ -1249,10 +1265,90 @@ module Spectre
     end
 
     ##
-    # A flattened list of all specs including those of child contexts.
+    # Returns all direct child contexts
     #
-    def all_specs
-      @specs + @children.map(&:all_specs).flatten
+    def children
+      @engine.contexts.select { |x| x.parent == self }
+    end
+
+    ##
+    # Execute this context with its specs, setups, and teardowns.
+    # Recursively executes child contexts using the tree structure.
+    #
+    def run(specs_set)
+      runs = []
+
+      # Find specs in this context that should be executed
+      selected = @specs.select { |x| specs_set.include? x }
+
+      # Check if any child contexts have specs to execute
+      has_child_specs = children.any? { |child| child.specs_in_tree?(specs_set) }
+
+      # Skip this context if it has no matching specs and no children with specs
+      return runs if selected.empty? && !has_child_specs
+
+      @engine.formatter.scope(@desc, self) do
+        # Execute setup, specs, and teardown for this context
+        if selected.any?
+          setup_bag = nil
+
+          if @setups.any?
+            setup_run = RunContext.new(@engine, self, :setup) do |run_context|
+              @setups.each do |block|
+                @engine.formatter.scope('setup', :setup) do
+                  @engine.logger.correlate do
+                    @engine.logger.debug("setup \"#{@desc}\"")
+                    run_context.execute(nil, &block)
+                  end
+                end
+              end
+            end
+
+            setup_bag = setup_run.bag
+            runs << setup_run
+          end
+
+          # Only run specs if setup was successful
+          if runs.all? { |x| x.status == :success }
+            runs += selected.map do |spec|
+              @engine.logger.correlate do
+                spec.run(@engine, @befores, @afters, setup_bag)
+              end
+            end
+          end
+
+          if @teardowns.any?
+            runs << RunContext.new(@engine, self, :teardown, setup_bag) do |run_context|
+              @teardowns.each do |block|
+                @engine.formatter.scope('teardown', :teardown) do
+                  @engine.logger.correlate do
+                    @engine.logger.debug("teardown \"#{@desc}\"")
+                    run_context.execute(nil, &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        # Recursively execute child contexts
+        children.each do |child_context|
+          @engine.logger.correlate do
+            runs += child_context.run(specs_set)
+          end
+        end
+      end
+
+      runs
+    end
+
+    ##
+    # Check recursively if this context or any of its children have specs in the filter set
+    #
+    def specs_in_tree?(specs_set)
+      return true if @specs.any? { |x| specs_set.include? x }
+
+      children.any? { |child| child.specs_in_tree?(specs_set) }
     end
 
     ##
@@ -1262,10 +1358,9 @@ module Spectre
       file = caller
         .first
         .gsub(/:in .*/, '')
-        .gsub(Spectre.pwd, '.')
+        .gsub(Dir.pwd, '.')
 
-      context = DefinitionContext.new(desc, file, self)
-      @children << context
+      context = DefinitionContext.new(desc, file, @engine, self)
       context.instance_eval(&)
     end
 
@@ -1312,12 +1407,18 @@ module Spectre
       file = caller
         .first
         .gsub(/:in .*/, '')
-        .gsub(Spectre.pwd, '.')
+        .gsub(Dir.pwd, '.')
 
       with ||= [nil]
 
-      with.each_with_index do |data, _index|
-        spec_index = root.all_specs.count + 1
+      initial_index = @engine
+        .contexts
+        .select { |x| x.root.name == root.name }
+        .flat_map(&:specs)
+        .count + 1
+
+      with.each_with_index do |data, index|
+        spec_index = initial_index + index
         name = "#{root.name}-#{spec_index}"
 
         spec = Specification.new(self, name, desc, tags, data, file, block)
@@ -1325,68 +1426,6 @@ module Spectre
         @specs << spec
       end
     end
-
-    # :nodoc:
-    def run engine, specs
-      runs = []
-
-      return runs unless all_specs.any? { |x| specs.include? x }
-
-      selected = @specs.select { |x| specs.include? x }
-
-      engine.formatter.scope(@desc, self) do
-        if selected.any?
-          setup_bag = nil
-
-          if @setups.any?
-            setup_run = RunContext.new(engine, self, :setup) do |run_context|
-              @setups.each do |block|
-                engine.formatter.scope('setup', :setup) do
-                  engine.logger.correlate do
-                    engine.logger.debug("setup \"#{@desc}\"")
-                    run_context.execute(nil, &block)
-                  end
-                end
-              end
-            end
-
-            setup_bag = setup_run.bag
-
-            runs << setup_run
-          end
-
-          # Only run specs if setup was successful
-          if runs.all? { |x| x.status == :success }
-            runs += selected.map do |spec|
-              engine.logger.correlate do
-                spec.run(engine, @befores, @afters, setup_bag)
-              end
-            end
-          end
-
-          if @teardowns.any?
-            runs << RunContext.new(engine, self, :teardown, setup_bag) do |run_context|
-              @teardowns.each do |block|
-                engine.formatter.scope('teardown', :teardown) do
-                  engine.logger.correlate do
-                    engine.logger.debug("teardown \"#{@desc}\"")
-                    run_context.execute(nil, &block)
-                  end
-                end
-              end
-            end
-          end
-        end
-
-        @children.each do |context|
-          engine.logger.correlate do
-            runs += context.run(engine, specs)
-          end
-        end
-      end
-
-      runs
-    end
   end
 
   ##
@@ -1581,9 +1620,6 @@ module Spectre
           require module_name
         end
       end
-    ensure
-      # return to the previous working directory
-      Dir.chdir(Spectre.pwd)
     end
 
     # :nodoc:
@@ -1609,8 +1645,7 @@ module Spectre
       tag_filter = config['tags'] || []
 
       @contexts
-        .map(&:all_specs)
-        .flatten
+        .flat_map(&:specs)
         .select do |spec|
           (spec_filter.empty? and tag_filter.empty?) or
             spec_filter.any? { |x| spec.name.match?("^#{x.gsub('*', '.*')}$") } or
@@ -1630,12 +1665,12 @@ module Spectre
         end
       end
 
-      list
+      specs = list
+      specs_set = Set.new(list)
+
+      specs
         .group_by { |x| x.parent.root }
-        .map do |context, specs|
-          context.run(self, specs)
-        end
-        .flatten
+        .flat_map { |context, _| context.run(specs_set) }
     rescue Interrupt
       # Do nothing here
     end
@@ -1669,15 +1704,15 @@ module Spectre
     ##
     # Describe a test subject
     #
-    def describe(name, &)
+    def describe(desc, &)
       file = caller
         .first
         .gsub(/:in .*/, '')
-        .gsub(Spectre.pwd, '.')
+        .gsub(Dir.pwd, '.')
 
-      main_context = DefinitionContext.new(name, file)
-      @contexts << main_context
-      main_context.instance_eval(&)
+      DefinitionContext
+        .new(desc, file, self)
+        .instance_eval(&)
     end
 
     ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectre-core
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Christian Neubauer