Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/bmspt 283 delegate methods #23

Open
wants to merge 30 commits into
base: develop
Choose a base branch
from

Conversation

BalintBende
Copy link
Contributor

@BalintBende BalintBende commented Sep 5, 2024

Description

PR includes the delegate callback function and stream process func for converters.

Fixes

Type Of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality
    to not work as expected)
  • This change requires a documentation update
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no API changes)
  • CI/Build related changes (so that Github is happy)
  • Dockerfile related changes
  • Documentation content changes
  • Tests (extended coverage or fixing existing tests)
  • Updated dependencies

API Changes

  • Introducing a new method or property
  • Updating the API
  • Deprecating methods or properties

Environment (Docker)

  • Adding a new environment variable
  • Updating the production container

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have checked my code and corrected any misspellings
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested my code in the local docker-compose environment
  • My feature branch builds on Github

eriadam and others added 29 commits May 29, 2024 13:57
* [BMSPT-275] implementation of bcf zip creation with memory stream

* [BMSPT-275] refactor & reorganization

* [BMSPT-275] added unit tests

* Simplified IConverter API. Added support for predefined output streams.

* [BMSPT-297] Checking incoming streams if they can be used for the given use case. Added documentation.

---------

Co-authored-by: DanielLepold <daniel@bimspot.io>
Co-authored-by: Adam Eri <adam.eri@blackmirror.at>
…18)

* [BMSPT-293] Added cancellation token to Converter stream operations.

* [BMSPT-293] Added cancellation token to Converter stream operations.

---------

Co-authored-by: Adam Eri <adam.eri@bimspot.io>
…, refactoring, extended worker with converter ToBcf fns, supporting cancellation token and output stream
…re/BMSPT-283-delegate-methods

# Conflicts:
#	bcf-toolkit.sln.DotSettings.user
#	src/bcf-toolkit/Builder/Bcf21/Interfaces/IViewPointBuilder.cs
#	src/bcf-toolkit/Builder/Bcf30/Interfaces/IViewPointBuilder.cs
#	src/bcf-toolkit/Builder/Bcf30/ViewPointBuilder.cs
#	src/bcf-toolkit/Converter/Bcf21/Converter.cs
#	src/bcf-toolkit/Converter/Bcf21/FileWriter.cs
#	src/bcf-toolkit/Converter/Bcf21/SchemaConverterToBcf30.cs
#	src/bcf-toolkit/Converter/Bcf30/Converter.cs
#	src/bcf-toolkit/Converter/Bcf30/FileWriter.cs
#	src/bcf-toolkit/Converter/Bcf30/SchemaConverterToBcf21.cs
#	src/bcf-toolkit/Model/Bcf21/MarkupExtensions.cs
#	src/bcf-toolkit/Model/Bcf21/VisInfo.cs
#	src/bcf-toolkit/Model/Bcf30/MarkupExtensions.cs
#	src/bcf-toolkit/Program.cs
#	src/bcf-toolkit/README.md
#	src/bcf-toolkit/Utils/BcfExtensions.cs
#	src/bcf-toolkit/Utils/ZipArchiveEntryExtensions.cs
#	src/bcf-toolkit/Utils/ZipArchiveExtensions.cs
#	src/tests/Converter/Bcf21/FileWriterTest.cs
#	src/tests/Converter/Bcf30/ConverterTests.cs
#	src/tests/Converter/Bcf30/FileWriterTests.cs
#	src/tests/WorkerTests.cs
…er and converter, fixed and extended tests, extended readme
@BalintBende BalintBende requested a review from eriadam September 5, 2024 14:31
Copy link

github-actions bot commented Sep 5, 2024

Test Results

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ❌ ±0 

Results for commit 7c099c7. ± Comparison against base commit 846135b.

♻️ This comment has been updated with latest results.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls consider the following solutions for the "return Task.Completed case":
if (_delegate is null) {
throw new InvalidOperationException("IBcfBuilderDelegate is not set.");
}

if (_delegate is null) {
    return Task.FromException(new InvalidOperationException("IBcfBuilderDelegate is not set."));
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the commented-out parts remain for future use?

Copy link
Contributor

@DanielLepold DanielLepold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work!
Pls see my comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants