Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

1. Go to '...'

2. Click on '....'

3. Scroll down to '....'

4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]

• Browser [e.g. chrome, safari]

• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]

• OS: [e.g. iOS8.1]

• Browser [e.g. stock browser, safari]

• Version [e.g. 22]

Additional context Add any other context about the problem here.

Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Our Standards

Examples of behavior that contributes to a positive environment for our community include:

• Demonstrating empathy and kindness toward other people

• Being respectful of differing opinions, viewpoints, and experiences

• Giving and gracefully accepting constructive feedback

• Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience

• Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

• The use of sexualized language or imagery, and sexual attention or advances of any kind

• Trolling, insulting or derogatory comments, and personal or political attacks

• Public or private harassment

• Publishing others' private information, such as a physical or email address, without their explicit permission

• Other conduct which could reasonably be considered inappropriate in a professional setting

Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at contact@luxoria.bluepelicansoft.com. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

1. Correction

Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

2. Warning

Community Impact: A violation through a single incident or series of actions.

Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

3. Temporary Ban

Community Impact: A serious violation of community standards, including sustained inappropriate behavior.

Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

4. Permanent Ban

Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

Consequence: A permanent ban from any sort of public interaction within the community.

Attribution

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

Name: Luxoria - Pull Request Title: [L__] - (____) ... Assignees:

Description

Provide a brief summary of the changes in this PR, including any context necessary for understanding it.

Checklist

• My code adheres to the project's coding standards.

• I have performed a self-review of my code.

• I have commented on my code, especially in areas that might be unclear.

• I have added or updated relevant documentation (if applicable).

• I have added tests that prove my fix is effective or that my feature works (if applicable).

• All new and existing tests pass.

• I have checked that my PR targets the develop branch.

Type of Change

• Bug fix (non-breaking change that fixes an issue)

• New feature (non-breaking change that adds functionality)

• Breaking change (fix or feature that would cause existing functionality to not work as expected)

• Documentation update

• Refactoring (non-breaking changes to improve code quality)

Related Issues

Fixes #<issue_number> Closes #<issue_number>

How Has This Been Tested?

Provide a brief description of how you tested your changes. Include details about the environment and test cases used.

Screenshots (If Applicable)

Attach any screenshots that help illustrate the changes made in this PR.

Additional Context

Add any additional information or context about the PR here.

                             Apache License
                       Version 2.0, January 2004
                    http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

   "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

   (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

   You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

  To apply the Apache License to your work, attach the following
  boilerplate notice, with the fields enclosed by brackets "[]"
  replaced with your own identifying information. (Don't include
  the brackets!)  The text should be enclosed in the appropriate
  comment syntax for the file format. We also recommend that a
  file or class name and description of purpose be included on the
  same "printed page" as the copyright notice for easier
  identification within third-party archives.

Copyright 2024 Luxoria

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

1. Go to '...'

2. Click on '....'

3. Scroll down to '....'

4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]

• Browser [e.g. chrome, safari]

• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]

• OS: [e.g. iOS8.1]

• Browser [e.g. stock browser, safari]

• Version [e.g. 22]

Additional context Add any other context about the problem here.

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

1. Go to '...'

2. Click on '....'

3. Scroll down to '....'

4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]

• Browser [e.g. chrome, safari]

• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]

• OS: [e.g. iOS8.1]

• Browser [e.g. stock browser, safari]

• Version [e.g. 22]

Additional context Add any other context about the problem here.

Requirements

• Docker (min. 27.4.0)

• Docker Compose

Installation

1. Clone the repository

2. Run docker-compose up in the LuxStudio directory

3. Run dotnet tool install --global dotnet-ef in the LuxAPI directory

4. Run dotnet ef database update in the LuxAPI directory

5. Run dotnet run in the LuxAPI directory

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Luxoria Desktop Software (Main Release)

Luxoria is a powerful all-in-one photography solution designed to streamline your workflow. Whether you are an individual photographer or part of a team, Luxoria makes it easy to manage and enhance your images, collaborate with clients, and deliver exceptional results.

📸 Introduction

