motion-sparkle-sandbox 2.0.0 → 2.1.1

data/lib/motion/project/project.rb

@@ -1,67 +1,58 @@
-module Motion::Project
+# frozen_string_literal: true
 
-  class Config
-    variable :sparkle
+require 'open3'
 
-    def sparkle(&block)
-      @sparkle ||= Motion::Project::Sparkle.new(self)
-      if block
-        @sparkle.instance_eval &block
-      end
-      @sparkle
-    end
-  end
+module Motion
+  module Project
+    class Config
+      variable :sparkle
 
-  class App
-    class << self
-      def build_with_sparkle(platform, opts = {})
-        if App.config.sparkle.setup_ok?
-          App.info "Sparkle", "Setup OK"
-        else
-          exit 1
-        end
-        build_without_sparkle(platform, opts)
+      def sparkle(&block)
+        @sparkle ||= Motion::Project::Sparkle.new(self)
+        @sparkle.instance_eval(&block) if block
+        @sparkle.after_initialize
+        @sparkle
       end
-
-      alias_method "build_without_sparkle", "build"
-      alias_method "build", "build_with_sparkle"
     end
-  end
 
-  class Builder
-    # if we're using the sandboxed version of Sparkle, then we need to copy the
-    # xpc services to the proper folder and sign them.  This has to be done
-    # before we sign the app itself
-    #------------------------------------------------------------------------------
-    def codesign_with_sparkle(config, platform)
-      if App.config.embedded_frameworks.any? {|item| item.to_s.include?('Sparkle.framework')}
-        bundle_path = App.config.app_bundle('MacOSX')
+    class App
+      class << self
+        def build_with_sparkle(platform, opts = {})
+          App.fail 'Sparkle not setup correctly' unless App.config.sparkle.setup_ok?
 
-        if File.directory?(App.config.sparkle.sparkle_xpc_path)
-          App.info 'Sparkle', 'Removing unnecessary executables...'
-          sparkle_path = File.join(bundle_path, "Frameworks/Sparkle.framework")
-          ['Resources/Autoupdate', 'Resources/Updater.app'].each do |item|
-            bundle = File.join(sparkle_path, item)
-            FileUtils.rm_r(bundle) if File.exist?(bundle)
-          end
+          App.info 'Sparkle', 'Setup OK'
 
-          xpc_path = File.join(bundle_path, "XPCServices")
-          App.info 'Sparkle', "Copying XPCServices to #{xpc_path}"
+          build_without_sparkle(platform, opts)
+        end
 
-          FileUtils.mkdir_p(xpc_path)
-          `cp -R #{App.config.sparkle.sparkle_xpc_path}/*.xpc "#{xpc_path}"`
+        alias_method 'build_without_sparkle', 'build'
+        alias_method 'build', 'build_with_sparkle'
+      end
+    end
 
-          Dir.glob("#{xpc_path}/*.xpc").each do |path|
-            App.info 'Codesign', path
-            results = `#{App.config.sparkle.sparkle_vendor_path}/codesign_embedded_executable "#{App.config.codesign_certificate}" "#{File.expand_path(path)}" 2>&1`
-          end
+    class Builder
+      # The XPC services are already residing in the Sparkle package.  But we need
+      # to re-sign the entire package to ensure all executables have the hardened
+      # runtime and correct certificate.
+      #------------------------------------------------------------------------------
+      def codesign_with_sparkle(config, platform)
+        if App.config.embedded_frameworks.any? { |item| item.to_s.include?('Sparkle.framework') }
+          bundle_path = App.config.app_bundle('MacOSX')
+          sparkle_path = File.join(bundle_path, 'Frameworks', 'Sparkle.framework')
+
+          `/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}"`
         end
+
+        codesign_without_sparkle(config, platform)
       end
 
-      codesign_without_sparkle(config, platform)
+      alias_method 'codesign_without_sparkle', 'codesign'
+      alias_method 'codesign', 'codesign_with_sparkle'
     end
-
-    alias_method "codesign_without_sparkle", "codesign"
-    alias_method "codesign", "codesign_with_sparkle"
   end
 end

data/lib/motion/project/rake_tasks.rb

@@ -1,18 +1,33 @@
-# Rake tasks
+# frozen_string_literal: true
+
+# Sparkle specific rake tasks
+# rubocop:disable Metrics/BlockLength
 namespace :sparkle do
