Skip to content

Feature/26 fluent create template pattern#56

Merged
JerrettDavis merged 4 commits intomainfrom
feature/26-fluent-create-template-pattern
Oct 28, 2025
Merged

Feature/26 fluent create template pattern#56
JerrettDavis merged 4 commits intomainfrom
feature/26-fluent-create-template-pattern

Conversation

@JerrettDavis
Copy link
Copy Markdown
Owner

No description provided.

- Add abstract TemplateMethod<TContext, TResult> with optional synchronization and before/after hooks
- Add fluent Template<TContext, TResult> with Before/After/OnError/Synchronized and Execute/TryExecute
- Add examples: subclassing demo (DataProcessor) and fluent demo (TemplateFluentDemo)
- Add tests: TemplateMethodTests and TemplateFluentTests for correctness, concurrency, and error handling
- Add docs for pattern and demo; update Behavioral patterns ToC and Examples index

Build: PASS (multi-target)
Tests: PASS (840/840)
@JerrettDavis JerrettDavis requested a review from Copilot October 14, 2025 05:12
@JerrettDavis JerrettDavis self-assigned this Oct 14, 2025
@JerrettDavis JerrettDavis added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 14, 2025
@JerrettDavis JerrettDavis linked an issue Oct 14, 2025 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces Template Method pattern implementations with both inheritance-based and fluent composition APIs. The implementation provides structured algorithm skeletons with customizable hooks for before/after operations, error handling, and optional synchronization.

  • Adds four new template classes: TemplateMethod<TContext,TResult>, AsyncTemplateMethod<TContext,TResult>, Template<TContext,TResult>, and AsyncTemplate<TContext,TResult>
  • Provides comprehensive test coverage for both sync and async variants with thread safety and error handling scenarios
  • Includes example implementations and documentation demonstrating practical usage patterns

Reviewed Changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/PatternKit.Core/Behavioral/Template/TemplateMethod.cs Base class for inheritance-based template method with sync execution
src/PatternKit.Core/Behavioral/Template/AsyncTemplateMethod.cs Base class for inheritance-based async template method with cancellation support
src/PatternKit.Core/Behavioral/Template/Template.cs Fluent builder for composable sync template with multicast hooks
src/PatternKit.Core/Behavioral/Template/AsyncTemplate.cs Fluent builder for composable async template with array-based hook storage
test/PatternKit.Tests/Behavioral/TemplateMethodTests.cs Test coverage for sync template method base class
test/PatternKit.Tests/Behavioral/TemplateFluentTests.cs Test coverage for fluent sync template builder
test/PatternKit.Tests/Behavioral/AsyncTemplateMethodTests.cs Test coverage for async template method base class
test/PatternKit.Tests/Behavioral/AsyncTemplateFluentTests.cs Test coverage for fluent async template builder
Multiple test files Cleanup of unused using statements
Multiple example files Demo implementations showing practical usage patterns
Documentation files Pattern documentation and usage examples

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread src/PatternKit.Examples/ProxyDemo/ProxyDemo.cs
Comment thread src/PatternKit.Core/Behavioral/Template/AsyncTemplate.cs
Comment thread test/PatternKit.Tests/Behavioral/AsyncTemplateFluentTests.cs
Comment thread test/PatternKit.Tests/Behavioral/AsyncTemplateFluentTests.cs
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 14, 2025

Codecov Report

❌ Patch coverage is 60.99585% with 94 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.31%. Comparing base (beda683) to head (fe3a162).
⚠️ Report is 79 commits behind head on main.