Luxoria offers photographers a comprehensive solution to optimize their image workflow. Our desktop application simplifies the process of importing, organizing, editing, and exporting images, while our web platform enables easy sharing and client feedback. The platform ensures photographers can focus on their creative process while effortlessly managing their projects.

Desktop App Highlights:

• Import images directly from your camera or storage devices.

• Organize your photos into albums and collections.

• Edit with a wide range of powerful editing tools, including AI enhancements.

• Collaborate with clients to refine and finalize image selections.

• Export to multiple formats with one-click options.

Web Platform Highlights:

• Share images via a web gallery.

• Allow clients to view and select their favorite photos.

• Collect feedback directly from clients in real-time.

🛠️ Features

• Image Importation: Seamless image import from cameras or local storage.

• Smart Organization: Organize images into albums, collections, or folders based on date, location, camera settings, and more.

• Advanced Filters: Search and filter images by metadata, including date, location, and camera settings.

• Editing Tools: Utilize a variety of editing tools such as cropping, color correction, retouching, and AI-powered enhancements.

• Collaboration Tools: Work directly with clients to review and approve images. Gather input via comments, selections, or ratings.

• Export Flexibility: Export images to multiple formats like JPEG, PNG, TIFF, or PDF with adjustable quality settings.

• Web Sharing: Share albums with clients through a custom web platform for easy viewing and feedback.

• Feedback Mechanism: Clients can provide individualized feedback, ensuring the final deliverables meet expectations.

🚀 Getting Started

1. Download and Install: Download the Luxoria desktop application from our website and follow the installation steps.

2. Set Up: Import your first batch of photos and start organizing your library.

3. Explore Features: Try out the editing tools, filters, and collaborative workflows.

4. Share with Clients: Upload selected photos to the web platform and invite clients to review and provide feedback.

💡 Why Luxoria?

Luxoria is more than just a photo editing tool, it's a complete photography management platform. From the moment you capture a shot, Luxoria ensures your photos are organized, edited, and shared efficiently. With AI-powered tools, intuitive collaboration features, and an easy-to-use interface, Luxoria is designed for photographers who want to focus on creativity while streamlining their workflow.

📄 License

Feel free to contribute or explore the codebase. Luxoria is constantly evolving, and we welcome your feedback and suggestions!

Table of Contents

Technical Stack

• Language: C#

• Framework: WinUI 3 with .NET 9

• IDE: Visual Studio 2022 / Rider

• Version Control: Git

• CI/CD: GitHub Actions

• Deployment: .MSIX

• Testing: xUnit

Project Structure

Luxoria Desktop is structured as follows:

• Luxoria.App: Main project containing the primary application logic.

• Luxoria.Desktop.Tests: Unit tests for ensuring application stability and correctness.

• Luxoria.Core: Provides fundamental services, repositories, and models essential for the application.

• Luxoria.Modules: Manages modular components of the application, including models, interfaces, and services.

• Luxoria.SDK: Houses shared utilities, services, and interfaces to ensure consistency across modules.

Luxoria.App

• Technologies: WinUI 3 with .NET 9

• Target SDK Version: net9.0-windows10.0.26100.0

• Minimum Platform Version: 10.0.17763.0

• Windows SDK Package Version: 10.0.26100.57

• Main Entry Point: App.xaml / App.xaml.cs

The application follows a modular architecture where each module is a separate project within the solution, responsible for specific features or functionality.

Luxoria.Core

• Technologies: .NET 9.0

• Target Framework: net9.0

• Functionality: Contains core services, repositories, and models used across the application.

Luxoria.Modules

• Technologies: .NET 9.0

• Target Framework: net9.0

• Functionality: Manages modules within the application, ensuring modularization and scalability.

Each module is developed as a separate project to provide distinct functionalities while maintaining interoperability.

Luxoria.SDK

Overview

Luxoria.SDK provides essential utilities, interfaces, and services to ensure consistency across Luxoria modules. It standardizes logging, file hashing, and module communication, promoting reusability and efficiency.

Core Components

Interfaces

• IFileHasherService: Defines contract for file hashing operations.

• ILoggerService: Provides structured logging capabilities.