+  desc 'Sparkle Help'
+  task :help do
+    puts <<~HELP
 
-  task :install do
-    sparkle = App.config.sparkle
-    sparkle.install
+
+      During initial Sparkle setup, run these rake tasks:
+
+      1. `rake sparkle:setup_certificates`
+      2. `rake sparkle:setup`
+
+      Then after running `rake build:release`, you can run
+
+      3. `rake sparkle:package`            create the zipped package and release notes
+      4. `rake sparkle:copy_to_release`    copy package/notes into release folder
+      5. `rake sparkle:generate_appcast`   generate the appcast
+    HELP
   end
 
-  desc "Setup Sparkle configuration"
+  desc 'Setup Sparkle configuration'
   task :setup do
     sparkle = App.config.sparkle
     sparkle.setup
   end
 
-  desc "Create a ZIP file with you application .app release build"
+  desc 'Create a ZIP file with your application .app release build'
   task :package do
     App.config_without_setup.build_mode = :release
     sparkle = App.config.sparkle
@@ -24,50 +39,44 @@ namespace :sparkle do
     sparkle.generate_keys
   end
 
-  desc "Sign the ZIP file with appropriate certificates"
+  desc 'Generate the EdDSA signature for a package'
   task :sign do
     App.config_without_setup.build_mode = :release
     sparkle = App.config.sparkle
     sparkle.sign_package
   end
 
-  task :recreate_public_key do
-    sparkle = App.config.sparkle
-    sparkle.generate_public_key
-  end
-
-  task :copy_release_notes_templates do
+  desc 'Copy the release notes and zip archive to the release folder'
+  task :copy_to_release do
     App.config_without_setup.build_mode = :release
     sparkle = App.config.sparkle
-    sparkle.copy_templates(force = true)
+    sparkle.copy_to_release
   end
 
-  desc "Generate the appcast xml feed"
-  task :feed do
+  desc "Generate the appcast xml feed using Sparkle's `generate_appcast`"
+  task :generate_appcast do
     App.config_without_setup.build_mode = :release
     sparkle = App.config.sparkle
-    sparkle.create_appcast
+    sparkle.generate_appcast
   end
 
-  desc "Generate the appcast using Sparkle's `generate_appcast`"
-  task :generate_appcast do
-    App.config_without_setup.build_mode = :release
-    sparkle = App.config.sparkle
-    results = `#{sparkle.sparkle_vendor_path}/generate_appcast "#{sparkle.private_key_path}" "#{sparkle.archive_folder}"`
+  namespace :generate_appcast do
+    desc "Show help for Sparkle's `generate_appcast`"
+    task :help do
+      App.config_without_setup.build_mode = :release
+      sparkle = App.config.sparkle
+      sparkle.generate_appcast_help
+    end
   end
 
-  desc "Update the release notes of this build"
+  desc 'Update the release notes of this build'
   task :release_notes do
     App.config_without_setup.build_mode = :release
     sparkle = App.config.sparkle
     sparkle.create_release_notes
   end
 
-  desc "Upload to configured location"
-  task :upload do
-  end
-
-  desc "Clean the Sparkle release folder"
+  desc 'Clean the Sparkle release folder'
   task :clean do
     dir = Motion::Project::Sparkle::RELEASE_PATH
     if File.exist?("./#{dir}")
@@ -87,3 +96,4 @@ namespace :clean do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/motion/project/setup.rb

@@ -1,96 +1,90 @@
-module Motion::Project
-  class Sparkle
+# frozen_string_literal: true
 
-    def setup_ok?
-      config_ok?
-      certificates_ok?
-    end
+module Motion
+  module Project
+    class Sparkle
+      def setup_ok?
+        config_ok?
+        certificates_ok?
+      end
 
-    def config_ok?
-      check_base_url
-      check_feed_url
-      check_public_key
-    end
+      def config_ok?
+        check_base_url
+        check_feed_url
+        check_public_key
+      end
+
+      def check_base_url
+        return true if appcast.base_url.present?
 
-    def check_base_url
-      base_url_check = appcast.base_url.to_s
-      if base_url_check.nil? or base_url_check.empty?
         App.fail "Sparkle :base_url missing. Use `release :base_url, 'http://example.com/your_app_folder'` in your Rakefile's `app.sparkle` block"
       end
-      true
-    end
 
