FractalDataWorks 0.1.6-alpha-gb9d189bbcb

FractalDataWorks

Part of the FractalDataWorks toolkit.

Build Status

Release Status

Package Status

License

Core interface definitions for the FractalDataWorks platform, providing foundational contracts for enhanced functionality.

Overview

FractalDataWorks is a Layer 0.5 package containing pure interface definitions that serve as the foundation for the FractalDataWorks platform. This package includes interfaces like IEnhancedEnumOption for advanced enumeration patterns and IGenericResult for functional error handling.

Features

• IGenericResult<T>: Result/Either monad pattern for functional error handling
• IEnhancedEnumOption: Interface for enhanced enumeration types with ID and name properties
• IEnhancedEnumOption<T>: Generic interface supporting self-referencing enum patterns
• Fractal: Unit type for operations without meaningful return values
• Pure interfaces with no implementation dependencies
• netstandard2.0 compatible for broad framework support

Getting Started

Prerequisites

• .NET Standard 2.0 compatible runtime
• For development: .NET 10.0 SDK or later

Installation

From NuGet

dotnet add package FractalDataWorks

From GitHub Packages

# Add GitHub Packages source (if not already added)
dotnet nuget add source --username YOUR_USERNAME --password YOUR_TOKEN --store-password-in-clear-text --name github "https://nuget.pkg.github.com/CyberdineDevelopment/index.json"

# Install the package
dotnet add package FractalDataWorks --source "github"

Building from Source

# Clone the repository
git clone https://github.com/CyberdineDevelopment/FractalDataWorks.git

# Navigate to the project directory
cd FractalDataWorks

# Restore dependencies
dotnet restore

# Build the project
dotnet build

Running Tests

# Run all tests
dotnet test

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

Usage

using FractalDataWorks;

public class OrderStatus : IEnhancedEnumOption<OrderStatus>
{
    public int Id { get; }
    public string Name { get; }
    
    private OrderStatus(int id, string name)
    {
        Id = id;
        Name = name;
    }
    
    public static OrderStatus Pending = new(1, "Pending");
    public static OrderStatus Processing = new(2, "Processing");
    public static OrderStatus Complete = new(3, "Complete");
    
    public OrderStatus Empty() => new OrderStatus(0, "None");
}

Project Structure

├── src/                    # Source code
│   └── FractalDataWorks/   # Core interfaces
├── tests/                  # Unit and integration tests
├── docs/                   # Documentation
├── samples/                # Sample projects (future)
├── azure-pipelines.yml     # CI/CD pipeline configuration
├── Directory.Build.props   # Common build properties
└── README.md              # This file

Package Structure

This package contains only interface definitions:

• No implementation code
• No external dependencies
• Minimal runtime footprint

Related Packages

• FractalDataWorks.EnhancedEnums: Source generator for implementing enhanced enumerations
• FractalDataWorks.SmartSwitches: Advanced pattern matching capabilities (coming soon)

Versioning

This project uses Nerdbank.GitVersioning for automatic versioning based on git history.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgments

• Part of the FractalDataWorks platform architecture
• Layer 0.5 pure interface package
• Follows semantic versioning