Split `namespaces` into Different Libraries. #3136

cschuchardt88 · 2024-02-12T20:02:03Z

Description

This is a small change for now. A lot more changes to come in future PRs. But this will force everyone to organize their code to the appropriate libraries. All namespace, class, methods and etc are all the same. The only difference is they may have moved to a different library. In addition, local or global variable names may have changed; these changes do not affect the functionality in any way; just following our coding practices.

Please Note: This will break neo-modules. We will need to update after this PR is merged. Nevermind this won't break them unless you don't import from neo.dll

Libraries

Neo.IO
- All things IO
Neo.Extensions
- All things that extend functionality of neo. Including but not limited to other libraries. No test functionality allowed. Please Note: you can include this library in tests; just don't add code that extends tests.

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

How Has This Been Tested?

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
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
Any dependent changes have been merged and published in downstream modules

cschuchardt88 · 2024-02-12T20:07:01Z

@shargon @Jim8y

shargon

Thanks for make this in small pr

src/Neo.IO/Neo.IO.csproj

src/Neo.IO/ByteArrayComparer.cs

src/Neo.Extensions/Neo.Extensions.csproj

shargon · 2024-02-12T22:03:46Z

src/Neo.IO/ByteArrayComparer.cs

-                : -CompareInternal(x, y);
+            if (ReferenceEquals(x, y)) return 0;
+            if (x is null && y is not null) return -y.Length;
+            if (y is null && x is not null) return x.Length;


If x is empty, it will return 0 that means is the same, I think that it's better to return -1 and +1 only when null

Now tell if i'm wrong; i sometimes have trouble with stuff like this.

Currently flow goes

if x is same instance as y return 0

if x is null and y is not null then return x is less than y length.

if y is null and x is not null then return x is greater than y length

if x and y is not null then return the comparison

the only thing left is: if x and y is null then return 0 aka the same.

shargon · 2024-02-12T22:04:36Z

src/Neo.IO/ByteArrayComparer.cs

+            if (ReferenceEquals(x, y)) return 0;
+            if (x is null && y is not null) return -y.Length;
+            if (y is null && x is not null) return x.Length;
+            if (x is not null && y is not null)


Is imposible to be null x and y here, we can remove this if

if they both null it return 0 its the last line in the method.

But we check if both are null twice

public int Compare(byte[]? x, byte[]? y) { if (ReferenceEquals(x, y)) return 0; // x == y || x == null && y == null if (x is null && y is not null) return _direction > 0 ? -y.Length : y.Length; if (y is null && x is not null) return _direction > 0 ? x.Length : -x.Length; #pragma warning disable CS8604 // Possible null reference argument. return _direction > 0 ? CompareInternal(x, y) : -CompareInternal(x, y); #pragma warning restore CS8604 // Possible null reference argument. }

cschuchardt88 · 2024-02-13T05:28:47Z

@shargon All test pass. Updated unit tests for `ByteArrayComparer` to test changes made.

shargon · 2024-02-13T09:29:23Z

src/Neo.Extensions/Utility.cs

@@ -31,7 +31,7 @@ public Logger()
            }
        }

-        public static event LogEventHandler Logging;


Use Neo.Extensions in Neo.Vm to avoid duplicate Neo.VM.Utility.StrictUTF8? This can be done later.

shargon · 2024-02-13T09:30:14Z

tests/Neo.UnitTests/IO/UT_ByteArrayComparer.cs

@@ -12,6 +12,7 @@
 using FluentAssertions;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Neo.IO;
+using System;

 namespace Neo.UnitTests.IO


We should create a test project to Neo.IO and move these test to that project.

I planning on it.

Why not in the same PR?

This PR moves existing code to new library. There is or should be tests already created. This PR also doesn't change anything for application besides, now having an extra dll. In the next few PRs will be moving and checking for tests, if none than iIl create them. Just want to get the library projects started and not be to big.

@shargon
I can create one. If you would like.

shargon · 2024-02-13T09:34:55Z

src/Neo.IO/ByteArrayComparer.cs

+            if (ReferenceEquals(x, y)) return 0;
+            if (x is null && y is not null) return -y.Length;
+            if (y is null && x is not null) return x.Length;
+            if (x is not null && y is not null)


But we check if both are null twice

