Support for props over getters/setters + initial OSLC RM support (#322)

Author: berezovskyi

.github/workflows/main.yml

@@ -87,9 +87,9 @@ jobs:
       - name: Target ${{ matrix.version.target }} only
         shell: pwsh
         run: |
-          (Get-Content Tests/OSLC4Net.ChangeManagementTest/OSLC4Net.ChangeManagementTest.csproj) |
+          (Get-Content Tests/OSLC4Net.Test.RefImpl/OSLC4Net.Test.RefImpl.csproj) |
             ForEach-Object { $_ -replace '>net8.0<', '>${{ matrix.version.target }}<' } |
-            Set-Content Tests/OSLC4Net.ChangeManagementTest/OSLC4Net.ChangeManagementTest.csproj
+            Set-Content Tests/OSLC4Net.Test.RefImpl/OSLC4Net.Test.RefImpl.csproj
           (Get-Content Tests/OSLC4Net.Client.Tests/OSLC4Net.Client.Tests.csproj) |
             ForEach-Object { $_ -replace '>net8.0<', '>${{ matrix.version.target }}<' } |
             Set-Content Tests/OSLC4Net.Client.Tests/OSLC4Net.Client.Tests.csproj

CHANGELOG.md

@@ -3,10 +3,11 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-Legend: 🔒️ security fixes; ⚡️ major features/updates; ❗️ breaking changes; 👉 important notes.
+and this project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+Legend: 🔒️ security fixes; ⚡️ major features/updates; ❗️ breaking changes; 👉
+important notes.
 
 ## [0.5.0] - 2025-04-13
 
@@ -16,10 +17,17 @@ This release does not contain security updates.
 
 ### Added
 
-- ⚡️ CI integration tests against OSLC RefImpl based on NET Aspire
-- Redirect loop protection for `OslcClient` (max 20 redirects as in Firefox/Blink/WebKit)
-- Follow redirects on more responses statuses (was: 301, became: 301, 302, 307, 308, and in case of GET requests, 303 too)
-- ❗️ `OslcResponse` can now expose multiple response resources, the `Graph` and, in case of error, the `oslc:Error` resource.
+- ⚡️ CI integration tests against OSLC RefImpl CM/RM based on NET Aspire
+- ⚡️ Ability to define OSLC resource POCOs using C# properties instead of
+  Java-style getters/setters.
+- ⚡️ Support for the OSLC Requirements Management 2.1 domain with property-based code.
+- Added full vocabulary definitions for FOAF, DC Terms, DC Elements, LDP, PROV-O, QUDT, SKOS.
+- Redirect loop protection for `OslcClient` (max 20 redirects as in
+  Firefox/Blink/WebKit)
+- Follow redirects on more responses statuses (was: 301, became: 301, 302, 307,
+  308, and in case of GET requests, 303 too)
+- ❗️ `OslcResponse` can now expose multiple response resources, the `Graph` and,
+  in case of error, the `oslc:Error` resource.
 
 ### Changed
 
@@ -29,7 +37,9 @@ This release does not contain security updates.
 ### Deprecated
 
 - Most non-async methods in client classes.
-- Further OSLC JSON deprecations. Clients should rely on RDF instead (RDF/XML, Turtle)
+- Further OSLC JSON deprecations. Clients should rely on RDF instead (RDF/XML,
+  Turtle)
+- Old OSLC Requirements Management classes that were hand-rolled and used Java code style.
 
 ### Removed
 
@@ -38,8 +48,8 @@ This release does not contain security updates.
 
 ### Fixed
 
-- Minor bug fixes to pass acceptance tests against OSLC RefImpl Change Management server.
-
+- Minor bug fixes to pass acceptance tests against OSLC RefImpl Change
+  Management server.
 
 ## [0.4.6] - 2024-11-15
 
@@ -71,8 +81,10 @@ This release does not remove any features.
 
 ### Security
 
--  🔒️  Transitive dependency System.Net.Http was set to version 4.3.4 to avoid failing the build when NU1903 is treated as error.
--  🔒️  Transitive dependency System.Text.RegularExpressions was set to version 4.3.1 to avoid failing the build when NU1903 is treated as error.
+- 🔒️ Transitive dependency System.Net.Http was set to version 4.3.4 to avoid
+  failing the build when NU1903 is treated as error.
+- 🔒️ Transitive dependency System.Text.RegularExpressions was set to version
+  4.3.1 to avoid failing the build when NU1903 is treated as error.
 
 ### Added
 
@@ -82,22 +94,27 @@ This release does not contain new features.
 
 - Significant build changes to manage package versions centrally.
 - NuGet/assembly versions are now set based on the git tag name.
-- 👉 "snapshot" builds how have the version similar to 999.9.9-ts.202410192025, where 202410192025 is a timestamp; please note that such snapshot builds are only available via [Github Packages](https://github.com/orgs/OSLC/packages?repo_name=oslc4net).
+- 👉 "snapshot" builds how have the version similar to 999.9.9-ts.202410192025,
+  where 202410192025 is a timestamp; please note that such snapshot builds are
+  only available
+  via [Github Packages](https://github.com/orgs/OSLC/packages?repo_name=oslc4net).
 
 ### Deprecated
 
 This release does not introduce deprecations.
 
 ### Removed
 
-- Dependencies on "bridge" packages added during the migration from .NET Framework to .NET 6:
-  - System.Configuration.ConfigurationManager
-  - System.Data.DataSetExtensions
-  - Microsoft.CSharp
+- Dependencies on "bridge" packages added during the migration from .NET
+  Framework to .NET 6:
+    - System.Configuration.ConfigurationManager
+    - System.Data.DataSetExtensions
+    - Microsoft.CSharp
 
 ### Fixed
 
-- Example and test project had `<IsPackable>false</IsPackable>` property set to prevent pushing their packages to NuGet.
+- Example and test project had `<IsPackable>false</IsPackable>` property set to
+  prevent pushing their packages to NuGet.
 
 ## [0.4.4] - 2024-10-19
 
@@ -111,56 +128,82 @@ This release does not contain security updates.
 
 ### Added
 
-- ️⚡️ An example project using `OslcClient` and basic auth to retrieve a WorkItem (OSLC ChangeRequest) from Jazz.
+- ️⚡️ An example project using `OslcClient` and basic auth to retrieve a
+  WorkItem (OSLC ChangeRequest) from Jazz.
 - ``OslcClient::ForBasicAuth()`` factory method.
-- ️️️⚡️ ``OslcClient.GetResourceAsync()`` strongly typed async method that returns `OslcResponse<T>` with either a typed resource or an error.
-- Support for complex MIME type strings for content negotiation. Current `Accept` string is set to ``text/turtle;q=1.0, application/rdf+xml;q=0.9, application/n-triples;q=0.8, text/n3;q=0.7`` by default.
+- ️️️⚡️ ``OslcClient.GetResourceAsync()`` strongly typed async method that
+  returns `OslcResponse<T>` with either a typed resource or an error.
+- Support for complex MIME type strings for content negotiation. Current
+  `Accept` string is set to
+  ``text/turtle;q=1.0, application/rdf+xml;q=0.9, application/n-triples;q=0.8, text/n3;q=0.7``
+  by default.
 - OSLC Query results now expose a `.TotalCount` property.
 
 ### Changed
 
 - ❗️ `OSLC4Net.Client` now requires `netstandard2.1` (was: `netstandard2.0`)
-- Upgraded dotNetRDF to [v3.3.0](https://github.com/dotnetrdf/dotnetrdf/releases/tag/v3.3.0)
+- Upgraded dotNetRDF
+  to [v3.3.0](https://github.com/dotnetrdf/dotnetrdf/releases/tag/v3.3.0)
 
 ### Deprecated
 
-- Some constructors on `OslcClient` were deprecated (around skipping TLS checks).
-- 👉 log4net logging will be replaced with the standard Microsoft [ILogger](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=net-8.0) in a future release.
-- Direct use of `IEnumerator` properties on `OslcQueryResponse` to iterate over response pages.
-- Multiple symbols on OSLC Query related code with Java-like signatures (various `Get*` methods) and string types. Prefer C# props of type `Uri`.
+- Some constructors on `OslcClient` were deprecated (around skipping TLS
+  checks).
+- 👉 log4net logging will be replaced with the standard
+  Microsoft [ILogger](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=net-8.0)
+  in a future release.
+- Direct use of `IEnumerator` properties on `OslcQueryResponse` to iterate over
+  response pages.
+- Multiple symbols on OSLC Query related code with Java-like signatures (various
+  `Get*` methods) and string types. Prefer C# props of type `Uri`.
 
 ### Removed
 
 This release does not remove any features.
 
 ### Fixed
 
-- `OslcClient` no longer overwrites most of the headers (#204). It was a similar issue to #19 (but happening with `OslcRestClient`).
-- Ensure OSLC Query responses are processed correctly when they contain multiple `oslc:ResponseInfo` objects ([!203](https://github.com/OSLC/oslc4net/pull/203)).
-
+- `OslcClient` no longer overwrites most of the headers (#204). It was a similar
+  issue to #19 (but happening with `OslcRestClient`).
+- Ensure OSLC Query responses are processed correctly when they contain multiple
+  `oslc:ResponseInfo`
+  objects ([!203](https://github.com/OSLC/oslc4net/pull/203)).
 
 ## [0.4.2] - 2024-10-09
 
 ### Security
 
-- 🔒️❗️ `OSLC4Net.Client` now defaults to strong TLS certificate checking. Skipping TLS checks now requires explicit configuration.
+- 🔒️❗️ `OSLC4Net.Client` now defaults to strong TLS certificate checking.
+  Skipping TLS checks now requires explicit configuration.
 
 ### Added
 
-- ⚡️ Support for .NET 6+ was added by migrating most of the projects in the solution to target `netstandard2.0`.
+- ⚡️ Support for .NET 6+ was added by migrating most of the projects in the
+  solution to target `netstandard2.0`.
 
 ### Changed
 
-- ⚡️ `OSLC4Net.Core` now targets `netstandard2.0`, which allows it to  be used under .NET Framework 4.7.2 or higher as well as .NET 6+.
+- ⚡️ `OSLC4Net.Core` now targets `netstandard2.0`, which allows it to be used
+  under .NET Framework 4.7.2 or higher as well as .NET 6+.
 - ⚡️ dotNetRDF was upgraded from v1 to v3 to enable targeting `netstandard2.0`.
-  - One of the key breaking changes is that `ITriple` and `INode` no longer have the `.Graph` property.
-  - ❗️ This caused breaking changes to some of the method signatures in `OSLC4Net.DotNetRdfProvider` to allow the `IGraph` instance to be passed.
+    - One of the key breaking changes is that `ITriple` and `INode` no longer
+      have the `.Graph` property.
+    - ❗️ This caused breaking changes to some of the method signatures in
+      `OSLC4Net.DotNetRdfProvider` to allow the `IGraph` instance to be passed.
 - `OSLC4Net.Client` now targets `netstandard2.0`.
-  - ❗️ The main breaking change is the replacement of the legacy `WebRequestHandler` with `HttpClientHandler`. This caused some method/constructor signatures to change.
-  - ❗️ `RemoteCertificateValidationCallback` was replaced with a lambda function.
-- `OSLC4Net.Query` now targets `netstandard2.0`. The Antlr3 runtime package targeting PCL was replaced with a package targeting NETStandard1.0 (Antlr 4 targets NETStandard2.0).
-- ❗️ `JsonMediaTypeFormatter` was renamed into `OslcJsonMediaTypeFormatter` to better reflect its purpose (support a bespoke OSLC JSON format) and avoid conflict with `System.Net.Http.Formatting.MediaTypeFormatter`.
-- Test projects were migrated from MSTestV2 to xUnit (except for integration tests for OSLC CM)
+    - ❗️ The main breaking change is the replacement of the legacy
+      `WebRequestHandler` with `HttpClientHandler`. This caused some
+      method/constructor signatures to change.
+    - ❗️ `RemoteCertificateValidationCallback` was replaced with a lambda
+      function.
+- `OSLC4Net.Query` now targets `netstandard2.0`. The Antlr3 runtime package
+  targeting PCL was replaced with a package targeting NETStandard1.0 (Antlr 4
+  targets NETStandard2.0).
+- ❗️ `JsonMediaTypeFormatter` was renamed into `OslcJsonMediaTypeFormatter` to
+  better reflect its purpose (support a bespoke OSLC JSON format) and avoid
+  conflict with `System.Net.Http.Formatting.MediaTypeFormatter`.
+- Test projects were migrated from MSTestV2 to xUnit (except for integration
+  tests for OSLC CM)
 
 ### Deprecated
 
@@ -171,7 +214,8 @@ This release does not remove any features.
 ### Removed
 
 - .NET 7 support was removed since the SDK has reached EOL.
-- `Newtonsoft.Json` package was only used in the StockQuoteSample ASP.NET MVC project. Its references were removed from all other projects.
+- `Newtonsoft.Json` package was only used in the StockQuoteSample ASP.NET MVC
+  project. Its references were removed from all other projects.
 
 ### Fixed
 
@@ -190,33 +234,48 @@ YANKED due to NuGet deployment issues.
 ### Security
 
 - 🔒️ **Updated `log4net` in response to CVE-2018-1285 (CVSS 9.8/10).**
-- 🔒️ **Updated `Newtonsoft.Json` in response to [CWE-755](https://cwe.mitre.org/data/definitions/755.html).**
+- 🔒️ **Updated `Newtonsoft.Json` in response
+  to [CWE-755](https://cwe.mitre.org/data/definitions/755.html).**
 
 ### Added
 
 - CI configuration based on Github Actions (MSBuild, NuGet, VStest).
 
 ### Changed
 
-- 👉 Since 2017-04-15, the project is hosted on Github under the OSLC community org.
+- 👉 Since 2017-04-15, the project is hosted on Github under the OSLC community
+  org.
 - The project now targets .NET 4.8 instead of .NET 4.5.
-- ⚡️ Nuget project configuration was migrated from `packages.config` to PackageReference.
+- ⚡️ Nuget project configuration was migrated from `packages.config` to
+  PackageReference.
 - ⚡️ The StockQuoteSample was updated to ASP.NET MVC 5.
-- Migrated from MSBuild-based NuGet package restore to NuGet 2.7+ Automatic Package Restore.
-- Migrated from MSTestV1 (`Microsoft.VisualStudio.QualityTools.UnitTestFramework`) to MSTestV2 (`MSTest.Test*`).
-- ❗️👉 **`AssemblyVersion` was set to `0.3.0.0`** (from 1.0.0.0 in the v0.2.3). This could be a breaking change in some cases, but given that the project was used by a small number of people, the version being obviously wrong (given being present in the 0.2.3 release) and not having a Nuget release before, we decided to go ahead. Furthermore, switching from a direct assembly reference or a project reference to a Nuget package would require changes to the project references anyway.
+- Migrated from MSBuild-based NuGet package restore to NuGet 2.7+ Automatic
+  Package Restore.
+- Migrated from MSTestV1 (
+  `Microsoft.VisualStudio.QualityTools.UnitTestFramework`) to MSTestV2 (
+  `MSTest.Test*`).
+- ❗️👉 **`AssemblyVersion` was set to `0.3.0.0`** (from 1.0.0.0 in the v0.2.3).
+  This could be a breaking change in some cases, but given that the project was
+  used by a small number of people, the version being obviously wrong (given
+  being present in the 0.2.3 release) and not having a Nuget release before, we
+  decided to go ahead. Furthermore, switching from a direct assembly reference
+  or a project reference to a Nuget package would require changes to the project
+  references anyway.
 
 ### Deprecated
 
-- Service Provider Catalog autodetection on the local host, port 8080, should not be relied upon, as the corresponding logic is deprecated.
+- Service Provider Catalog autodetection on the local host, port 8080, should
+  not be relied upon, as the corresponding logic is deprecated.
 
 ### Removed
 
 - ❗️ Support for .NET 4.5, 4.6, and 4.7 was dropped.
 
 ### Fixed
 
-- `System.Net.Http.Formatting` issues were resolved by removing references to related SDK-provider assemblies, assembly extensions, and replacing them with a uniform reference to `Microsoft.AspNet.WebApi.Client` 5.2.9.
+- `System.Net.Http.Formatting` issues were resolved by removing references to
+  related SDK-provider assemblies, assembly extensions, and replacing them with
+  a uniform reference to `Microsoft.AspNet.WebApi.Client` 5.2.9.
 
 ## [0.2.3] - 2013-07-26
 
@@ -278,11 +337,19 @@ This release does not contain bug fixes.
 
 
 [UNRELEASED]: https://github.com/OSLC/oslc4net/compare/v0.5.0...HEAD
+
 [0.5.0]: https://github.com/OSLC/oslc4net/releases/tag/v0.5.0
+
 [0.4.6]: https://github.com/OSLC/oslc4net/releases/tag/v0.4.6
+
 [0.4.5]: https://github.com/OSLC/oslc4net/releases/tag/v0.4.5
+
 [0.4.4]: https://github.com/OSLC/oslc4net/releases/tag/v0.4.4
+
 [0.4.3]: https://github.com/OSLC/oslc4net/releases/tag/v0.4.3
+
 [0.4.2]: https://github.com/OSLC/oslc4net/releases/tag/v0.4.2
+
 [0.3.0-alpha]: https://github.com/OSLC/oslc4net/releases/tag/v0.3.0-alpha
+
 [0.2.3]: https://github.com/OSLC/oslc4net/releases/tag/v0.2.3

OSLC4Net_SDK/Directory.Build.props

@@ -24,8 +24,8 @@
 
 
   <ItemGroup>
-    <SourceRoot Include="$(MSBuildThisFileDirectory)/" />
-    <None Include="$(SolutionDir)\..\README.md" Pack="true" PackagePath="README.md" />
+    <SourceRoot Include="$(MSBuildThisFileDirectory)/"/>
+    <None Include="$(SolutionDir)\..\README.md" Pack="true" PackagePath="README.md"/>
   </ItemGroup>
 
   <PropertyGroup>

OSLC4Net_SDK/OSLC4Net.Client/Oslc/Resources/Requirement.cs

@@ -24,6 +24,7 @@ namespace OSLC4Net.Client.Oslc.Resources;
 /// </summary>
 [OslcNamespace(RmConstants.REQUIREMENTS_MANAGEMENT_NAMESPACE)]
 [OslcResourceShape(title = "Requirement Resource Shape", describes = new string[] { RmConstants.TYPE_REQUIREMENT })]
+[Obsolete("See OSLC4Net.Domains.RequirementsManagement")]
 public class Requirement : RequirementBase
 {
     public Requirement()
@@ -37,6 +38,7 @@ public Requirement(Uri about) : base(about)
     }
 }
 
+[Obsolete("See OSLC4Net.Domains.RequirementsManagement")]
 public abstract class RequirementBase : AbstractResource
 {
     private string? _title;
@@ -615,4 +617,4 @@ public void SetSubjects(string[] subjects)
 
         if (subjects != null) _subjects.AddAll(subjects);
     }
-}
+}

OSLC4Net_SDK/OSLC4Net.Client/Oslc/Resources/RequirementCollection.cs

@@ -25,6 +25,7 @@ namespace OSLC4Net.Client.Oslc.Resources;
 [OslcNamespace(RmConstants.REQUIREMENTS_MANAGEMENT_NAMESPACE)]
 [OslcResourceShape(title = "Requirement Collection Resource Shape",
     describes = new string[] { RmConstants.TYPE_REQUIREMENT_COLLECTION })]
+[Obsolete("See OSLC4Net.Domains.RequirementsManagement")]
 public class RequirementCollection : RequirementBase
 {
     // The only extra field is uses
@@ -61,4 +62,4 @@ public void SetUses(Uri[] uses)
         _uses.Clear();
         _uses.AddAll(uses);
     }
-}
+}

OSLC4Net_SDK/OSLC4Net.Client/Oslc/Resources/RmConstants.cs

@@ -17,6 +17,7 @@
 
 namespace OSLC4Net.Client.Oslc.Resources;
 
+[Obsolete("See OSLC4Net.Domains.RequirementsManagement")]
 public static class RmConstants
 {
     public const string REQUIREMENTS_MANAGEMENT_DOMAIN = "http://open-services.net/ns/rm#";
@@ -38,11 +39,11 @@ public static class RmConstants
     public const string JAZZ_RM_NAV_NAMESPACE = "http://jazz.net/ns/rm/navigation#";
     public const string JAZZ_RM_ACCESS_NAMESPACE = "http://jazz.net/ns/acp#";
 
-    public static readonly QName PROPERTY_PRIMARY_TEXT = new QName(RmConstants.JAZZ_RM_NAMESPACE, "primaryText");
-    public static readonly QName PROPERTY_PARENT_FOLDER = new QName(RmConstants.JAZZ_RM_NAV_NAMESPACE, "parent");
+    public static readonly QName PROPERTY_PRIMARY_TEXT = new QName(JAZZ_RM_NAMESPACE, "primaryText");
+    public static readonly QName PROPERTY_PARENT_FOLDER = new QName(JAZZ_RM_NAV_NAMESPACE, "parent");
 
     public static readonly QName PROPERTY_ACCESS_CONTROL =
-        new QName(RmConstants.JAZZ_RM_ACCESS_NAMESPACE, "accessControl");
+        new QName(JAZZ_RM_ACCESS_NAMESPACE, "accessControl");
 
     public const string NAMESPACE_URI_XHTML = "http://www.w3.org/1999/xhtml"; //$NON-NLS-1$
-}
+}