• ILogTarget: Specifies logging targets for various outputs.

Models

• LogLevel: Defines log severity levels for structured logging.

Services

• FileHashService: Implements file hashing with multiple algorithms.

• LoggerService: Provides system-wide and module-specific logging.

Benefits

• Code Reusability: Centralizes common functionalities across modules.

• Scalability: Easily extensible for new services and features.

• Consistency: Ensures uniformity in logging, file management, and cross-module communication.

Luxoria Standard Modules (LuxStd Modules)

Overview

Luxoria Standard Modules (LuxStd Modules) provide core functionalities within the Luxoria ecosystem. They follow a standardized architecture, ensuring seamless integration, extensibility, and interoperability.

Key Features

• Modular Design: Follows a plug-and-play structure.

• Event-Driven: Utilizes IEventBus for module communication.

• Extensible: Allows enhancement without breaking compatibility.

• Asynchronous Processing: Optimized for high-performance and non-blocking operations.

• Structured Logging & Error Handling: Implements ILoggerService for debugging and diagnostics.

List of LuxStd Modules

1. LuxImport

• Manages importation, indexing, and organization of digital asset collections.

• Processes large datasets with asynchronous operations and real-time progress tracking.

2. LuxFilter

• Provides an advanced filtering pipeline for processing and scoring digital assets.

• Implements a modular filtering framework with weighted execution for improved accuracy.

Read More

Conclusion

Luxoria Desktop follows a modular architecture, ensuring scalability, maintainability, and high performance. LuxStd Modules serve as the foundation of the ecosystem, providing essential functionalities in an event-driven and extensible manner. The inclusion of Luxoria.SDK ensures consistency across different modules, making development more efficient and streamlined.

Objective

The purpose of this testing policy is to establish a clear and robust framework for writing, organizing, and maintaining unit tests for the Luxoria project. This ensures consistent quality, high coverage, and minimal regressions throughout development.

Core Principles

1. High Coverage:

   • Ensure all critical components and workflows are covered, including normal, edge, and error scenarios.

2. Test Isolation:

   • Each unit test must run independently of others. External dependencies must be mocked or stubbed.

3. Performance:

   • Tests should execute quickly to support continuous testing during development.

4. Readability:

   • Test code should be self-explanatory, with clear naming conventions and comments where needed.

5. Ease of Maintenance:

   • Tests must be straightforward to update as the code evolves. Avoid excessive coupling between tests and implementation details.

Test Structure

1. Organization

• Tests should mirror the structure of the source code:

  • Luxoria.Modules → Luxoria.Modules.Tests

• Each class or module should have a dedicated test file named ClassNameTests.cs.

2. Naming Conventions

• Tests should clearly describe their intent using the format:

  • MethodName_StateUnderTest_ExpectedBehavior

  • Example: Subscribe_WithValidHandler_ShouldAddSubscriber

3. Test Scenarios

Tests must cover:

• Standard Cases: Typical input and expected behavior.

• Edge Cases: Extreme conditions such as null values, empty lists, or large inputs.

• Error Cases: Behavior when exceptions are expected or invalid data is provided.

Testing Best Practices

1. Use of Mocking

• Use mocking libraries (e.g., Moq) to isolate dependencies.

• Verify mock interactions to ensure proper communication between components.

2. Centralized Setup

• Common dependencies should be initialized in a shared setup method (e.g., constructors or [SetUp] in test frameworks).

3. Assertions

• Assertions must be explicit and descriptive to validate expected outcomes:

  • Use Assert.Equal, Assert.NotNull, and Mock.Verify for clarity.

4. Test-Driven Development (TDD)

• Write tests before implementing the functionality to capture business requirements effectively.

5. Handle Exceptional Scenarios

• Ensure error handling paths are tested. For example:

  • Validate proper exceptions are thrown for invalid inputs.

  • Test fallback mechanisms where applicable.

Guidelines for Writing Unit Tests

1. Test File Template

A unit test file should follow this basic structure:

using Xunit;
using Moq;
using Luxoria.Modules;

namespace Luxoria.Modules.Tests
{
    public class ClassNameTests
    {
        private readonly ClassName _classUnderTest;

