ann-flavor-cocoapods 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 203077b214e8b6dcbf87c8792ea6df6055d34b4b6ea36af00c1c28a94207aab9
-  data.tar.gz: fcdbfba3ba5e54184fb3d05ace52259c10476947259d550cc4b134009d83e560
+  metadata.gz: 0b4a6fb9baad3561d14ffa73da2e419ebbaa0664edf12924875484973e5e5f21
+  data.tar.gz: a88e357ca0d0fdf957a3640229d7f98a852a058d3ea442f5333d8c6f02c1393c
 SHA512:
-  metadata.gz: 1968396623737c7d68439d68cb2fb4d8b8ac6d1da7bba9c32722bc9a0408e3d73fc2b6a4087fbff63231d0d8bd1403949d62e46bf2382a7d9361bd33a7d9fbd1
-  data.tar.gz: 5f6f3d65b87f5f8c41d52f6201c622fb379da14d81cf7d6338edf5a76bde7168213c2722f067495d0e8571f0ce35415f67e37538f47f4b5d266e297887672cee
+  metadata.gz: a156d31659cb317a3e114adda24d44048e0a8c28bf781f23b50f3821a8e0eb84e19aabf2ac57beec9da4d3e7cc192ab3182acf8a4f95c5177eb8ff3445298df0
+  data.tar.gz: 7c4b22bba78a36cb28338c38152e2126ea9b9d92007e633d1b6684bb40b2db1a30ca5f7ac74ad0855e31a3ae65bcca98210d3e6d8c2f98cac7664dbded19ee18

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.4.0
+
+### Added
+- **New `[ann-flavor] Merge Entitlements` build phase composes the final
+  `.entitlements` file Xcode signs with at build time**, not sync time: copies
+  `ios/Runner/Runner.entitlements` (the generic/base layer, developer-owned —
+  if present; unlike `Runner/Info.plist`, most projects have no stock
+  entitlements file at all, so a missing base file here starts from an empty
+  plist rather than failing), then merges in every key from the current
+  flavor's `ann/Entitlements/<flavor>.entitlements` delta (see
+  `ann_flutter_flavor` 1.3.0 — that file now holds only the flavor's
+  `entitlements:` cascade, not a full copy of `Runner.entitlements`), with the
+  flavor's value winning on any key both define. Uses `PlistBuddy`, mirroring
+  `[ann-flavor] Merge Info.plist` (0.3.0) exactly — entitlements files and
+  Info.plist are both plain Apple XML property lists, so the same
+  type-preserving merge logic applies unchanged. Injected only when at least
+  one flavor actually needs entitlements (its own cascade, or a stock
+  `Runner.entitlements`); removed automatically once nothing needs it anymore.
+
+### Changed
+- **`CODE_SIGN_ENTITLEMENTS` now points at
+  `$(DERIVED_FILE_DIR)/Entitlements-merged.entitlements`** (the Merge
+  Entitlements phase's output above) instead of directly at
+  `ann/Entitlements/<flavor>.entitlements`, whenever anything needs signing —
+  extends the same `INFOPLIST_FILE` rewiring from 0.3.0 to entitlements. See
+  [plan 039](../../docs/03-planning/features/039-entitlements-build-time-merge.md)
+  and the [Entitlements](../../docs/04-userguide/ios/overview.md#entitlements)
+  section of the iOS userguide for the full design.
+
 ## 0.3.0
 
 ### Added

data/lib/ann_flavor_cocoapods/podfile_helper.rb

@@ -155,6 +155,7 @@ module AnnFlavorCocoapods
         user_project.native_targets.each do |target|
           if target.symbol_type == :application
             find_or_create_icon_catalog(target, user_project)
+            target_has_entitlements = false
 
             ios.flavors.each_key do |flavor_key|
               flavor = ios.flavors[flavor_key]
@@ -178,16 +179,25 @@ module AnnFlavorCocoapods
 
                 assert_icon_generated!(user_project, flavor_key, icon_name)
 
-                # Unlike the icon catalog and Info.plist, entitlements: is
-                # opt-in -- ios_generator.dart's _generateEntitlements skips
-                # creating ios/ann/Entitlements/ entirely when no annspec.yaml
-                # entitlements: block and no stock Runner.entitlements exist
-                # anywhere. Only set CODE_SIGN_ENTITLEMENTS when the file
-                # actually exists on disk; leaving it unset is correct (no
-                # entitlements to sign with), not an error condition.
-                entitlements_path = "ann/Entitlements/#{flavor_key}.entitlements"
-                entitlements_file = File.join(user_project.project_dir.to_s, 'ann', 'Entitlements', "#{flavor_key}.entitlements")
-                entitlements_path = nil unless File.exist?(entitlements_file)
+                # Extended opt-in check (plan 039): CODE_SIGN_ENTITLEMENTS is
+                # wired only when there is something to sign with at all --
+                # either this flavor's entitlements: cascade, or a stock
+                # Runner.entitlements to fall back to. Mirrors
+                # ios_generator.dart's _anyFlavorHasEntitlements OR-condition,
+                # but evaluated here instead of at sync time -- the actual
+                # merge now happens at this (pod install / build time) layer,
+                # not sync time, so this is where "is there anything to sign
+                # with" needs to be answered from. The Merge Entitlements
+                # phase itself is injected once per target below (like Merge
+                # Info.plist), not per flavor/build-type here -- it derives
+                # $FLAVOR_NAME from $CONFIGURATION at build time, so one
+                # shared phase correctly serves every flavor, whether or not
+                # that specific flavor has its own entitlements: cascade.
+                flavor_entitlements_file = File.join(user_project.project_dir.to_s, 'ann', 'Entitlements', "#{flavor_key}.entitlements")
+                stock_entitlements_file = File.join(user_project.project_dir.to_s, 'Runner', 'Runner.entitlements')
+                has_entitlements = File.exist?(flavor_entitlements_file) || File.exist?(stock_entitlements_file)
+                entitlements_path = has_entitlements ? '$(DERIVED_FILE_DIR)/Entitlements-merged.entitlements' : nil
+                target_has_entitlements ||= has_entitlements
 
                 configure_build_configuration(
                   target, user_project, xcode_config, xcconfig_path,
@@ -203,6 +213,17 @@ module AnnFlavorCocoapods
             end
 
             inject_merge_info_plist_phase(target)
+
+            # Unlike Merge Info.plist (unconditional -- every flavor always
+            # has an Info.plist), Merge Entitlements is only injected when at
+            # least one flavor actually needs it (its own cascade, or a
+            # stock Runner.entitlements) -- entitlements are opt-in overall,
+            # and a phase with nothing to sign would just be dead weight.
+            if target_has_entitlements
+              inject_merge_entitlements_phase(target)
+            else
+              remove_merge_entitlements_phase(target)
+            end
           end
 
           # Fixes a real pod-install failure: PBXNativeTarget#resolved_build_setting
@@ -894,5 +915,110 @@ module AnnFlavorCocoapods
 
       target.build_phases.unshift(phase) unless existing
     end
+
+    # Composes the final .entitlements file Xcode actually signs with, from
+    # two layers -- Runner.entitlements (generic/base, developer-owned, may
+    # not exist at all) and the flavor-specific ann/Entitlements/<flavor>
+    # .entitlements delta (annspec.yaml's entitlements: cascade, opt-in --
+    # may also not exist) -- with the flavor layer winning on any key
+    # collision. Plan 039: mirrors inject_merge_info_plist_phase (plan 038)
+    # exactly -- same PlistBuddy-based merge (entitlements files and Info.plist
+    # are both plain Apple XML property lists; PlistBuddy has no notion of
+    # file "kind" beyond that), same find-or-update idempotency, same
+    # collision-warning behavior. The one real difference: unlike
+    # Runner/Info.plist (every Xcode project has one), most projects have no
+    # Runner.entitlements at all -- a missing base file here is a normal,
+    # non-fatal case (starts from an empty plist dict), not the fatal error
+    # Merge Info.plist treats a missing Runner/Info.plist as.
+    def self.inject_merge_entitlements_phase(target)
+      script = <<~SHELL
+        # Injected by ann-flavor-cocoapods: compose the final .entitlements file
+        # from two layers -- Runner.entitlements (generic/base, may not exist)
+        # and the flavor-specific ann/Entitlements/<flavor>.entitlements delta
+        # (annspec.yaml's entitlements: cascade, may also not exist) -- with the
+        # flavor layer winning on any key collision. Mirrors [ann-flavor] Merge
+        # Info.plist (plan 038) -- see plan 039 for why entitlements needed the
+        # same redesign.
+        PLISTBUDDY=/usr/libexec/PlistBuddy
+        BASE="${SRCROOT}/Runner/Runner.entitlements"
+        FLAVOR_NAME="${CONFIGURATION#*-}"
+        FLAVOR_FILE="${SRCROOT}/ann/Entitlements/${FLAVOR_NAME}.entitlements"
+        OUT="${DERIVED_FILE_DIR}/Entitlements-merged.entitlements"
+
+        if [ -f "$BASE" ]; then
+          cp "$BASE" "$OUT"
+        else
+          # No stock Runner.entitlements -- start from an empty plist dict
+          # rather than failing; the flavor delta (if any) is still applied
+          # below.
+          cat > "$OUT" <<PLISTEOF
+        <?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/>
+        </plist>
+        PLISTEOF
+        fi
+
+        if [ ! -f "$FLAVOR_FILE" ]; then
+          echo "[ann-flavor] Entitlements: no flavor delta found for '$FLAVOR_NAME' at $FLAVOR_FILE -- using Runner.entitlements unmerged."
+          exit 0
+        fi
+
+        FLAVOR_KEYS=$("$PLISTBUDDY" -c "Print" "$FLAVOR_FILE" | grep -E '^    [A-Za-z]' | sed 's/ =.*//' | sed 's/^ *//')
+
+        for KEY in $FLAVOR_KEYS; do
+          BASE_VALUE=$("$PLISTBUDDY" -c "Print :$KEY" "$OUT" 2>/dev/null)
+          BASE_HAD_KEY=$?
+          FLAVOR_VALUE=$("$PLISTBUDDY" -c "Print :$KEY" "$FLAVOR_FILE")
+
+          if [ "$BASE_HAD_KEY" -eq 0 ] && [ "$BASE_VALUE" != "$FLAVOR_VALUE" ]; then
+            echo "[ann-flavor] Entitlements: '$KEY' overridden by flavor value ($FLAVOR_NAME) -- Runner.entitlements' value ignored for this build."
+          fi
+
+          VALUE_XML=$("$PLISTBUDDY" -x -c "Print :$KEY" "$FLAVOR_FILE" | sed -n '/<plist version/,/<\\/plist>/p' | sed '1d;$d')
+
+          "$PLISTBUDDY" -c "Delete :$KEY" "$OUT" >/dev/null 2>&1
+          FRAGMENT=$(mktemp /tmp/ann-flavor-entitlements-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
+
+      existing = target.build_phases.find { |p| p.respond_to?(:name) && p.name == '[ann-flavor] Merge Entitlements' }
+      phase = existing || target.project.new(Xcodeproj::Project::Object::PBXShellScriptBuildPhase)
+      phase.name = '[ann-flavor] Merge Entitlements'
+      phase.shell_path = '/bin/sh'
+      phase.shell_script = script
+      phase.show_env_vars_in_log = '0'
+      phase.output_paths = ['$(DERIVED_FILE_DIR)/Entitlements-merged.entitlements']
+
+      target.build_phases.unshift(phase) unless existing
+    end
+
+    # Removes a previously-injected Merge Entitlements phase when no flavor
+    # needs entitlements anymore (annspec.yaml's entitlements: cascade was
+    # removed, and no stock Runner.entitlements exists either) -- entitlements
+    # are opt-in overall, so a stale phase with nothing to sign would be dead
+    # weight left in project.pbxproj. Uses ObjectList#delete (not plain
+    # Array#reject!/select), same rationale as the stale "[ann-flavor] Remove
+    # Firebase plist" cleanup above -- plain array removal only drops the
+    # phase from target.build_phases, leaving the object itself permanently
+    # orphaned in the project's global objects table.
+    def self.remove_merge_entitlements_phase(target)
+      target.build_phases.select do |p|
+        p.respond_to?(:name) && p.name == '[ann-flavor] Merge Entitlements'
+      end.each { |p| target.build_phases.delete(p) }
+    end
   end
 end

data/lib/ann_flavor_cocoapods/version.rb

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

metadata

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