thoreau 0.2.1 → 0.2.2

data/lib/thoreau/util.rb

@@ -10,3 +10,32 @@ def combos_of(entries)
     combos_of_rest.map { |r| r.merge(f) }
   end
 end
+
+module Thoreau
+  class HashUtil
+
+    # prop_map is a map from canonical property name to all versions
+    def self.normalize_props(hash, prop_map, include_all_normalized_props = true)
+      prop_map.reduce(Hash.new) do |memo, (k, v)|
+        value   = one_of_these(hash, v, include_all_normalized_props ? nil : :secret_default_value)
+        memo[k] = value unless value == :secret_default_value
+        memo
+      end
+    end
+
+    def self.one_of_these(hash, pick_one_of_these_keys, default_value = nil)
+      keys_present = pick_one_of_these_keys.intersection hash.keys
+
+      if keys_present.size > 1
+        logger.error "Only of of these keys is allowed: #{keys_present.to_sentence}"
+      end
+
+      pick_one_of_these_keys.each do |k|
+        return hash[k] if hash.key?(k)
+      end
+
+      default_value
+    end
+
+  end
+end

data/lib/thoreau/version.rb

@@ -1,3 +1,3 @@
 module Thoreau
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/thoreau.rb

@@ -1,10 +1,16 @@
 require_relative 'thoreau/version'
 require_relative 'thoreau/dsl'
+require_relative 'thoreau/configuration'
 
 module Thoreau
-  class Error < StandardError;
+  def self.configure &block
+    block.call configuration
   end
-  # Your code goes here...
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
 end
 
 if defined?(RSpec)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thoreau
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Peterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,23 +122,32 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/thoreau.rb
-- lib/thoreau/case.rb
-- lib/thoreau/case/builder.rb
+- lib/thoreau/auto_run.rb
+- lib/thoreau/case/case_builder.rb
 - lib/thoreau/case/context_builder.rb
-- lib/thoreau/case/runner.rb
+- lib/thoreau/case/multi_clan_case_builder.rb
+- lib/thoreau/case/suite_runner.rb
+- lib/thoreau/configuration.rb
 - lib/thoreau/dsl.rb
 - lib/thoreau/dsl/appendix.rb
-- lib/thoreau/dsl/context.rb
+- lib/thoreau/dsl/clan.rb
 - lib/thoreau/dsl/expanded.rb
-- lib/thoreau/dsl/groups.rb
-- lib/thoreau/dsl/groups_support.rb
-- lib/thoreau/legacy_results.rb
+- lib/thoreau/dsl/suite_context.rb
+- lib/thoreau/dsl/test_cases.rb
+- lib/thoreau/errors.rb
+- lib/thoreau/legacy_expected_outcomes.rb
+- lib/thoreau/logging.rb
+- lib/thoreau/models/appendix.rb
+- lib/thoreau/models/outcome.rb
+- lib/thoreau/models/setup.rb
+- lib/thoreau/models/test_case.rb
+- lib/thoreau/models/test_clan.rb
+- lib/thoreau/models/test_family.rb
 - lib/thoreau/rspec.rb
 - lib/thoreau/rspec/configuration.rb
 - lib/thoreau/rspec/example_helpers.rb
-- lib/thoreau/setup.rb
-- lib/thoreau/spec_group.rb
 - lib/thoreau/test_suite.rb
+- lib/thoreau/test_suite_data.rb
 - lib/thoreau/util.rb
 - lib/thoreau/version.rb
 homepage: https://github.com/ndp/thoreau

data/lib/thoreau/case/builder.rb

