fastlane-plugin-versioning 0.3.3 → 0.4.4

data/lib/fastlane/plugin/versioning/actions/get_info_plist_path.rb

@@ -7,17 +7,16 @@ module Fastlane
       def self.run(params)
         unless params[:xcodeproj]
           if Helper.test?
-            params[:xcodeproj] = "/tmp/fastlane/tests/fastlane/bundle.xcodeproj"
+            params[:xcodeproj] = "/tmp/fastlane/tests/fastlane/xcodeproj/bundle.xcodeproj"
           else
             params[:xcodeproj] = Dir["*.xcodeproj"][0] unless params[:xcodeproj]
           end
         end
 
-
-        if params[:target] then
-            path = find_path_using_target(params)
+        if params[:target]
+          path = find_path_using_target(params)
         else
-            path = find_path_using_scheme(params)
+          path = find_path_using_scheme(params)
         end
         path
       end
@@ -25,44 +24,44 @@ module Fastlane
       def self.find_path_using_target(params)
         project = Xcodeproj::Project.open(params[:xcodeproj])
         if params[:target]
-          target = project.targets.detect { |t| t.name == params[:target]}
+          target = project.targets.detect { |t| t.name == params[:target] }
         else
           # firstly we are trying to find modern application target
           target = project.targets.detect do |t|
             t.kind_of?(Xcodeproj::Project::Object::PBXNativeTarget) &&
-            t.product_type == 'com.apple.product-type.application'
+              t.product_type == 'com.apple.product-type.application'
           end
           target = project.targets[0] if target.nil?
         end
 
-        if params[:build_configuration_name]
-          build_settings = target.build_settings(params[:build_configuration_name])
-          plist = build_settings['INFOPLIST_FILE']
+        # This ensures we get correctly resolved variables against present configuration files.
+        plist = target.resolved_build_setting('INFOPLIST_FILE', true)
+        UI.user_error! 'Cannot resolve Info.plist build setting. Check it\'s defined or try defining it explicitly on the target without variables.' if plist.nil? || plist.empty?
+
+        if !(build_configuration_name = params[:build_configuration_name]).nil?
+          plist = plist[build_configuration_name]
+          UI.user_error! "Cannot resolve Info.plist build setting for #{build_configuration_name}." if plist.nil?
         else
-          begin
-            plist = target.common_resolved_build_setting('INFOPLIST_FILE')
-          rescue
-            UI.user_error! 'Cannot resolve Info.plist build setting. Maybe you should specify :build_configuration_name?'
-          end
+          plist = plist.values.compact.uniq
+          UI.user_error! 'Cannot accurately resolve Info.plist build setting, try specifying :build_configuration_name.' if plist.count > 1
+          plist = plist.first
         end
 
-        path = plist.gsub('$(SRCROOT)', project.path.parent.to_path)
-        unless (Pathname.new path).absolute?
-          path = File.join(project.path.parent.to_path, path)
-        end
+        path = plist.gsub('SRCROOT', project.path.parent.to_path)
+        path = File.join(project.path.parent.to_path, path) unless (Pathname.new path).absolute?
         path
       end
 
       def self.find_path_using_scheme(params)
-          config = {project: params[:xcodeproj], scheme: params[:scheme], configuration: params[:build_configuration_name]}
-          project = FastlaneCore::Project.new(config)
-          project.select_scheme
+        config = { project: params[:xcodeproj], scheme: params[:scheme], configuration: params[:build_configuration_name] }
+        project = FastlaneCore::Project.new(config)
+        project.select_scheme
 
-          path = project.build_settings(key: 'INFOPLIST_FILE')
-          unless (Pathname.new path).absolute?
-            path = File.join(Pathname.new(project.path).parent.to_path, path)
-          end
-          path
+        path = project.build_settings(key: 'INFOPLIST_FILE')
+        unless (Pathname.new path).absolute?
+          path = File.join(Pathname.new(project.path).parent.to_path, path)
+        end
+        path
       end
 
       #####################################################