        public ClassNameTests()
        {
            _classUnderTest = new ClassName();
        }

        [Fact]
        public void MethodName_StateUnderTest_ExpectedBehavior()
        {
            // Arrange
            var mockDependency = new Mock<IDependency>();
            // Set up dependencies

            // Act
            var result = _classUnderTest.MethodUnderTest();

            // Assert
            Assert.NotNull(result);
        }
    }
}

2. Examples of Improved Test Cases

Case 1: Validating Null Handling

[Fact]
public void Subscribe_NullSubscriber_ShouldThrowArgumentNullException()
{
    // Arrange
    Action<LogEvent> nullSubscriber = null;

    // Act & Assert
    Assert.Throws<ArgumentNullException>(() => _eventBus.Subscribe(nullSubscriber));
}

Case 2: Testing State Changes

[Fact]
public void Unsubscribe_NonexistentSubscriber_ShouldNotThrow()
{
    // Arrange
    var mockSubscriber = new Mock<Action<LogEvent>>();

    // Act & Assert
    _eventBus.Unsubscribe(mockSubscriber.Object); // Should not throw
}

Continuous Integration and Testing Automation

• Use CI tools (e.g., GitHub Actions, Jenkins) to run unit tests automatically on every commit.

• Track test coverage metrics using tools like coverlet or dotCover.

• Set thresholds for coverage to prevent regressions (e.g., 80% minimum).

Review Process

1. Code Reviews:

   • All new test code must be reviewed by peers to ensure adherence to this policy.

2. Test Audits:

   • Conduct periodic reviews to identify outdated or redundant tests and improve overall coverage.

3. Refactoring:

   • Update tests whenever code is refactored to align with new implementations.

Monitoring and Metrics

Track the following metrics to ensure test quality:

• Test Coverage: Percentage of code covered by tests.

• Test Reliability: Percentage of flaky or unreliable tests.

• Execution Time: Average time taken for tests to run.

This policy ensures consistency and scalability for the testing practices in Luxoria. With proper adherence, it will facilitate long-term project stability and maintainability.

Development Guidelines

To contribute to this project, please follow the guidelines below to ensure consistency and quality in our development process.

Gitflow Workflow

We follow the Gitflow branching model for managing development. This involves using separate branches for features, bugfixes, hotfixes, and releases.

1. Main Branches:

   • main: Contains the production-ready code.

   • develop: Used as an integration branch for features, bugfixes, and hotfixes before releases.

