Add deprecation warning for with_strategu & with_default_apply_strategu includes

Author: mpraglowski

aggregate_root/lib/aggregate_root.rb

@@ -65,13 +65,18 @@ def unpublished_events
   def self.with_default_apply_strategy
     Module.new do
       def self.included(host_class)
-        host_class.extend  OnDSL
-        host_class.include AggregateRoot.with
+        warn <<~EOW
+          Please replace include AggregateRoot.with_default_apply_strategy with include AggregateRoot
+        EOW
+        host_class.include AggregateRoot
       end
     end
   end
 
   def self.with_strategy(strategy)
+    warn <<~EOW
+      Please replace include AggregateRoot.with_strategy(...) with include AggregateRoot.with(strategy: ...)
+    EOW
     with(strategy: strategy)
   end
 
@@ -89,6 +94,7 @@ def self.included(host_class)
   end
 
   def self.included(host_class)
-    host_class.include with_default_apply_strategy
+    host_class.extend  OnDSL
+    host_class.include with
   end
 end

aggregate_root/spec/aggregate_root_spec.rb

@@ -35,15 +35,48 @@
     expect { order.apply(spanish_inquisition) }.to raise_error(AggregateRoot::MissingHandler, "Missing handler method apply_spanish_inquisition on aggregate Order")
   end
 
+  it "should raise error for missing apply method based on a default apply strategy (explicity stated)" do
+    klass = silence_warnings do
+      Class.new do
+        include AggregateRoot.with_default_apply_strategy
+      end
+    end
+    order = klass.new
+    spanish_inquisition = Orders::Events::SpanishInquisition.new
+    expect { order.apply(spanish_inquisition) }.to raise_error(AggregateRoot::MissingHandler, "Missing handler method apply_spanish_inquisition on aggregate #{klass}")
+  end
+
   it "should ignore missing apply method based on a default non-strict apply strategy" do
-    klass = Class.new do
-      include AggregateRoot.with_strategy(->{ AggregateRoot::DefaultApplyStrategy.new(strict: false) })
+    klass = silence_warnings do
+      Class.new do
+        include AggregateRoot.with_strategy(->{ AggregateRoot::DefaultApplyStrategy.new(strict: false) })
+      end
     end
     order = klass.new
     spanish_inquisition = Orders::Events::SpanishInquisition.new
     expect { order.apply(spanish_inquisition) }.to_not raise_error
   end
 
+  it "include with_strategy should warn about depracations" do
+    expect{
+      Class.new do
+        include AggregateRoot.with_strategy(->{ AggregateRoot::DefaultApplyStrategy.new(strict: false) })
+      end
+    }.to output(<<~EOW).to_stderr
+      Please replace include AggregateRoot.with_strategy(...) with include AggregateRoot.with(strategy: ...)
+    EOW
+  end
+
+  it "include with_default_apply_strategy should warn about depracations" do
+    expect {
+      Class.new do
+        include AggregateRoot.with_default_apply_strategy
+      end
+    }.to output(<<~EOW).to_stderr
+      Please replace include AggregateRoot.with_default_apply_strategy with include AggregateRoot
+    EOW
+  end
+
   it "should receive a method call based on a custom strategy" do
     strategy = -> do
       ->(aggregate, event) do
@@ -53,23 +86,25 @@
         }.fetch(event.event_type, ->(ev) {}).call(event)
       end
     end
-    klass = Class.new do
-      include AggregateRoot.with_strategy(strategy)
+    klass = silence_warnings do
+      Class.new do
+        include AggregateRoot.with_strategy(strategy)
 
-      def initialize
-        @status = :draft
-      end
+        def initialize
+          @status = :draft
+        end
 
-      attr_accessor :status
+        attr_accessor :status
 
-      private
+        private
 
-      def custom_created(_event)
-        @status = :created
-      end
+        def custom_created(_event)
+          @status = :created
+        end
 
-      def custom_expired(_event)
-        @status = :expired
+        def custom_expired(_event)
+          @status = :expired
+        end
       end
     end
     order = klass.new