Merge pull request #1 from KoNekoD/refactor

Refactor

README.md

@@ -18,30 +18,31 @@ The depfile is the config file for this tool, in this file you define (mainly) t
 Here is an example depfile:
 
 ```yaml
-# depfile.yaml
-paths:
-  - ./src
-exclude_files:
-  - .*test.*
-layers:
-  - name: Controller
-    collectors:
-      - type: directory
-        regex: .*Controller.*
-  - name: Repository
-    collectors:
-      - type: directory
-        regex: .*Repository.*
-  - name: Service
-    collectors:
-      - type: directory
-        regex: .*Service.*
-ruleset:
-  Controller:
-    - Service
-  Service:
-    - Repository
-  Repository: ~
+# deptrac.yaml
+deptrac:
+    paths:
+      - ./src
+    exclude_files:
+      - .*test.*
+    layers:
+      - name: Controller
+        collectors:
+          - type: directory
+            value: .*Controller.*
+      - name: Repository
+        collectors:
+          - type: directory
+            value: .*Repository.*
+      - name: Service
+        collectors:
+          - type: directory
+            value: .*Service.*
+    ruleset:
+      Controller:
+        - Service
+      Service:
+        - Repository
+      Repository: ~
 ```
 
 #### Explanation
@@ -78,7 +79,7 @@ go-deptrac was only tested on Linux and should also work on OS X. Probably it do
 To run the tool, simply pass the path of the depfile:
 
 ```shell script
-go-deptrac ./examples/simple-mvc/depfile.yaml
+go_deptrac ./examples/simple_mvc/deptrac.yaml
 ```
 
 ## Contributing

cmd/main.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	"github.com/KoNekoD/go-deptrac/pkg/infrastructure/app"
+)
+
+func main() {
+	app.Run()
+}

deptrac.yaml

@@ -5,17 +5,18 @@ services:
 
 deptrac:
   paths:
-    - ./pkg/src
+    - ./pkg
 
   analyser:
     internal_tag: "@internal"
     types:
       - class
       - class_superglobal
-      - file
+      - file_supportive
       - function
       - function_superglobal
       - function_call
+      - use
 
   formatters:
     graphviz:
@@ -39,126 +40,22 @@ deptrac:
 
   layers:
     # Domains
-    - name: Analyser
+    - name: domain
       collectors:
         - type: directory
-          value: pkg/src/core/Analyser/.*
-    - name: Ast
+          value: pkg/domain/.*
+    - name: application
       collectors:
         - type: directory
-          value: pkg/src/core/Ast/.*
-        - type: composer
-          private: true
-          composerPath: composer.json
-          composerLockPath: composer.lock
-          packages:
-            - phpstan/phpdoc-parser
-            - nikic/php-parser
-            - phpdocumentor/type-resolver
-    - name: Console
+          value: pkg/application/.*
+    - name: infrastructure
       collectors:
         - type: directory
-          value: pkg/src/supportive/Console/.*
-    - name: Dependency
-      collectors:
-        - type: directory
-          value: pkg/src/core/Dependency/.*
-    - name: DependencyInjection
-      collectors:
-        - type: directory
-          value: pkg/src/supportive/DependencyInjection/.*
-    - name: Contract
-      collectors:
-        - type: directory
-          value: pkg/src/contract/.*
-    - name: InputCollector
-      collectors:
-        - type: directory
-          value: pkg/src/core/InputCollector/.*
-    - name: Layer
-      collectors:
-        - type: directory
-          value: pkg/src/core/Layer/.*
-    - name: OutputFormatter
-      collectors:
-        - type: directory
-          value: pkg/src/supportive/OutputFormatter/.*
-        - type: composer
-          private: true
-          composerPath: composer.json
-          composerLockPath: composer.lock
-          packages:
-            - phpdocumentor/graphviz
-    - name: File
-      collectors:
-        - type: directory
-          value: pkg/src/supportive/File/.*
-    - name: Time
-      collectors:
-        - type: directory
-          value: pkg/src/supportive/Time/.*
-    - name: Supportive
-      collectors:
-        - type: bool
-          must_not:
-            - type: directory
-              value: pkg/src/supportive/.*/.*
-          must:
-            - type: directory
-              value: pkg/src/supportive/.*
-    - name: Symfony
-      collectors:
-        - type: composer
-          composerPath: composer.json
-          composerLockPath: composer.lock
-          packages:
-            - symfony/config
-            - symfony/console
-            - symfony/dependency-injection
-            - symfony/event-dispatcher
-            - symfony/filesystem
-            - symfony/finder
-            - symfony/yaml
+          value: pkg/infrastructure/.*
 
   ruleset:
-    Layer:
-      - Ast
-      - Symfony
-      - Contract
-    Console:
-      - Analyser
-      - OutputFormatter
-      - DependencyInjection
-      - File
-      - Time
-      - Symfony
-      - Contract
-    Dependency:
-      - Ast
-      - Contract
-    Analyser:
-      - Layer
-      - Dependency
-      - Ast
-      - Symfony
-      - Contract
-    OutputFormatter:
-      - DependencyInjection
-      - Symfony
-      - Contract
-    Ast:
-      - File
-      - InputCollector
-      - Symfony
-      - Contract
-    InputCollector:
-      - File
-      - Symfony
-    DependencyInjection:
-      - Symfony
-      - Console
-      - Contract
-    Contract:
-      - Symfony
-    File:
-      - Symfony
+    application:
+      - domain
+    infrastructure:
+      - application
+      - domain