@@ -1,110 +0,0 @@
-module Thoreau
-  class Case
-    # Build test cases.
-    #
-    # It is responsible for:
-    # - building an list of Test::Case objects based
-    #   on the groups provided.
-    # - expanding input specs in the groups into multiple cases
-    # - skipping unfocused tests, if any are focused
-    # - returning a count of those skipped
-    class Builder
-
-      def initialize(groups, suite_context)
-        @groups        = groups
-        @suite_context = suite_context
-      end
-
-      def logger
-        @suite_context.logger
-      end
-
-      def any_focused?
-        @groups.count(&:focused?) > 0
-      end
-
-      def skipped_count
-        return 0 unless any_focused?
-        @groups.count - @groups.count(&:focused?)
-      end
-
-      def build_test_cases!
-        logger.debug "build_test_cases!"
-
-        @groups
-          .select { |g| any_focused? && g.focused? || !any_focused? }
-          .flat_map do |g|
-          build_group_cases g
-        end
-      end
-
-      private
-
-      def setup_key_to_inputs key
-        setup = @suite_context.setups[key.to_s]
-        raise "Unrecognized setup context '#{key}'. Available: #{@suite_setups.keys.to_sentence}" if setup.nil?
-
-        return setup.values if setup.block.nil?
-
-        result = Class.new.new.instance_eval(&setup.block)
-        logger.error "Setup #{key} did not return a hash object" unless result.is_a?(Hash)
-        result
-      end
-
-      def build_group_cases g
-        # We have "specs" for the inputs. These may be actual
-        # values, or they may be enumerables that need to execute.
-        # So we need to "explode" (or enumerate) the values,
-        # generating a single test for each combination.
-        #
-        setup_values = g.setups
-                        .map { |key| setup_key_to_inputs key }
-                        .reduce(Hash.new) { |m, h| m.merge(h) }
-
-        input_sets = g.input_specs
-                      .map { |is| setup_values.merge(is) }
-                      .flat_map do |input_spec|
-          explode_input_specs(input_spec.keys, input_spec)
-        end
-
-        input_sets.map do |input_set|
-          Thoreau::Case.new(
-            group:              g,
-            input:              input_set,
-            action:             @suite_context.data.action,
-            expected_output:    g.expected_output,
-            expected_exception: g.expected_exception,
-            asserts:            g.asserts,
-            suite_context:      @suite_context,
-            logger:             logger)
-        end
-
-      end
-
-      # Expand any values that are enumerators (Thoreau::DSL::Expanded),
-      # creating a list of objects, where all the combinations
-      # of enumerated values are present.
-      def explode_input_specs(keys, input_spec)
-        k = keys.pop
-
-        value_spec = input_spec[k]
-        specs      = if value_spec.is_a?(Thoreau::DSL::Expanded)
-                       value_spec.map do |v|
-                         input_spec.merge(k => v)
-                       end
-                     else
-                       [input_spec]
-                     end
-
-        # Are we done?
-        return specs if keys.empty?
-
-        specs.flat_map do |spec|
-          explode_input_specs(keys, spec) # recurse!
-        end
-
-      end
-
-    end
-  end
-end

data/lib/thoreau/case/runner.rb

@@ -1,42 +0,0 @@
-module Thoreau
-  class Case
-    class Runner
-
-      def initialize(context)
-        @context = context
-      end
-
-      def logger
-        @context.logger
-      end
-
-      def run_test_cases! cases, skipped
-        logger.info "  § #{@context.name} §"
-        cases.each do |c|
-          if c.ok?
-            logger.info "  ✓ #{c.desc}"
-          else
-            logger.error "❓ #{c.desc}, #{c.problem}"
-          end
-        end
-        logger.info (summary cases, skipped)
-        logger.info ""
-
-      end
-
-      def summary cases, skipped
-        ok     = cases.count(&:ok?)
-        total  = cases.count
-        failed = cases.count(&:failed?)
-        if failed == 0
-          "  ∴ All OK 👌🏾 #{skipped > 0 ? "#{skipped} skipped." : ""}"
-        else
-          " 🛑  #{failed} problem(s) detected.  [#{ok} of #{total} OK#{skipped > 0 ? ", #{skipped} skipped" : ""}.]"
-        end
-
-      end
-
-    end
-
-  end
-end

data/lib/thoreau/case.rb

