ann-flavor-cocoapods 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68dcf959d5d5f927bc43085645168885f76ac29cff73dc973fa9d0d5a8809beb
-  data.tar.gz: 9d214c8beb19db807200490e5a66e4bc6b22b20539cc950abbf316bb059f3ca7
+  metadata.gz: 203077b214e8b6dcbf87c8792ea6df6055d34b4b6ea36af00c1c28a94207aab9
+  data.tar.gz: fcdbfba3ba5e54184fb3d05ace52259c10476947259d550cc4b134009d83e560
 SHA512:
-  metadata.gz: dfd4c329b80c085c88607557aaa9027793f7a43c680751019608acdfb16d930a71ed9dc7d464a5ea7e2beb608af88148661ac3324083ea40aa8d370b0787b7dd
-  data.tar.gz: a0c24e164cc92f315382be34c593a6326151db80e33b69f473b7fbb3a3bb19431b6520e4357b7475ea39c0ec573d1a3b3b40ec6486c73fbf2eb872f967191748
+  metadata.gz: 1968396623737c7d68439d68cb2fb4d8b8ac6d1da7bba9c32722bc9a0408e3d73fc2b6a4087fbff63231d0d8bd1403949d62e46bf2382a7d9361bd33a7d9fbd1
+  data.tar.gz: 5f6f3d65b87f5f8c41d52f6201c622fb379da14d81cf7d6338edf5a76bde7168213c2722f067495d0e8571f0ce35415f67e37538f47f4b5d266e297887672cee

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 0.3.0
+
+### Added
+- **New `[ann-flavor] Merge Info.plist` build phase composes the final
+  Info.plist Xcode builds against at build time**, not sync time: copies
+  `ios/Runner/Info.plist` (the generic/base layer, developer-owned, always
+  present) to `$(DERIVED_FILE_DIR)/Info-merged.plist`, then merges in every
+  key from the current flavor's `ios/ann/Info/Info-<flavor>.plist` delta (see
+  `ann_flutter_flavor` 1.2.0 — that file now holds only the flavor's
+  `info_plist:` cascade, not a full copy of `Runner/Info.plist`), with the
+  flavor's value winning on any key both define. Uses `PlistBuddy`
+  (`/usr/libexec/PlistBuddy`), not `python3`/`ruby` — ships as part of Xcode
+  itself, so this phase adds no dependency on any scripting runtime beyond
+  what Xcode already requires. Every plist value type (string, bool, integer,
+  real, array, nested dict — e.g. `SKAdNetworkItems`) round-trips correctly
+  through the merge, not just strings. Prints a one-line notice to the Xcode
+  build log for any key the flavor delta actually overrides, to make an
+  unintentional override easy to spot. Found-and-updated in place on a
+  re-run, same UUID-stability guarantee as the Firebase-copy and Print Build
+  Info phases.
+
+### Changed
+- **`INFOPLIST_FILE` now points at `$(DERIVED_FILE_DIR)/Info-merged.plist`**
+  (the Merge Info.plist phase's output above) instead of directly at
+  `ios/ann/Info/Info-<flavor>.plist`. Enables `Runner/Info.plist` to remain a
+  live, always-consulted base layer instead of a one-time sync-time template
+  — the change this whole release exists to support. See
+  [plan 038](../../docs/03-planning/features/038-info-plist-build-time-merge.md)
+  and the [`Info.plist`
+  keys](../../docs/04-userguide/ios/overview.md#infoplist-keys) section of the
+  iOS userguide for the full design and migration notes.
+
 ## 0.2.0
 
 ### Added

data/lib/ann_flavor_cocoapods/podfile_helper.rb

@@ -174,7 +174,6 @@ module AnnFlavorCocoapods
                 # until checked against what the xcconfig #include actually
                 # applied).
                 xcconfig_path = "ann/xcconfig/#{flavor_key}#{bt.capitalize}.xcconfig"
-                info_plist_path = "ann/Info/Info-#{flavor_key}.plist"
                 icon_name = "#{flavor_key.capitalize}AppIcon"
 
                 assert_icon_generated!(user_project, flavor_key, icon_name)
@@ -191,7 +190,7 @@ module AnnFlavorCocoapods
                 entitlements_path = nil unless File.exist?(entitlements_file)
 
                 configure_build_configuration(
-                  target, user_project, xcode_config, xcconfig_path, info_plist_path,
+                  target, user_project, xcode_config, xcconfig_path,
                   icon_name, entitlements_path
                 )
               end
@@ -202,6 +201,8 @@ module AnnFlavorCocoapods
             if print_build_info
               inject_build_info_phase(target)
             end
+
+            inject_merge_info_plist_phase(target)
           end
 
           # Fixes a real pod-install failure: PBXNativeTarget#resolved_build_setting
@@ -598,7 +599,7 @@ module AnnFlavorCocoapods
       CODE_SIGN_ENTITLEMENTS
     ].freeze
 
-    def self.configure_build_configuration(target, user_project, xcode_config, xcconfig_path, info_plist_path, icon_name, entitlements_path = nil)
+    def self.configure_build_configuration(target, user_project, xcode_config, xcconfig_path, icon_name, entitlements_path = nil)
       config_list = target.build_configuration_list
       config = config_list[xcode_config]
 
@@ -624,7 +625,12 @@ module AnnFlavorCocoapods
         user_project.main_group.new_reference(xcconfig_path)
       config.base_configuration_reference = xcconfig_ref
 
-      config.build_settings['INFOPLIST_FILE'] = info_plist_path
+      # Points at the [ann-flavor] Merge Info.plist run-script phase's output
+      # (plan 038), not directly at ann/Info/Info-<flavor>.plist -- that file
+      # now holds only the flavor's info_plist: cascade delta, not a complete
+      # plist; the merge phase composes it with Runner/Info.plist (base) at
+      # build time and writes the result here.
+      config.build_settings['INFOPLIST_FILE'] = '$(DERIVED_FILE_DIR)/Info-merged.plist'
       config.build_settings['ASSETCATALOG_COMPILER_APPICON_NAME'] = icon_name
       # entitlements: is opt-in (unlike INFOPLIST_FILE/the icon catalog, which
       # every flavor always has) -- only set CODE_SIGN_ENTITLEMENTS when the
@@ -769,5 +775,124 @@ module AnnFlavorCocoapods
         target.build_phases.unshift(phase)
       end
     end
+
+    # Composes the final Info.plist Xcode actually builds against, from two
+    # layers -- Runner/Info.plist (generic/base, developer-owned) and the
+    # flavor-specific ann/Info/Info-<flavor>.plist (annspec.yaml's info_plist:
+    # cascade, opt-in -- may not exist for a flavor with no cascade) -- with
+    # the flavor layer winning on any key collision. Plan 038: since plan 035,
+    # ios_generator.dart's _generateInfoPlists used to bake a full copy of
+    # Runner/Info.plist into every flavor's generated plist at sync time; that
+    # made the generated file impossible to read as "what's actually
+    # flavor-specific" and gave nothing else (e.g. a CocoaPods plugin like
+    # ann_ads) any way to contribute Info.plist keys, since INFOPLIST_FILE
+    # pointed at the fully-resolved flavor file and Runner/Info.plist was
+    # never read again. This phase moves that composition to build time
+    # instead, so Runner/Info.plist stays a live, always-consulted base layer.
+    #
+    # Uses PlistBuddy (/usr/libexec/PlistBuddy), not python3/ruby -- PlistBuddy
+    # ships as part of Xcode itself, so this phase has no dependency on any
+    # scripting runtime beyond what Xcode already requires (OQ-1,
+    # docs/03-planning/features/038-info-plist-build-time-merge.md).
+    #
+    # Runs before_compile, ahead of Xcode's own Info.plist processing --
+    # INFOPLIST_FILE (set in configure_build_configuration) points at this
+    # phase's output, not at either source file directly.
+    def self.inject_merge_info_plist_phase(target)
+      script = <<~SHELL
+        # Injected by ann-flavor-cocoapods: compose the final Info.plist from
+        # two layers -- Runner/Info.plist (generic/base) and the flavor-
+        # specific ann/Info/Info-<flavor>.plist (annspec.yaml's info_plist:
+        # cascade) -- with the flavor layer winning on any key collision.
+        # See docs/03-planning/features/038-info-plist-build-time-merge.md.
+        PLISTBUDDY=/usr/libexec/PlistBuddy
+        BASE="${SRCROOT}/Runner/Info.plist"
+        FLAVOR_NAME="${CONFIGURATION#*-}"
+        FLAVOR_PLIST="${SRCROOT}/ann/Info/Info-${FLAVOR_NAME}.plist"
+        OUT="${DERIVED_FILE_DIR}/Info-merged.plist"
+
+        if [ ! -f "$BASE" ]; then
+          echo "error: [ann-flavor] Runner/Info.plist not found at $BASE"
+          exit 1
+        fi
+
+        # Start from a full copy of the base layer -- every key
+        # Runner/Info.plist already has is correct by default; only the
+        # flavor delta's keys need explicit merging in below.
+        cp "$BASE" "$OUT"
+
+        if [ ! -f "$FLAVOR_PLIST" ]; then
+          echo "warning: [ann-flavor] no flavor Info.plist found for '$FLAVOR_NAME' at $FLAVOR_PLIST -- using Runner/Info.plist unmerged."
+          exit 0
+        fi
+
+        # Enumerate the flavor delta's top-level keys. PlistBuddy "Print" with
+        # no key path dumps the whole dict; grep the top-level "Key = " lines
+        # (four leading spaces = depth 1 in PlistBuddy's indented dump format).
+        FLAVOR_KEYS=$("$PLISTBUDDY" -c "Print" "$FLAVOR_PLIST" | grep -E '^    [A-Za-z]' | sed 's/ =.*//' | sed 's/^ *//')
+
+        for KEY in $FLAVOR_KEYS; do
+          # OQ-2: warn (non-fatal) only on a genuine collision -- Runner/Info.plist
+          # already had this key, with a different value, before the flavor delta
+          # is applied. A net-new key (not previously in Runner/Info.plist) is not
+          # a collision and stays silent -- that's the expected, common case.
+          # Compared via PlistBuddy's human-readable Print output, which is
+          # good enough for equality-detection purposes even though it can't
+          # reliably tell types apart (see the VALUE_XML extraction below,
+          # which is what actually determines the merged value/type).
+          BASE_VALUE=$("$PLISTBUDDY" -c "Print :$KEY" "$OUT" 2>/dev/null)
+          BASE_HAD_KEY=$?
+          FLAVOR_VALUE=$("$PLISTBUDDY" -c "Print :$KEY" "$FLAVOR_PLIST")
+
+          if [ "$BASE_HAD_KEY" -eq 0 ] && [ "$BASE_VALUE" != "$FLAVOR_VALUE" ]; then
+            echo "[ann-flavor] Info.plist: '$KEY' overridden by flavor value ($FLAVOR_NAME) -- Runner/Info.plist's value ignored for this build."
+          fi
+
+          # Extract the flavor value's own XML fragment (e.g. <string>x</string>,
+          # <true/>, <integer>42</integer>, <array>...</array>) via PlistBuddy's
+          # -x (XML) output, scoped to just this key, stripping the <plist
+          # version="1.0">...</plist> wrapper that -x always adds. This
+          # preserves the flavor delta's real plist type -- Print's
+          # human-readable output alone can't distinguish an integer 42 from
+          # the string "42", or a bool true from the string "true", so a
+          # scalar-vs-composite TYPE guess from Print was unreliable and has
+          # been replaced with this approach (verified against a real
+          # PlistBuddy: bool/int/real/string/array/dict all round-trip
+          # correctly this way, plan 038 STEP-02).
+          VALUE_XML=$("$PLISTBUDDY" -x -c "Print :$KEY" "$FLAVOR_PLIST" | sed -n '/<plist version/,/<\\/plist>/p' | sed '1d;$d')
+
+          "$PLISTBUDDY" -c "Delete :$KEY" "$OUT" >/dev/null 2>&1
+          FRAGMENT=$(mktemp /tmp/ann-flavor-plist-fragment.XXXXXX)
+          cat > "$FRAGMENT" <<XMLEOF
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+        <key>$KEY</key>
+        $VALUE_XML
+        </dict>
+        </plist>
+        XMLEOF
+          "$PLISTBUDDY" -c "Merge \\"$FRAGMENT\\"" "$OUT"
+          rm -f "$FRAGMENT"
+        done
+      SHELL
+
+      # Find-or-update in place, rather than delete+recreate -- same
+      # idempotency rationale as inject_build_info_phase above.
+      existing = target.build_phases.find { |p| p.respond_to?(:name) && p.name == '[ann-flavor] Merge Info.plist' }
+      phase = existing || target.project.new(Xcodeproj::Project::Object::PBXShellScriptBuildPhase)
+      phase.name = '[ann-flavor] Merge Info.plist'
+      phase.shell_path = '/bin/sh'
+      phase.shell_script = script
+      phase.show_env_vars_in_log = '0'
+      # Declares this phase's output so Xcode's build system understands the
+      # dependency (same technique already used for the Firebase-copy phase's
+      # output_paths) -- suppresses "input file not found" for INFOPLIST_FILE
+      # referencing a path nothing else produces until this phase runs.
+      phase.output_paths = ['$(DERIVED_FILE_DIR)/Info-merged.plist']
+
+      target.build_phases.unshift(phase) unless existing
+    end
   end
 end

data/lib/ann_flavor_cocoapods/version.rb

@@ -1,3 +1,3 @@
 module AnnFlavorCocoapods
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ann-flavor-cocoapods
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ANN Solutions