[WIP] Add the Given() addon

solid-process · Jan 2, 2024 · 97fda8b · 97fda8b
1 parent f9ef26b
commit 97fda8b
Show file tree

Hide file tree

Showing 13 changed files with 221 additions and 16 deletions.
diff --git a/lib/bcdd/result/config/switchers/addons.rb b/lib/bcdd/result/config/switchers/addons.rb
@@ -11,7 +11,8 @@ module Addons
       ].freeze
 
       OPTIONS = {
-        continue: { default: false, affects: AFFECTS }
+        continue: { default: false, affects: AFFECTS },
+        given: { default: true, affects: AFFECTS }
       }.transform_values!(&:freeze).freeze
 
       def self.switcher

diff --git a/lib/bcdd/result/context/expectations/mixin.rb b/lib/bcdd/result/context/expectations/mixin.rb
@@ -13,7 +13,15 @@ module Continue
         end
       end
 
-      OPTIONS = { continue: Continue }.freeze
+      module Given
+        private def Given(*values)
+          value = values.map(&:to_h).reduce({}) { |acc, val| acc.merge(val) }
+
+          Success.new(type: :initial_input, value: value, subject: self)
+        end
+      end
+
+      OPTIONS = { continue: Continue, given: Given }.freeze
 
       def self.options(config_flags)
         ::BCDD::Result::Config::Options.addon(map: config_flags, from: OPTIONS)

diff --git a/lib/bcdd/result/context/mixin.rb b/lib/bcdd/result/context/mixin.rb
@@ -29,7 +29,15 @@ def Success(type, **value)
         end
       end
 
-      OPTIONS = { continue: Continue }.freeze
+      module Given
+        private def Given(*values)
+          value = values.map(&:to_h).reduce({}) { |acc, val| acc.merge(val) }
+
+          _ResultAs(Success, :initial_input, value)
+        end
+      end
+
+      OPTIONS = { continue: Continue, given: Given }.freeze
 
       def self.options(config_flags)
         ::BCDD::Result::Config::Options.addon(map: config_flags, from: OPTIONS)

diff --git a/lib/bcdd/result/expectations/mixin.rb b/lib/bcdd/result/expectations/mixin.rb
@@ -42,7 +42,13 @@ module Continue
         end
       end
 
-      OPTIONS = { continue: Continue }.freeze
+      module Given
+        private def Given(value)
+          Success.new(type: :initial_input, value: value, subject: self)
+        end
+      end
+
+      OPTIONS = { continue: Continue, given: Given }.freeze
 
       def self.options(config_flags)
         Config::Options.addon(map: config_flags, from: OPTIONS)

diff --git a/lib/bcdd/result/mixin.rb b/lib/bcdd/result/mixin.rb
@@ -36,7 +36,13 @@ def Success(type, value = nil)
         end
       end
 
-      OPTIONS = { continue: Continue }.freeze
+      module Given
+        private def Given(value)
+          _ResultAs(Success, :initial_input, value)
+        end
+      end
+
+      OPTIONS = { continue: Continue, given: Given }.freeze
 
       def self.options(config_flags)
         Config::Options.addon(map: config_flags, from: OPTIONS)

diff --git a/sig/bcdd/result/config.rbs b/sig/bcdd/result/config.rbs
@@ -73,6 +73,7 @@ class BCDD::Result::Config::Switcher
 end
 
 module BCDD::Result::Config::Addons
+  AFFECTS: Array[String]
   OPTIONS: Hash[String, Hash[Symbol, untyped]]
 
   def self.switcher: -> BCDD::Result::Config::Switcher

diff --git a/sig/bcdd/result/context.rbs b/sig/bcdd/result/context.rbs
@@ -66,6 +66,14 @@ class BCDD::Result::Context
         def Continue: (**untyped) -> BCDD::Result::Context::Success
       end
 
+      module Given
+        include BCDD::Result::Context::Mixin::Methods
+
+        private
+
+        def Given: (*untyped) -> BCDD::Result::Context::Success
+      end
+
       OPTIONS: Hash[Symbol, Module]
 
       def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]
@@ -95,6 +103,10 @@ module BCDD::Result::Context::Expectations::Mixin
       private def Continue: (**untyped) -> BCDD::Result::Context::Success
     end
 
+    module Given
+      private def Given: (*untyped) -> BCDD::Result::Context::Success
+    end
+
     OPTIONS: Hash[Symbol, Module]
 
     def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]

