fastlane-plugin-wpmreleasetoolkit 9.0.1 → 9.2.0

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/files/ios_version_file.rb

@@ -0,0 +1,64 @@
+require 'xcodeproj'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `IOSVersionFile` class takes in an .xcconfig file path and reads/writes values to/from the file.
+      class IOSVersionFile
+        attr_reader :xcconfig_path
+
+        # Initializes a new instance of IOSVersionFile with the specified .xcconfig file path.
+        #
+        # @param [String] xcconfig_path The path to the .xcconfig file.
+        #
+        def initialize(xcconfig_path:)
+          UI.user_error!(".xcconfig file not found at this path: #{xcconfig_path}") unless File.exist?(xcconfig_path)
+
+          @xcconfig_path = xcconfig_path
+        end
+
+        # Reads the release version from the .xcconfig file and returns it as a String.
+        #
+        # @return [String] The release version.
+        #
+        def read_release_version
+          config = Xcodeproj::Config.new(xcconfig_path)
+          config.attributes['VERSION_SHORT']
+        end
+
+        # Reads the build code from the .xcconfig file and returns it String.
+        #
+        # Some apps store the build code in the VERSION_LONG attribute, while others store it in the BUILD_NUMBER attribute.
+        #
+        # @param [String] attribute_name The name of the attribute to read.
+        #
+        # @return [String] The build code.
+        #
+        def read_build_code(attribute_name:)
+          UI.user_error!('attribute_name must be `VERSION_LONG` or `BUILD_NUMBER`') unless attribute_name.eql?('VERSION_LONG') || attribute_name.eql?('BUILD_NUMBER')
+
+          config = Xcodeproj::Config.new(xcconfig_path)
+          config.attributes[attribute_name]
+        end
+
+        # Writes the provided version numbers to the .xcconfig file.
+        #
+        # @param [String, nil] version_short The short version string (optional).
+        # @param [String, nil] version_long The long version string (optional).
+        # @param [String, nil] build_number The build number (optional).
+        #
+        # version_long is optional because there are times when it won't be updated, such as a new beta build.
+        # version_short is optional because some apps (such as Day One iOS/Mac or Simplenote Mac) don't use it.
+        # build_number is optional because some apps (such as WP/JP iOS or WCiOS) don't use it.
+        #
+        def write(version_short: nil, version_long: nil, build_number: nil)
+          config = Xcodeproj::Config.new(xcconfig_path)
+          config.attributes['VERSION_SHORT'] = version_short.to_s unless version_short.nil?
+          config.attributes['VERSION_LONG'] = version_long.to_s unless version_long.nil?
+          config.attributes['BUILD_NUMBER'] = build_number.to_s unless build_number.nil?
+          config.save_as(Pathname.new(xcconfig_path))
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/abstract_version_formatter.rb

@@ -0,0 +1,27 @@
+require_relative '../calculators/abstract_version_calculator'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `VersionFormatter` class is a generic version formatter that can be used as a base class
+      # for formatting version objects used by for different platforms. It contains formatting methods that
+      # are shared by all platforms. It has the abstract suffix because it should not be instantiated directly.
+      class AbstractVersionFormatter
+        # Get the release version string for the app.
+        #
+        # This method constructs the release version string based on the major, minor, and
+        # patch components of the provided `@version`. If the patch component is zero, it returns
+        # a version string in the format "major.minor" (e.g., '1.2'). Otherwise, it returns a
+        # version string in the format "major.minor.patch" (e.g., '1.2.3').
+        #
+        # @param [AppVersion] version The version object to format
+        #
+        # @return [String] The formatted release version string.
+        #
+        def release_version(version)
+          version.patch.zero? ? "#{version.major}.#{version.minor}" : "#{version.major}.#{version.minor}.#{version.patch}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/derived_build_code_formatter.rb

