DtoUsageAnalyzer 1.0.0-beta.1

Usage Analyzer

A .NET solution for processing and analyzing user event data.

For a high-level overview of the codebase, see docs/CodebaseOverview.md.

Project Structure

The solution consists of the following projects:

• Dto: Contains data transfer objects used for deserializing user event data
• Processors: Contains processors for handling different types of user data
• Dto.Tests: Unit tests for the DTO project
• Processors.Tests: Unit tests for the Processors project
• DtoUsageAnalyzer: Library that implements the Roslyn-based analysis service
• Analyze: Main application project for analyzing user data using DtoUsageAnalyzer

DtoUsageAnalyzer Library

DtoUsageAnalyzer exposes an AnalysisService that performs Roslyn-based code analysis. By referencing this library, other applications and unit tests can run the same usage analysis logic as the console app.

Getting Started

Prerequisites

• .NET 8.0 SDK or later
• Your favorite IDE (Visual Studio, VS Code, etc.)

Building the Solution

dotnet build

Running the Application

To run the Analyze application:

cd Analyze
dotnet run

The application is a DTO Usage Analyzer that helps you understand how DTO classes and their properties are used throughout your solution. It provides:

1. A selection of DTO classes to analyze
2. Analysis of property usage across the solution
3. Detailed reports showing:
   • Total usage count for each property
   • Usage distribution across different files
   • Identification of unused properties

The tool helps identify:

• Which DTO properties are most frequently used
• Where specific properties are being accessed
• Potentially unused properties that might be candidates for removal

Running Tests

The solution includes comprehensive unit tests for both DTOs and Processors. Run the tests using:

dotnet test

Usage

The solution provides several processors for handling different types of user data:

• UserAddressProcessor: Processes user address information
• UserPreferencesProcessor: Processes user preferences (theme, language, notifications, etc.)
• UserDeviceInfoProcessor: Processes device information (device type, OS, browser, IP)
• UserSocialMediaProcessor: Processes social media profiles
• ActivityLogProcessor: Processes user activity logs
• UserEventProcessor: Processes general event information
• UserProcessor: Processes core user information (profile, preferences, activity)

Example usage:

// Create a processor instance
var processor = new UserAddressProcessor();

// Process the JSON input
using var writer = new StringWriter();
processor.Process(jsonInput, writer);
var result = writer.ToString();

Each processor follows the same pattern:

1. Takes JSON input containing user event data
2. Deserializes the data into appropriate DTOs
3. Processes the data and writes formatted output to a TextWriter

License

This project is licensed under the MIT License.