Upgrade to Sparkle 2.2

- rename `-s` option to `--ed-key-file`
- remove unnecessary headers from framework
- renamed XPC services
- fix `copy_to_release` output

Author: digitalmoksha

lib/motion-sparkle-sandbox.rb

@@ -16,7 +16,7 @@
 
 lib_dir_path = File.dirname(File.expand_path(__FILE__))
 
-POD_VERSION = '~> 2.1.0'
+POD_VERSION = '~> 2.2.0'
 
 unless @running_specs
   Motion::Project::App.setup do |app|

lib/motion-sparkle-sandbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MotionSparkleSandbox
-  VERSION = '2.1.1'
+  VERSION = '2.2'
 end

lib/motion/project/appcast.rb

@@ -19,7 +19,7 @@ class Appcast
 
         CLI_OPTIONS = {
           account: '--account',
-          private_eddsa_key: '-s',
+          private_ed_key_file: '--ed-key-file',
           download_url_prefix: '--download-url-prefix',
           release_notes_url_prefix: '--release-notes-url-prefix',
           full_release_notes_url: '--full-release-notes-url',
@@ -93,7 +93,7 @@ def prepare_args
           args = []
 
           account(args)
-          private_eddsa_key(args)
+          private_ed_key_file(args)
           download_url_prefix(args)
           release_notes_url_prefix(args)
           full_release_notes_url(args)
@@ -127,12 +127,11 @@ def account(args)
         # -s <private-EdDSA-key>  The private EdDSA string (128 characters). If not
         #                         specified, the private EdDSA key will be read from
         #                         the Keychain instead.
-        def private_eddsa_key(args)
-          if cli_options[:private_eddsa_key].present?
-            args << "-s=#{cli_options[:private_eddsa_key]}"
-          elsif use_exported_private_key && File.exist?(private_key_path)
-            private_key = File.read(private_key_path)
-            args << "-s=#{private_key}"
+        def private_ed_key_file(args)
+          if cli_options[:private_ed_key_file].present?
+            args << "--ed-key-file=#{cli_options[:private_ed_key_file]}"
+          elsif use_exported_private_key && File.exist?(@sparkle.private_key_path)
+            args << "--ed-key-file=#{@sparkle.private_key_path}"
           end
         end
 

lib/motion/project/project.rb

@@ -40,10 +40,18 @@ def codesign_with_sparkle(config, platform)
           bundle_path = App.config.app_bundle('MacOSX')
           sparkle_path = File.join(bundle_path, 'Frameworks', 'Sparkle.framework')
 
+          # strip out any header files, as they are not needed for a built product, and Xcode
+          # typically does this.  Their permissions are set such that it conflicts
+          # with building the deltas. See https://github.com/sparkle-project/Sparkle/issues/1972
+          `rm -fr "#{sparkle_path}/Versions/B/PrivateHeaders"`
+          `rm "#{sparkle_path}/PrivateHeaders"`
+          `rm -fr "#{sparkle_path}/Versions/B/Headers"`
+          `rm "#{sparkle_path}/Headers"`
+
           `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/Autoupdate"`
           `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/Updater.app"`
-          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/XPCServices/org.sparkle-project.InstallerLauncher.xpc"`
-          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime --entitlements "./vendor/Pods/Sparkle/Entitlements/org.sparkle-project.Downloader.entitlements" "#{sparkle_path}/Versions/B/XPCServices/org.sparkle-project.Downloader.xpc"` # rubocop:disable Layout/LineLength
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}/Versions/B/XPCServices/Installer.xpc"`
+          `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime --entitlements "./vendor/Pods/Sparkle/Entitlements/Downloader.entitlements" "#{sparkle_path}/Versions/B/XPCServices/Downloader.xpc"` # rubocop:disable Layout/LineLength
 
           `/usr/bin/codesign -f -s "#{config.codesign_certificate}" -o runtime "#{sparkle_path}"`
         end

lib/motion/project/sparkle.rb

@@ -210,12 +210,12 @@ def export_private_key
       # copy the release notes and zip archive into the releases_folder,
       # where the appcast will get built
       def copy_to_release
-        path = (project_path + releases_folder).realpath
-        zip_file_path = (sparkle_release_path + zip_file).realpath
+        destination_path = (project_path + releases_folder).realpath
+        zip_file_path = (sparkle_release_path + zip_file)
 
         [release_notes_path, zip_file_path].each do |file|
-          FileUtils.cp(file, "#{path}/")
-          App.info 'Copied', "./#{path}/#{file}"
+          FileUtils.cp(file, "#{destination_path}/")
+          App.info 'Copied', "#{destination_path}/#{file}"
         end
       end
 

spec/appcast_spec.rb

@@ -11,13 +11,13 @@
     it 'defaults to empty' do
       args = @appcast.prepare_args
 
-      expect(args).to eq []
+      expect(args).to eq ['--account=ed25519']
     end
 
     it 'sets all command line options' do
       expected_results = [
         '--account=test1',
-        '-s=test2',
+        '--ed-key-file=test2',
         '--download-url-prefix=test3',
         '--release-notes-url-prefix=test4',
         '--full-release-notes-url=test5',
@@ -36,7 +36,7 @@
       ]
 
       @appcast.process_option(:account, 'test1')
-      @appcast.process_option(:private_eddsa_key, 'test2')
+      @appcast.process_option(:private_ed_key_file, 'test2')
       @appcast.process_option(:download_url_prefix, 'test3')
       @appcast.process_option(:release_notes_url_prefix, 'test4')
       @appcast.process_option(:full_release_notes_url, 'test5')