fastlane-plugin-xcconfig 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58d03002755a01a9c94e7962b7b2f1acf8aacc536b5ace59b55d6cf9de3141a6
-  data.tar.gz: 6b6d1c2b45cbf6967defcda7877b4320f9ec390954354c5c8457ea57dcda910a
+  metadata.gz: 1744250f9238b86752f3d125ad67b77d62a35d0e416da171cc52c303c7bb83b1
+  data.tar.gz: 4abc691adbfa8e9dc6dbe6b66e7e28e19c360b45c4b8ad3d58a013c0fe0ee5a9
 SHA512:
-  metadata.gz: 7e367b932e6d92ccfd97393d898f2748e3f0b3faa3fb0491cfb0fea65ec1aabbeee4599d03c95f3272142b0d802d544f07b9381b16a94823484ac744bfbae9b8
-  data.tar.gz: cd7a29d07757efbaa4c5e36dfd27f12fe71794ab0b8409fe1afaff60f570a408db8270c2c5627cc8cfd6d11160ec6ad04f4a3353b18621c94da9a3951b5293d8
+  metadata.gz: db890577830b765b3707141bf2dc55d75b8ec12cd30fe6d9c69e416cfef70054b7bea4d314f0d64423119a7bf855f9e21fb6a9a5f2ace3b885915c311798e2bb
+  data.tar.gz: 92958255e587fd80d6baaae501f1a83d4c6424c778d292634b5a8a98383749319eb68ad5b54173e9d9deda6bb9b9173146fbef2f68343195cccfba16c9b0fdf5

data/README.md

@@ -11,27 +11,54 @@ fastlane add_plugin xcconfig
 ```
 
 ## About xcconfig
-Adds 2 actions to fastlane to read and update xcconfig files.
+Adds 3 actions to fastlane to read and update xcconfig files.
 
 
 ## Example
 
 ```ruby
 lane :test do
-  
+
   # Read PRODUCT_BUNDLE_IDENTIFIER value from Configs/Release.xcconfig
   bundle_id = get_xcconfig_value(
-    path: 'fastlane/Configs/Release.xcconfig', 
+    path: 'fastlane/Configs/Release.xcconfig',
     name: 'PRODUCT_BUNDLE_IDENTIFIER'
   )
-  
-  # Sets PRODUCT_BUNDLE_IDENTIFIER value to 'com.sovcharenko.App-beta' in Configs/Release.xcconfig 
+
+  # Update PRODUCT_NAME value to 'Updated App' in Configs/Test.xcconfig
+  # Will fail if PRODUCT_NAME doesn't exist in Configs/Test.xcconfig
+  update_xcconfig_value(
+    path: 'fastlane/Test.xcconfig',
+    name: 'PRODUCT_NAME',
+    value: 'Updated App'
+  )
+
+  # Updates the value and hides it from being printed to the UI.
+  # Used to hide sensitive data from being displayed in logs.
+  update_xcconfig_value(
+    path: 'fastlane/Test.xcconfig',
+    name: 'PRODUCT_NAME',
+    value: 'Updated App Hidden',
+    mask_value: true
+  )
+
+  # Sets PRODUCT_BUNDLE_IDENTIFIER value to 'com.sovcharenko.App-beta' in Configs/Release.xcconfig
+  # PRODUCT_BUNDLE_IDENTIFIER will be added if it doesn't exist
   set_xcconfig_value(
-    path: 'fastlane/Configs/Release.xcconfig', 
-    name: 'PRODUCT_BUNDLE_IDENTIFIER', 
+    path: 'fastlane/Configs/Release.xcconfig',
+    name: 'PRODUCT_BUNDLE_IDENTIFIER',
     value: 'com.sovcharenko.App-beta'
   )
-  
+
+  # Sets the value and hides it from printed to the UI.
+  # Used to hide sensitive data from being displayed in logs.
+  set_xcconfig_value(
+    path: 'fastlane/Configs/Release.xcconfig',
+    name: 'PRODUCT_BUNDLE_IDENTIFIER',
+    value: 'com.sovcharenko.App-beta',
+    mask_value: true
+  )
+
 end
 
 ```

data/lib/fastlane/plugin/xcconfig/actions/set_xcconfig_value_action.rb

@@ -7,7 +7,7 @@ module Fastlane
       def self.run(params)
         path = File.expand_path(params[:path])
 
-        tmp_file = path + '.updated'
+        tmp_file = path + '.set'
 
         name = params[:name]
 
@@ -28,12 +28,17 @@ module Fastlane
                 file.write(name + ' = ' + value + "\n")
                 updated = true
               else
-                file.write(line)
+                file.write(line.strip + "\n")
               end
             end
+            file.write(name + ' = ' + value) unless updated
           end
 
-          Fastlane::UI.user_error!("Couldn't find '#{name}' in #{path}.") unless updated
+          if params[:mask_value]
+            Fastlane::UI.message("Set `#{name}` to `****`")
+          else
+            Fastlane::UI.message("Set `#{name}` to `#{value}`")
+          end
 
           FileUtils.cp(tmp_file, path)
         ensure
