apadmi_grout 2.6.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8db6b7eca5ee2eb554e888bd25c267dde94978757015ed037c0d193dc372bc51
-  data.tar.gz: 514ebf8f1057e01d9b36867b5e6ee419c037691039f5a2165cca471c56a2bd9b
+  metadata.gz: 75c06e02304d0547ca158b319c9c88e895753233fd06da8d864c402ae89946e1
+  data.tar.gz: 6fda7788c5401a14481f715f4007dec869219438304b0206dfce5eb3735c3e07
 SHA512:
-  metadata.gz: d9fc365c23f6292fe1690b8b3250e7e9dd7195854f6dceb5cb0a704fb4849c9b63c1a514e786df4b911c08805237416d59c21f191e631f3bec65273a329abff1
-  data.tar.gz: 0d45b1e9c056154c19733486bad4dd34ed37fb3f7da68c825a2c639eeda9514138fce722bfe546d4238ab9d24da96597ac8520796c1132f58537e79bc776fd54
+  metadata.gz: b34320096c5d746f833c48ab31d00933188fdfe86c607a5529f58f03f15b8fb2636ba752b8d5a2743bf4b0d98563c39d21a64b950fb8706b278cc4ddca2500fb
+  data.tar.gz: 38c1b2705c12d5fb8480270a26022f1266f0bb9b15da84ffde2447ada05e7de497356a46ae759a1fc3a91fefb1aa50524a30bf52094e0da6fec31ebcdc9f763c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Core Changelog
 
+## [2.8.0] - 2025-05-22
+* Add ability to disable use of the undocumented JIRA apis
+
+## [2.7.0] - 2024-09-24
+* Add utility for checking for unmerged release branches before deployments
+
 ## [2.6.1] - 2024-01-09
 * Fix: missing blank? method because ActiveSupport requires you to load the extensions explicitly from 7.1
 

data/lib/apadmi/grout/actions/check_unfinished_releases_action.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "semantic" # We'll use this gem for semantic versioning comparison
+
+module Apadmi
+  module Grout
+    # Checks that all releases before this one are ancestors in the commit
+    # history to ensure that any unmerged fixes don't get missed
+    class CheckUnfinishedReleasesAction
+      # @param [Apadmi::Grout::GitUtils]
+      # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
+      def initialize(git_utils, logger)
+        @git_utils = git_utils
+        @logger = logger
+      end
+
+      # Runs the action.
+      # @param current_version [String] The version of this release.
+      # @param suppress_error_versions [Array<String>] Errors from unmerged versions in this list will be suppressed
+      def run(current_version, suppress_error_versions)
+        @git_utils.fetch_all
+
+        @logger.message("Checking for unmerged versions")
+        @logger.message("Suppressing checks for versions: #{suppress_error_versions}") if suppress_error_versions
+        this_version = Semantic::Version.new current_version
+        versions = extract_non_ancestor_versions
+        suppressed = suppress_error_versions.map do |version|
+          Semantic::Version.new version
+        end
+
+        # Only older versions should cause errors since features in newer
+        # versions have legitimate reasons not to be in this release
+        versions.select do |version|
+          version < this_version && !suppressed.include?(version)
+        end
+      end
+
+      private
+
+      def extract_non_ancestor_versions
+        refs = @git_utils.list_tags(
+          "--no-merged"
+        ) + @git_utils.branch(
+          " --list '*release*' '*hotfix*' --all --no-merged"
+        ).split("\n")
+
+        version_strings = refs.map do |ref|
+          match = ref.match(/.*(\d+\.\d+\.\d.*)/)
+          match[1] if match
+        end.compact
+        @logger.message("Found versions to compare #{version_strings}")
+        version_strings.map do |version_string|
+          Semantic::Version.new version_string
+        end
+      end
+    end
+  end
+end

data/lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_jira_action.rb

@@ -39,7 +39,7 @@ module Apadmi
         options = nil
       )
         custom_flag_messages ||= Apadmi::Grout::FlagMessages.default(status)
-        options ||= Apadmi::Grout::JiraFindTicketsOptions.new(include_no_sprint_tickets: false)
+        options ||= Apadmi::Grout::JiraFindTicketsOptions.new(include_no_sprint_tickets: false, inspect_prs: true)
 
         issues = @jira_board_service.search_unblocked_issues(
           component, status, [], options
@@ -55,11 +55,7 @@ module Apadmi
           @git_utils.merge_changelog(issue_keys)
         )
 
-        final_list = issues.filter do |issue|
-          # Decide whether to include this ticket based on PRs
-          status = process_prs(issue, custom_flag_messages)
-          decide_should_include(issue, status, changelog_ids)
-        end
+        final_list = filter_on_prs(changelog_ids, custom_flag_messages, issues, options)
 
         @logger.message("Final list:  #{final_list.map(&:key).join(", ")}")
         final_list
