Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@
DerivedData
.idea/
*.xcodeproj/xcuserdata
.swiftpm/xcode/xcuserdata/
xcuserdata/
*.log
test_output*.txt

This file was deleted.

19 changes: 5 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added
- N/A

### Changed
- N/A

### Deprecated
- N/A
- README rewritten to match the code: purpose, products, platforms, dependencies, build/test, known issues

### Removed
- N/A
- `docs/DESIGN_PATTERNS.md` and `docs/EXAMPLES.md` (examples used APIs that do not exist; superseded by the README)
- Committed `.swiftpm/xcode/xcuserdata` (now git-ignored)

### Fixed
- N/A

### Security
- N/A
### Notes
- Releases v1.8.0 (FilenameTokenizer, UUIDv5Generator), v1.9.0 (Visitor, Graph, Gzip) and v1.10.0 were tagged without CHANGELOG entries; backfill is tracked in `platform-and-test-hygiene`

## [1.7.0] - 2025-12-21

Expand All @@ -43,7 +35,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed
- Boosted unit test coverage across multiple patterns (Builder, Factory, Adapter, Facade, Observer, Strategy)
- Added `AGENTS.md` release/tagging guideline documentation

## [v1.4.0] - 2025-12-12

Expand Down
23 changes: 12 additions & 11 deletions Documentation.docc/DesignAlgorithmsKit.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ All patterns and algorithms follow consistent implementation guidelines for main
### Design Patterns

#### Creational Patterns
- ``Singleton`` - Thread-safe singleton implementations
- ``Factory`` - Object creation without specifying concrete classes
- ``Builder`` - Step-by-step object construction with fluent API
- ``ThreadSafeSingleton`` - Thread-safe singleton base class
- ``ObjectFactory`` - Object creation without specifying concrete classes
- ``BaseBuilder`` - Step-by-step object construction

#### Structural Patterns
- ``Facade`` - Simplified interface to complex subsystems
- ``Adapter`` - Adapting interfaces to client expectations
- ``BaseFacade`` - Simplified interface to complex subsystems
- ``BaseAdapter`` - Adapting interfaces to client expectations

#### Behavioral Patterns
- ``Strategy`` - Interchangeable algorithms
- ``Observer`` - Event notification and subscription
- ``StrategyContext`` - Interchangeable algorithms
- ``BaseObservable`` - Event notification and subscription

#### Modern Patterns
- ``Registry`` - Centralized type registration and discovery
- ``TypeRegistry`` / ``Registry`` - Centralized type and value registration

### Algorithms & Data Structures

Expand All @@ -38,7 +38,8 @@ All patterns and algorithms follow consistent implementation guidelines for main
- ``CountingBloomFilter`` - Bloom Filter variant that supports element removal

#### Hashing
- ``HashAlgorithm`` - Protocol for hash algorithms
- ``HashAlgorithm`` - Supported hash algorithms (SHA-256, SHA-1, MD5, CRC-32)
- ``HashComputation`` - Hash computation helpers
- ``SHA256`` - SHA-256 hash algorithm implementation

## Getting Started
Expand All @@ -47,13 +48,13 @@ Add DesignAlgorithmsKit to your `Package.swift`:

```swift
dependencies: [
.package(url: "https://github.com/rickhohler/DesignAlgorithmsKit.git", from: "1.0.0")
.package(url: "https://github.com/nibbleware/DesignAlgorithmsKit.git", from: "1.0.0")
]
```

## See Also

- [GitHub Repository](https://github.com/rickhohler/DesignAlgorithmsKit)
- [GitHub Repository](https://github.com/nibbleware/DesignAlgorithmsKit)
- [Design Patterns Guide](https://en.wikipedia.org/wiki/Design_Patterns)
- [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree)
- [Bloom Filter](https://en.wikipedia.org/wiki/Bloom_filter)
Expand Down
Loading
Loading