examples/run_test.go

@@ -0,0 +1,34 @@
+package examples
+
+import (
+	"flag"
+	"github.com/KoNekoD/go-deptrac/pkg/infrastructure/app"
+	_ "github.com/KoNekoD/go-deptrac/resources"
+	"os"
+	"testing"
+)
+
+func TestRunSimpleCleanarch(t *testing.T) {
+	t.Parallel()
+
+	t.Run("simple_clean_arch", func(t *testing.T) {
+		configArg := "--config=examples/simple_clean_arch/deptrac.yaml"
+		os.Args = []string{"", configArg, "analyse"}
+		flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
+		app.NewApp().Run()
+	})
+
+	t.Run("simple_invalid_mvc", func(t *testing.T) {
+		configArg := "--config=examples/simple_invalid_mvc/deptrac.yaml"
+		os.Args = []string{"", configArg, "analyse"}
+		flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
+		app.NewApp().Run()
+	})
+
+	t.Run("simple_mvc", func(t *testing.T) {
+		configArg := "--config=examples/simple_mvc/deptrac.yaml"
+		os.Args = []string{"", configArg, "analyse"}
+		flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
+		app.NewApp().Run()
+	})
+}

pkg/test_projects/examples/simple-cleanarch/app/app.go → examples/simple_clean_arch/app/app.go

@@ -1,7 +1,7 @@
 package app
 
 import (
-	"github.com/KoNekoD/go-deptrac/pkg/test_projects/examples/simple-cleanarch/domain"
+	"simple-cleanarch/domain"
 )
 
 type App interface {

examples/simple_clean_arch/go.mod

@@ -0,0 +1,3 @@
+module simple-cleanarch
+
+go 1.22

pkg/test_projects/examples/simple-cleanarch/infrastructure/kv-store.go → examples/simple_clean_arch/infrastructure/kv-store.go

@@ -1,7 +1,7 @@
 package infrastructure
 
 import (
-	"github.com/KoNekoD/go-deptrac/pkg/test_projects/examples/simple-cleanarch/domain"
+	"simple-cleanarch/domain"
 )
 
 type kvStore struct {

pkg/test_projects/examples/simple-invalid-mvc/controller/controller.go → examples/simple_invalid_mvc/controller/controller.go

@@ -1,8 +1,6 @@
 package controller
 
-import (
-	"github.com/KoNekoD/go-deptrac/pkg/test_projects/examples/simple-invalid-mvc/repository"
-)
+import "github.com/KoNekoD/go-deptrac/examples/simple_invalid_mvc/repository"
 
 type Controller interface{}
 

pkg/test_projects/examples/simple-mvc/run_test.go → examples/simple_invalid_mvc/run_test.go

@@ -2,7 +2,7 @@ package simple_cleanarch
 
 import (
 	"flag"
-	"github.com/KoNekoD/go-deptrac/pkg/src/supportive/Console/Application"
+	"github.com/KoNekoD/go-deptrac/pkg/infrastructure/app"
 	_ "github.com/KoNekoD/go-deptrac/resources"
 	"os"
 	"testing"
@@ -11,7 +11,7 @@ import (
 func TestRun(t *testing.T) {
 	os.Args = []string{
 		"",
-		"--config-file=pkg/test_projects/examples/simple-mvc/depfile.yaml",
+		"--config=pkg/test_projects/examples/simple_invalid_mvc/deptrac.yaml",
 		"analyse",
 	}
 
@@ -21,7 +21,6 @@ func TestRun(t *testing.T) {
 	//	t.Fatal(err)
 	//}
 
-	Application.
-		NewApplication().
+	app.NewApp().
 		Run()
 }

pkg/test_projects/examples/simple-mvc/controller/controller.go → examples/simple_mvc/controller/controller.go

@@ -1,8 +1,6 @@
 package controller
 
-import (
-	"github.com/KoNekoD/go-deptrac/pkg/test_projects/examples/simple-mvc/service"
-)
+import "github.com/KoNekoD/go-deptrac/examples/simple_mvc/service"
 
 type Controller interface{}
 

pkg/test_projects/examples/simple-cleanarch/run_test.go → examples/simple_mvc/run_test.go

@@ -2,7 +2,7 @@ package simple_cleanarch
 
 import (
 	"flag"
-	"github.com/KoNekoD/go-deptrac/pkg/src/supportive/Console/Application"
+	"github.com/KoNekoD/go-deptrac/pkg/infrastructure/app"
 	_ "github.com/KoNekoD/go-deptrac/resources"
 	"os"
 	"testing"
@@ -11,7 +11,7 @@ import (
 func TestRun(t *testing.T) {
 	os.Args = []string{
 		"",
-		"--config-file=pkg/test_projects/examples/simple-cleanarch/depfile.yaml",
+		"--config=pkg/test_projects/examples/simple_mvc/deptrac.yaml",
 		"analyse",
 	}
 
@@ -21,7 +21,6 @@ func TestRun(t *testing.T) {
 	//	t.Fatal(err)
 	//}
 
-	Application.
-		NewApplication().
+	app.NewApp().
 		Run()
 }