Files with missing lines Patch % Lines
...ternKit.Examples/TemplateDemo/TemplateAsyncDemo.cs 11.90% 37 Missing ⚠️
...tternKit.Core/Behavioral/Template/AsyncTemplate.cs 69.56% 21 Missing ⚠️
...c/PatternKit.Examples/TemplateDemo/TemplateDemo.cs 0.00% 9 Missing ⚠️
...ternKit.Core/Behavioral/Template/TemplateMethod.cs 46.66% 8 Missing ⚠️
...ernKit.Examples/TemplateDemo/TemplateFluentDemo.cs 20.00% 8 Missing ⚠️
...rc/PatternKit.Core/Behavioral/Template/Template.cs 88.00% 6 Missing ⚠️
...it.Core/Behavioral/Template/AsyncTemplateMethod.cs 81.25% 3 Missing ⚠️
...tternKit.Examples/AsyncStateDemo/AsyncStateDemo.cs 83.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
+ Coverage   77.19%   83.31%   +6.11%     
==========================================
  Files          64       71       +7     
  Lines        4741     4951     +210     
  Branches      744      773      +29     
==========================================
+ Hits         3660     4125     +465     
+ Misses        827      826       -1     
+ Partials      254        0     -254     
Flag Coverage Δ
unittests 83.31% <60.99%> (+6.11%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage

Summary
  Generated on: 10/28/2025 - 02:03:19
  Coverage date: 10/28/2025 - 02:03:09 - 10/28/2025 - 02:03:15
  Parser: MultiReport (6x Cobertura)
  Assemblies: 3
  Classes: 172
  Files: 77
  Line coverage: 81.2%
  Covered lines: 4113
  Uncovered lines: 948
  Coverable lines: 5061
  Total lines: 15121
  Branch coverage: 71.6% (1406 of 1961)
  Covered branches: 1406
  Total branches: 1961
  Method coverage: 87.6% (1063 of 1213)
  Full method coverage: 80.6% (978 of 1213)
  Covered methods: 1063
  Fully covered methods: 978
  Total methods: 1213

PatternKit.Core                                                                    84%
  PatternKit.Behavioral.Chain.ActionChain<T>                                     84.7%
  PatternKit.Behavioral.Chain.ResultChain<T1, T2>                                 100%
  PatternKit.Behavioral.Command.Command<T>                                       54.9%
  PatternKit.Behavioral.Iterator.AsyncFlow<T>                                     100%
  PatternKit.Behavioral.Iterator.AsyncFlowExtensions                              100%
  PatternKit.Behavioral.Iterator.AsyncReplayBuffer<T>                            74.6%
  PatternKit.Behavioral.Iterator.Flow<T>                                         94.4%
  PatternKit.Behavioral.Iterator.FlowExtensions                                  21.4%
  PatternKit.Behavioral.Iterator.ReplayableSequence<T>                           80.7%
  PatternKit.Behavioral.Iterator.ReplayableSequenceExtensions                     100%
  PatternKit.Behavioral.Iterator.SharedAsyncFlow<T>                               100%
  PatternKit.Behavioral.Iterator.SharedFlow<T>                                   63.1%
  PatternKit.Behavioral.Iterator.WindowSequence                                  92.3%
  PatternKit.Behavioral.Mediator.Mediator                                        88.2%
  PatternKit.Behavioral.Mediator.MediatorHelpers                                   50%
  PatternKit.Behavioral.Mediator.TaskExtensions                                     0%
  PatternKit.Behavioral.Memento.Memento<T>                                       85.3%
  PatternKit.Behavioral.Observer.AsyncObserver<T>                                87.8%
  PatternKit.Behavioral.Observer.Observer<T>                                     96.5%
  PatternKit.Behavioral.State.AsyncStateMachine<T1, T2>                            68%
  PatternKit.Behavioral.State.StateMachine<T1, T2>                                 74%
  PatternKit.Behavioral.Strategy.ActionStrategy<T>                                 97%
  PatternKit.Behavioral.Strategy.AsyncStrategy<T1, T2>                           93.5%
  PatternKit.Behavioral.Strategy.Strategy<T1, T2>                                 100%
  PatternKit.Behavioral.Strategy.TryStrategy<T1, T2>                             95.8%
  PatternKit.Behavioral.Template.AsyncTemplate<T1, T2>                           69.5%
  PatternKit.Behavioral.Template.AsyncTemplateMethod<T1, T2>                     81.2%
  PatternKit.Behavioral.Template.Template<T1, T2>                                  82%
  PatternKit.Behavioral.Template.TemplateMethod<T1, T2>                          46.6%
  PatternKit.Common.Option<T>                                                      80%
  PatternKit.Common.Throw                                                          80%
  PatternKit.Common.TryHandlerExtensions                                         33.3%
  PatternKit.Creational.Builder.BranchBuilder<T1, T2>                             100%
  PatternKit.Creational.Builder.BuilderExtensions                                 100%
  PatternKit.Creational.Builder.ChainBuilder<T>                                   100%
  PatternKit.Creational.Builder.Composer<T1, T2>                                  100%
  PatternKit.Creational.Builder.MutableBuilder<T>                                 100%
  PatternKit.Creational.Factory.Factory<T1, T2>                                  76.9%
  PatternKit.Creational.Factory.Factory<T1, T2, T3>                              76.9%
  PatternKit.Creational.Prototype.Prototype<T>                                    100%
  PatternKit.Creational.Prototype.Prototype<T1, T2>                                90%
  PatternKit.Creational.Singleton.Singleton<T>                                   96.5%
  PatternKit.Structural.Adapter.Adapter<T1, T2>                                  82.2%
  PatternKit.Structural.Bridge.Bridge<T1, T2, T3>                                77.5%
  PatternKit.Structural.Composite.Composite<T1, T2>                              97.3%
  PatternKit.Structural.Decorator.Decorator<T1, T2>                              97.6%
  PatternKit.Structural.Facade.Facade<T1, T2>                                    88.8%
  PatternKit.Structural.Facade.TypedFacade<T>                                    79.4%
  PatternKit.Structural.Facade.TypedFacadeDispatchProxy<T>                       81.8%
  PatternKit.Structural.Facade.TypedFacadeProxyFactory<T>                         100%
  PatternKit.Structural.Flyweight.Flyweight<T1, T2>                              83.3%
  PatternKit.Structural.Proxy.Proxy<T1, T2>                                      98.8%

PatternKit.Examples                                                              78.7%
  PatternKit.Examples.ApiGateway.Demo                                            97.9%
  PatternKit.Examples.ApiGateway.MiniRouter                                      96.6%
  PatternKit.Examples.ApiGateway.Request                                           75%
  PatternKit.Examples.ApiGateway.Response                                         100%
  PatternKit.Examples.ApiGateway.Responses                                        100%
  PatternKit.Examples.AsyncStateDemo.ConnectionStateDemo                         93.5%
  PatternKit.Examples.Chain.AuthLoggingDemo                                      95.2%
  PatternKit.Examples.Chain.CardProcessors                                        100%
  PatternKit.Examples.Chain.CardTenderStrategy                                      0%
  PatternKit.Examples.Chain.CashTenderStrategy                                      0%
  PatternKit.Examples.Chain.ChainStage                                            100%
  PatternKit.Examples.Chain.CharityRoundUpRule                                     20%
  PatternKit.Examples.Chain.ConfigDriven.Bundle1OffEach                          14.2%
  PatternKit.Examples.Chain.ConfigDriven.CardTender                              72.2%
  PatternKit.Examples.Chain.ConfigDriven.Cash2Pct                                16.6%
  PatternKit.Examples.Chain.ConfigDriven.CashTender                              90.9%
  PatternKit.Examples.Chain.ConfigDriven.CharityRoundUp                           100%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineBuilderExtensions   94.2%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineDemo                 100%
  PatternKit.Examples.Chain.ConfigDriven.Loyalty5Pct                               20%
  PatternKit.Examples.Chain.ConfigDriven.NickelCashOnly                          77.7%
  PatternKit.Examples.Chain.ConfigDriven.PipelineOptions                          100%
  PatternKit.Examples.Chain.Customer                                              100%
  PatternKit.Examples.Chain.DeviceBus                                             100%
  PatternKit.Examples.Chain.GenericProcessor                                      100%
  PatternKit.Examples.Chain.HttpRequest                                           100%
  PatternKit.Examples.Chain.IRoundingRule                                         100%
  PatternKit.Examples.Chain.LineItem                                              100%
  PatternKit.Examples.Chain.MediatedTransactionPipelineDemo                       100%
  PatternKit.Examples.Chain.NickelCashOnlyRule                                    100%
  PatternKit.Examples.Chain.NoopCharityTracker                                      0%
  PatternKit.Examples.Chain.RoundingPipeline                                      100%
  PatternKit.Examples.Chain.Tender                                                100%
  PatternKit.Examples.Chain.TenderRouterFactory                                  91.3%
  PatternKit.Examples.Chain.TransactionContext                                    100%
  PatternKit.Examples.Chain.TransactionPipeline                                   100%
  PatternKit.Examples.Chain.TransactionPipelineBuilder                           92.3%
  PatternKit.Examples.Chain.TxResult                                              100%
  PatternKit.Examples.FacadeDemo.FacadeDemo                                      62.9%
  PatternKit.Examples.FlyweightDemo.FlyweightDemo                                96.9%
  PatternKit.Examples.Generators.IntParser                                         60%
  PatternKit.Examples.Generators.OrderRouter                                     95.2%
  PatternKit.Examples.Generators.ScoreLabeler                                     100%
  PatternKit.Examples.MediatorDemo.AppMediator                                    100%
  PatternKit.Examples.MediatorDemo.AuditLogHandler                                100%
  PatternKit.Examples.MediatorDemo.BoxHelper                                       25%
  PatternKit.Examples.MediatorDemo.CountUpCmd                                     100%
  PatternKit.Examples.MediatorDemo.CountUpHandler                                 100%
  PatternKit.Examples.MediatorDemo.EchoCmd                                        100%
  PatternKit.Examples.MediatorDemo.EchoHandler                                    100%
  PatternKit.Examples.MediatorDemo.LoggingBehavior<T1, T2>                        100%
  PatternKit.Examples.MediatorDemo.MediatorAssemblyScanner                        100%
  PatternKit.Examples.MediatorDemo.MediatorDemoSink                               100%
  PatternKit.Examples.MediatorDemo.MediatorRegistry                               100%
  PatternKit.Examples.MediatorDemo.PingCmd                                        100%
  PatternKit.Examples.MediatorDemo.PingHandler                                    100%
  PatternKit.Examples.MediatorDemo.ServiceCollectionExtensions                   83.3%
  PatternKit.Examples.MediatorDemo.SumCmd                                         100%
  PatternKit.Examples.MediatorDemo.SumCmdBehavior                                 100%
  PatternKit.Examples.MediatorDemo.SumHandler                                     100%
  PatternKit.Examples.MediatorDemo.UserCreated                                    100%
  PatternKit.Examples.MediatorDemo.WelcomeEmailHandler                            100%
  PatternKit.Examples.MementoDemo.MementoDemo                                    83.5%
  PatternKit.Examples.ObserverDemo.EventHub<T>                                      0%
  PatternKit.Examples.ObserverDemo.LineItem                                       100%
  PatternKit.Examples.ObserverDemo.ObservableList<T>                               47%
  PatternKit.Examples.ObserverDemo.ObservableVar<T>                               100%
  PatternKit.Examples.ObserverDemo.ProfileViewModel                               100%
  PatternKit.Examples.ObserverDemo.PropertyChangedHub                             100%
  PatternKit.Examples.ObserverDemo.ReactiveTransaction                           95.4%
  PatternKit.Examples.ObserverDemo.UserEvent                                        0%
  PatternKit.Examples.PointOfSale.CustomerInfo                                    100%
  PatternKit.Examples.PointOfSale.Demo                                              0%
  PatternKit.Examples.PointOfSale.OrderLineItem                                   100%
  PatternKit.Examples.PointOfSale.PaymentProcessorDemo                           94.8%
  PatternKit.Examples.PointOfSale.PaymentReceipt                                  100%
  PatternKit.Examples.PointOfSale.PromotionConfig                                 100%
  PatternKit.Examples.PointOfSale.PurchaseOrder                                   100%
  PatternKit.Examples.PointOfSale.ReceiptLineItem                                 100%
  PatternKit.Examples.PointOfSale.StoreLocation                                   100%
  PatternKit.Examples.Pricing.ApiPricingSource                                    100%
  PatternKit.Examples.Pricing.CharityRoundUpRule                                  100%
  PatternKit.Examples.Pricing.Coupon                                              100%
  PatternKit.Examples.Pricing.DbPricingSource                                     100%
  PatternKit.Examples.Pricing.DefaultSourceRouting                               83.3%
  PatternKit.Examples.Pricing.FilePricingSource                                   100%
  PatternKit.Examples.Pricing.LineItem                                            100%
  PatternKit.Examples.Pricing.Location                                            100%
  PatternKit.Examples.Pricing.LoyaltyMembership                                   100%
  PatternKit.Examples.Pricing.NickelCashOnlyRule                                  100%
  PatternKit.Examples.Pricing.PercentLoyaltyRule                                  100%
  PatternKit.Examples.Pricing.PricingContext                                      100%
  PatternKit.Examples.Pricing.PricingDemo                                        56.7%
  PatternKit.Examples.Pricing.PricingPipeline                                     100%
  PatternKit.Examples.Pricing.PricingPipelineBuilder                              100%
  PatternKit.Examples.Pricing.PricingResult                                       100%
  PatternKit.Examples.Pricing.RegionCategoryTaxPolicy                             100%
  PatternKit.Examples.Pricing.Sku                                                85.7%
  PatternKit.Examples.Pricing.SourceRouter                                       92.3%
  PatternKit.Examples.ProxyDemo.ProxyDemo                                        94.5%
  PatternKit.Examples.Singleton.DeviceRegistry                                    100%
  PatternKit.Examples.Singleton.PosAppState                                       100%
  PatternKit.Examples.Singleton.PosAppStateDemo                                   100%
  PatternKit.Examples.Singleton.PricingCache                                      100%
  PatternKit.Examples.Singleton.StoreConfig                                       100%
  PatternKit.Examples.StateDemo.OrderStateDemo                                    100%
  PatternKit.Examples.Strategies.Coercion.Coercer<T>                             83.3%
  PatternKit.Examples.Strategies.Coercion.CoercerExtensions                       100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicy                           100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicyFactory                    100%
  PatternKit.Examples.Strategies.Composed.ComposedStrategies                     94.2%
  PatternKit.Examples.Strategies.Composed.SendContext                             100%
  PatternKit.Examples.Strategies.Composed.SendResult                              100%
  PatternKit.Examples.TemplateDemo.AsyncDataPipeline                                0%
  PatternKit.Examples.TemplateDemo.DataProcessor                                    0%
  PatternKit.Examples.TemplateDemo.TemplateAsyncFluentDemo                          0%
  PatternKit.Examples.TemplateDemo.TemplateFluentDemo                               0%
  PatternKit.Examples.TemplateDemo.TemplateMethodDemo                               0%

PatternKit.Generators                                                            88.2%
  PatternKit.Generators.GenerateStrategyAttribute                                   0%
  PatternKit.Generators.StrategyGenerator                                        93.9%

@JerrettDavis JerrettDavis merged commit 2a71bf8 into main Oct 28, 2025
5 of 6 checks passed
@JerrettDavis JerrettDavis deleted the feature/26-fluent-create-template-pattern branch October 28, 2025 02:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fluent: Create Template Pattern

3 participants