@@ -67,6 +63,18 @@ module Apadmi
 
       private
 
+      def filter_on_prs(changelog_ids, custom_flag_messages, issues, options)
+        if options.inspect_prs
+          issues.filter do |issue|
+            # Decide whether to include this ticket based on PRs
+            status = process_prs(issue, custom_flag_messages)
+            decide_should_include(issue, status, changelog_ids)
+          end
+        else
+          issues
+        end
+      end
+
       # @param issue [Apadmi::Grout::Issue]
       # @param pr_status [Int] status of whether or not we can move
       # @param changelog_ids [Array<String>] the ticket ids pulled from git

data/lib/apadmi/grout/di.rb

@@ -27,7 +27,7 @@ module Apadmi
       )
         network_service = Apadmi::Grout::NetworkService.init_for_basic_auth(username, token, base_url)
         jira_board_service = Apadmi::Grout::JiraBoardService.new(username, token, base_url, context_path, project, network_service)
-        git_utils = Apadmi::Grout::GitUtils
+        git_utils = Apadmi::Grout::GitUtils.new
         issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(jira_board_service, "#{project}-", logger)
 
         DependencyInjector.new(
@@ -53,7 +53,7 @@ module Apadmi
         ticket_prefix = "#"
         network_service = Apadmi::Grout::NetworkService.init_for_basic_auth("", personal_access_token, base_url)
         ado_board_service = Apadmi::Grout::AdoBoardService.new(network_service, ado_config, logger)
-        git_utils = Apadmi::Grout::GitUtils
+        git_utils = Apadmi::Grout::GitUtils.new
         issues_from_changelog_action = Apadmi::Grout::IssuesFromChangelogAction.new(ado_board_service, ticket_prefix, logger)
 
         DependencyInjector.new(

data/lib/apadmi/grout/models/bitrise.rb

@@ -10,7 +10,7 @@ module Apadmi
 
     BitriseBuild = Struct.new(:triggered_at, :slug, :status, :commit_hash) do
       def finished_with_success
-        STATUS_SUCCESS == status
+        status == STATUS_SUCCESS
       end
     end
 
@@ -18,7 +18,7 @@ module Apadmi
 
     TriggeredBitriseBuild = Struct.new(:build_number, :build_slug, :build_url, :message, :service, :slug, :status, :triggered_workflow) do
       def finished_with_success
-        STATUS_SUCCESS == status
+        status == STATUS_SUCCESS
       end
 
       def self.from_json(json)

data/lib/apadmi/grout/models/find_tickets_options.rb

@@ -7,11 +7,12 @@ module Apadmi
 
     # Jira specific find tickets options
     class JiraFindTicketsOptions < FindTicketsOptions
-      attr_reader :include_no_sprint_tickets
+      attr_reader :include_no_sprint_tickets, :inspect_prs
 
       # @param include_no_sprint_tickets [String] whether or not to include tickets with no sprint assigned
-      def initialize(include_no_sprint_tickets: false)
+      def initialize(include_no_sprint_tickets: false, inspect_prs: true)
         @include_no_sprint_tickets = include_no_sprint_tickets
+        @inspect_prs = inspect_prs
       end
 
       def ==(other)
@@ -19,7 +20,7 @@ module Apadmi
       end
 
       def state
-        [@include_no_sprint_tickets]
+        [@include_no_sprint_tickets, @inspect_prs]
       end
     end
 

data/lib/apadmi/grout/utils/git_utils.rb

@@ -6,60 +6,140 @@ module Apadmi
   module Grout
     # Generic Git related utils
     class GitUtils
+      def initialize(repo_path = nil)
+        @repo_path_arg = repo_path.nil? ? "" : " -C #{repo_path} "
+      end
+
+      # rubocop:disable Style/ClassVars:
+      @@default = Apadmi::Grout::GitUtils.new(nil)
+      # rubocop:enable Style/ClassVars:
+
       # Gets the root of the Git repo we're in
       # @return [String] The full path for the root of this Git repo
-      def self.git_root
-        stdout, stderr, status = Open3.capture3("git rev-parse --show-toplevel")
+      def git_root
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} rev-parse --show-toplevel")
         raise "Failed to get git root: #{stderr}" unless status.success?
 
         stdout.strip
       end
 
+      def self.git_root
+        @@default.git_root
+      end
+
+      # Returns all the tags in the repo
+      # @return [String[]] The tags
+      def list_tags(args = "")
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} tag --list #{args}")
+        raise "Failed to list tags: #{stderr}" unless status.success?
+
+        stdout.strip.split("\n")
+      end
+
+      # Returns all the tags in the repo
+      # @return [String[]] The tags
+      def self.list_tags(args = "")
+        @@default.list_tags(args)
+      end
+
+      # Runs git branch command with given args
+      def branch(args = "")
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} branch #{args}")
+        raise "Failed to run branch: #{stderr}" unless status.success?
+
+        stdout.strip
+      end
+
+      # Runs git branch command with given args
+      def self.branch(args = "")
+        @@default.branch(args)
+      end
+
       # Gets the commit hash of the current HEAD