@@ -42,11 +47,11 @@ module Fastlane
       end
 
       def self.description
-        'Updates value of a setting in xcconfig file.'
+        'Sets the value of a setting in xcconfig file.'
       end
 
       def self.authors
-        ["Sergii Ovcharenko"]
+        ["Sergii Ovcharenko", "steprescott"]
       end
 
       def self.return_value
@@ -54,7 +59,7 @@ module Fastlane
       end
 
       def self.details
-        'This action updates the value of a given setting in a given xcconfig file. Will throw an error if specified setting doesn\'t exist'
+        'This action sets the value of a given setting in a given xcconfig file.'
       end
 
       def self.available_options
@@ -77,7 +82,13 @@ module Fastlane
                                        optional: false,
                                        verify_block: proc do |value|
                                          UI.user_error!("Couldn't find xcconfig file at path '#{value}'") unless File.exist?(File.expand_path(value))
-                                       end)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :mask_value,
+                                        env_name: "XCCP_SET_VALUE_PARAM_MASK_VALUE",
+                                        description: "Masks the value from being printed to the console",
+                                        optional: true,
+                                        is_string: false,
+                                        default_value: false)
         ]
       end
 

data/lib/fastlane/plugin/xcconfig/actions/update_xcconfig_value_action.rb

@@ -0,0 +1,100 @@
+require 'fastlane/action'
+require_relative '../helper/xcconfig_helper'
+
+module Fastlane
+  module Actions
+    class UpdateXcconfigValueAction < Action
+      def self.run(params)
+        path = File.expand_path(params[:path])
+
+        tmp_file = path + '.updated'
+
+        name = params[:name]
+
+        # Revert fastlane's auto conversion of strings into booleans
+        # https://github.com/fastlane/fastlane/pull/11923
+        value = if [true, false].include?(params[:value])
+                  params[:value] ? 'YES' : 'NO'
+                else
+                  params[:value].strip
+                end
+        begin
+          updated = false
+
+          File.open(tmp_file, 'w') do |file|
+            File.open(path).each do |line|
+              xcname, = Helper::XcconfigHelper.parse_xcconfig_name_value_line(line)
+              if xcname == name
+                file.write(name + ' = ' + value + "\n")
+                updated = true
+              else
+                file.write(line)
+              end
+            end
+          end
+
+          Fastlane::UI.user_error!("Couldn't find '#{name}' in #{path}.") unless updated
+          if params[:mask_value]
+            Fastlane::UI.message("Updated `#{name}` to `****`")
+          else
+            Fastlane::UI.message("Updated `#{name}` to `#{value}`")
+          end
+
+          FileUtils.cp(tmp_file, path)
+        ensure
+          File.delete(tmp_file)
+        end
+      end
+
+      def self.description
+        'Updates value of a setting in xcconfig file.'
+      end
+
+      def self.authors
+        ["Sergii Ovcharenko", "steprescott"]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.details
+        'This action updates the value of a given setting in a given xcconfig file. Will throw an error if specified setting doesn\'t exist'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "XCCP_UPDATE_VALUE_PARAM_NAME",
+                                       description: "Name of key in xcconfig file to update",
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "XCCP_UPDATE_VALUE_PARAM_VALUE",
+                                       description: "Value to set",
+                                       skip_type_validation: true, # skipping type validation as fastlane converts YES/NO/true/false strings into booleans
+                                       type: String,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "XCCP_UPDATE_VALUE_PARAM_PATH",
+                                       description: "Path to xcconfig file you want to update",
+                                       type: String,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find xcconfig file at path '#{value}'") unless File.exist?(File.expand_path(value))
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :mask_value,
+                                        env_name: "XCCP_UPDATE_VALUE_PARAM_MASK_VALUE",
+                                        description: "Masks the value from being printed to the console",
+                                        optional: true,
+                                        is_string: false,
+                                        default_value: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xcconfig/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Xcconfig
-    VERSION = "1.0.0"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-xcconfig
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sergii Ovcharenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -147,6 +147,7 @@ files:
 - lib/fastlane/plugin/xcconfig.rb
 - lib/fastlane/plugin/xcconfig/actions/get_xcconfig_value_action.rb
 - lib/fastlane/plugin/xcconfig/actions/set_xcconfig_value_action.rb
+- lib/fastlane/plugin/xcconfig/actions/update_xcconfig_value_action.rb
 - lib/fastlane/plugin/xcconfig/helper/xcconfig_helper.rb
 - lib/fastlane/plugin/xcconfig/version.rb
 homepage: https://github.com/sovcharenko/fastlane-plugin-xcconfig
@@ -168,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Adds 2 actions to fastlane to read and update xcconfig files.