public int Compare(byte[]? x, byte[]? y) { if (ReferenceEquals(x, y)) return 0; // x == y || x == null && y == null if (x is null && y is not null) return _direction > 0 ? -y.Length : y.Length; if (y is null && x is not null) return _direction > 0 ? x.Length : -x.Length; #pragma warning disable CS8604 // Possible null reference argument. return _direction > 0 ? CompareInternal(x, y) : -CompareInternal(x, y); #pragma warning restore CS8604 // Possible null reference argument. }

src/Neo.IO/ByteArrayComparer.cs

cschuchardt88

@shargon thanks for fixing that up. if statements lose me sometimes.

cschuchardt88 · 2024-02-14T17:18:54Z

@Jim8y @shargon Can you review. This doesn't break anything; neo.dll imports these new libraries.

Also i need this to continue #3103 along with some other PRs i need to create after this. If it needs more testing, than lets merge to core-refactor branch instead.

Jim8y · 2024-02-14T17:38:52Z

working on it.

shargon · 2024-02-14T18:20:32Z

@Jim8y @shargon Can you review. This doesn't break anything; neo.dll imports these new libraries.

Also i need this to continue #3103 along with some other PRs i need to create after this. If it needs more testing, than lets merge to core-refactor branch instead.

I was waiting this response #3136 (comment)

cschuchardt88 added 4 commits February 12, 2024 14:34

INit

ecac916

Update

ac26dcb

Merge branch 'core-refactor' into refactor

41476cc

Allow access internals

eded848

cschuchardt88 marked this pull request as ready for review February 12, 2024 20:06

Update github actions workflow.

bdfbda3

shargon reviewed Feb 12, 2024

View reviewed changes

src/Neo.IO/Neo.IO.csproj Show resolved Hide resolved

src/Neo.IO/ByteArrayComparer.cs Outdated Show resolved Hide resolved

src/Neo.Extensions/Neo.Extensions.csproj Show resolved Hide resolved

cschuchardt88 added 2 commits February 12, 2024 15:25

Add assmebly internals to test assemblies

787782d

Added null checking in ByteArrayComparer.cs

dab1542

cschuchardt88 requested a review from shargon February 12, 2024 20:47

shargon reviewed Feb 12, 2024

View reviewed changes

Updated unit test for ByteArrayComparer

7b4b2d9

shargon reviewed Feb 13, 2024

View reviewed changes

Fixed ByteArrayComparer.Compare double checking.

259d29a

shargon reviewed Feb 13, 2024

View reviewed changes

src/Neo.IO/ByteArrayComparer.cs Outdated Show resolved Hide resolved

cschuchardt88 and others added 3 commits February 13, 2024 05:16

Fixed iterate same x, y in ByteArrayComparer.Compare

326bdce

Fixed test error in ByteArrayComparer.Compare

8768236

Fix redundant condition

9d89a38

cschuchardt88 commented Feb 13, 2024

View reviewed changes

Merge branch 'master' into refactor

403c2a7

Jim8y approved these changes Feb 14, 2024

View reviewed changes

shargon approved these changes Feb 15, 2024

View reviewed changes

shargon merged commit 6746665 into neo-project:master Feb 15, 2024
2 checks passed

shargon deleted the refactor branch February 15, 2024 07:48

roman-khimov added this to the v3.7.0 milestone Feb 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split `namespaces` into Different Libraries. #3136

Split `namespaces` into Different Libraries. #3136

cschuchardt88 commented Feb 12, 2024 •

edited

Loading

cschuchardt88 commented Feb 12, 2024

shargon left a comment

shargon Feb 12, 2024

cschuchardt88 Feb 13, 2024 •

edited

Loading

shargon Feb 12, 2024

cschuchardt88 Feb 13, 2024 •

edited

Loading

shargon Feb 13, 2024

cschuchardt88 commented Feb 13, 2024 •

edited

Loading

shargon Feb 13, 2024 •

edited

Loading

shargon Feb 13, 2024 •

edited

Loading

cschuchardt88 Feb 13, 2024 •

edited

Loading

shargon Feb 13, 2024

cschuchardt88 Feb 15, 2024 •

edited

Loading

shargon Feb 13, 2024

cschuchardt88 left a comment •

edited

Loading

cschuchardt88 commented Feb 14, 2024 •

edited

Loading

Jim8y commented Feb 14, 2024

shargon commented Feb 14, 2024

Split namespaces into Different Libraries. #3136

Split namespaces into Different Libraries. #3136

Conversation

cschuchardt88 commented Feb 12, 2024 • edited Loading

Description

Libraries

Type of change

How Has This Been Tested?

Checklist:

cschuchardt88 commented Feb 12, 2024

shargon left a comment

Choose a reason for hiding this comment

shargon Feb 12, 2024

Choose a reason for hiding this comment

cschuchardt88 Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

shargon Feb 12, 2024

Choose a reason for hiding this comment

cschuchardt88 Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

shargon Feb 13, 2024

Choose a reason for hiding this comment

cschuchardt88 commented Feb 13, 2024 • edited Loading

@shargon All test pass. Updated unit tests for ByteArrayComparer to test changes made.

shargon Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

shargon Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

cschuchardt88 Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

shargon Feb 13, 2024

Choose a reason for hiding this comment

cschuchardt88 Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

shargon Feb 13, 2024

Choose a reason for hiding this comment

cschuchardt88 left a comment • edited Loading

Choose a reason for hiding this comment

cschuchardt88 commented Feb 14, 2024 • edited Loading

Jim8y commented Feb 14, 2024

shargon commented Feb 14, 2024

Split `namespaces` into Different Libraries. #3136

Split `namespaces` into Different Libraries. #3136

cschuchardt88 commented Feb 12, 2024 •

edited

Loading

cschuchardt88 Feb 13, 2024 •

edited

Loading

cschuchardt88 Feb 13, 2024 •

edited

Loading

cschuchardt88 commented Feb 13, 2024 •

edited

Loading

@shargon All test pass. Updated unit tests for `ByteArrayComparer` to test changes made.

shargon Feb 13, 2024 •

edited

Loading

shargon Feb 13, 2024 •

edited

Loading

cschuchardt88 Feb 13, 2024 •

edited

Loading

cschuchardt88 Feb 15, 2024 •

edited

Loading

cschuchardt88 left a comment •

edited

Loading

cschuchardt88 commented Feb 14, 2024 •

edited

Loading