Merge pull request #7 from fabiodcorreia/restructure-v1

Restructure v1

Author: fabiodcorreia

.github/workflows/codeql-analysis.yml

@@ -33,8 +33,6 @@ jobs:
       fail-fast: false
       matrix:
         language: [ 'go' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:

Makefile

@@ -1,5 +1,4 @@
-#VERSION = $(shell git describe --tags --always --dirty --match=v* 2> /dev/null || echo v0)
-VERSION = $(shell git describe --tags --match=v* 2> /dev/null || echo 0.1.0)
+VERSION = $(shell git describe --tags --match=v* 2> /dev/null || echo 0.0.0)
 
 APPID = com.github.fabiodcorreia.catch-my-file
 ICON = assets/icons/icon-512.png
@@ -15,13 +14,10 @@ review: format
 	@misspell .
 
 	@echo "============= Ineffectual Assignments Check ============= "
-	@ineffassign $(TARGET)
-
-	@echo "============= Cyclomatic Complexity Check ============= "
-	@gocyclo -total -over 5 -avg $(TARGET)
+	@ineffassign ./...
 
 	@echo "============= Duplication Check ============= "
-	@dupl -t 15 $(TARGET)
+	find ./pkg -not -name '*_test.go' -name '*.go' | dupl -t 30 -files
 
 	@echo "============= Repeated Strings Check ============= "
 	@goconst $(TARGET)
@@ -37,8 +33,26 @@ review: format
 
 	@echo "============= Shadow Variables Check ============= "
 	@shadow -strict ./...
+
+	@echo "============= Cyclomatic Complexity Check ============= "
+	@gocyclo -total -ignore "_test" -over 8 -avg $(TARGET)
 
-pre-build: review
+test: 
+	@go test -cover ./pkg/...
+
+cover: 
+	@go test -coverprofile=coverage.out ./pkg/...
+	@go tool cover -func=coverage.out
+
+cover-html: 
+	@go test -coverprofile=coverage.out ./pkg/...
+	@go tool cover -html=coverage.out
+
+
+bench:
+	go test -benchtime=1s -count=5 -benchmem -bench . ./pkg/...
+
+pre-build: review test
 	go mod tidy
 
 build: pre-build
@@ -51,7 +65,9 @@ linux: pre-build
 	fyne-cross linux -arch amd64,arm64 -app-id $(APPID) -icon $(ICON) -app-version $(VERSION) -output $(NAME)
 
 windows: pre-build
-	fyne-cross windows -arch amd64 -app-id $(APPID) -icon $(ICON) -app-version $(VERSION) -output $(NAME)
+	fyne-cross windows -arch amd64 -app-id $(APPID) -icon $(ICON) -app-version $(VERSION) -output "$(NAME).exe"
+
+build-all: pre-build darwin linux windows
 
 bundle-linux: linux
 	mv fyne-cross/dist/linux-amd64/$(NAME).tar.gz dist/$(NAME)-$(VERSION)-linux-amd64.tar.gz

README.md

@@ -2,7 +2,7 @@
 
 # Catch My File
 
-Catch My File lets you easily send and receive files between the peers on the local network.
+Catch My File lets you easily send and receive files between peers on the local network.
 
 ## Why?
 
@@ -18,27 +18,27 @@ I wanted a tool that allows to:
 - Discover other peers on the local network without any configuration
 - Send specific files to specific peers
 - Accept or reject files sent by other peers
+- Follow the transfer progress
 - Checksum (SHA256) verification of the file when transfer is completed
-- Log display for relevant messages
 
 ## Installation
 
 - Download the required package from the releases page
 - Extract the package and run the application
 - MacOS
-    - Copy the application to the applications folder
+    - Copy the application to the applications folder or just run it directly
     - On the frist run need to allow the app to run and make network connections
 - Linux 
     - Run the command `sudo make install` to install the application
     - Run the command `sudo make uninstall` to remove the application
 - Windows
-    - *TODO*
+    - Just run the executable
 
 ## Usage
 
 ### Peers Panel
 
-This panel will show all the other peers using the application on the local network. Pressing **Send File** we can select a file from the filesystem and send it to that peer.
+This panel will show all the other peers using the application on the local network. Pressing send button we can select a file from the filesystem and send it to that peer.
 
 ![peers-view](assets/screenshots/peers-view.png)
 
@@ -49,21 +49,11 @@ After the file is selected a checksum(SHA256) is generated and a file transfer r
 ![prepar-for-sending](assets/screenshots/prepar-for-sending.png)
 
 
-### Sending Panel
+### Transfers Panel
 
-After the request is send a record is added to the Sending tab where we can follow the progress.
+After the request is send a record is added to the Transfers tab where the sender can follow the progress.
 
-![sender-view](assets/screenshots/sender-view.png)
-
-### Receiver
-
-When a peer receives a request to accept a file, a modal is shown showing that information.
-
-![transfer-request-received](assets/screenshots/transfer-request-received.png)
-
-### Receiving Panel
-
-After a request is received we can **Accept** or **Reject** it, if rejected nothing will be transferred.
+At the same time on the receiver side a similar record is added with the options to **Accept** or **Reject** the transfer, if rejected nothing will be transferred.
 
 ![receiver-view](assets/screenshots/receiver-view.png)
 
@@ -75,6 +65,14 @@ The sender can also see the progress.
 
 ![sending](assets/screenshots/sending.png)
 
+Once the transfer is completed on the sender side, the receiver will start the verification to insure the file integrity.
+
+![verifying](assets/screenshots/verifying.png)
+
+When the verification is completed with success the transfer will be completed.
+
+![completed](assets/screenshots/completed.png)
+
 
 ## Built With
 - [Go](https://go.dev/)