fastlane-plugin-plist_surgeon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a5bd9c8099f25d525594f7152adcfadfa2376e6be3beaade87899ad526d9609
+  data.tar.gz: c1459ef6a8ac23c538a4147e62b6bb89a1fa121e4e4c512bae56bef68963a63d
+SHA512:
+  metadata.gz: 189d851c3a93be5cca4cc4c8c68eebc27469d47aa1ad124484602b29b26c39718106d3b79ef58cd22b03fffb1f3bf15fac38ef962abb5e64dba074eeb19f8ca1
+  data.tar.gz: e80a97936aeff2105af0f323bb710b7a3359b0b8c7d2ecec91a4cc2ee13f8906fef1ed3fbb6e16bd4f22b459e15314dd72898688e049f55c6e5eea1076ba8f5b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Sourcetoad <info@sourcetoad.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# plist_surgeon plugin
+_The all-in-one tool to edit iOS configuration files from one plugin._
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-plist_surgeon)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-plist_surgeon`, add it to your project by running:
+
+```bash
+fastlane add_plugin plist_surgeon
+```
+
+## About plist_surgeon
+
+Edit .plist, .entitlements or .xcprivacy files for any reason as part of your pipeline.
+
+## Actions
+
+### plist_surgeon
+
+Edit a `.plist` file.
+
+```rb
+plist_surgeon(
+  path: "./Info.plist",
+  key: "CFBundleShortVersionString",
+  value: "1.2.3"
+)
+```
+
+| Parameter | Description                                               | Required | Default |
+|-----------|-----------------------------------------------------------|----------|---------|
+| `path`    | The path to the plist file                                | Yes      |         |
+| `key`     | The key to update (supports dot notation for nested keys) | Yes      |         |
+| `value`   | The value to set                                          | Yes      |         |
+
+### entitlements_surgeon
+
+Edit an `.entitlements` file.
+
+```rb
+entitlements_surgeon(
+  path: "./App.entitlements",
+  key: "aps-environment",
+  value: "production"
+)
+```
+
+| Parameter | Description                                               | Required | Default |
+|-----------|-----------------------------------------------------------|----------|---------|
+| `path`    | The path to the entitlements file                         | Yes      |         |
+| `key`     | The key to update (supports dot notation for nested keys) | Yes      |         |
+| `value`   | The value to set                                          | Yes      |         |
+
+### privacy_surgeon
+
+Edit an `.xcprivacy` file.
+
+```rb
+privacy_surgeon(
+  path: "./PrivacyInfo.xcprivacy",
+  key: "NSPrivacyTracking",
+  value: false
+)
+```
+
+| Parameter | Description                                               | Required | Default |
+|-----------|-----------------------------------------------------------|----------|---------|
+| `path`    | The path to the xcprivacy file                            | Yes      |         |
+| `key`     | The key to update (supports dot notation for nested keys) | Yes      |         |
+| `value`   | The value to set                                          | Yes      |         |
+
+### Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+### Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+### Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+### Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+### About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/plist_surgeon/actions/entitlements_surgeon_action.rb

@@ -0,0 +1,43 @@
+require 'fastlane/action'
+require_relative '../helper/plist_surgeon_helper'
+
+module Fastlane
+  module Actions
+    class EntitlementsSurgeonAction < Action
+      def self.run(params)
+        Helper::PlistSurgeonHelper.run(params[:path], params[:key], params[:value])
+      end
+
+      def self.description
+        "Edit an .entitlements file."
+      end
+
+      def self.authors
+        ["Connor Tumbleson"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "ENTITLEMENTS_SURGEON_PATH",
+                                       description: "The path to the entitlements file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "ENTITLEMENTS_SURGEON_KEY",
+                                       description: "The key to update (supports dot notation for nested keys)",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "ENTITLEMENTS_SURGEON_VALUE",
+                                       description: "The value to set",
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/plist_surgeon/actions/plist_surgeon_action.rb

@@ -0,0 +1,47 @@
+require 'fastlane/action'
+require_relative '../helper/plist_surgeon_helper'
+
+module Fastlane
+  module Actions
+    class PlistSurgeonAction < Action
+      def self.run(params)
+        Helper::PlistSurgeonHelper.run(params[:path], params[:key], params[:value])
+      end
+
+      def self.description
+        "Edit a .plist file."
+      end
+
+      def self.authors
+        ["Connor Tumbleson"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "PLIST_SURGEON_PATH",
+                                       description: "The path to the plist file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "PLIST_SURGEON_KEY",
+                                       description: "The key to update (supports dot notation for nested keys)",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "PLIST_SURGEON_VALUE",
+                                       description: "The value to set",
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/plist_surgeon/actions/privacy_surgeon_action.rb

@@ -0,0 +1,43 @@
+require 'fastlane/action'
+require_relative '../helper/plist_surgeon_helper'
+
+module Fastlane
+  module Actions
+    class PrivacySurgeonAction < Action
+      def self.run(params)
+        Helper::PlistSurgeonHelper.run(params[:path], params[:key], params[:value])
+      end
+
+      def self.description
+        "Edit an .xcprivacy file."
+      end
+
+      def self.authors
+        ["Connor Tumbleson"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "PRIVACY_SURGEON_PATH",
+                                       description: "The path to the xcprivacy file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "PRIVACY_SURGEON_KEY",
+                                       description: "The key to update (supports dot notation for nested keys)",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "PRIVACY_SURGEON_VALUE",
+                                       description: "The value to set",
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/plist_surgeon/helper/plist_surgeon_helper.rb

@@ -0,0 +1,51 @@
+require 'fastlane_core/ui/ui'
+require 'plist'
+
+module Fastlane
+  module Helper
+    class PlistSurgeonHelper
+      def self.run(path, key, value)
+        unless File.exist?(path)
+          FastlaneCore::UI.user_error!("File not found at path: #{path}")
+        end
+
+        plist = Plist.parse_xml(path)
+        if plist.nil?
+          FastlaneCore::UI.user_error!("Failed to parse plist at path: #{path}")
+        end
+
+        set_value(plist, key, value)
+
+        File.write(path, plist.to_plist)
+      end
+
+      def self.set_value(plist, key, value)
+        if key.include?('.')
+          set_nested_value(plist, key, value)
+        else
+          plist[key] = value
+        end
+      end
+
+      def self.set_nested_value(plist, key, value)
+        keys = key.split('.')
+        last_key = keys.pop
+        current = plist
+        keys.each do |k|
+          if current.kind_of?(Array)
+            current = current[k.to_i]
+          else
+            current[k] ||= {}
+            current = current[k]
+          end
+        end
+
+        if current.kind_of?(Array)
+          current[last_key.to_i] = value
+        else
+          current[last_key] = value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module PlistSurgeon
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/plist_surgeon.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/plist_surgeon/version'
+
+module Fastlane
+  module PlistSurgeon
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::PlistSurgeon.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-plist_surgeon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sourcetoad
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+email: info@sourcetoad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/plist_surgeon.rb
+- lib/fastlane/plugin/plist_surgeon/actions/entitlements_surgeon_action.rb
+- lib/fastlane/plugin/plist_surgeon/actions/plist_surgeon_action.rb
+- lib/fastlane/plugin/plist_surgeon/actions/privacy_surgeon_action.rb
+- lib/fastlane/plugin/plist_surgeon/helper/plist_surgeon_helper.rb
+- lib/fastlane/plugin/plist_surgeon/version.rb
+homepage: https://github.com/sourcetoad/fastlane-plugin-plist_surgeon
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Edit .plist, .entitlements or .xcprivacy files for any reason as part of
+  your pipeline.
+test_files: []