@@ -0,0 +1,33 @@
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `DerivedBuildCodeFormatter` class is a specialized build code formatter for derived build codes.
+      # It takes in an AppVersion object and derives a build code from it.
+      class DerivedBuildCodeFormatter
+        # Calculate the next derived build code.
+        #
+        # This method derives a new build code from the given AppVersion object by concatenating the digit 1,
+        # the major version, the minor version, the patch version, and the build number.
+        #
+        # @param [AppVersion] version The AppVersion object to derive the next build code from.
+        #
+        # @param [BuildCode] build_code A BuildCode object. This parameter is ignored but is included
+        # to have a consistent signature with other build code formatters.
+        #
+        # @return [String] The formatted build code string.
+        #
+        def build_code(build_code = nil, version:)
+          format(
+            # 1 is appended to the beginning of the string in case there needs to be additional platforms or
+            # extensions that could then use a different digit prefix such as 2, etc.
+            '1%<major>.2i%<minor>.2i%<patch>.2i%<build_number>.2i',
+            major: version.major,
+            minor: version.minor,
+            patch: version.patch,
+            build_number: version.build_number
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/four_part_build_code_formatter.rb

@@ -0,0 +1,22 @@
+require_relative '../formatters/four_part_version_formatter'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `FourPartBuildCodeFormatter` is a specialized build code formatter for apps that use
+      # build codes in the format of `major.minor.patch.build_number`.
+      class FourPartBuildCodeFormatter
+        # @param [AppVersion] version The AppVersion object to format
+        #
+        # @param [BuildCode] build_code A BuildCode object. This parameter is ignored but is included
+        # to have a consistent signature with other build code formatters.
+        #
+        # @return [String] The formatted build code string.
+        #
+        def build_code(build_code = nil, version:)
+          FourPartVersionFormatter.new.to_s(version)
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/four_part_version_formatter.rb

@@ -0,0 +1,35 @@
+require_relative 'abstract_version_formatter'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `FourPartVersionFormatter` class  extends the `VersionFormatter` class. It is a specialized version formatter for
+      # apps that use versions in the format of `1.2.3.4`.
+      class FourPartVersionFormatter < AbstractVersionFormatter
+        # Parse the version string into an AppVersion instance
+        #
+        # @param [String] version The version string to parse
+        #
+        # @return [AppVersion] The parsed version
+        #
+        def parse(version)
+          # Split the version string into its components
+          components = version.split('.').map(&:to_i)
+
+          # Create a new AppVersion instance from the version string components
+          Fastlane::Models::AppVersion.new(*components)
+        end
+
+        # Return the formatted version string
+        #
+        # @param [AppVersion] version The version object to format
+        #
+        # @return [String] The formatted version string
+        #
+        def to_s(version)
+          "#{version.major}.#{version.minor}.#{version.patch}.#{version.build_number}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/rc_notation_version_formatter.rb

@@ -0,0 +1,65 @@
+require_relative 'abstract_version_formatter'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `RCNotationVersionFormatter` class extends the `VersionFormatter` class. It is a specialized version
+      # formatter for apps that may use versions in the format of `1.2.3-rc-4`.
+      class RCNotationVersionFormatter < AbstractVersionFormatter
+        # The string identifier used for beta versions in Android.
+        RC_SUFFIX = 'rc'.freeze
+
+        # Parse the version string into an AppVersion instance
+        #
+        # @param [String] version_name The version string to parse
+        #
+        # @return [AppVersion] The parsed version
+        #
+        def parse(version_name)
+          # Set the build number to 0 by default so that it will be set correctly for non-beta version numbers
+          build_number = 0
+
+          if version_name.include?(RC_SUFFIX)
+            # Extract the build number from the version name
+            build_number = version_name.split('-')[2].to_i
+            # Extract the version name without the build number and drop the RC suffix
+            version_name = version_name.split(RC_SUFFIX)[0]
+          end
+
+          # Split the version name into its components
+          version_number_parts = version_name.split('.').map(&:to_i)
+          # Fill the array with 0 if needed to ensure array has at least 3 components
+          version_number_parts.fill(0, version_number_parts.length...3)
+
+          # Map version_number_parts to AppVersion model
+          major = version_number_parts[0]
+          minor = version_number_parts[1]
+          patch = version_number_parts[2]
+
+          # Create an AppVersion object
+          Fastlane::Models::AppVersion.new(major, minor, patch, build_number)
+        end
+
+        # Get the formatted beta version of the Android app
+        #
+        # This method constructs a beta version string by combining the release version
+        # with the beta identifier and the build number. It ensures that the build number is
+        # 1 or higher, as beta versions must have a build number greater than or equal to 1.
+        #
+        # @param [AppVersion] version The version object to format
+        #
+        # @return [String] The formatted beta version of the Android app
+        #
+        # @raise [UI::Error] If the build number of the beta version is not 1 or higher
+        #
+        def beta_version(version)
+          # Ensure that the build number is 1 or higher for a beta version
+          UI.user_error!('The build number of a beta version must be 1 or higher') unless version.build_number.positive?
+
+          # Construct and return the formatted beta version string.
+          "#{release_version(version)}-#{RC_SUFFIX}-#{version.build_number}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/simple_build_code_formatter.rb

@@ -0,0 +1,20 @@
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `IntegerBuildCodeFormatter` is a specialized build code formatter for apps that use simple
+      # integer build codes in the format of `build_number`.
+      class SimpleBuildCodeFormatter
+        # @param version [AppVersion] An AppVersion object. This parameter is ignored but is included
+        # to have a consistent signature with other build code formatters.
+        #
+        # @param [BuildCode] build_code The BuildCode object to format
+        #
+        # @return [String] The formatted build code string.
+        #
+        def build_code(version = nil, build_code:)
+          build_code.to_s
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit.rb

@@ -4,7 +4,7 @@ module Fastlane
   module Wpmreleasetoolkit
     # Return all .rb files inside the "actions", "helper" and "models" directories
     def self.all_classes
-      Dir[File.expand_path('**/{actions,helper,models}/**/*.rb', File.dirname(__FILE__))]
+      Dir[File.expand_path('**/{actions,helper,models,versioning}/**/*.rb', File.dirname(__FILE__))]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 9.2.0
 platform: ruby
 authors:
 - Automattic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: java-properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -426,6 +440,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/circleci_trigger_job_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/close_milestone_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/comment_on_pr.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/copy_branch_protection_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_new_milestone_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/create_release_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb
@@ -436,8 +451,8 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/prototype_build_details_comment_action.rb
-- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/removebranchprotection_action.rb
-- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setbranchprotection_action.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/remove_branch_protection_action.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/common/set_branch_protection_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setfrozentag_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/common/upload_to_s3.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_add_files_to_copy_action.rb
@@ -484,6 +499,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/app_size_metrics_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/ci_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/helper/deprecated.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/encryption_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/filesystem_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/git_helper.rb
@@ -506,6 +522,8 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/release_notes_helper.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/helper/user_agent.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/models/app_version.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/models/build_code.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/models/configuration.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/models/file_reference.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_account.rb
@@ -513,6 +531,20 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_test_lab_result.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/models/firebase_test_runner.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/version.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/abstract_version_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/date_build_code_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/date_version_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/marketing_version_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/semantic_version_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/simple_build_code_calculator.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/files/android_version_file.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/files/ios_version_file.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/abstract_version_formatter.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/derived_build_code_formatter.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/four_part_build_code_formatter.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/four_part_version_formatter.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/rc_notation_version_formatter.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/versioning/formatters/simple_build_code_formatter.rb
 homepage: https://github.com/wordpress-mobile/release-toolkit
 licenses:
 - MIT

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setbranchprotection_action.rb

@@ -1,63 +0,0 @@
-require 'fastlane/action'
-require_relative '../../helper/github_helper'
-
-module Fastlane
-  module Actions
-    class SetbranchprotectionAction < Action
-      def self.run(params)
-        repository = params[:repository]
-        branch_name = params[:branch]
-
-        branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
-        restrictions = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
-        required_pull_request_reviews = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
-
-        github_helper = Fastlane::Helper::GithubHelper.new(github_token: params[:github_token])
-        github_helper.set_branch_protection(
-          repository: repository,
-          branch: branch_name,
-          restrictions: restrictions,
-          enforce_admins: nil,
-          required_pull_request_reviews: required_pull_request_reviews
-        )
-      end
-
-      def self.description
-        "Sets the 'release branch' protection state for the specified branch"
-      end
-
-      def self.authors
-        ['Automattic']
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
-      def self.details
-        # Optional:
-        "Sets the 'release branch' protection state for the specified branch"
-      end
-
-      def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(key: :repository,
-                                       env_name: 'GHHELPER_REPOSITORY',
-                                       description: 'The remote path of the GH repository on which we work',
-                                       optional: false,
-                                       type: String),
-          FastlaneCore::ConfigItem.new(key: :branch,
-                                       env_name: 'GHHELPER_BRANCH',
-                                       description: 'The branch to protect',
-                                       optional: false,
-                                       type: String),
-          Fastlane::Helper::GithubHelper.github_token_config_item,
-        ]
-      end
-
-      def self.is_supported?(platform)
-        true
-      end
-    end
-  end
-end