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.

Sign up for GitHub

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

Jump to bottom

Inspect the DefaultCompress Class for Changes and Improvements #94

Closed
SibTiger opened this issue Dec 3, 2024 · 3 comments
Closed

Inspect the DefaultCompress Class for Changes and Improvements #94

SibTiger opened this issue Dec 3, 2024 · 3 comments
Assignees
@SibTiger
Labels
Priority: NORMAL Priority for this report or submission is: NORMAL
Milestone
Third Release (1....

Comments

@SibTiger
Copy link
Owner

SibTiger commented Dec 3, 2024

I think it is time to do one last comb over to make sure that the code is properly aligned. Make sure that the documentation and comments are correct, make sure that the code is accurate with no redundancies or superfluous statements. To perform this task on the entire class, all of the member functions will need to be inspected as we as the member variables. It would also be best to inspect the enumerators as well.

Action:

  • Inspect and revise each functions that exists within the Default Compress class, if needed.
  • Inspect and revise each variables that exists within the Default Compress class, if needed.
  • Inspect and revise each Enumerators withing the Default Compress, if needed.
  • Inspect and revise documentation within the Default Compress, if needed.
  • Further inspection may be required within the class; this will probably be the last.
@SibTiger SibTiger added the Priority: NORMAL Priority for this report or submission is: NORMAL label Dec 3, 2024
@SibTiger SibTiger added this to the Third Release (1.2.0) milestone Dec 3, 2024
@SibTiger SibTiger moved this from To do to In Progress in PSCAT Software Kanban (Version 1.2.0) Dec 5, 2024
@SibTiger SibTiger self-assigned this Dec 5, 2024
SibTiger added a commit that referenced this issue Dec 5, 2024
@SibTiger
Updated the class documentation for DefaultCompress
a586ffc 
Updated the documentation for the class description, DefaultCompress.  This was long over due and the dependencies where not entirely correct previously.  Because the focus will be on PowerShell Core, the documentation should reflect solely on that - not on Windows PowerShell 5.1, as that environment cannot work with PSCAT.

#94
SibTiger added a commit that referenced this issue Dec 5, 2024
@SibTiger
Minor wording discrepancy, "object" -> "class"
2c84abe 
Technically, we are talking about the 'class' not the 'object'.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Documentation correction - SettingsZip
ceb7c5a 
This is not truly part of this ticket, but I will go ahead an allow it so I can move forward without holding this hostage for a long period of time.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Instead of saying 'Private' just say 'Hidden'
58354bd 
I know what I am trying to do, but others more technical in POSH may not.  The intention was to 'think' of these hidden variables as 'Private' in the C++ world, but that principle is not extinct nor possible in POSH as the variable is always visible.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Changed how $__powerShellModuleName is initialized
27fa61b 
Instead of assigning the value during the creation of the DefaultCompress object, we will instead declare and initialize without having to use the class constructors.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised documentation
3a5d366 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised some Documentation in DefaultCompress
8db4580 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Removed Setters for Log Path and Log Directory
4bd1e75 
It is strongly recommended to /_NOT_/ move these directories around as the entire program will not play nice doing so -- with that do /NOT/ encourage it.  Remove the SetRootLogPath() and SetLogPath() from the DefaultCompress class.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Instead of saying 'Private' Functions, say 'Hidden'
819ced6 
The reasoning for this change can be found in this commit: 58354bd

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised Documentation for __CreateDirectories()
61bc123 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised documentation for __CheckRequiredDirectories()
da75926 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised Documentation in DetectCompressModule()
c3587c2 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised wording in log-entries for DetectCompressModule
2913fc9 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Instead of saying 'Public', say 'Visible' instead
75e5603 
Same idea as with commit: 58354bd

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Resolved Load Config. Issue
2790094 
Resolved an issue when loading the user configuration where none-existent functions would be called, SetRootLogPath() and SetLogPath().  This change is related to:  4bd1e75

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Changed how crucial member variables are initialized
d0a1a70 
Because we can assign default values of member variables when the object is created without needing a class constructor, we can assign the default values to the following member variables: $__rootLogPath, $__logPath, and $__objectGUID without needing to have the same assignment in two different constructors.

#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised Documentation in ShowAbout()
c3a0ee4 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Revised the logging strings in ShowAbout()
f1de1fc 
#94
SibTiger added a commit that referenced this issue Dec 7, 2024
@SibTiger
Removed FetchHashInformation()
9e88601 
This function is no longer required; was only used for Generating Report which had been removed in commit fe45b74

#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised the VerifyArchive() description
9710fbf 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised the documentation for DefaultCompressionLevel enum
7365a8c 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Removed ListFIles() as it is no longer used
c905c95 
Because this function was only used for reports, which was removed in commit fe45b74 .

#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Updated the Sandbox script file
20d68e3 
Despite I do not use this script file anymore, lets try not to completely forget this.

#94
@SibTiger SibTiger mentioned this issue Dec 8, 2024
Open
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised some documentation in VerifyArchive()
8261271 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Present error MsgBox when log dirs cannot be created
3e662c3 
When the required logging directories could not be created, provide a message box and further details onto the terminal buffer for the reasoning of the error.

#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised some comments in VerifyArchive()
144e26e 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Discarded unnecessary additional whitespace
32d6d79 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Show MsgBox and Error inTerminal Buf. when POSH Module not avail
a042579 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised Verbose Logging when POSH Module not avail.
7b56999 
I do not think it is possible to obtain the dotNET Core anymore; I think I wrote this in the early days when dotNET Core was not entirely bundled within POSH Core?  I could had swore you had to install both back in the day, but not really needed these days?  Hard for me to confirm 😕

#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Show Message Box and Error Message when Target File not Found
0243908 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Show a MsgBox and Error Message when Unable to Create Temp Dir.
8064f50 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised some Comments during Creating Temp. Dir.
350d3ec 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised comments in VerifyArchive()
dad4ea2 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Revised logging in VerifyArchive()
8ee059b 
#94
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Removed the DebugLoggintState() call in VerifyArchive()
e5d987b 
Because the [Logging]::DebugLoggintState() function had been removed in commit 23ed4fe , then this can be removed.

#94
#97
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Removed the DebugLoggintState() call in ExtractArchive()
92a2868 
Because the [Logging]::DebugLoggintState() function had been removed in commit 23ed4fe , then this can be removed.

#94
#97
SibTiger added a commit that referenced this issue Dec 8, 2024
@SibTiger
Removed the DebugLoggintState() call in CreateArchive()
b293332 
Because the [Logging]::DebugLoggintState() function had been removed in commit 23ed4fe , then this can be removed.

#94
#97
SibTiger added a commit that referenced this issue Dec 11, 2024
@SibTiger
Did another look over on VerifyArchive()
5c33b98 
#94
SibTiger added a commit that referenced this issue Dec 12, 2024
@SibTiger
Revised the ExtractArchive() Description
dbdbfc1 
#94
SibTiger added a commit that referenced this issue Dec 12, 2024
@SibTiger
Provide double tabs for readability
399d6ff 
#94
SibTiger added a commit that referenced this issue Dec 12, 2024
@SibTiger
Slowly Updating ExtractArchive()
7bf4798 
- Updating documentation
- $fileNameExt was never included in the initialization list
- Moved the assignments  for $fileName, $fileNameExt, $execReason right below the initialization list.
- Provide a message box to the user when things go horribly wrong.

#94
SibTiger added a commit that referenced this issue Dec 13, 2024
@SibTiger
Revised ExtractArchive() and CreateArchive()
af1a955 
When an error occurs, present a message box to the user when something happens.

#94
SibTiger added a commit that referenced this issue Dec 13, 2024
@SibTiger
Revised ThrashLogs() to not support Reports
f1ba2ce 
Revised the function  such that there is no mention nor support of 'Reports', as that is no longer a feature within the class.

#94
@SibTiger
Copy link
Owner Author

In a conversation today, I noticed - through some self reflection - that I fell into that 'perfection trap' again. I will focus on what /needs/ to be changed, but don't make it perfect - it'll never be perfect.

I will look over the functions again if incase I notice something out of whack, I can make the changes as needed. Otherwise, if the changes are not necessary - I'll close this ticket and call it done.

SibTiger added a commit that referenced this issue Dec 15, 2024
@SibTiger
Corrected Missing Info for Logging
317c198 
#94
@SibTiger
Copy link
Owner Author

I will go ahead and close this ticket.

@github-project-automation github-project-automation bot moved this from In Progress to Finished in PSCAT Software Kanban (Version 1.2.0) Dec 16, 2024
@SibTiger SibTiger mentioned this issue Dec 16, 2024
Closed
@SibTiger
Copy link
Owner Author

Attaching this to #73

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SibTiger SibTiger

Labels
Priority: NORMAL Priority for this report or submission is: NORMAL
Projects
PSCAT Software Kanban (Version 1.2.0)
Status: Finished
Milestone
Third Release (1.2.0)
Development

No branches or pull requests
1 participant
@SibTiger