@@ -74,35 +73,32 @@ module Fastlane
       end
 
       def self.details
-        [
-          "This action will return path to Info.plist for specific target in your project."
-        ].join(' ')
+        'This action will return path to Info.plist for specific target in your project.'
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
-                             env_name: "FL_INFO_PLIST_PROJECT",
-                             description: "optional, you must specify the path to your main Xcode project if it is not in the project root directory or if you have multiple *.xcodeproj's in the root directory",
-                             optional: true,
-                             verify_block: proc do |value|
-                               UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
-                               UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
-                             end),
+                                       env_name: "FL_INFO_PLIST_PROJECT",
+                                       description: "Optional, you must specify the path to your main Xcode project if it is not in the project root directory or if you have multiple *.xcodeproj's in the root directory",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
+                                         UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
+                                       end),
           FastlaneCore::ConfigItem.new(key: :target,
-                             env_name: "FL_INFO_PLIST_TARGET",
-                             optional: true,
-                             conflicting_options: [:scheme],
-                             description: "Specify a specific target if you have multiple per project, optional"),
+                                       env_name: "FL_INFO_PLIST_TARGET",
+                                       optional: true,
+                                       conflicting_options: [:scheme],
+                                       description: "Specify a specific target if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :scheme,
-                             env_name: "FL_INFO_PLIST_SCHEME",
-                             optional: true,
-                             conflicting_options: [:target],
-                             description: "Specify a specific scheme if you have multiple per project, optional"),
+                                       env_name: "FL_INFO_PLIST_SCHEME",
+                                       optional: true,
+                                       conflicting_options: [:target],
+                                       description: "Specify a specific scheme if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
-                             optional: true,
-                             description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration")
-
+                                       optional: true,
+                                       description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration")
         ]
       end
 
@@ -111,7 +107,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include? platform
+        %i[ios mac].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/get_version_number_from_git_branch.rb

@@ -39,7 +39,7 @@ module Fastlane
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac, :android].include? platform
+        %i[ios mac android].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/get_version_number_from_plist.rb

@@ -1,16 +1,24 @@
-module Fastlane
+ module Fastlane
   module Actions
     class GetVersionNumberFromPlistAction < Action
       def self.run(params)
         if Helper.test?
-          plist = "/tmp/fastlane/tests/fastlane/Info.plist"
+          plist = "/tmp/fastlane/tests/fastlane/plist/Info.plist"
         else
           plist = GetInfoPlistPathAction.run(params)
         end
 
-        version_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleShortVersionString')
+        if params[:plist_build_setting_support]
+          UI.important "version will originate from xcodeproj"
+          version_number = GetVersionNumberFromXcodeprojAction.run(params)
+        else
+          UI.important "version will originate from plist."
+          version_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleShortVersionString')
+        end
+
         # Store the number in the shared hash
         Actions.lane_context[SharedValues::VERSION_NUMBER] = version_number
+        version_number
       end
 
       #####################################################
@@ -23,7 +31,8 @@ module Fastlane
 
       def self.details
         [
-          "This action will return the current version number set on your project's Info.plist."
+          "This action will return the current version number set on your project's Info.plist.",
+          "note that you can pass plist_build_setting_support: true, in which case it will return from your xcodeproj."
         ].join(' ')
       end
 
@@ -49,8 +58,11 @@ module Fastlane
                              description: "Specify a specific scheme if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                              optional: true,
-                             description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration")
-
+                             description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration"),
+          FastlaneCore::ConfigItem.new(key: :plist_build_setting_support,
+                            description: "support automatic resolution of build setting from xcodeproj if not a literal value in the plist",
+                            is_string: false,
+                            default_value: false)
         ]
       end
 
@@ -61,11 +73,11 @@ module Fastlane
       end
 
       def self.authors
-        ["SiarheiFedartsou"]
+        ["SiarheiFedartsou", "jdouglas-nz"]
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include? platform
+        %i[ios mac].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/get_version_number_from_xcodeproj.rb

