Merge pull request #512 from wordpress-mobile/add/version-model

Add Version Models and Formatter/Calculator Classes

Author: spencertransier

CHANGELOG.md

@@ -10,14 +10,17 @@ _None_
 
 ### New Features
 
- - Renamed `addbranchprotection` to `set_branch_protection`, and allow it to provide additional optional protection
+- Adds `AppVersion` and `BuildCode` models that can be used by version actions. [#512]
+- Adds version calculator and formatter classes that can be used with the `AppVersion` and `BuildCode` models. [#512]
+- Adds methods for writing values to `xcconfig` files using the `Xcodeproj` gem. [#512]
+- Renamed `addbranchprotection` to `set_branch_protection`, and allow it to provide additional optional protection
    settings to set/update on the target branch (like `lock_branch`, `required_ci_checks`, etc).
    The `addbranchprotection` action name still exists for backward compatibility for now (with a deprecation notice),
    but it will be removed in a future major release. [#513]
- - Renamed `removebranchprotection` to `remove_branch_protection`.
+- Renamed `removebranchprotection` to `remove_branch_protection`.
    The `removebranchprotection` action name still exists for now for backward compatibility (with a deprecation notice),
    but it will be removed in a future major release. [#513]
- - Added `copy_branch_protection` action to replicate the branch protection settings of one branch onto another. [#513]
+- Added `copy_branch_protection` action to replicate the branch protection settings of one branch onto another. [#513]
 
 ### Bug Fixes
 

Gemfile

@@ -2,11 +2,9 @@ source('https://rubygems.org')
 
 gemspec
 
+gem 'buildkite-test_collector', '~> 2.3'
+gem 'codecov', require: false
 gem 'danger', '~> 9.3'
 gem 'danger-rubocop', '~> 0.6'
-
-gem 'codecov', require: false
 gem 'webmock', require: false
 gem 'yard'
-
-gem 'buildkite-test_collector', '~> 2.3'

Gemfile.lock

@@ -9,6 +9,7 @@ PATH
       fastlane (~> 2.213)
       git (~> 1.3)
       google-cloud-storage (~> 1.31)
+      java-properties (~> 0.3.0)
       nokogiri (~> 1.11)
       octokit (~> 6.1)
       parallel (~> 1.14)
@@ -264,6 +265,7 @@ GEM
     httpclient (2.8.3)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    java-properties (0.3.0)
     jmespath (1.6.2)
     json (2.6.3)
     jwt (2.7.0)

fastlane-plugin-wpmreleasetoolkit.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'diffy', '~> 3.3'
   spec.add_dependency 'fastlane', '~> 2.213'
   spec.add_dependency 'git', '~> 1.3'
+  spec.add_dependency 'java-properties', '~> 0.3.0'
   spec.add_dependency 'nokogiri', '~> 1.11' # Needed for AndroidLocalizeHelper
   spec.add_dependency 'octokit', '~> 6.1'
   spec.add_dependency 'parallel', '~> 1.14'

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

lib/fastlane/plugin/wpmreleasetoolkit/models/app_version.rb

@@ -0,0 +1,36 @@
+module Fastlane
+  module Models
+    # The AppVersion model represents a version of an app with major, minor, patch, and build number components.
+    class AppVersion
+      attr_accessor :major, :minor, :patch, :build_number
+
+      # Initializes a new AppVersion instance.
+      #
+      # @param [Integer] major The major version number.
+      # @param [Integer] minor The minor version number.
+      # @param [Integer] patch The patch version number.
+      # @param [Integer] build_number The build number.
+      #
+      def initialize(major, minor, patch = 0, build_number = 0)
+        # Validate that the major and minor version numbers are not nil
+        UI.user_error!('Major version cannot be nil') if major.nil?
+        UI.user_error!('Minor version cannot be nil') if minor.nil?
+
+        @major = major
+        @minor = minor
+        @patch = patch
+        @build_number = build_number
+      end
+
+      # Converts the AppVersion object to a string representation.
+      # This should only be used for internal debugging/testing purposes, not to write versions in version files
+      # In order to format an `AppVersion` into a `String`, you should use the appropriate `VersionFormatter` for your project instead.
+      #
+      # @return [String] a string in the format "major.minor.patch.build_number".
+      #
+      def to_s
+        "#{@major}.#{@minor}.#{@patch}.#{@build_number}"
+      end
+    end
+  end
+end

lib/fastlane/plugin/wpmreleasetoolkit/models/build_code.rb

@@ -0,0 +1,27 @@
+module Fastlane
+  module Models
+    # The `BuildCode` model represents a build code for an app. This could be the Version Code for an Android app or
+    # the VERSION_LONG/BUILD_NUMBER for an iOS/Mac app.
+    class BuildCode
+      attr_accessor :build_code
+
+      # Initializes a new BuildCode instance with the provided build code value.
+      #
+      # @param build_code [String] The build code value.
+      #
+      def initialize(build_code)
+        UI.user_error!('Build code cannot be nil') if build_code.nil?
+
+        @build_code = build_code
+      end
+
+      # Returns the build code as a string.
+      #
+      # @return [String] The build code represented as a string.
+      #
+      def to_s
+        @build_code.to_s
+      end
+    end
+  end
+end

lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/abstract_version_calculator.rb

@@ -0,0 +1,85 @@
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `AbstractVersionCalculator` class is responsible for performing version calculations and transformations. It can be used
+      # as a base class for version calculations that use different versioning schemes. It contains calculation and
+      # transformation methods that are shared by all platforms. It has the abstract suffix because it should not be
+      # instantiated directly.
+      class AbstractVersionCalculator
+        # This method increments the major version component and resets minor, patch, and build number
+        # components to zero.
+        #
+        # @param version [AppVersion] The version to calculate the next major version for.
+        #
+        # @return [AppVersion] The next major version.
+        #
+        def next_major_version(version:)
+          new_version = version.dup
+          new_version.major += 1
+          new_version.minor = 0
+          new_version.patch = 0
+          new_version.build_number = 0
+
+          new_version
+        end
+
+        # This method increments the minor version component and resets patch and build number components
+        # to zero.
+        #
+        # @param version [AppVersion] The version to calculate the next minor version for.
+        #
+        # @return [AppVersion] The next minor version.
+        #
+        def next_minor_version(version:)
+          new_version = version.dup
+          new_version.minor += 1
+          new_version.patch = 0
+          new_version.build_number = 0
+
+          new_version
+        end
+
+        # This method increments the patch version component and resets the build number component to zero.
+        #
+        # @param version [AppVersion] The version to calculate the next patch version for.
+        #
+        # @return [AppVersion] The next patch version.
+        #
+        def next_patch_version(version:)
+          new_version = version.dup
+          new_version.patch += 1
+          new_version.build_number = 0
+
+          new_version
+        end
+
+        # This method increments the build number component.
+        #
+        # @param version [AppVersion] The version to calculate the next build number for.
+        #
+        # @return [AppVersion] The next version with an incremented build number.
+        #
+        def next_build_number(version:)
+          new_version = version.dup
+          new_version.build_number += 1
+
+          new_version
+        end
+
+        # Calculate the previous patch version by decrementing the patch version if it's not zero.
+        #
+        # @param [AppVersion] version The version to calculate the previous patch version for.
+        #
+        # @return [AppVersion] The previous patch version.
+        #
+        def previous_patch_version(version:)
+          new_version = version.dup
+          new_version.patch -= 1 unless version.patch.zero?
+          new_version.build_number = 0
+
+          new_version
+        end
+      end
+    end
+  end
+end

lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/date_build_code_calculator.rb

@@ -0,0 +1,32 @@
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `DateBuildCodeCalculator` class is a build code calculator for apps that use date-based
+      # build codes.
+      class DateBuildCodeCalculator
+        # Calculate the next internal build code by setting the build number to the current date.
+        #
+        # @param [AppVersion] version The version to calculate the next internal version for.
+        #
+        # @return [AppVersion] The next version with the build number set to the current date.
+        #
+        def next_build_code(version:)
+          new_version = version.dup
+          new_version.build_number = today_date
+
+          new_version
+        end
+
+        private
+
+        # Get the current date in the format 'YYYYMMDD'.
+        #
+        # @return [String] The current date in 'YYYYMMDD' format.
+        #
+        def today_date
+          DateTime.now.strftime('%Y%m%d')
+        end
+      end
+    end
+  end
+end

lib/fastlane/plugin/wpmreleasetoolkit/versioning/calculators/date_version_calculator.rb

@@ -0,0 +1,37 @@
+require_relative 'abstract_version_calculator'
+
+module Fastlane
+  module Wpmreleasetoolkit
+    module Versioning
+      # The `DateVersionCalculator` class is a specialized version calculator for date-based versions
+      # of an app, extending the `AbstractVersionCalculator` class.
+      class DateVersionCalculator < AbstractVersionCalculator
+        # Calculate the next date-based release version.
+        #
+        # If the current month is December, the method prompts the user to determine if the next
+        # release will be the first release of the next year. If so, it increments the major version
+        # and sets the minor version to 1, resetting the patch and build number components to zero.
+        # Otherwise, it calculates the next minor version.
+        #
+        # @param [AppVersion] version The version to calculate the next date-based release version for.
+        #
+        # @return [AppVersion] The next date-based release version.
+        #
+        def next_release_version(version:)
+          new_version = version.dup
+          first_release_of_year = FastlaneCore::UI.confirm('Is this release the first release of next year?') if Time.now.month == 12
+          if first_release_of_year
+            new_version.major += 1
+            new_version.minor = 1
+            new_version.patch = 0
+            new_version.build_number = 0
+
+            new_version
+          else
+            next_minor_version(version: version)
+          end
+        end
+      end
+    end
+  end
+end