From a7226db9e9914e02b30b8f57d3cf7cb7fa1a1439 Mon Sep 17 00:00:00 2001 From: "D. Moonfire" Date: Sun, 21 Apr 2024 12:58:51 -0500 Subject: [PATCH] feat: renamed MfGames.Crypto to MfGames.Cryptography --- MfGames.sln | 2 +- README.md | 2 +- news/2024-04-21-renaming-mfgames-crypto.md | 7 +++++++ src/MfGames.Cryptography/ByteStringFormat.cs | 2 +- ...ayExtensions.cs => CryptographyByteArrayExtensions.cs} | 6 +++--- ...tringExtensions.cs => CryptographyStringExtensions.cs} | 6 +++--- src/MfGames.Cryptography/Hashes/HashType.cs | 2 +- src/MfGames.Cryptography/Hashes/HashTypeExtensions.cs | 2 +- ...nfoExtensions.cs => CryptographyFileInfoExtensions.cs} | 8 ++++---- ...tentExtensions.cs => CryptographyContentExtensions.cs} | 8 ++++---- .../CryptographyStringExtensionsTests.cs} | 8 ++++---- .../MfGames.Cryptography.Tests.csproj} | 0 ...ryptoFileInfoTests.cs => CryptographyFileInfoTests.cs} | 6 +++--- 13 files changed, 33 insertions(+), 26 deletions(-) create mode 100644 news/2024-04-21-renaming-mfgames-crypto.md rename src/MfGames.Cryptography/Extensions/{CryptoByteArrayExtensions.cs => CryptographyByteArrayExtensions.cs} (94%) rename src/MfGames.Cryptography/Extensions/{CryptoStringExtensions.cs => CryptographyStringExtensions.cs} (94%) rename src/MfGames.IO/Extensions/{CryptoFileInfoExtensions.cs => CryptographyFileInfoExtensions.cs} (89%) rename src/MfGames.Nitride/Contents/{CryptoContentExtensions.cs => CryptographyContentExtensions.cs} (94%) rename tests/{MfGames.Crypto.Tests/CryptoStringExtensionsTests.cs => MfGames.Cryptography.Tests/CryptographyStringExtensionsTests.cs} (92%) rename tests/{MfGames.Crypto.Tests/MfGames.Crypto.Tests.csproj => MfGames.Cryptography.Tests/MfGames.Cryptography.Tests.csproj} (100%) rename tests/MfGames.IO.Tests/{CryptoFileInfoTests.cs => CryptographyFileInfoTests.cs} (90%) diff --git a/MfGames.sln b/MfGames.sln index beb41ec..02524a8 100644 --- a/MfGames.sln +++ b/MfGames.sln @@ -95,7 +95,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Nitride.Exec.Tests" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Cryptography", "src\MfGames.Cryptography\MfGames.Cryptography.csproj", "{832DBBC9-3A53-4F6B-B98C-4059DF780124}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Crypto.Tests", "tests\MfGames.Crypto.Tests\MfGames.Crypto.Tests.csproj", "{7A773B2F-ADF4-450F-8F43-D3C3C689E1CE}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Cryptography.Tests", "tests\MfGames.Cryptography.Tests\MfGames.Cryptography.Tests.csproj", "{7A773B2F-ADF4-450F-8F43-D3C3C689E1CE}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Nitride.SpectreConsole", "src\MfGames.Nitride.SpectreConsole\MfGames.Nitride.SpectreConsole.csproj", "{0C5C8D0A-D283-477F-82C4-2FF026F6EC0C}" EndProject diff --git a/README.md b/README.md index eced27e..1167ce5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This [monorepo](https://en.wikipedia.org/wiki/Monorepo) is the collection of all The documentation for the entire project can be found in the [./docs/ folder](./docs/index.md) of this project, but below are some notable links are: -- [MfGames.Gallium](./docs/gallium/index.md) - A toy Entity-Component-System (ECS) modeled after LINQ methods calls and suitable for environment where ease of use is more critical than performance. +- [MfGames.Gallium](./docs/gallium/index.md) - A simplified Entity-Component-System (ECS) modeled after LINQ methods calls and suitable for environment where ease of use is more critical than performance. - [MfGames.Nitride](./docs/nitride/index.md) - A flexible, configuration-as-code, static site generator build on top of MfGames.Gallium. ## Installing Packages diff --git a/news/2024-04-21-renaming-mfgames-crypto.md b/news/2024-04-21-renaming-mfgames-crypto.md new file mode 100644 index 0000000..92865a0 --- /dev/null +++ b/news/2024-04-21-renaming-mfgames-crypto.md @@ -0,0 +1,7 @@ +# Renaming MfGames.Crypto to MfGames.Cryptography + +For many years, "crypto" really meant only one thing in the programming world: cryptozoology. No, actually "cryptography." However, with the advent of web3 and cryptocurrencies, the world "crypto" is becoming muddled and no-longer obvious of its purpose. + +Recently, [BouncyCastle](https://www.bouncycastle.org/) has gone through a little refactoring themselves after starting with `BouncyCastle` then renaming themselves to `Portable.BouncyCastle` and finally `BouncyCastle.Cryptography`. Overally, we like the final name and it was inspiration for us doing the same. + +So, it isn't really marked as a "breaking" change, but `MfGames.Crypto` is being renamed to `MfGames.Cryptography`. And, to avoid the struggle we had with BouncyCastle, the namespace also was changed to reflect that change. diff --git a/src/MfGames.Cryptography/ByteStringFormat.cs b/src/MfGames.Cryptography/ByteStringFormat.cs index 10cdca7..102a1ee 100644 --- a/src/MfGames.Cryptography/ByteStringFormat.cs +++ b/src/MfGames.Cryptography/ByteStringFormat.cs @@ -1,4 +1,4 @@ -namespace MfGames.Crypto; +namespace MfGames.Cryptography; public enum ByteStringFormat { diff --git a/src/MfGames.Cryptography/Extensions/CryptoByteArrayExtensions.cs b/src/MfGames.Cryptography/Extensions/CryptographyByteArrayExtensions.cs similarity index 94% rename from src/MfGames.Cryptography/Extensions/CryptoByteArrayExtensions.cs rename to src/MfGames.Cryptography/Extensions/CryptographyByteArrayExtensions.cs index 83bc5f4..a4406cb 100644 --- a/src/MfGames.Cryptography/Extensions/CryptoByteArrayExtensions.cs +++ b/src/MfGames.Cryptography/Extensions/CryptographyByteArrayExtensions.cs @@ -1,11 +1,11 @@ -using MfGames.Crypto.Hashes; +using MfGames.Cryptography.Hashes; -namespace MfGames.Crypto.Extensions; +namespace MfGames.Cryptography.Extensions; /// /// Extension methods on byte arrays. /// -public static class CryptoByteArrayExtensions +public static class CryptographyByteArrayExtensions { /// /// Converts the input into a hash string, such as hex or base64. diff --git a/src/MfGames.Cryptography/Extensions/CryptoStringExtensions.cs b/src/MfGames.Cryptography/Extensions/CryptographyStringExtensions.cs similarity index 94% rename from src/MfGames.Cryptography/Extensions/CryptoStringExtensions.cs rename to src/MfGames.Cryptography/Extensions/CryptographyStringExtensions.cs index 5862fbe..4ce04c0 100644 --- a/src/MfGames.Cryptography/Extensions/CryptoStringExtensions.cs +++ b/src/MfGames.Cryptography/Extensions/CryptographyStringExtensions.cs @@ -1,12 +1,12 @@ using System.Text; -using MfGames.Crypto.Hashes; +using MfGames.Cryptography.Hashes; -namespace MfGames.Crypto.Extensions; +namespace MfGames.Cryptography.Extensions; /// /// Extension methods for generating hashes for strings. /// -public static class CryptoStringExtensions +public static class CryptographyStringExtensions { /// /// Gets the encoded byte array of the given string. diff --git a/src/MfGames.Cryptography/Hashes/HashType.cs b/src/MfGames.Cryptography/Hashes/HashType.cs index 67d237a..c368171 100644 --- a/src/MfGames.Cryptography/Hashes/HashType.cs +++ b/src/MfGames.Cryptography/Hashes/HashType.cs @@ -1,4 +1,4 @@ -namespace MfGames.Crypto.Hashes; +namespace MfGames.Cryptography.Hashes; /// /// An enumeration of various hash types. diff --git a/src/MfGames.Cryptography/Hashes/HashTypeExtensions.cs b/src/MfGames.Cryptography/Hashes/HashTypeExtensions.cs index 581a35d..6021fc9 100644 --- a/src/MfGames.Cryptography/Hashes/HashTypeExtensions.cs +++ b/src/MfGames.Cryptography/Hashes/HashTypeExtensions.cs @@ -1,6 +1,6 @@ using System.Security.Cryptography; -namespace MfGames.Crypto.Hashes; +namespace MfGames.Cryptography.Hashes; public static class HashTypeExtensions { diff --git a/src/MfGames.IO/Extensions/CryptoFileInfoExtensions.cs b/src/MfGames.IO/Extensions/CryptographyFileInfoExtensions.cs similarity index 89% rename from src/MfGames.IO/Extensions/CryptoFileInfoExtensions.cs rename to src/MfGames.IO/Extensions/CryptographyFileInfoExtensions.cs index dfc4f66..6f139b8 100644 --- a/src/MfGames.IO/Extensions/CryptoFileInfoExtensions.cs +++ b/src/MfGames.IO/Extensions/CryptographyFileInfoExtensions.cs @@ -1,13 +1,13 @@ -using MfGames.Crypto; -using MfGames.Crypto.Extensions; -using MfGames.Crypto.Hashes; +using MfGames.Cryptography; +using MfGames.Cryptography.Extensions; +using MfGames.Cryptography.Hashes; namespace MfGames.IO.Extensions; /// /// Extensions for generating /// -public static class CryptoFileInfoExtensions +public static class CryptographyFileInfoExtensions { /// /// Hashes the given input and returns the results. diff --git a/src/MfGames.Nitride/Contents/CryptoContentExtensions.cs b/src/MfGames.Nitride/Contents/CryptographyContentExtensions.cs similarity index 94% rename from src/MfGames.Nitride/Contents/CryptoContentExtensions.cs rename to src/MfGames.Nitride/Contents/CryptographyContentExtensions.cs index c697e40..75c27e4 100644 --- a/src/MfGames.Nitride/Contents/CryptoContentExtensions.cs +++ b/src/MfGames.Nitride/Contents/CryptographyContentExtensions.cs @@ -1,10 +1,10 @@ -using MfGames.Crypto; -using MfGames.Crypto.Extensions; -using MfGames.Crypto.Hashes; +using MfGames.Cryptography; +using MfGames.Cryptography.Extensions; +using MfGames.Cryptography.Hashes; namespace MfGames.Nitride.Contents; -public static class CryptoContentExtensions +public static class CryptographyContentExtensions { /// /// Hashes the given input and returns the results. diff --git a/tests/MfGames.Crypto.Tests/CryptoStringExtensionsTests.cs b/tests/MfGames.Cryptography.Tests/CryptographyStringExtensionsTests.cs similarity index 92% rename from tests/MfGames.Crypto.Tests/CryptoStringExtensionsTests.cs rename to tests/MfGames.Cryptography.Tests/CryptographyStringExtensionsTests.cs index 5730f06..90c84f6 100644 --- a/tests/MfGames.Crypto.Tests/CryptoStringExtensionsTests.cs +++ b/tests/MfGames.Cryptography.Tests/CryptographyStringExtensionsTests.cs @@ -1,10 +1,10 @@ -using MfGames.Crypto.Extensions; -using MfGames.Crypto.Hashes; +using MfGames.Cryptography.Extensions; +using MfGames.Cryptography.Hashes; using Xunit; -namespace MfGames.Crypto.Tests; +namespace MfGames.Cryptography.Tests; -public class CryptoStringExtensionsTests +public class CryptographyStringExtensionsTests { [Fact] public void PasswordAsBase64Md5() diff --git a/tests/MfGames.Crypto.Tests/MfGames.Crypto.Tests.csproj b/tests/MfGames.Cryptography.Tests/MfGames.Cryptography.Tests.csproj similarity index 100% rename from tests/MfGames.Crypto.Tests/MfGames.Crypto.Tests.csproj rename to tests/MfGames.Cryptography.Tests/MfGames.Cryptography.Tests.csproj diff --git a/tests/MfGames.IO.Tests/CryptoFileInfoTests.cs b/tests/MfGames.IO.Tests/CryptographyFileInfoTests.cs similarity index 90% rename from tests/MfGames.IO.Tests/CryptoFileInfoTests.cs rename to tests/MfGames.IO.Tests/CryptographyFileInfoTests.cs index 630a153..c15ee48 100644 --- a/tests/MfGames.IO.Tests/CryptoFileInfoTests.cs +++ b/tests/MfGames.IO.Tests/CryptographyFileInfoTests.cs @@ -1,12 +1,12 @@ using System.IO; -using MfGames.Crypto; -using MfGames.Crypto.Hashes; +using MfGames.Cryptography; +using MfGames.Cryptography.Hashes; using MfGames.IO.Extensions; using Xunit; namespace MfGames.IO.Tests; -public class CryptoFileInfoTests +public class CryptographyFileInfoTests { [Fact] public void HashPasswordFileAsLowercaseHexSha256()