Merge pull request #4 from yumemi-inc/feature/ResponsibilityRefactor

Feature/responsibility refactor

README.md

@@ -39,27 +39,29 @@ A danger-swift plug-in to manage/post danger checking results with markdown styl
 
 ## Usage
 
-- First of all create a result data structure with `CheckResult` initializer
+Basically just use `.shoki` property from a `DangerDSL` instance to access all features provided by DangerSwiftShoki
+
+Examples below assume you have initialized a `danger` using `Danger()` in your `Dangerfile.swift`
+
+- First of all create a report data structure with `makeInitialReport` method
 
     ```swift
-    var checkResult = CheckResult(title: "My Check")
+    var report = danger.shoki.makeInitialReport(title: "My Report")
     ```
 
-- Then you can perform any check with `check` method, by returning your check result in the trailing `execution` closure
+- Then you can perform any checks with `check` method, by returning your check result in the trailing `execution` closure
 
     ```swift
-    checkResult.check("Test Result Check") {
+    danger.shoki.check("Test Result Check", into: &report) {
         if testPassed {
             return .good
 
         } else {
             if isAcceptable {
-                warn("Encouraged to make a change but OK at this time")
-                return .acceptable
+                return .acceptable(warningMessage: "Encouraged to make a change but OK at this time")
 
             } else {
-                fail("Must fix")
-                return .rejected
+                return .rejected(failureMessage: "Must fix")
             }
         }
     }
@@ -68,20 +70,20 @@ A danger-swift plug-in to manage/post danger checking results with markdown styl
 - You can also ask reviewers not to forget to do some manual checks with `askReviewer` method if needed
 
     ```swift
-    checkResult.askReviewer(to: "Check whether commit messages are correctly formatted or not")
+    danger.shoki.askReviewer(to: "Check whether commit messages are correctly formatted or not", into: $report)
     ```
 
-- At last post the whole check result with `shoki.report` method which is available for `DangerDSL` instances
+- At last post the whole check result with `report` method
 
     ```swift
-    danger.shoki.report(checkResult) // Assume you have initialized `danger` by code like `let danger = Danger()`
+    danger.shoki.report(report)
     ```
 
 ## Preview
 
 Code above will make danger producing markdown messages like below
 
-> ## My Check
+> ## My Report
 >
 > Checking Item | Result
 > | ---| --- |

Sources/DangerSwiftShoki/DangerDSL+.swift

@@ -10,8 +10,12 @@ import Danger
 extension DangerDSL {
 
     public var shoki: Shoki {
-        return .init(markdownExecutor: { markdown($0) },
-                     messageExecutor: { message($0) })
+        return .init(
+            markdownExecutor: { markdown($0) },
+            messageExecutor: { message($0) },
+            warningExecutor: { warn($0) },
+            failureExecutor: { fail($0) }
+        )
     }
 
 }

Sources/DangerSwiftShoki/MarkdownConfiguration.swift

@@ -0,0 +1,113 @@
+//
+//  MarkdownConfiguration.swift
+//  
+//
+//  Created by 史 翔新 on 2021/12/02.
+//
+
+public struct MarkdownConfiguration {
+
+    var titleMarkdownFormatter: (String) -> String
+    var messageMarkdownFormatter: ([Report.CheckItem]) -> String
+    var warningMarkdownFormatter: (Report.WarningMessage) -> String
+    var failureMarkdownFormatter: (Report.FailureMessage) -> String
+    var todosMarkdownFormatter: ([String]) -> String
+    var congratulationsMessage: String
+
+    public static func defaultTitleMarkdown(title: String) -> String {
+
+        "## " + title
+
+    }
+
+    public static func defaultMessageMarkdown(checkItems: [Report.CheckItem]) -> String {
+
+        guard !checkItems.isEmpty else {
+            return ""
+        }
+
+        let chartHeader = """
+            Checking Item | Result
+            | ---| --- |
+            
+            """
+        let chartContent = checkItems.map {
+            "\($0.title) | \($0.result.markdownSymbol)"
+        } .joined(separator: "\n")
+
+        return chartHeader + chartContent
+
+    }
+
+    public static func defaultWarningMarkdown(warning: Report.WarningMessage) -> String {
+
+        let messageSuffix = warning.message.map { ": \($0)" } ?? " has a warning."
+        return warning.title + messageSuffix
+
+    }
+
+    public static func defaultFailureMarkdown(failure: Report.FailureMessage) -> String {
+
+        let messageSuffix = failure.message.map { ": \($0)" } ?? " failed."
+        return failure.title + messageSuffix
+
+    }
+
+    public static func defaultTodosMarkdown(todos: [String]) -> String {
+
+        guard !todos.isEmpty else {
+            return ""
+        }
+
+        let todoContent = todos.map {
+            "- [ ] \($0)"
+        }
+
+        return todoContent.joined(separator: "\n")
+
+    }
+
+    public static var defaultCongratulationsMessage: String {
+
+        "Good Job :white_flower:"
+
+    }
+
+    public init(
+        titleMarkdownFormatter: @escaping (String) -> String = defaultTitleMarkdown(title:),
+        messageMarkdownFormatter: @escaping ([Report.CheckItem]) -> String = defaultMessageMarkdown(checkItems:),
+        warningMarkdownFormatter: @escaping (Report.WarningMessage) -> String = defaultWarningMarkdown(warning:),
+        failureMarkdownFormatter: @escaping (Report.FailureMessage) -> String = defaultFailureMarkdown(failure:),
+        todosMarkdownFormatter: @escaping ([String]) -> String = defaultTodosMarkdown(todos:),
+        congratulationsMessage: String = defaultCongratulationsMessage
+    ) {
+        self.titleMarkdownFormatter = titleMarkdownFormatter
+        self.messageMarkdownFormatter = messageMarkdownFormatter
+        self.warningMarkdownFormatter = warningMarkdownFormatter
+        self.failureMarkdownFormatter = failureMarkdownFormatter
+        self.todosMarkdownFormatter = todosMarkdownFormatter
+        self.congratulationsMessage = congratulationsMessage
+    }
+
+    public static var `default`: MarkdownConfiguration {
+        .init()
+    }
+
+}
+
+private extension Report.CheckItem.Result {
+
+    var markdownSymbol: String {
+        switch self {
+        case .good:
+            return ":tada:"
+
+        case .acceptable:
+            return ":thinking:"
+
+        case .rejected:
+            return ":no_good:"
+        }
+    }
+
+}