Improve maintainability of labeler class with labels class extract

dependabot · Mar 30, 2021 · 5139882 · 5139882
1 parent 47351a1
commit 5139882
Show file tree

Hide file tree

Showing 19 changed files with 90 additions and 91 deletions.
diff --git a/bundler/lib/dependabot/bundler.rb b/bundler/lib/dependabot/bundler.rb
@@ -10,9 +10,9 @@
 require "dependabot/bundler/requirement"
 require "dependabot/bundler/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("bundler", name: "ruby", colour: "ce2d2d")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("bundler", name: "ruby", colour: "ce2d2d")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/cargo/lib/dependabot/cargo.rb b/cargo/lib/dependabot/cargo.rb
@@ -10,9 +10,9 @@
 require "dependabot/cargo/requirement"
 require "dependabot/cargo/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("cargo", name: "rust", colour: "000000")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("cargo", name: "rust", colour: "000000")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("cargo", ->(_) { true })
diff --git a/common/lib/dependabot/pull_request_creator/labeler.rb b/common/lib/dependabot/pull_request_creator/labeler.rb
@@ -9,22 +9,7 @@ class Labeler
       DEFAULT_DEPENDENCIES_LABEL = "dependencies"
       DEFAULT_SECURITY_LABEL = "security"
 
-      @package_manager_labels = {}
-
-      class << self
-        attr_reader :package_manager_labels
-
-        def label_details_for_package_manager(package_manager)
-          label_details = @package_manager_labels[package_manager]
-          return label_details if label_details
-
-          raise "Unsupported package_manager #{package_manager}"
-        end
-
-        def register_label_details(package_manager, label_details)
-          @package_manager_labels[package_manager] = label_details
-        end
-      end
+      Labels = Dependabot::PullRequestCreator::Labelers::PackageManagerLabels
 
       def initialize(source:, custom_labels:, credentials:, dependencies:,
                      includes_security_fixes:, label_language:,
@@ -226,10 +211,8 @@ def language_label_exists?
       end
 
       def language_label
-        label_name =
-          self.class.label_details_for_package_manager(package_manager).
-          fetch(:name)
-        labels.find { |l| l.casecmp(label_name).zero? }
+        label = Labels.details(package_manager)
+        labels.find { |l| l.casecmp(label.language).zero? }
       end
 
       def labels
@@ -269,15 +252,13 @@ def fetch_gitlab_labels
       end
 
       def fetch_azure_labels
-        langauge_name =
-          self.class.label_details_for_package_manager(package_manager).
-          fetch(:name)
+        label = Labels.details(package_manager)
 
         @labels = [
           *@labels,
           DEFAULT_DEPENDENCIES_LABEL,
           DEFAULT_SECURITY_LABEL,
-          langauge_name
+          label.language
         ].uniq
       end
 
@@ -351,36 +332,30 @@ def create_gitlab_security_label
       end
 
       def create_github_language_label
-        langauge_name =
-          self.class.label_details_for_package_manager(package_manager).
-          fetch(:name)
+        label = Labels.details(package_manager)
         github_client_for_source.add_label(
           source.repo,
-          langauge_name,
-          self.class.label_details_for_package_manager(package_manager).
-            fetch(:colour),
-          description: "Pull requests that update #{langauge_name.capitalize} "\
+          label.language,
+          label.colour,
+          description: "Pull requests that update #{label.language.capitalize} "\
                        "code",
           accept: "application/vnd.github.symmetra-preview+json"
         )
-        @labels = [*@labels, langauge_name].uniq
+        @labels = [*@labels, label.language].uniq
       rescue Octokit::UnprocessableEntity => e
         raise unless e.errors.first.fetch(:code) == "already_exists"
 
-        @labels = [*@labels, langauge_name].uniq
+        @labels = [*@labels, label.language].uniq
       end
 
       def create_gitlab_language_label
-        langauge_name =
-          self.class.label_details_for_package_manager(package_manager).
-          fetch(:name)
+        label = Labels.details(package_manager)
         gitlab_client_for_source.create_label(
           source.repo,
-          langauge_name,
-          "#" + self.class.label_details_for_package_manager(package_manager).
-                fetch(:colour)
+          label.language,
+          "#" + label.colour
         )
-        @labels = [*@labels, langauge_name].uniq
+        @labels = [*@labels, label.language].uniq
       end
 
       def github_client_for_source

diff --git a/common/lib/dependabot/pull_request_creator/labelers/package_manager_labels.rb b/common/lib/dependabot/pull_request_creator/labelers/package_manager_labels.rb
@@ -0,0 +1,24 @@
+
+class PackageManagerLabels
+  attr_reader :language, :colour
+
+  @@labels = {}
+
+  def initialize(language, colour)
+    @language = language
+    @colour = colour
+  end
+
+  class << self
+    def details(package_manager)
+      label_details = @@labels[package_manager]
+      return label_details if label_details
+
+      raise "Unsupported package_manager #{package_manager}"
+    end
+
+    def register_label(package_manager, details)
+      @@labels[package_manager] = new(details[:name], details[:colour])
+    end
+  end
+end
diff --git a/common/spec/dummy_package_manager/dummy.rb b/common/spec/dummy_package_manager/dummy.rb
@@ -4,9 +4,9 @@
 require_relative "requirement"
 require_relative "version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("dummy", name: "ruby", colour: "ce2d2d")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("dummy", name: "ruby", colour: "ce2d2d")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/composer/lib/dependabot/composer.rb b/composer/lib/dependabot/composer.rb
@@ -10,9 +10,9 @@
 require "dependabot/composer/requirement"
 require "dependabot/composer/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("composer", name: "php", colour: "45229e")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("composer", name: "php", colour: "45229e")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/dep/lib/dependabot/dep.rb b/dep/lib/dependabot/dep.rb
@@ -10,9 +10,9 @@
 require "dependabot/dep/requirement"
 require "dependabot/dep/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("dep", name: "go", colour: "16e2e2")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("dep", name: "go", colour: "16e2e2")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("dep", ->(_) { true })
diff --git a/docker/lib/dependabot/docker.rb b/docker/lib/dependabot/docker.rb
@@ -10,9 +10,9 @@
 require "dependabot/docker/requirement"
 require "dependabot/docker/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("docker", name: "docker", colour: "21ceff")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("docker", name: "docker", colour: "21ceff")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("docker", ->(_) { true })
diff --git a/elm/lib/dependabot/elm.rb b/elm/lib/dependabot/elm.rb
@@ -10,9 +10,9 @@
 require "dependabot/elm/requirement"
 require "dependabot/elm/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("elm", name: "elm", colour: "76d3f2")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("elm", name: "elm", colour: "76d3f2")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("elm", ->(_) { true })
diff --git a/git_submodules/lib/dependabot/git_submodules.rb b/git_submodules/lib/dependabot/git_submodules.rb
@@ -10,9 +10,9 @@
 require "dependabot/git_submodules/requirement"
 require "dependabot/git_submodules/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("submodules", name: "submodules", colour: "000000")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("submodules", name: "submodules", colour: "000000")
 
 require "dependabot/dependency"
 Dependabot::Dependency.

diff --git a/github_actions/lib/dependabot/github_actions.rb b/github_actions/lib/dependabot/github_actions.rb
@@ -10,9 +10,9 @@
 require "dependabot/github_actions/requirement"
 require "dependabot/github_actions/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details(
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label(
     "github_actions",
     name: "github_actions",
     colour: "000000"

diff --git a/go_modules/lib/dependabot/go_modules.rb b/go_modules/lib/dependabot/go_modules.rb
@@ -10,9 +10,9 @@
 require "dependabot/go_modules/requirement"
 require "dependabot/go_modules/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("go_modules", name: "go", colour: "16e2e2")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("go_modules", name: "go", colour: "16e2e2")
 
 require "dependabot/dependency"
 Dependabot::Dependency.

diff --git a/gradle/lib/dependabot/gradle.rb b/gradle/lib/dependabot/gradle.rb
@@ -10,9 +10,9 @@
 require "dependabot/gradle/requirement"
 require "dependabot/gradle/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("gradle", name: "java", colour: "ffa221")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("gradle", name: "java", colour: "ffa221")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("gradle", ->(_) { true })

diff --git a/hex/lib/dependabot/hex.rb b/hex/lib/dependabot/hex.rb
@@ -10,9 +10,9 @@
 require "dependabot/hex/requirement"
 require "dependabot/hex/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("hex", name: "elixir", colour: "9380dd")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("hex", name: "elixir", colour: "9380dd")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/maven/lib/dependabot/maven.rb b/maven/lib/dependabot/maven.rb
@@ -10,9 +10,9 @@
 require "dependabot/maven/requirement"
 require "dependabot/maven/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("maven", name: "java", colour: "ffa221")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("maven", name: "java", colour: "ffa221")
 
 require "dependabot/dependency"
 Dependabot::Dependency.

diff --git a/npm_and_yarn/lib/dependabot/npm_and_yarn.rb b/npm_and_yarn/lib/dependabot/npm_and_yarn.rb
@@ -10,9 +10,9 @@
 require "dependabot/npm_and_yarn/requirement"
 require "dependabot/npm_and_yarn/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("npm_and_yarn", name: "javascript", colour: "168700")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("npm_and_yarn", name: "javascript", colour: "168700")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/nuget/lib/dependabot/nuget.rb b/nuget/lib/dependabot/nuget.rb
@@ -10,9 +10,9 @@
 require "dependabot/nuget/requirement"
 require "dependabot/nuget/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("nuget", name: ".NET", colour: "7121c6")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("nuget", name: ".NET", colour: "7121c6")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check("nuget", ->(_) { true })
diff --git a/python/lib/dependabot/python.rb b/python/lib/dependabot/python.rb
@@ -11,9 +11,9 @@
 require "dependabot/python/version"
 require "dependabot/python/name_normaliser"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("pip", name: "python", colour: "2b67c6")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("pip", name: "python", colour: "2b67c6")
 
 require "dependabot/dependency"
 Dependabot::Dependency.register_production_check(

diff --git a/terraform/lib/dependabot/terraform.rb b/terraform/lib/dependabot/terraform.rb
@@ -10,9 +10,9 @@
 require "dependabot/terraform/requirement"
 require "dependabot/terraform/version"
 
-require "dependabot/pull_request_creator/labeler"
-Dependabot::PullRequestCreator::Labeler.
-  register_label_details("terraform", name: "terraform", colour: "5C4EE5")
+require "dependabot/pull_request_creator/labelers/package_manager_labels"
+Dependabot::PullRequestCreator::Labelers::PackageManagerLabels.
+  register_label("terraform", name: "terraform", colour: "5C4EE5")
 
 require "dependabot/dependency"
 Dependabot::Dependency.