diff --git a/sig/bcdd/result/expectations.rbs b/sig/bcdd/result/expectations.rbs
@@ -60,6 +60,10 @@ module BCDD::Result::Expectations::Mixin
       private def Continue: (untyped) -> BCDD::Result::Success
     end
 
+    module Given
+      private def Given: (untyped) -> BCDD::Result::Success
+    end
+
     OPTIONS: Hash[Symbol, Module]
 
     def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]

diff --git a/sig/bcdd/result/mixin.rbs b/sig/bcdd/result/mixin.rbs
@@ -23,6 +23,14 @@ class BCDD::Result
         def Continue: (untyped) -> BCDD::Result::Success
       end
 
+      module Given
+        include BCDD::Result::Mixin::Methods
+
+        private
+
+        def Given: (untyped) -> BCDD::Result::Success
+      end
+
       OPTIONS: Hash[Symbol, Module]
 
       def self.options: (Hash[Symbol, Hash[Symbol, bool]]) -> Hash[Symbol, Module]

diff --git a/test/bcdd/result/config/addon/given_test.rb b/test/bcdd/result/config/addon/given_test.rb
@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class BCDD::Result::Config
+  class AddonGivenTest < Minitest::Test
+    test 'the side effects' do
+      BCDD::Result.config.addon.disable!(:given)
+
+      class1a = Class.new do
+        include BCDD::Result.mixin
+
+        def call
+          Given("this method won't exist as the default config is disabled")
+        end
+      end
+
+      class2a = Class.new do
+        include BCDD::Result::Expectations.mixin
+
+        def call
+          Given("this method won't exist as the default config is disabled")
+        end
+      end
+
+      class3a = Class.new do
+        include BCDD::Result::Context.mixin
+
+        def call
+          Given(msg: "this method won't exist as the default config is disabled")
+        end
+      end
+
+      class4a = Class.new do
+        include BCDD::Result::Context::Expectations.mixin
+
+        def call
+          Given(msg: "this method won't exist as the default config is disabled")
+        end
+      end
+
+      error1a = assert_raises(NoMethodError) { class1a.new.call }
+      error2a = assert_raises(NoMethodError) { class2a.new.call }
+      error3a = assert_raises(NoMethodError) { class3a.new.call }
+      error4a = assert_raises(NoMethodError) { class4a.new.call }
+
+      assert_match(/undefined method.+Given/, error1a.message)
+      assert_match(/undefined method.+Given/, error2a.message)
+      assert_match(/undefined method.+Given/, error3a.message)
+      assert_match(/undefined method.+Given/, error4a.message)
+
+      BCDD::Result.config.addon.enable!(:given)
+
+      class1b = Class.new do
+        include BCDD::Result.mixin
+
+        def call
+          Given('this method will exist as the config is enabled by default')
+        end
+      end
+
+      class2b = Class.new do
+        include BCDD::Result::Expectations.mixin
+
+        def call
+          Given('this method will exist as the config is enabled by default')
+        end
+      end
+
+      class3b = Class.new do
+        include BCDD::Result::Context.mixin
+
+        def call
+          part1 = { part1: 'this method will exist' }
+          part2 = { part2: 'as the config is enabled by default' }
+
+          Given(part1, part2)
+            .and_then { |data| Given(msg: "#{data[:part1]} #{data[:part2]}") }
+        end
+      end
+
+      class4b = Class.new do
+        include BCDD::Result::Context::Expectations.mixin
+
+        def call
+          part1 = { part1: 'this method will exist' }
+          part2 = { part2: 'as the config is enabled by default' }
+
+          Given(part1, part2)
+            .and_then { |data| Given(msg: "#{data[:part1]} #{data[:part2]}") }
+        end
+      end
+
+      result1b = class1b.new.call
+      result2b = class2b.new.call
+      result3b = class3b.new.call
+      result4b = class4b.new.call
+
+      assert_equal('this method will exist as the config is enabled by default', result1b.value)
+      assert_equal('this method will exist as the config is enabled by default', result2b.value)
+      assert_equal('this method will exist as the config is enabled by default', result3b.value[:msg])
+      assert_equal('this method will exist as the config is enabled by default', result4b.value[:msg])
+
+      assert(result1b.success?(:initial_input))
+      assert(result2b.success?(:initial_input))
+      assert(result3b.success?(:initial_input) && result3b.value.keys == [:msg])
+      assert(result4b.success?(:initial_input) && result4b.value.keys == [:msg])
+    end
+
+    test 'the overwriting of the default config' do
+      BCDD::Result.config.addon.enable!(:given)
+
+      class1 = Class.new do
+        include BCDD::Result.mixin(config: { addon: { given: false } })
+
+        def call
+          Given("this method won't exist as the default config was overwritten")
+        end
+      end
+
+      class2 = Class.new do
+        include BCDD::Result::Expectations.mixin(config: { addon: { given: false } })
+
+        def call
+          Given("this method won't exist as the default config was overwritten")
+        end
+      end
+
+      class3 = Class.new do
+        include BCDD::Result::Context.mixin(config: { addon: { given: false } })
+
+        def call
+          Given(msg: "this method won't exist as the default config was overwritten")
+        end
+      end
+
+      class4 = Class.new do
+        include BCDD::Result::Context::Expectations.mixin(config: { addon: { given: false } })
+
+        def call
+          Given(msg: "this method won't exist as the default config was overwritten")
+        end
+      end
+
+      error1 = assert_raises(NoMethodError) { class1.new.call }
+      error2 = assert_raises(NoMethodError) { class2.new.call }
+      error3 = assert_raises(NoMethodError) { class3.new.call }
+      error4 = assert_raises(NoMethodError) { class4.new.call }
+
+      assert_match(/undefined method.+Given/, error1.message)
+      assert_match(/undefined method.+Given/, error2.message)
+      assert_match(/undefined method.+Given/, error3.message)
+      assert_match(/undefined method.+Given/, error4.message)
+    end
+  end
+end
diff --git a/test/bcdd/result/config/addon_test.rb b/test/bcdd/result/config/addon_test.rb
@@ -18,7 +18,8 @@ class AddonTest < Minitest::Test
 
       assert_equal(
         {
-          continue: { enabled: false, affects: AFFECTS }
+          continue: { enabled: false, affects: AFFECTS },
+          given: { enabled: true, affects: AFFECTS }
         },
         config.options
       )

