fastlane-plugin-plist_surgeon 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a4c842111d0642840d28e07781a460e50c2391ece4591051efea52033861617
-  data.tar.gz: f6065508091457bee57180beb14181b688771f0f16c6198fa9723226c001b3d2
+  metadata.gz: 82054adab900dcfce44257cf14ca8424b4b67d88aa91d199b0a4dc9fea582b54
+  data.tar.gz: ac5dc48534e943bbbd5e904ae0d11d391bb11a912cd21126d727e5209dd02606
 SHA512:
-  metadata.gz: d94f7e8ac67bfa10333845e5dc07694dd741c1f22f5d8729218d52517a3e4cee8cd9a00a2c7fb106f760db685f350fbc0418958ff8a802ca6397c02b21548f17
-  data.tar.gz: 3e14d8221bf389634e6352d5be9a257eeeabf8d9aa7b318f901844840eb3f1f60899fc90d7e3e138818c930763b57593e958ac8cdcf223839324c6a38b802d32
+  metadata.gz: be055a5d05b355171d0e8957e4d3ecfdeb1d643478acba8eed57576d3c85dad31463a12bae4621a4c6fd1b03af2c0f9428d17fe035c50c868b7e8149170f0a3b
+  data.tar.gz: d721daa745390daff18e8a40329c18f2014c05b9f3b4dd7372b86c5309f28dd76e65ff63019222e2df1bd9b6509266ae410eeb4d1497109d8356fd7c166bf297