-    def check_feed_url
-      feed_url_check = @config.info_plist['SUFeedURL']
-      feed_filename_check = appcast.feed_filename
-      if feed_url_check.nil? or feed_url_check.empty? or feed_filename_check.nil? or feed_filename_check.empty?
-        App.fail "Sparkle :feed_filename is nil or blank. Please check your Rakefile."
+      def check_feed_url
+        return true if feed_url.present? && appcast.feed_filename.present?
+
+        App.fail 'Sparkle :feed_filename is nil or blank. Please check your Rakefile.'
       end
-      true
-    end
 
-    def check_public_key
-      public_key_check = @config.info_plist['SUPublicDSAKeyFile'].to_s
-      if public_key_check.nil? or public_key_check.empty?
-        App.fail "Sparkle :public_key is nil or blank. Please check your Rakefile."
+      def check_public_key
+        return true if public_ed_dsa_key.present?
+
+        App.fail 'Sparkle :public_key is nil or blank. Please check your Rakefile.'
       end
-      true
-    end
 
-    def certificates_ok?(silence=false)
-      unless File.exist?("./#{Sparkle::CONFIG_PATH}")
-        if silence
-          return false
-        else
-          App.fail "Missing `#{Sparkle::CONFIG_PATH}`. Run `rake sparkle:setup` to get started" 
+      def certificates_ok?(silence = false)
+        unless File.exist?("./#{Sparkle::CONFIG_PATH}")
+          return false if silence
+
+          App.fail "Missing `#{Sparkle::CONFIG_PATH}`. Run `rake sparkle:setup` to get started"
         end
-      end
-      unless File.exist?(private_key_path)
-        if silence
-          return false
-        else
+
+        if appcast.use_exported_private_key && !File.exist?(private_key_path)
+          return false if silence
+
           App.fail "Missing `#{private_key_path}`. Please run `rake sparkle:setup_certificates` or check the docs to know where to put them."
         end
-      end
-      unless File.exist?(public_key_path)
-        if silence
-          return false
-        else
+
+        unless public_ed_dsa_key.present?
+          return false if silence
+
           App.fail "Missing `#{public_key_path}`. Did you configure `release :public_key` correctly in the Rakefile? Advanced: recreate your public key with `rake sparkle:recreate_public_key`"
         end
+
+        true
       end
-      true
-    end
 
-    def setup
-      verify_installation
-      create_sparkle_folder
-      add_to_gitignore
-      copy_templates
+      def setup
+        verify_installation
+        create_sparkle_folder
+        add_to_gitignore
+        copy_templates
 
-      if config_ok?
-        App.info "Sparkle", "Config found"
-      else
-        return false
-      end
+        return false unless config_ok?
+
+        App.info 'Sparkle', 'Config found'
 
-      silence = true
-      if certificates_ok?(silence)
-        App.info "Sparkle", "Certificates found"
-      else
-        App.info "Sparkle", "Certificates not found
-Please generate your private and public keys with
-    `rake sparkle:setup_certificates`
-If you already have your certificates and only need to include them in the project, follow these steps:
-    1. Rename your private key to `./#{private_key_path}`
-    2. Place your public key in `./#{public_key_path}`
-    3. If you wish to use a different name or location for your public key within the resources dir, 
-       make sure you add `publish :public_key, 'folder/new_name.pem'` to the sparkle config in your Rakefile
-        "
-        return false
+        silence = true
+        unless certificates_ok?(silence)
+          App.info 'Sparkle', <<~CERTIFICATES
+            Certificates not found
+
+                        Please generate your private and public keys with
+                           `rake sparkle:setup_certificates`
+
+                        If you already have your certificates and only need to include them in the project, follow these steps:
+                           1. Rename your private key to `./#{private_key_path}`
+                              and make sure you've added it to your `.gitignore` file - it should NEVER be
+                              stored in your repository
+                           2. Add `publish :public_key, 'PUBLIC_KEY'` to the Sparkle config in your Rakefile
+          CERTIFICATES
+
+          return false
+        end
+
+        App.info 'Sparkle', 'Certificates found'
+        App.info 'Sparkle', 'Setup OK. After `rake build:release`, you can now run `rake sparkle:package`.'
       end
-      App.info "Sparkle", "Setup OK. After `rake build:release`, you can now run `rake sparkle:package`."
     end
-
   end
 end