@@ -0,0 +1,111 @@
+module Fastlane
+  module Actions
+    class GetVersionNumberFromXcodeprojAction < Action
+      require 'xcodeproj'
+      require 'pathname'
+
+      def self.run(params)
+        unless params[:xcodeproj]
+          if Helper.test?
+            params[:xcodeproj] = "/tmp/fastlane/tests/fastlane/xcodeproj/versioning_fixture_project.xcodeproj"
+          else
+            params[:xcodeproj] = Dir["*.xcodeproj"][0] unless params[:xcodeproj]
+          end
+        end
+
+        if params[:target]
+          version_number = get_version_number_using_target(params)
+        else
+          version_number = get_version_number_using_scheme(params)
+        end
+
+        Actions.lane_context[SharedValues::VERSION_NUMBER] = version_number
+        version_number
+      end
+
+      def self.get_version_number_using_target(params)
+        project = Xcodeproj::Project.open(params[:xcodeproj])
+        if params[:target]
+          target = project.targets.detect { |t| t.name == params[:target] }
+        else
+          # firstly we are trying to find modern application target
+          target = project.targets.detect do |t|
+            t.kind_of?(Xcodeproj::Project::Object::PBXNativeTarget) &&
+              t.product_type == 'com.apple.product-type.application'
+          end
+          target = project.targets[0] if target.nil?
+        end
+
+        version_number = target.resolved_build_setting('MARKETING_VERSION', true)
+        UI.user_error! 'Cannot resolve version number build setting.' if version_number.nil? || version_number.empty?
+
+        if !(build_configuration_name = params[:build_configuration_name]).nil?
+          version_number = version_number[build_configuration_name]
+          UI.user_error! "Cannot resolve $(MARKETING_VERSION) build setting for #{build_configuration_name}." if version_number.nil?
+        else
+          version_number = version_number.values.compact.uniq
+          UI.user_error! 'Cannot accurately resolve $(MARKETING_VERSION) build setting, try specifying :build_configuration_name.' if version_number.count > 1
+          version_number = version_number.first
+        end
+
+        version_number
+      end
+
+      def self.get_version_number_using_scheme(params)
+        config = { project: params[:xcodeproj], scheme: params[:scheme], configuration: params[:build_configuration_name] }
+        project = FastlaneCore::Project.new(config)
+        project.select_scheme
+
+        build_number = project.build_settings(key: 'MARKETING_VERSION')
+        UI.user_error! "Cannot resolve $(MARKETING_VERSION) in for the scheme #{config.scheme} with the name #{params.configuration}" if build_number.nil? || build_number.empty?
+        build_number
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the version number of your project"
+      end
+
+      def self.details
+        'Gets the $(MARKETING_VERSION) build setting using the specified parameters, or the first if not enough parameters are passed.'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_VERSION_NUMBER_PROJECT",
+                                       description: "Optional, you must specify the path to your main Xcode project if it is not in the project root directory or if you have multiple *.xcodeproj's in the root directory",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
+                                         UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                       env_name: "FL_VERSION_NUMBER_TARGET",
+                                       optional: true,
+                                       conflicting_options: [:scheme],
+                                       description: "Specify a specific target if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "FL_VERSION_NUMBER_SCHEME",
+                                       optional: true,
+                                       conflicting_options: [:target],
+                                       description: "Specify a specific scheme if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :build_configuration_name,
+                                       optional: true,
+                                       description: "Specify a specific build configuration if you have different build settings for each configuration")
+        ]
+      end
+
+      def self.authors
+        ["jdouglas-nz"]
+      end
+
+      def self.is_supported?(platform)
+        %i[ios mac].include? platform
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/versioning/actions/increment_build_number_in_plist.rb

@@ -7,19 +7,40 @@ module Fastlane
         else
           current_build_number = GetBuildNumberFromPlistAction.run(params)
           build_array = current_build_number.split(".").map(&:to_i)
-          build_array[-1] = build_array[-1]+1            
+          build_array[-1] = build_array[-1] + 1
           next_build_number = build_array.join(".")
         end
 
         if Helper.test?