2. Supporting Branches:

   • feat/*: For new features.

   • bugfix/*: For resolving bugs found during development.

   • hotfix/*: For urgent fixes in the production code.

Branch Naming Convention

Use the following prefixes for your branch names to maintain consistency:

• feat/FEATURE_NAME: For new features.

• bugfix/BUG_NAME: For bug fixes during development.

• hotfix/HOTFIX_NAME: For critical fixes applied directly to main.

Commit Messages

Use the following structure for writing clear, informative commit messages:

• Format: <type>: <description>

• Types:

  • feat: For new features (e.g., feat: Add image editing tool).

  • bugfix: For bug fixes (e.g., bugfix: Fix alignment issue).

  • hotfix: For critical bug fixes (e.g., hotfix: Fix crash on startup).

Add a brief description after the type, and make sure your message is concise and descriptive.

Pull Requests

Each feature, bugfix, or hotfix should be accompanied by a pull request (PR). The steps are:

1. Open a PR targeting the develop branch.

2. Assign a reviewer for code review.

3. Ensure the PR passes all automated checks and tests.

4. Provide a detailed description of what was changed and why.

Code Reviews

Every PR must undergo a code review before merging:

• Reviewers should carefully check the changes for quality, readability, and correctness.

• Provide constructive feedback.

• Approve the PR if it meets the necessary standards.

Merging

Once your pull request has been reviewed and approved:

1. Ensure all checks pass before merging.

2. Merge into develop (or main in the case of hotfixes).

3. Delete the branch after merging to keep the repository clean.

Versioning

We use Semantic Versioning for releases:

• Major: Incompatible API changes or large-scale changes.

• Minor: New features or functionality.

• Patch: Bug fixes or minor updates.

Follow this versioning structure when preparing release branches.

Documentation

Make sure the documentation is updated for each new feature, bugfix, or hotfix:

• Update docs for in-depth documentation.

• Update README.md for general project information.

• Use DEVELOPMENT.md for developer guidelines.

• Use CONTRIBUTING.md for contribution guidelines.

• Update CHANGELOG.md with the history of changes.

• Keep the LICENSE.md up-to-date with any changes in licensing.

Testing Policy

Additional Guidelines

• Testing: Ensure all code changes are properly tested.

• Code Style: Follow project-specific coding standards to maintain uniformity.

By following these guidelines, you help maintain a smooth and efficient development process at Luxoria.

Introduction

This is the official documentation for the Luxoria project.

How to use

To use this documentation, simply navigate to the desired section, please navigate in the selected section to find the desired information.

Are you ready for development ?

Good practices

• Always use the latest version of the documentation.

• If you find any errors, please report them.

• If you have any suggestions, please let us know.

Contributing

Introduction

This is the official documentation for the Luxoria project.

Are you ready for development ?

How to contribute

To contribute to this documentation, please follow the steps below:

Step 1: Fork the repository

• Click on the Fork button at the top right corner of the repository.

Step 2: Clone the repository

• Clone the repository to your local machine using the following command:

git clone REPOSITORY_URL

Step 3: Create a new branch

• Create a new branch using the following command:

git checkout -b BRANCH_NAME

Step 4: Make changes

• Make the necessary changes to the documentation.

Step 5: Commit changes

• Commit the changes using the following command:

git add .
git commit -m "COMMIT_MESSAGE"

Step 6: Push changes

• Push the changes to the repository using the following command:

git push origin BRANCH_NAME

Step 7: Create a pull request

• Create a pull request from your forked repository to the original repository.

Features

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Features

Features

Features

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Features

Features

Features

Features

Bug Fixes

Features

1.0.0 (2024-11-19)

Bug Fixes

Features

Overview

Luxoria Standard Modules (LuxStd Modules) are a collection of core modules designed to provide essential functionalities within the Luxoria ecosystem. These modules follow a standardized architecture, ensuring seamless integration, extensibility, and interoperability with other Luxoria components.

Characteristics of LuxStd Modules

• Modular Design: Each module follows a plug-and-play architecture.

• Event-Driven: Modules communicate through event-based interactions using IEventBus.

• Extensible: Can be enhanced with additional features without breaking compatibility.

• Asynchronous Processing: Designed for high performance with non-blocking operations.

• Logging & Error Handling: Implements structured logging via ILoggerService for debugging and diagnostics.

List of LuxStd Modules

• Handles the importation, indexing, and management of digital asset collections.

• Processes large datasets with asynchronous operations and progress tracking.

• Provides a filtering pipeline for processing and scoring digital assets.

• Uses a modular filtering algorithm framework with weighted execution.

Conclusion

LuxStd Modules form the backbone of the Luxoria ecosystem, ensuring a robust, scalable, and modular approach to handling digital assets. Their event-driven and extensible design makes them ideal for a wide range of applications within the system.

BenchmarkDotNet v0.14.0, Windows 11 (10.0.26100.2894) Apple Silicon, 6 CPU, 6 logical and 6 physical cores .NET SDK 9.0.102 [Host] : .NET 9.0.1 (9.0.124.61010), Arm64 RyuJIT AdvSIMD DEBUG DefaultJob : .NET 9.0.1 (9.0.124.61010), Arm64 RyuJIT AdvSIMD

Overview

LuxFilter is a modular filtering system designed for processing and scoring digital assets efficiently. It integrates with the Luxoria ecosystem and provides a pipeline-based approach to apply filtering algorithms to image data.

Features

• Modular filtering pipeline with weighted algorithms

• Event-driven architecture for processing notifications

• Parallelized execution for optimized performance

• Error handling for robust processing

Architecture

Core Components

LuxFilter Module

• Implements IModule

• Handles initialization, execution, and shutdown

• Provides logging for module actions

PipelineService

• Manages the execution of filtering algorithms

• Tracks progress and scores

• Uses concurrency for efficiency

IFilterAlgorithm

• Defines a standard interface for filtering algorithms

• Implements a scoring method based on image analysis

Implemented Filtering Algorithms

Image Quality Algorithms

• ResolutionAlgo: Evaluates the resolution of an image.

• SharpnessAlgo: Measures the sharpness level in an image.

Perceptual Metrics Algorithms

• BrisqueAlgo: Uses the BRISQUE metric to assess perceptual quality.

How to Use

Prerequisites

• Ensure that the Luxoria ecosystem is installed and configured properly.

• Your project should reference the necessary LuxFilter libraries.

• Implement and register IEventBus for event-driven interactions.

Installation

1. Clone or download the LuxFilter module.

2. Add the project reference in your Luxoria-based application.

3. Implement IModule interface in your module system.

Running the Module

1. Initialize the module using Initialize().

2. Configure the filtering pipeline using AddAlgorithm().

3. Pass image data through the Compute() function.

Example Usage

Initialization

• Subscribes to filtering events

• Initializes logger and context

Filtering Process

1. Pipeline Configuration

• Uses AddAlgorithm(IFilterAlgorithm algorithm, double weight) to add algorithms

• Ensures the total weight of all algorithms does not exceed 1.0

2. Image Processing

• Processes images using Compute(IEnumerable<(Guid, SKBitmap)> bitmaps)

• Applies each algorithm in the workflow to every image

3. Score Computation

• Each image receives a final score based on weighted algorithm outputs

• Results are returned as (Guid, double) tuples

Event Handling

Score Computation Event

• Notifies when an image has been processed and scored

Pipeline Completion Event

• Notifies when the pipeline has finished executing

Error Handling & Logging

• Uses ILoggerService for structured logs

• Exception handling ensures robust error reporting

• Logs execution times for performance analysis

Performance Optimizations

• Uses parallel processing for scoring

• Implements concurrent data structures for thread safety

• Optimized event-driven execution to reduce overhead

Future Enhancements

• Dynamic algorithm tuning for real-time adjustments

• Support for additional image formats

• Graphical visualization of scores

Conclusion

LuxFilter provides a scalable and efficient filtering pipeline for processing images in the Luxoria ecosystem. Its modular design, event-driven execution, and parallel processing capabilities make it an ideal choice for large-scale image scoring and analysis.

LuxImport is a image collection management system designed for efficient indexing, asset organization, and metadata handling. It provides capabilities for importing, processing, and managing image datasets, making it an ideal solution for large-scale photography and media applications.

Architecture

LuxImport follows a modular architecture to ensure scalability, maintainability, and high performance. The key components are:

1. Core Components

• ImportService: Handles the import process, including asset hashing, metadata extraction, and database initialization.

• Manifest Repository: Manages the manifest file that keeps track of indexed assets.

• LuxConfig Repository: Stores configuration settings related to collections and assets.

• FileHasherService: Computes unique hashes for images to prevent duplication.

• SkiaSharp Integration: Used for image processing, including metadata extraction and transformations.

2. Data Flow

1. Initialization: The system checks whether the target collection exists and initializes it if necessary.

2. Indexing: Images are scanned, hashed, and added to the database with relevant metadata.

3. Storage & Retrieval: Indexed assets are stored with reference to their respective manifest files.

4. Loading Assets: Assets are loaded from storage and processed based on application requirements.

3. Technologies Used

• .NET 9: Primary Framework.

• BenchmarkDotNet: Used for performance benchmarking.

• System.Threading.Tasks: Ensures efficient async processing.

• Concurrent Collections: Optimizes parallel data processing.

• SkiaSharp: Handles image processing operations such as metadata extraction and transformations.

Testing

LuxImport includes a robust testing strategy to ensure stability and correctness.

1. Unit Tests

• Covers core functionalities such as:

  • Initialization of import service.

  • Manifest file creation and retrieval.

  • File hashing and metadata extraction.

• Uses xUnit for testing.

2. Integration Tests

• Verifies the interaction between different modules.

• Tests how the ImportService handles large datasets.

3. Performance Tests

• Uses BenchmarkDotNet to measure execution time, memory allocation, and threading behavior.

• Ensures that asset indexing, loading, and retrieval are optimized for large datasets.

4. Edge Case Handling

• Ensures stability with:

  • Empty folders

  • Corrupt image files

  • Large-scale imports

Benchmarking

Performance is a key focus of LuxImport. The system is benchmarked to analyze indexing and retrieval efficiency.

1. Benchmark Strategy

• Uses BenchmarkDotNet to measure:

  • Execution time per operation.

  • Memory allocations and garbage collection pressure.

  • Threading efficiency and lock contention.

2. Benchmark Scenarios

• Initialization: Measures the time required to set up a new collection.

• Indexing: Evaluates performance when scanning and hashing assets.

• Database Operations: Tests manifest file read/write performance.

• Asset Loading: Benchmarks retrieval times for indexed images.

3. Sample Benchmark Results

Result is in microseconds (μs). You can find detailed benchmark results in the LuxImport.Benchmark/BenchmarkDotNet.Artifacts folder. The provided benchmark results are for reference only and may vary based on the system configuration. It has been tested on an Apple Silicon M2 chip on Parallels Desktop.

With 3 different collections, 50, 100, and 200 images, the benchmark results are as follows:

Overview

LuxImport is a modular system designed for importing, indexing, and managing digital collections efficiently. It integrates with the Luxoria ecosystem and provides functionalities for handling structured asset collections.

Features

• Event-driven architecture with IEventBus integration

• Asynchronous operations for improved performance

• Modular and scalable design

• Progress tracking through event notifications

• Parallel processing for asset loading

Architecture

Core Components

LuxImport Module

• Implements IModule

• Handles initialization, execution, and shutdown

• Listens to OpenCollectionEvent and triggers import process

ImportService

• Manages the actual import process

• Tracks progress and sends updates via event notifications

• Loads assets into memory

ManifestRepository

• Handles metadata storage and retrieval

• Ensures collection initialization and integrity

LuxConfigRepository

• Stores per-asset configuration

• Manages LuxCfg models in .lux/assets

ImageDataHelper

• Loads image assets efficiently

• Uses SkiaSharp for image decoding

How to Use

Prerequisites

• Ensure that the Luxoria ecosystem is installed and configured properly.

• Your project should reference the necessary LuxImport libraries.

• Implement and register IEventBus for event-driven interactions.

Installation

1. Clone or download the LuxImport module.

2. Add the project reference in your Luxoria-based application.

3. Implement IModule interface in your module system.

Running the Module

1. Initialize the module using Initialize().

2. Subscribe to the OpenCollectionEvent.

3. When an import request is triggered, LuxImport processes the collection.

4. Once completed, CollectionUpdatedEvent is published.

Example Usage

Initialization

• Subscribes to OpenCollectionEvent

• Initializes logger and context

Import Process

1. Collection Validation

• Checks if the collection path is valid and initialized

2. Indexing & Asset Processing

• Reads metadata from manifest.json

• Hashes and stores asset references

• Uses parallel processing for efficiency

3. Asset Loading

• Loads assets into memory

• Uses ImageDataHelper for efficient decoding

4. Completion & Event Publishing

• Publishes CollectionUpdatedEvent upon successful import

Event Handling

OpenCollectionEvent Listener

• Triggers collection import

• Sends progress updates

CollectionUpdatedEvent Publisher

• Notifies the system of import completion

Error Handling & Logging

• Uses ILoggerService for structured logs

• Exception handling ensures robust error reporting

Performance Optimizations

• Uses parallel processing in LoadAssets

• Minimizes blocking I/O operations

• Implements batch logging to prevent log spam

Future Enhancements

• Cache system for faster re-imports

• Support for more file formats

• UI integration for progress monitoring

Conclusion

LuxImport is designed for efficient, modular asset importation and indexing within the Luxoria ecosystem. Its event-driven design and asynchronous processing make it highly scalable and reliable.