Merge pull request #28 from yumemi-inc/feature/git_hosting

feat: support for Git hosting other than GitHub

Sources/DangerSwiftEda/DangerDSL+.swift

@@ -12,7 +12,7 @@ extension DangerDSL {
     public var eda: Eda {
         .init(
             prMetaDataResolver: { .init(
-                gitHubInstanceResolver: { github },
+                gitHostingInstanceResolver: { Eda.gitHostingInstance ?? github },
                 gitInstanceResolver: { git },
                 hammerResolver: { hammer }
             )},

Sources/DangerSwiftEda/Eda.swift

@@ -12,7 +12,8 @@ import DangerSwiftShoki
 
 // MARK: resolvers and executors
 public struct Eda {
-
+    public static var gitHostingInstance: GitHostingInstance?
+
     private let prMetaDataResolver: () -> PRMetaData
     private let prUtilityResolver: () -> PRUtility
     private let shokiResolver: () -> Shoki
@@ -43,6 +44,10 @@ extension Eda {
         let utility = prUtilityResolver()
         let shoki = shokiResolver()
 
+        if metadata.customGitHostingInstance == nil {
+            utility.message("local PR Check: skip")
+            return
+        }
         do {
             let report = try workflow.doWorkflowCheck(against: metadata, using: utility)
             shoki.report(report)

Sources/DangerSwiftEda/GitHostingInstance.swift

@@ -0,0 +1,87 @@
+//
+//  GitHostingInstance.swift
+//  
+//
+//  Created by 古宮 伸久 on 2024/01/12.
+//
+
+import Danger
+
+public protocol GitHostingInstance {
+    var baseBranchName: String { get }
+    var headBranchName: String { get }
+    var additionLines: Int? { get }
+    var deletionLines: Int? { get }
+}
+
+extension Danger.GitHub: GitHostingInstance {
+    public var baseBranchName: String {
+        pullRequest.base.ref
+    }
+
+    public var headBranchName: String {
+        pullRequest.head.ref
+    }
+
+    public var additionLines: Int? {
+        pullRequest.additions
+    }
+
+    public var deletionLines: Int? {
+        pullRequest.deletions
+    }
+}
+
+extension Danger.GitLab: GitHostingInstance {
+    public var baseBranchName: String {
+        mergeRequest.sourceBranch.name
+    }
+
+    public var headBranchName: String {
+        mergeRequest.targetBranch.name
+    }
+
+    public var additionLines: Int? {
+        Int(mergeRequest.changesCount.replacingOccurrences(of: "+", with: ""))
+    }
+
+    public var deletionLines: Int? {
+        nil
+    }
+}
+
+extension Danger.BitBucketCloud: GitHostingInstance {
+    public var baseBranchName: String {
+        pr.source.branchName
+    }
+
+    public var headBranchName: String {
+        pr.destination.branchName
+    }
+
+    public var additionLines: Int? {
+        nil
+    }
+
+    public var deletionLines: Int? {
+        nil
+    }
+}
+
+extension Danger.BitBucketServer: GitHostingInstance {
+    public var baseBranchName: String {
+        pullRequest.fromRef.id
+    }
+
+    public var headBranchName: String {
+        pullRequest.toRef.id
+    }
+
+    public var additionLines: Int? {
+        nil
+    }
+
+    public var deletionLines: Int? {
+        nil
+    }
+}

Sources/DangerSwiftEda/PRMetaData.swift

@@ -14,7 +14,7 @@ import DangerSwiftHammer
 // MARK: resolvers
 public struct PRMetaData {
 
-    private let gitHubInstanceResolver: () -> Danger.GitHub
+    private let gitHostingInstanceResolver: () -> GitHostingInstance?
     private let gitInstanceResolver: () -> Danger.Git
     private let hammerResolver: () -> Hammer
 
@@ -26,9 +26,9 @@ public struct PRMetaData {
     private let deletionLinesResolver: (() -> Int)?
     private let modifiedFilesResolver: (() -> [String])?
     private let commitsResolver: (() -> [GitCommit])?
-    
+
     init(
-        gitHubInstanceResolver: @escaping () -> Danger.GitHub,
+        gitHostingInstanceResolver: @escaping () -> GitHostingInstance?,
         gitInstanceResolver: @escaping () -> Danger.Git,
         hammerResolver: @escaping () -> Hammer,
         baseBranchNameResolver: (() -> String)? = nil,
@@ -38,7 +38,7 @@ public struct PRMetaData {
         modifiedFilesResolver: (() -> [String])? = nil,
         commitsResolver: (() -> [GitCommit])? = nil
     ) {
-        self.gitHubInstanceResolver = gitHubInstanceResolver
+        self.gitHostingInstanceResolver = gitHostingInstanceResolver
         self.gitInstanceResolver = gitInstanceResolver
         self.hammerResolver = hammerResolver
         self.baseBranchNameResolver = baseBranchNameResolver
@@ -48,26 +48,25 @@ public struct PRMetaData {
         self.modifiedFilesResolver = modifiedFilesResolver
         self.commitsResolver = commitsResolver
     }
-
 }
 
 // MARK: resolved properties
 extension PRMetaData {
 
     public var baseBranchName: String {
-        baseBranchNameResolver?() ?? gitHubInstanceResolver().pullRequest.base.ref
+        baseBranchNameResolver?() ?? gitHostingInstanceResolver()?.baseBranchName ?? ""
     }
 
     public var headBranchName: String {
-        headBranchNameResolver?() ?? gitHubInstanceResolver().pullRequest.head.ref
+        headBranchNameResolver?() ?? gitHostingInstanceResolver()?.headBranchName ?? ""
     }
 
     public var additionLines: Int {
-        additionLinesResolver?() ?? gitHubInstanceResolver().pullRequest.additions ?? 0
+        additionLinesResolver?() ?? gitHostingInstanceResolver()?.additionLines ?? 0
     }
 
     public var deletionLines: Int {
-        deletionLinesResolver?() ?? gitHubInstanceResolver().pullRequest.deletions ?? 0
+        deletionLinesResolver?() ?? gitHostingInstanceResolver()?.deletionLines ?? 0
     }
 
     public var modifiedLines: Int {
@@ -93,9 +92,14 @@ extension PRMetaData {
     public func diffLines(in filePath: String) -> (deletions: [String], additions: [String]) {
         hammerResolver().diffLines(in: filePath)
     }
-
+
+    @available(*, deprecated, renamed: "customGitHostingInstance")
     public var customGitHubInstance: Danger.GitHub {
-        gitHubInstanceResolver()
+        Danger().github
+    }
+
+    public var customGitHostingInstance: GitHostingInstance? {
+        gitHostingInstanceResolver()
     }
 
     public var customGitInstance: Danger.Git {