data/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-plist_surgeon.svg)](https://badge.fury.io/rb/fastlane-plugin-plist_surgeon)
 
 ## Getting Started
 
@@ -71,6 +71,22 @@ privacy_surgeon(
 | `key`     | The key to update (supports dot notation for nested keys) | Yes      |         |
 | `value`   | The value to set                                          | Yes      |         |
 
+### plist_surgeon_delete
+
+Delete a key from a `.plist` file.
+
+```rb
+plist_surgeon_delete(
+  path: "./Info.plist",
+  key: "CFBundleAlternateIcons"
+)
+```
+
+| Parameter | Description                                               | Required | Default |
+|-----------|-----------------------------------------------------------|----------|---------|
+| `path`    | The path to the plist file                                | Yes      |         |
+| `key`     | The key to delete (supports dot notation for nested keys) | Yes      |         |
+
 ### Complex Values
 
 You can set complex values (Arrays or Hashes) by passing a JSON string. This is especially useful when running from the command line.
@@ -82,6 +98,40 @@ fastlane run plist_surgeon \
   value:'{"CFBundlePrimaryIcon":{"CFBundleIconFiles":["AppIcon"]}}'
 ```
 
+### Array Search Syntax
+
+When dealing with arrays of dictionaries, you can use the `(key=value)` syntax to find the correct element instead of relying on a fixed index.
+
+For example, given an `Info.plist` with:
+
+```xml
+<key>service_api_key</key>
+<array>
+  <dict>
+    <key>test</key>
+    <string>other_app</string>
+    <key>live</key>
+    <string>old_key_1</string>
+  </dict>
+  <dict>
+    <key>test</key>
+    <string>my_app</string>
+    <key>live</key>
+    <string>old_key_2</string>
+  </dict>
+</array>
+```
+
+You can update the `live` key for the dictionary where `test` is `my_app`:
+
+```rb
+plist_surgeon(
+  path: "Info.plist",
+  key: "service_api_key.(test=my_app).live",
+  value: "new_live_key"
+)
+```
+
 ### Run tests for this plugin
 
 To run both the tests, and code style validation, run

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

@@ -36,11 +36,7 @@ module Fastlane
       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
+        [:ios, :mac].include?(platform)
       end
     end
   end

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

@@ -0,0 +1,39 @@
+require 'fastlane/action'
+require_relative '../helper/plist_surgeon_helper'
+
+module Fastlane
+  module Actions
+    class PlistSurgeonDeleteAction < Action
+      def self.run(params)
+        Helper::PlistSurgeonHelper.delete(params[:path], params[:key])
+      end
+
+      def self.description
+        "Delete a key from a .plist file."
+      end
+
+      def self.authors
+        ["Connor Tumbleson"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "PLIST_SURGEON_PLIST_PATH",
+                                       description: "The path to the plist file",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "PLIST_SURGEON_PLIST_KEY",
+                                       description: "The key to delete (supports dot notation for nested keys)",
+                                       optional: false,
+                                       type: String)
+        ]
+      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

@@ -20,6 +20,22 @@ module Fastlane
         "#{File.basename(path)} saved with #{key} change."
       end
 
+      def self.delete(path, key)
+        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
+
+        delete_key(plist, key)
+        plist_content = plist.to_plist
+        File.write(path, plist_content)
+        "#{File.basename(path)} saved after deleting #{key}."
+      end
+
       def self.set_value(plist, key, value)
         value = parse_json_if_needed(value)
 
@@ -34,12 +50,25 @@ module Fastlane
 
       def self.set_direct_value(plist, key, value)
         if plist.kind_of?(Array)
-          plist[key.to_i] = value
+          index = find_index_for_key(plist, key)
+          plist[index] = value
         else
           plist[key] = value
         end
       end
 
+      def self.find_index_for_key(array, key)
+        if key.start_with?('(') && key.end_with?(')')
+          search_term = key[1...-1]
+          search_key, search_value = search_term.split('=', 2)
+          if search_key && search_value
+            index = array.index { |item| item.kind_of?(Hash) && item[search_key].to_s == search_value }
+            return index if index
+          end
+        end
+        key.to_i
+      end
+
       def self.parse_json_if_needed(value)
         if value.kind_of?(String) && value.start_with?('{', '[')
           begin
@@ -82,7 +111,8 @@ module Fastlane
         current = plist
         keys.each do |k|
           if current.kind_of?(Array)
-            current = current[k.to_i]
+            index = find_index_for_key(current, k)
+            current = current[index]
           else
             current[k] ||= {}
             current = current[k]
@@ -90,11 +120,71 @@ module Fastlane
         end
 
         if current.kind_of?(Array)
-          current[last_key.to_i] = value
+          index = find_index_for_key(current, last_key)
+          current[index] = value
         else
           current[last_key] = value
         end
       end
+
+      def self.delete_key(plist, key)
+        if plist.kind_of?(Hash) && plist.key?(key)
+          plist.delete(key)
+        elsif key.include?('.')
+          delete_nested_value(plist, key)
+        else
+          delete_direct_value(plist, key)
+        end
+      end
+
+      def self.delete_direct_value(plist, key)
+        if plist.kind_of?(Array)
+          index = find_index_for_key(plist, key)
+          plist.delete_at(index) if index
+        else
+          plist.delete(key)
+        end
+      end
+
+      def self.delete_nested_value(plist, key)
+        parts = key.split('.')
+        prefix_key = find_prefix_key(plist, parts)
+
+        if prefix_key
+          prefix, remainder = prefix_key
+          delete_key(plist[prefix], remainder)
+        else
+          delete_deep_nested_value(plist, parts)
+        end
+      end
+
+      def self.delete_deep_nested_value(plist, keys)
+        last_key = keys.pop
+        current = navigate_to_container(plist, keys)
+
+        return unless current
+
+        if current.kind_of?(Array)
+          index = find_index_for_key(current, last_key)
+          current.delete_at(index) if index
+        elsif current.kind_of?(Hash)
+          current.delete(last_key)
+        end
+      end
+
+      def self.navigate_to_container(plist, keys)
+        current = plist
+        keys.each do |k|
+          current = if current.kind_of?(Array)
+                      index = find_index_for_key(current, k)
+                      current[index]
+                    else
+                      current[k]
+                    end
+          break unless current
+        end
+        current
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module PlistSurgeon
-    VERSION = "0.1.2"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-plist_surgeon
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sourcetoad
@@ -33,6 +33,7 @@ files:
 - 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/plist_surgeon_delete_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