@@ -1,97 +0,0 @@
-require 'active_support/core_ext/module/delegation'
-require_relative './case/context_builder'
-
-module Thoreau
-  class Case
-    def initialize group:,
-                   input:,
-                   action:,
-                   expected_output:,
-                   expected_exception:,
-                   asserts:,
-                   logger:,
-                   suite_context:
-      @group  = group
-      @input  = input
-      @action = action
-      if expected_output.is_a?(Proc)
-        @expected_output_proc = expected_output
-      else
-        @expected_output = expected_output
-      end
-      @expected_exception = expected_exception
-      @assert_proc        = asserts
-      @logger             = logger
-      @suite_context      = suite_context
-      @ran                = false
-    end
-
-    delegate :failure_expected?, to: :@group
-
-    def desc
-      "#{@group.kind}:  #{@group.desc} #{(@input == {} ? nil : @input.sort.to_h) || @expected_exception || "(no args)"}"
-    end
-
-    def problem
-      run unless @ran
-      if @expected_exception
-
-        logger.debug " -> @expected_exception:#{@expected_exception} @raised_exception:#{@raised_exception}"
-
-        if @raised_exception.to_s == @expected_exception.to_s
-          nil
-        elsif @raised_exception.nil?
-          "Expected exception, but none raised"
-        elsif @raised_exception.is_a?(NameError)
-          "Did you forget to define an input? Error: #{@raised_exception}"
-        else
-          "Expected '#{@expected_exception}' exception, but raised '#{@raised_exception}' (#{@raised_exception.class.name})"
-        end
-
-      elsif @assert_proc
-
-        logger.debug " -> @assert_result: #{@assert_result}"
-
-        @assert_result ? nil : "Assertion failed. (got #{@assert_result})"
-      else
-
-        logger.debug " -> @result: #{@result} @expected_output: #{@expected_output} @raised_exception:#{@raised_exception}"
-
-        if @raised_exception
-          "Expected output, but raised exception '#{@raised_exception}'"
-        elsif @expected_output != @result
-          "Expected '#{@expected_output}', but got '#{@result}'"
-        else
-          nil
-        end
-      end
-    end
-
-    def ok?
-      failure_expected? ^ !!problem.nil?
-    end
-
-    def failed?
-      !ok?
-    end
-
-    def run
-      logger.debug("create_context for #{desc} -> ")
-      context_builder = Case::ContextBuilder.new(group: @group, input: @input)
-      context         = context_builder.create_context
-      begin
-        # Only capture exceptions around the action itself.
-        @result = context.instance_exec(&(@action))
-      rescue Exception => e
-        @raised_exception = e
-        return
-      ensure
-        @ran = true
-      end
-
-      @assert_result   = context.instance_exec(@result, &(@assert_proc)) if @assert_proc
-      @expected_output = context.instance_exec(@result, &(@expected_output_proc)) if @expected_output_proc
-    end
-
-  end
-end

data/lib/thoreau/dsl/context.rb

@@ -1,55 +0,0 @@
-module Thoreau
-  module DSL
-    class Data
-      attr_accessor :action
-      attr_accessor :cases
-      attr_accessor :appendix
-      attr_accessor :groups
-
-      def initialize
-        @groups = []
-      end
-    end
-
-    class Context
-
-      attr_reader :data
-      attr_reader :name
-      attr_reader :logger
-      attr_reader :setups
-
-      def initialize name, logger
-        @name   = name
-        @logger = logger
-        @data   = Data.new
-        @setups = {}
-      end
-
-      def action(&block)
-        logger.debug "adding action"
-        @data.action = block
-      end
-
-      alias testing action
-      alias subject action
-
-      def cases(&block)
-        logger.debug "adding cases"
-        @data.cases = block
-      end
-
-      alias test_cases cases
-
-      def appendix(&block)
-        logger.debug "adding appendix"
-        @data.appendix = block
-      end
-
-      def context
-        self
-      end
-
-    end
-
-  end
-end