Merge pull request #50 from qorix-group/arkjedrz_rename-to-score-log

log: rename `mw_log` to `score_log`

Author: pawelrutkaq

Cargo.lock

@@ -17,17 +17,17 @@ resolver = "2"
 # Used when executing cargo from project root.
 default-members = [
     "src/containers",
-    "src/log/mw_log",
-    "src/log/mw_log_fmt",
-    "src/log/mw_log_fmt_macro",
+    "src/log/score_log",
+    "src/log/score_log_fmt",
+    "src/log/score_log_fmt_macro",
     "src/log/stdout_logger",
 ]
 # Include tests and examples as a member for IDE support and Bazel builds.
 members = [
     "src/containers",
-    "src/log/mw_log",
-    "src/log/mw_log_fmt",
-    "src/log/mw_log_fmt_macro",
+    "src/log/score_log",
+    "src/log/score_log_fmt",
+    "src/log/score_log_fmt_macro",
     "src/log/stdout_logger",
     "examples/log_builtin",
     "examples/log_custom",
@@ -40,9 +40,9 @@ license-file = "LICENSE.md"
 authors = ["S-CORE Contributors"]
 
 [workspace.dependencies]
-mw_log = { path = "src/log/mw_log" }
-mw_log_fmt = { path = "src/log/mw_log_fmt" }
-mw_log_fmt_macro = { path = "src/log/mw_log_fmt_macro" }
+score_log = { path = "src/log/score_log" }
+score_log_fmt = { path = "src/log/score_log_fmt" }
+score_log_fmt_macro = { path = "src/log/score_log_fmt_macro" }
 stdout_logger = { path = "src/log/stdout_logger" }
 
 [workspace.lints.clippy]

Cargo.toml

@@ -20,7 +20,7 @@ package log <<component>> {
         Trace
     }
 
-    class mw_log <<module>> {
+    class score_log <<module>> {
         +set_global_logger(logger: Box<dyn Log>) : Result<(), SetLoggerError>
         +set_max_level(level: LevelFilter) : ()
         +max_level() : LevelFilter
@@ -36,26 +36,26 @@ package log <<component>> {
         +trace!(...) : ()
     }
 
-    class mw_log_fmt_macro <<module>> {
-        +mw_log_format_args!(format_string: &str, args...) : Arguments<'_>
+    class score_log_fmt_macro <<module>> {
+        +score_log_format_args!(format_string: &str, args...) : Arguments<'_>
     }
 
-    package mw_log_fmt {
+    package score_log_fmt {
         +interface ScoreDebug <<trait>> {
             +fmt(&self, f: &mut dyn ScoreWrite, spec: &FormatSpec) : Result
         }
 
-        class mw_log_fmt <<module>> {
+        class score_log_fmt <<module>> {
             +write(output: &mut dyn ScoreWrite, args: Arguments<'_>) : Result
 
             +score_write!(format_string: &str, args...) : Result
         }
     }
 
-    mw_log -- Level
-    mw_log -- LevelFilter
-    mw_log -- mw_log_fmt_macro
-    mw_log -right- mw_log_fmt
+    score_log -- Level
+    score_log -- LevelFilter
+    score_log -- score_log_fmt_macro
+    score_log -right- score_log_fmt
 }
 
 @enduml

docs/baselibs_rust/log/architecture/_assets/interface.puml

@@ -2,7 +2,7 @@
 
 participant "User" as actor
 participant "<<component>> log" as frontend
-participant "<<component>> mw_log_subscriber" as backend
+participant "<<component>> score_log_subscriber" as backend
 participant "no-op logger" as nop_logger
 
 actor -> frontend : Log message

docs/baselibs_rust/log/architecture/_assets/log_with_global_logger.puml

@@ -2,7 +2,7 @@
 
 participant "User" as actor
 participant "<<component>> log" as frontend
-participant "<<component>> mw_log_subscriber" as backend
+participant "<<component>> score_log_subscriber" as backend
 
 actor -> backend : Create concrete logger instance
 backend --> actor : Logger instance

docs/baselibs_rust/log/architecture/_assets/log_with_local_logger.puml

@@ -1,7 +1,7 @@
 @startuml register_global_logger
 
 participant "User" as actor
-participant "<<component>> mw_log_subscriber" as backend
+participant "<<component>> score_log_subscriber" as backend
 participant "<<component>> log" as frontend
 
 actor -> backend : Create concrete logger instance

docs/baselibs_rust/log/architecture/_assets/register_global_logger.puml

@@ -1,21 +1,21 @@
 @startuml log_static_view
 
 package "log" <<component>> {
-    component "mw_log" <<interface>>
+    component "score_log" <<interface>>
 
-    component "mw_log_fmt"
+    component "score_log_fmt"
 
-    component "mw_log_fmt_macro"
+    component "score_log_fmt_macro"
 
-    mw_log ..> mw_log_fmt : use
-    mw_log ..> mw_log_fmt_macro : use
+    score_log ..> score_log_fmt : use
+    score_log ..> score_log_fmt_macro : use
 }
 
-component "mw_log_subscriber" <<component>>
+component "score_log_subscriber" <<component>>
 note bottom
     Backend implementation.
 end note
 
-mw_log --> mw_log_subscriber : implements
+score_log --> score_log_subscriber : implements
 
 @enduml

docs/baselibs_rust/log/architecture/_assets/static_view.puml

@@ -1,7 +1,7 @@
 @startuml class_diagram
 
-package "mw_log crate" {
-    note as mw_log_desc
+package "score_log crate" {
+    note as score_log_desc
         Implementation of logging front-end.
         Based on 'log' library.
     end note
@@ -60,7 +60,7 @@ package "mw_log crate" {
         Trace
     }
 
-    class mw_log <<module>> {
+    class score_log <<module>> {
         {static} -LOGGER: &dyn Log
 
         +set_global_logger(logger: Box<dyn Log>) : Result<(), SetLoggerError>
@@ -96,13 +96,13 @@ package "mw_log crate" {
         </code>
     end note
 
-    mw_log -- Log
-    mw_log -- Level
-    mw_log -- LevelFilter
+    score_log -- Log
+    score_log -- Level
+    score_log -- LevelFilter
 }
 
-package "mw_log_fmt crate" {
-    note as mw_log_fmt_desc
+package "score_log_fmt crate" {
+    note as score_log_fmt_desc
         Formatting interface, similar to 'std::fmt'.
         Expanded with support for non-string variables.
     end note
@@ -190,7 +190,7 @@ package "mw_log_fmt crate" {
     ' Trait implementations rely on "ScoreWrite".
     ScoreDebug --> ScoreWrite
 
-    class mw_log_fmt <<module>> {
+    class score_log_fmt <<module>> {
         +write(output: &mut dyn ScoreWrite, args: Arguments<'_>) : Result
 
         +score_write!(format_string: &str, args...) : Result
@@ -212,12 +212,12 @@ package "mw_log_fmt crate" {
         </code>
     end note
 
-    mw_log_fmt -- Arguments
+    score_log_fmt -- Arguments
 }
 
-package "mw_log_fmt_macro crate" {
-    +class mw_log_fmt_macro <<module>> {
-        +mw_log_format_args!(format_string: &str, args...) : Arguments<'_>
+package "score_log_fmt_macro crate" {
+    +class score_log_fmt_macro <<module>> {
+        +score_log_format_args!(format_string: &str, args...) : Arguments<'_>
     }
 
     note top
@@ -226,8 +226,8 @@ package "mw_log_fmt_macro crate" {
     end note
 }
 
-package "mw_log_subscriber crate" {
-    note as mw_log_subscriber_desc
+package "score_log_subscriber crate" {
+    note as score_log_subscriber_desc
         Example of backend implementation.
     end note
 
@@ -258,10 +258,10 @@ package "mw_log_subscriber crate" {
     ExampleLog *-- ExampleScoreWrite
 }
 
-"mw_log crate" -[hidden]down-> "mw_log_fmt crate"
-"mw_log crate" -[hidden]up-> "mw_log_fmt_macro crate"
+"score_log crate" -[hidden]down-> "score_log_fmt crate"
+"score_log crate" -[hidden]up-> "score_log_fmt_macro crate"
 
-"mw_log crate" -[hidden]down------> "mw_log_subscriber crate"
-"mw_log_fmt crate" -[hidden]down------> "mw_log_subscriber crate"
+"score_log crate" -[hidden]down------> "score_log_subscriber crate"
+"score_log_fmt crate" -[hidden]down------> "score_log_subscriber crate"
 
 @enduml

docs/baselibs_rust/log/detailed_design/_assets/class_diagram.puml

@@ -3,11 +3,11 @@
 participant "User" as actor
 
 box #LightBlue
-participant "mw_log <<module>>" as mw_log
+participant "score_log <<module>>" as score_log
 end box
 
 box #LightGreen
-participant "mw_log_fmt_macro <<module>>" as mw_log_fmt_macro
+participant "score_log_fmt_macro <<module>>" as score_log_fmt_macro
 end box
 
 box #LightPink
@@ -16,55 +16,55 @@ participant "Writer\n<<ScoreWrite implementation>>" as writer
 end box
 
 box #LightYellow
-participant "mw_log_fmt\n<<module>>" as mw_log_fmt
+participant "score_log_fmt\n<<module>>" as score_log_fmt
 participant "ConcreteType\n<<ScoreDebug implementation>>" as score_debug
 end box
 
-actor -> mw_log : log!()
+actor -> score_log : log!()
 
 alt no-user-provided-logger
-    mw_log -> mw_log : global_logger()
+    score_log -> score_log : global_logger()
 end
 
 alt no-user-provided-context
-    mw_log -> mw_log : module_path()
+    score_log -> score_log : module_path()
 end
 
-mw_log -> mw_log : max_level()
+score_log -> score_log : max_level()
 
 alt log-level-check-failed
-    mw_log --> actor
+    score_log --> actor
 
 else log-level-check-passed
-    mw_log -> mw_log_fmt_macro : mw_log_format_args!()
-    mw_log_fmt_macro --> mw_log
+    score_log -> score_log_fmt_macro : score_log_format_args!()
+    score_log_fmt_macro --> score_log
 
-    mw_log -> logger : log()
+    score_log -> logger : log()
 
     logger -> logger : enabled()
 
     alt logger-not-enabled
-        logger --> mw_log
+        logger --> score_log
 
     else logger-enabled
-        logger -> mw_log_fmt : write(writer: ScoreWrite, args: Arguments)
+        logger -> score_log_fmt : write(writer: ScoreWrite, args: Arguments)
         loop process-format-string-fragments
             alt is-literal
-                mw_log_fmt -> writer : write_str()
-                writer --> mw_log_fmt
+                score_log_fmt -> writer : write_str()
+                writer --> score_log_fmt
             else is-placeholder
-                mw_log_fmt -> score_debug : fmt()
-                score_debug --> mw_log_fmt
+                score_log_fmt -> score_debug : fmt()
+                score_debug --> score_log_fmt
 
-                mw_log_fmt -> writer : write_<type>()
-                writer --> mw_log_fmt
+                score_log_fmt -> writer : write_<type>()
+                writer --> score_log_fmt
             end
         end
 
-        mw_log_fmt --> logger
-        logger --> mw_log
+        score_log_fmt --> logger
+        logger --> score_log
     end
-    mw_log --> actor
+    score_log --> actor
 end
 
 @enduml