From 9a188874d0ca85ba32d96d0c67b367bbd2b26f19 Mon Sep 17 00:00:00 2001 From: Phanindra Srungavarapu Date: Wed, 7 Aug 2024 13:17:47 +0530 Subject: [PATCH] chore: changed can-i-merge build badge text --- .rubocop.yml | 2 +- .../api/resources/can_i_merge_badge.rb | 7 ++----- lib/pact_broker/badges/service.rb | 18 +++++++++++------- .../api/resources/can_i_merge_badge_spec.rb | 2 +- spec/lib/pact_broker/badges/service_spec.rb | 7 ++++--- 5 files changed, 19 insertions(+), 17 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 468cf638f..7929ddddf 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -72,7 +72,6 @@ Lint/EachWithObjectArgument: Lint/ElseLayout: Description: 'Check for odd code arrangement in an else block.' Enabled: true - EnforcedStyleAlignWith: variable Lint/EmptyEnsure: Description: 'Checks for empty ensure block.' @@ -85,6 +84,7 @@ Lint/EmptyInterpolation: Layout/EndAlignment: Description: 'Align ends correctly.' Enabled: true + EnforcedStyleAlignWith: variable Lint/EnsureReturn: Description: 'Do not use return in an ensure block.' diff --git a/lib/pact_broker/api/resources/can_i_merge_badge.rb b/lib/pact_broker/api/resources/can_i_merge_badge.rb index 846724eda..964b74957 100644 --- a/lib/pact_broker/api/resources/can_i_merge_badge.rb +++ b/lib/pact_broker/api/resources/can_i_merge_badge.rb @@ -8,7 +8,7 @@ class CanIMergeBadge < BaseResource include BadgeMethods # This module contains all necessary webmachine methods for badge implementation def badge_url - if pacticipant.nil? + if pacticipant.nil? # pacticipant method is defined in BaseResource # if the pacticipant is nil, we return an error badge url badge_service.error_badge_url("pacticipant", "not found") elsif version.nil? @@ -16,10 +16,7 @@ def badge_url badge_service.error_badge_url("main branch version", "not found") else # we call badge_service to build the badge url - badge_service.can_i_merge_badge_url( - version_number: version.number, - deployable: results - ) + badge_service.can_i_merge_badge_url(deployable: results) end end diff --git a/lib/pact_broker/badges/service.rb b/lib/pact_broker/badges/service.rb index a835585bc..a96b53220 100644 --- a/lib/pact_broker/badges/service.rb +++ b/lib/pact_broker/badges/service.rb @@ -40,16 +40,20 @@ def can_i_deploy_badge_url(tag, environment_tag, label, deployable) build_shield_io_uri(title, status, color) end - def can_i_merge_badge_url(version_number: nil, deployable: nil) + def can_i_merge_badge_url(deployable: nil) title = "can-i-merge" - status = deployable ? "yes" : "no" - if deployable.nil? - color = "lightgrey" - status = "unknown" + + # rubocop:disable Layout/EndAlignment + color, status = case deployable + when nil + [ "lightgrey", "unknown" ] + when true + [ "brightgreen", "success" ] else - color = deployable ? "brightgreen" : "red" - status = version_number + [ "red", "failed" ] end + # rubocop:enable Layout/EndAlignment + # left text is "can-i-merge", right text is the version number build_shield_io_uri(title, status, color) end diff --git a/spec/lib/pact_broker/api/resources/can_i_merge_badge_spec.rb b/spec/lib/pact_broker/api/resources/can_i_merge_badge_spec.rb index 06faf32d4..b0ebb8e4d 100644 --- a/spec/lib/pact_broker/api/resources/can_i_merge_badge_spec.rb +++ b/spec/lib/pact_broker/api/resources/can_i_merge_badge_spec.rb @@ -33,7 +33,7 @@ module Resources end it "return the badge URL" do - expect(badge_service). to receive(:can_i_merge_badge_url).with(version_number: "1", deployable: true) + expect(badge_service). to receive(:can_i_merge_badge_url).with(deployable: true) expect(subject.headers["Location"]).to eq "http://badge_url" end end diff --git a/spec/lib/pact_broker/badges/service_spec.rb b/spec/lib/pact_broker/badges/service_spec.rb index 209e88ad6..fc2b451ff 100644 --- a/spec/lib/pact_broker/badges/service_spec.rb +++ b/spec/lib/pact_broker/badges/service_spec.rb @@ -33,14 +33,15 @@ module Badges let(:version_number) { "abcd1234" } let(:deployable) { true } - subject { Service.can_i_merge_badge_url(version_number: version_number, deployable: deployable) } + subject { Service.can_i_merge_badge_url(deployable: deployable) } + context "when deployable is true" do - it { is_expected.to eq URI("https://img.shields.io/badge/can--i--merge-abcd1234-brightgreen.svg") } + it { is_expected.to eq URI("https://img.shields.io/badge/can--i--merge-success-brightgreen.svg") } end context "when deployable is false" do let(:deployable) { false } - it { is_expected.to eq URI("https://img.shields.io/badge/can--i--merge-abcd1234-red.svg") } + it { is_expected.to eq URI("https://img.shields.io/badge/can--i--merge-failed-red.svg") } end end