diff --git a/test/bcdd/result/config_test.rb b/test/bcdd/result/config_test.rb
@@ -47,7 +47,7 @@ class Test < Minitest::Test
     test '#to_h' do
       config_values = BCDD::Result.config.to_h
 
-      assert_equal({ continue: false }, config_values[:addon])
+      assert_equal({ continue: false, given: true }, config_values[:addon])
       assert_equal({ expectations: true, transitions: true }, config_values[:feature])
       assert_equal({ nil_as_valid_value_checking: false }, config_values[:pattern_matching])
       assert_equal({ 'Result' => false, 'Context' => false, 'BCDD::Context' => false }, config_values[:constant_alias])

diff --git a/test/bcdd/result/transitions/enabled/with_subject/singleton/nested_test.rb b/test/bcdd/result/transitions/enabled/with_subject/singleton/nested_test.rb
@@ -5,14 +5,8 @@
 class BCDD::Result::TransitionsEnabledWithSubjectSingletonNestedTest < Minitest::Test
   include BCDDResultTransitionAssertions
 
-  module Giveable
-    def Given(value)
-      _ResultAs(BCDD::Result::Success, :initial_input, value)
-    end
-  end
-
   module CheckForZeros
-    extend self, Giveable, BCDD::Result.mixin(config: { addon: { continue: true } })
+    extend self, BCDD::Result.mixin(config: { addon: { continue: true } })
 
     def call(numbers)
       BCDD::Result.transitions(name: 'CheckForZeros') do
@@ -33,7 +27,7 @@ def detect_zero(numbers, ref)
   end
 
   module Division
-    extend self, Giveable, BCDD::Result.mixin(config: { addon: { continue: true } })
+    extend self, BCDD::Result.mixin(config: { addon: { continue: true } })
 
     def call(num1, num2)
       BCDD::Result.transitions(name: 'Division') do
@@ -67,7 +61,7 @@ def divide((num1, num2))
   end
 
   module SumDivisionsByTwo
-    extend self, Giveable, BCDD::Result.mixin(config: { addon: { continue: true } })
+    extend self, BCDD::Result.mixin(config: { addon: { continue: true } })
 
     def call(*numbers)
       BCDD::Result.transitions(name: 'SumDivisionsByTwo') do