Skip to content

feat(memento): implemented fluent memento pattern#53

Merged
JerrettDavis merged 1 commit intomainfrom
feature/23-fluent-create-memento-pattern
Oct 9, 2025
Merged

feat(memento): implemented fluent memento pattern#53
JerrettDavis merged 1 commit intomainfrom
feature/23-fluent-create-memento-pattern

Conversation

@JerrettDavis
Copy link
Copy Markdown
Owner

No description provided.

@JerrettDavis JerrettDavis requested a review from Copilot October 9, 2025 03:04
@JerrettDavis JerrettDavis self-assigned this Oct 9, 2025
@JerrettDavis JerrettDavis added the documentation Improvements or additions to documentation label Oct 9, 2025
@JerrettDavis JerrettDavis linked an issue Oct 9, 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 implements a fluent Memento pattern for capturing and restoring immutable snapshots of mutable state with undo/redo functionality.

  • Implements a generic Memento<TState> class with fluent builder configuration for cloning, equality comparison, and capacity management
  • Adds comprehensive documentation and examples demonstrating text editor history use cases
  • Includes complete test coverage for core functionality including undo/redo, capacity eviction, duplicate suppression, and branching scenarios

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/PatternKit.Core/Behavioral/Memento/Memento.cs Core Memento implementation with fluent builder pattern
src/PatternKit.Examples/MementoDemo/MementoDemo.cs Text editor demo showcasing practical Memento usage
test/PatternKit.Tests/Behavioral/Memento/MementoTests.cs Unit tests for core Memento functionality
test/PatternKit.Examples.Tests/MementoDemo/MementoDemoTests.cs Integration tests for the demo implementation
docs/patterns/behavioral/memento/memento.md Comprehensive documentation with API reference and examples
docs/examples/text-editor-memento.md Detailed example documentation for the text editor demo
docs/index.md Updated pattern list to include Memento
docs/examples/toc.yml Added table of contents entry for Memento example
docs/examples/index.md Updated examples index with Memento demo description
README.md Updated main README pattern list to mark Memento as completed

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

Comment thread src/PatternKit.Examples/MementoDemo/MementoDemo.cs
Comment thread src/PatternKit.Examples/MementoDemo/MementoDemo.cs
Comment thread test/PatternKit.Tests/Behavioral/Memento/MementoTests.cs
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2025

Code Coverage

Summary
  Generated on: 10/09/2025 - 03:05:52
  Coverage date: 10/09/2025 - 03:05:38 - 10/09/2025 - 03:05:48
  Parser: MultiReport (6x Cobertura)
  Assemblies: 3
  Classes: 149
  Files: 61
  Line coverage: 82.4%
  Covered lines: 3560
  Uncovered lines: 756
  Coverable lines: 4316
  Total lines: 13061
  Branch coverage: 72.1% (1164 of 1613)
  Covered branches: 1164
  Total branches: 1613
  Method coverage: 89.5% (914 of 1021)
  Full method coverage: 82.2% (840 of 1021)
  Covered methods: 914
  Fully covered methods: 840
  Total methods: 1021

PatternKit.Core                                                                  86.3%
  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>                              75%
  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.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.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                                                              79.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.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.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.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.Generators                                                            88.2%
  PatternKit.Generators.GenerateStrategyAttribute                                   0%
  PatternKit.Generators.StrategyGenerator                                        93.9%

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 86.84211% with 30 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.23%. Comparing base (23401ad) to head (d4784ac).

Files with missing lines Patch % Lines
src/PatternKit.Examples/MementoDemo/MementoDemo.cs 86.98% 19 Missing ⚠️
src/PatternKit.Core/Behavioral/Memento/Memento.cs 86.58% 11 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
+ Coverage   77.19%   84.23%   +7.03%     
==========================================
  Files          53       55       +2     
  Lines        3978     4206     +228     
  Branches      594      636      +42     
==========================================
+ Hits         3071     3543     +472     
+ Misses        701      663      -38     
+ Partials      206        0     -206     
Flag Coverage Δ
unittests 84.23% <86.84%> (+7.03%) ⬆️

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.

@JerrettDavis JerrettDavis merged commit 9ea109e into main Oct 9, 2025
4 checks passed
@JerrettDavis JerrettDavis deleted the feature/23-fluent-create-memento-pattern branch October 9, 2025 03:17
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fluent: Create Memento Pattern

3 participants