-      def self.commit_hash
-        stdout, stderr, status = Open3.capture3("git rev-parse HEAD")
+      def commit_hash
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} rev-parse HEAD")
         raise "Failed to get hash: #{stderr}" unless status.success?
 
         stdout.strip
       end
 
+      # Gets the commit hash of the current HEAD
+      def self.commit_hash
+        @@default.commit_hash
+      end
+
       # Gets the number of commits accessible from HEAD treating the history as a graph.
       # See more details here: https://git-scm.com/docs/git-rev-list
       # @return [String] The number of commits
-      def self.number_of_commits
-        stdout, stderr, status = Open3.capture3("git rev-list HEAD --count")
+      def number_of_commits
+        raise "Repo is a shallow clone so this method will always return 1" if is_shallow_clone
+
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} rev-list HEAD --count")
         raise "Failed to get commit number: #{stderr}" unless status.success?
 
         stdout.strip
       end
 
+      # Helper function to check if a repo is a shallow clone
+      # @return [Boolean] If the repo is a shallow clone
+      def is_shallow_clone
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} rev-parse --is-shallow-repository")
+        raise "Failed to check if repo is shallow clone: #{stderr}" unless status.success?
+
+        stdout.strip.downcase == "true"
+      end
+
+      # Gets the number of commits accessible from HEAD treating the history as a graph.
+      # See more details here: https://git-scm.com/docs/git-rev-list
+      # @return [String] The number of commits
+      def self.number_of_commits
+        @@default.number_of_commits
+      end
+
       # Runs a git fetch all
-      def self.fetch_all
-        stdout, stderr, status = Open3.capture3("git fetch --all")
+      def fetch_all
+        stdout, stderr, status = Open3.capture3("git #{@repo_path_arg} fetch --all")
         raise "Failed to fetch #{stderr}" unless status.success?
 
         stdout.strip
       end
 
+      # Runs a git fetch all
+      def self.fetch_all
+        @@default.fetch_all
+      end
+
       # Gets all the merges accessible from the current HEAD which matches at least one of the given grep conditions
       # @param grep_conditions [Array<String>] values to be passed in as grep cases (https://git-scm.com/docs/git-log)
-      def self.merge_changelog(grep_conditions)
-        command = "git log HEAD --merges --format=%s#{grep_conditions.map { |c| " --grep #{c}" }.join(" ")}"
+      def merge_changelog(grep_conditions)
+        command = "git #{@repo_path_arg} log HEAD --merges --format=%s#{grep_conditions.map { |c| " --grep #{c}" }.join(" ")}"
         stdout, stderr, status = Open3.capture3(command)
         raise "Failed to get changelog: #{stderr}" unless status.success?
 
         stdout
       end
 
+      # Gets all the merges accessible from the current HEAD which matches at least one of the given grep conditions
+      # @param grep_conditions [Array<String>] values to be passed in as grep cases (https://git-scm.com/docs/git-log)
+      def self.merge_changelog(grep_conditions)
+        @@default.merge_changelog(grep_conditions)
+      end
+
       # Gets all the merges that are NOT accessible from HEAD which matches at least one of the given grep conditions
       # @param grep_conditions [Array<String>] values to be passed in as grep cases (https://git-scm.com/docs/git-log)
-      def self.invert_changelog(grep_conditions)
-        command = "git log --all ^HEAD --merges --format=%s#{grep_conditions.map { |c| " --grep #{c}" }.join(" ")}"
+      def invert_changelog(grep_conditions)
+        command = "git #{@repo_path_arg} log --all ^HEAD --merges --format=%s#{grep_conditions.map { |c| " --grep #{c}" }.join(" ")}"
         stdout, stderr, status = Open3.capture3(command)
         raise "Failed to get changelog: #{stderr}" unless status.success?
 
         stdout
       end
+
+      # Gets all the merges that are NOT accessible from HEAD which matches at least one of the given grep conditions
+      # @param grep_conditions [Array<String>] values to be passed in as grep cases (https://git-scm.com/docs/git-log)
+      def self.invert_changelog(grep_conditions)
+        @@default.invert_changelog(grep_conditions)
+      end
     end
   end
 end

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "2.6.1"
+    VERSION = "2.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Apadmi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: Apadmi build tool utils for use through Fastlane on Android and iOS.
 email:
 - samdc@apadmi.com
@@ -63,6 +77,7 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
+- lib/apadmi/grout/actions/check_unfinished_releases_action.rb
 - lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_action.rb
 - lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_ado_action.rb
 - lib/apadmi/grout/actions/find_tickets_to_move_action/find_tickets_to_move_jira_action.rb
@@ -105,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="