-          plist = "/tmp/fastlane/tests/fastlane/Info.plist"
+          plist = "/tmp/fastlane/tests/fastlane/plist/Info.plist"
         else
           plist = GetInfoPlistPathAction.run(params)
         end
 
-        SetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion', value: next_build_number)
+        build_number = GetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion')
+        if build_number =~ /\$\(([\w\-]+)\)/
+          UI.important "detected that build number is a build setting."
+          if params[:plist_build_setting_support]
+            UI.important "will continue and update the xcodeproj $(CURRENT_PROJECT_VERSION) instead."
+            IncrementBuildNumberInXcodeprojAction.run(params)
+          else
+            UI.important "will continue and update the info plist key. this will replace the existing value."
+            SetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion', value: next_build_number)
+          end
+        else
+          if params[:plist_build_setting_support]
+            UI.important "will continue and update the xcodeproj $(CURRENT_PROJECT_VERSION) instead."
+            IncrementBuildNumberInXcodeprojAction.run(params)
+            UI.important "will also update info plist key to be a build setting"
+            SetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion', value: "$(CURRENT_PROJECT_VERSION)")
+          else
+            UI.important "will continue and update the info plist key. this will replace the existing value."
+            SetInfoPlistValueAction.run(path: plist, key: 'CFBundleVersion', value: next_build_number)
+          end 
+        end
 
         Actions.lane_context[SharedValues::BUILD_NUMBER] = next_build_number
+        next_build_number
       end
 
       def self.description
@@ -28,7 +49,8 @@ module Fastlane
 
       def self.details
         [
-          "This action will increment the build number directly in Info.plist. "
+          "This action will increment the build number directly in Info.plist",
+          "unless plist_build_setting_support: true is passed in as parameters"
         ].join("\n")
       end
 
@@ -36,7 +58,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :build_number,
                                        env_name: "FL_BUILD_NUMBER_BUILD_NUMBER",
-                                       description: "Change to a specific version",
+                                       description: "Change to a specific build number",
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
                                        env_name: "FL_VERSION_NUMBER_PROJECT",
@@ -58,22 +80,26 @@ module Fastlane
                                        description: "Specify a specific scheme if you have multiple per project, optional"),
           FastlaneCore::ConfigItem.new(key: :build_configuration_name,
                                        optional: true,
-                                       description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration")
+                                       description: "Specify a specific build configuration if you have different Info.plist build settings for each configuration"),
+          FastlaneCore::ConfigItem.new(key: :plist_build_setting_support,
+                                        description: "support automatic resolution of build setting from xcodeproj if not a literal value in the plist",
+                                        is_string: false,
+                                        default_value: false)
         ]
       end
 
       def self.output
         [
-          ['BUILD_NUMBER', 'The new version number']
+          ['BUILD_NUMBER', 'The new build number']
         ]
       end
 
-      def self.author
-        "SiarheiFedartsou"
+      def self.authors
+        ["SiarheiFedartsou", "jdouglas-nz"]
       end
 
       def self.is_supported?(platform)
-        [:ios, :mac].include? platform
+        %i[ios mac].include? platform
       end
     end
   end

data/lib/fastlane/plugin/versioning/actions/increment_build_number_in_xcodeproj.rb

@@ -0,0 +1,126 @@
+module Fastlane
+  module Actions
+    class IncrementBuildNumberInXcodeprojAction < Action
+      def self.run(params)
+        unless params[:xcodeproj]
+          if Helper.test?
+            params[:xcodeproj] = "/tmp/fastlane/tests/fastlane/xcodeproj/versioning_fixture_project.xcodeproj"
+          else
+            params[:xcodeproj] = Dir["*.xcodeproj"][0] unless params[:xcodeproj]
+          end
+        end
+
+        if params[:build_number]
+          next_build_number = params[:build_number]
+        else
+          current_build_number = GetBuildNumberFromXcodeprojAction.run(params)
+          build_array = current_build_number.split(".").map(&:to_i)
+          build_array[-1] = build_array[-1] + 1
+          next_build_number = build_array.join(".")
+        end
+
+        if params[:target]
+          set_build_number_using_target(params, next_build_number)
+        elsif params[:build_configuration_name] && params[:scheme]
+          set_build_number_using_scheme(params, next_build_number)
+        else
+          set_all_xcodeproj_build_numbers(params, next_build_number)
+        end
+        Actions.lane_context[SharedValues::BUILD_NUMBER] = next_build_number
+        next_build_number
+      end
+
+      def self.set_all_xcodeproj_build_numbers(params, next_build_number)
+        project = Xcodeproj::Project.open(params[:xcodeproj])
+        configs = project.objects.select { |obj| select_build_configuration_predicate(nil, obj) }
+        configs.each do |config|
+          config.build_settings["CURRENT_PROJECT_VERSION"] = next_build_number
+        end
+        project.save
+      end
+
+      private_class_method
+      def self.select_build_configuration_predicate(name, configuration)
+        is_build_valid_configuration = configuration.isa == "XCBuildConfiguration" && !configuration.build_settings["PRODUCT_BUNDLE_IDENTIFIER"].nil?
+        is_build_valid_configuration &&= configuration.name == name unless name.nil?
+        return is_build_valid_configuration
+      end
+
+      def self.set_build_number_using_target(params, next_build_number)
+        project = Xcodeproj::Project.open(params[:xcodeproj])
+        if params[:target]
+          target = project.targets.detect { |t| t.name == params[:target] }
+        else
+          # firstly we are trying to find modern application target
+          target = project.targets.detect do |t|
+            t.kind_of?(Xcodeproj::Project::Object::PBXNativeTarget) &&
+              t.product_type == 'com.apple.product-type.application'
+          end
+          target = project.targets[0] if target.nil?
+        end
+
+        target.build_configurations.each do |config|
+          UI.message "updating #{config.name} to build #{next_build_number}"
+          config.build_settings["CURRENT_PROJECT_VERSION"] = next_build_number
+        end unless target.nil?
+
+        project.save
+      end
+
+      def self.set_build_number_using_scheme(params, next_build_number)
+        config = { project: params[:xcodeproj], scheme: params[:scheme], configuration: params[:build_configuration_name] }
+        project = FastlaneCore::Project.new(config)
+        project.select_scheme
+
+        project.build_settings["CURRENT_PROJECT_VERSION"] = next_build_number
+        project.save
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Increment build number in xcodeproj"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :build_number,
+                                      env_name: "FL_BUILD_NUMBER_BUILD_NUMBER",
+                                      description: "Change to a specific build number",
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                         env_name: "FL_VERSION_NUMBER_PROJECT",
+                                         description: "Optional, you must specify the path to your main Xcode project if it is not in the project root directory or if you have multiple *.xcodeproj's in the root directory",
+                                         optional: true,
+                                         verify_block: proc do |value|
+                                           UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with? ".xcworkspace"
+                                           UI.user_error!("Could not find Xcode project at path '#{File.expand_path(value)}'") if !File.exist?(value) and !Helper.is_test?
+                                         end),
+          FastlaneCore::ConfigItem.new(key: :target,
+                                         env_name: "FL_VERSION_NUMBER_TARGET",
+                                         optional: true,
+                                         conflicting_options: [:scheme],
+                                         description: "Specify a specific target if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                         env_name: "FL_VERSION_NUMBER_SCHEME",
+                                         optional: true,
+                                         conflicting_options: [:target],
+                                         description: "Specify a specific scheme if you have multiple per project, optional"),
+          FastlaneCore::ConfigItem.new(key: :build_configuration_name,
+                                         optional: true,
+                                         description: "Specify a specific build configuration if you have different build settings for each configuration")
+        ]
+      end
+
+      def self.authors
+        ["jdouglas-nz"]
+      end
+
+      def self.is_supported?(platform)
+        %i[ios mac android].include? platform
+      end
+    end
+  end
+  end