motion-sparkle-sandbox 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7c1845f67138c6774aab881d396058ee2041c1ed541ba0cc824bb48fac8839
-  data.tar.gz: eaaa9add1f9755ebf2858da7ee56781836c5aeb63cddb4483f2326ad7c5751bc
+  metadata.gz: ca50d516f00ac1b85b4212983fbe11e53f1d859ebbb18b2d3e4fad974a055523
+  data.tar.gz: 263ad26c09854be232dd7a19485270b02d33b148838925f09f06c874eef2f993
 SHA512:
-  metadata.gz: 47b4434bdfdaa48004bdd4e70f4c1608548c204b001246609a8a25356aa9f5cbad502e6b0c14198e1161a0d319599b53361fb25f6de1284e0553914c13f9db96
-  data.tar.gz: 62a6a7bbee1cd82ebc2a414300db3d0307b75a052c9d480167cefc5401182cff2adcb7394eb119d2d7eafac52b7c2fb3bca6e9f31cc3d15fea2b9656691d58e1
+  metadata.gz: 85a7857cc96ef6e0a54bca54bdb416316781101cd7a85510c4905d8ecca79c3558795c89f83225df83db2f914052be24a570ddf03d093f80ea0121b75324141a
+  data.tar.gz: fecced623e72e228bc0f64025c40aae21bd89819de2a7c8d655e8f04043be0af6d68820372a5018dbad69302d67678b1feccacd6efe683b84d583ff23f899309

data/bin/bundle

@@ -11,7 +11,7 @@
 require "rubygems"
 
 m = Module.new do
-    module_function
+  module_function
 
   def invoked_as_script?
     File.expand_path($0) == File.expand_path(__FILE__)
@@ -31,7 +31,7 @@ m = Module.new do
         bundler_version = a
       end
       next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1 || ">= 0.a"
+      bundler_version = $1
       update_index = i
     end
     bundler_version
@@ -61,32 +61,41 @@ m = Module.new do
   end
 
   def bundler_version
-    @bundler_version ||= begin
+    @bundler_version ||=
       env_var_version || cli_arg_version ||
-        lockfile_version || "#{Gem::Requirement.default}.a"
-    end
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
   end
 
   def load_bundler!
     ENV["BUNDLE_GEMFILE"] ||= gemfile
 
-    # must dup string for RG < 1.8 compatibility
-    activate_bundler(bundler_version.dup)
+    activate_bundler
   end
 
-  def activate_bundler(bundler_version)
-    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
-      bundler_version = "< 2"
-    end
+  def activate_bundler
     gem_error = activation_error_handling do
-      gem "bundler", bundler_version
+      gem "bundler", bundler_requirement
     end
     return if gem_error.nil?
     require_error = activation_error_handling do
       require "bundler/version"
     end
-    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
     exit 42
   end
 

data/lib/motion/project/appcast.rb

@@ -1,45 +1,179 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
 module Motion
   module Project
     class Sparkle
-      # Generate the appcast.
-      # Note: We do not support the old DSA keys, only the newer EdDSA keys.
-      #       See https://sparkle-project.org/documentation/eddsa-migration
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def generate_appcast
-        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
-        path = (project_path + archive_folder).realpath
-        appcast_filename = (path + appcast.feed_filename)
+      class Appcast
+        PARAMS = %i[
+          package_base_url
+          package_filename
+          notes_base_url
+          notes_filename
+          use_exported_private_key
+          base_url
+          releases_folder
+          feed_base_url
+          feed_filename
+        ].freeze
+
+        CLI_OPTIONS = {
+          account: '--account',
+          private_eddsa_key: '-s',
+          download_url_prefix: '--download-url-prefix',
+          release_notes_url_prefix: '--release-notes-url-prefix',
+          full_release_notes_url: '--full-release-notes-url',
+          link: '--link',
+          versions: '--versions',
+          maximum_deltas: '--maximum-deltas',
+          delta_compression: '--delta-compression',
+          delta_compression_level: '--delta-compression-level',
+          channel: '--channel',
+          major_version: '--major-version',
+          ignore_skipped_upgrades_below_version: '--ignore-skipped-upgrades-below-version',
+          phased_rollout_interval: '--phased-rollout-interval',
+          critical_update_version: '--critical-update-version',
+          informational_update_versions: '--informational-update-versions',
+          output_path: '-o'
+        }.freeze
+
+        attr_accessor :base_url,
+                      :feed_base_url,
+                      :feed_filename,
+                      :notes_filename,
+                      :package_filename,
+                      :releases_folder,
+                      :use_exported_private_key,
+                      :cli_options
+        attr_writer   :notes_base_url,
+                      :package_base_url
+
+        def initialize(sparkle_object)
+          @sparkle = sparkle_object
+          @cli_options = {
+            account: 'ed25519' # Sparkle's default account
+          }
+
+          @feed_base_url = nil
+          @feed_filename = 'releases.xml'
+          @notes_base_url = nil
+          @notes_filename = nil
+          @package_base_url = nil
+          @package_filename = nil
+          @base_url = nil
+          @releases_folder = nil
+          @use_exported_private_key = false
+        end
+
+        def process_option(key, value)
+          if CLI_OPTIONS.keys.include?(key)
+            cli_options[key] = value
+          elsif PARAMS.include?(key)
+            send("#{key}=", value)
+          else
+            return false
+          end
+
+          true
+        end
+
+        def feed_url
+          "#{feed_base_url || base_url}#{feed_filename}"
+        end
+
+        def notes_base_url
+          @notes_base_url || base_url
+        end
 
-        args = []
+        def package_base_url
+          @package_base_url || base_url
+        end
+
+        def prepare_args
+          args = []
+
+          account(args)
+          private_eddsa_key(args)
+          download_url_prefix(args)
+          release_notes_url_prefix(args)
+          full_release_notes_url(args)
+          link(args)
+          versions(args)
+          maximum_deltas(args)
+          delta_compression(args)
+          delta_compression_level(args)
+          channel(args)
+          major_version(args)
+          ignore_skipped_upgrades_below_version(args)
+          phased_rollout_interval(args)
+          critical_update_version(args)
+          informational_update_versions(args)
+          output_path(args)
+
+          args
+        end
+
+        private
 
-        FileUtils.mkdir_p(path) unless File.exist?(path)
+        # --account <account>     The account name in your keychain associated with
+        #                         your private EdDSA (ed25519) key to use for signing
+        #                         new updates. (default: ed25519)
+        def account(args)
+          return unless cli_options[:account].present?
 
-        App.info('Sparkle', "Generating appcast using `#{generate_appcast_app}`")
-        puts "from files in `#{path}`...".indent(11)
+          args << "--account=#{cli_options[:account]}"
+        end
 
-        if appcast.use_exported_private_key && File.exist?(private_key_path)
-          # -s <private-EdDSA-key>  The private EdDSA string (128 characters). If not
-          #                         specified, the private EdDSA key will be read from
-          #                         the Keychain instead.
-          private_key = File.read(private_key_path)
-          args << "-s=#{private_key}"
+        # -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}"
+          end
         end
 
         # --download-url-prefix <url> A URL that will be used as prefix for the URL from
         #                             where updates will be downloaded.
-        args << "--download-url-prefix=#{appcast.package_base_url}" if appcast.package_base_url.present?
+        def download_url_prefix(args)
+          if cli_options[:download_url_prefix].present?
+            args << "--download-url-prefix=#{cli_options[:download_url_prefix]}"
+          elsif package_base_url.present?
+            args << "--download-url-prefix=#{package_base_url}"
+          end
+        end
 
         # --release-notes-url-prefix <url> A URL that will be used as prefix for constructing
         #                                  URLs for release notes.
-        args << "--release-notes-url-prefix=#{appcast.notes_base_url}" if appcast.notes_base_url.present?
+        def release_notes_url_prefix(args)
+          if cli_options[:release_notes_url_prefix].present?
+            args << "--release-notes-url-prefix=#{cli_options[:release_notes_url_prefix]}"
+          elsif notes_base_url.present?
+            args << "--release-notes-url-prefix=#{notes_base_url}"
+          end
+        end
+
+        # --full-release-notes-url <url>
+        #                         A URL that will be used for the full release notes.
+        def full_release_notes_url(args)
+          return unless cli_options[:full_release_notes_url].present?
+
+          args << "--full-release-notes-url=#{cli_options[:full_release_notes_url]}"
+        end
 
         # --link <link>           A URL to the application's website which Sparkle may
         #                         use for directing users to if they cannot download a
         #                         new update from within the application. This will be
         #                         used for new generated update items. By default, no
         #                         product link is used.
+        def link(args)
+          return unless cli_options[:link].present?
+
+          args << "--link=#{cli_options[:link]}"
+        end
 
         # --versions <versions>   An optional comma delimited list of application
         #                         versions (specified by CFBundleVersion) to generate
@@ -47,27 +181,88 @@ module Motion
         #                         are inferred from the available archives and are only
         #                         generated if they are in the latest 5 updates in the
         #                         appcast.
+        def versions(args)
+          return unless cli_options[:versions].present?
+
+          args << "--versions=#{cli_options[:versions]}"
+        end
 
         # --maximum-deltas <maximum-deltas>
         #                         The maximum number of delta items to create for the
         #                         latest update for each minimum required operating
         #                         system. (default: 5)
+        def maximum_deltas(args)
+          return unless cli_options[:maximum_deltas].present?
+
+          args << "--maximum-deltas=#{cli_options[:maximum_deltas]}"
+        end
+
+        # --delta-compression <delta-compression>
+        #                         The compression method to use for generating delta
+        #                         updates. Supported methods for version 3 delta files
+        #                         are 'lzma', 'bzip2', 'zlib', 'lzfse', 'lz4', 'none',
+        #                         and 'default'. Note that version 2 delta files only
+        #                         support 'bzip2', 'none', and 'default' so other
+        #                         methods will be ignored if version 2 files are being
+        #                         generated. The 'default' compression for version 3
+        #                         delta files is currently lzma. (default: default)
+        def delta_compression(args)
+          return unless cli_options[:delta_compression].present?
+
+          args << "--delta-compression=#{cli_options[:delta_compression]}"
+        end
+
+        # --delta-compression-level <delta-compression-level>
+        #                         The compression level to use for generating delta
+        #                         updates. This only applies if the compression method
+        #                         used is bzip2 which accepts values from 1 - 9. A
+        #                         special value of 0 will use the default compression
+        #                         level. (default: 0)
+        def delta_compression_level(args)
+          return unless cli_options[:delta_compression_level].present?
+
+          args << "--delta-compression-level=#{cli_options[:delta_compression_level]}"
+        end
 
         # --channel <channel-name>
         #                         The Sparkle channel name that will be used for
         #                         generating new updates. By default, no channel is
         #                         used. Old applications need to be using Sparkle 2 to
         #                         use this feature.
+        def channel(args)
+          return unless cli_options[:channel].present?
+
+          args << "--channel=#{cli_options[:channel]}"
+        end
 
         # --major-version <major-version>
         #                         The last major or minimum autoupdate sparkle:version
         #                         that will be used for generating new updates. By
         #                         default, no last major version is used.
+        def major_version(args)
+          return unless cli_options[:major_version].present?
+
+          args << "--major-version=#{cli_options[:major_version]}"
+        end
+
+        # --ignore-skipped-upgrades-below-version <below-version>
+        #                         Ignore skipped major upgrades below this specified
+        #                         version. Only applicable for major upgrades.
+        def ignore_skipped_upgrades_below_version(args)
+          return unless cli_options[:ignore_skipped_upgrades_below_version].present?
+
+          args << "--ignore-skipped-upgrades-below-version=#{cli_options[:ignore_skipped_upgrades_below_version]}"
+        end
 
         # --phased-rollout-interval <phased-rollout-interval>
         #                         The phased rollout interval in seconds that will be
         #                         used for generating new updates. By default, no
         #                         phased rollout interval is used.
+        def phased_rollout_interval(args)
+          return unless cli_options[:phased_rollout_interval].present?
+
+          args << "--phased-rollout-interval=#{cli_options[:phased_rollout_interval]}"
+        end
 
         # --critical-update-version <critical-update-version>
         #                         The last critical update sparkle:version that will be
@@ -76,125 +271,40 @@ module Motion
         #                         from any application version. By default, no last
         #                         critical update version is used. Old applications
         #                         need to be using Sparkle 2 to use this feature.
+        def critical_update_version(args)
+          return unless cli_options[:critical_update_version].present?
+
+          args << "--critical-update-version=#{cli_options[:critical_update_version]}"
+        end
 
         # --informational-update-versions <informational-update-versions>
         #                         A comma delimited list of application
         #                         sparkle:version's that will see newly generated
         #                         updates as being informational only. An empty string
         #                         argument will treat this update as informational
-        #                         coming from any application version. By default,
-        #                         updates are not informational only. --link must also
-        #                         be provided. Old applications need to be using
-        #                         Sparkle 2 to use this feature.
+        #                         coming from any application version. Prefix a version
+        #                         string with '<' to indicate (eg "<2.5") to indicate
+        #                         older versions than the one specified should treat
+        #                         the update as informational only. By default, updates
+        #                         are not informational only. --link must also be
+        #                         provided. Old applications need to be using Sparkle 2
+        #                         to use this feature, and 2.1 or later to use the '<'
+        #                         upper bound feature.
+        def informational_update_versions(args)
+          return unless cli_options[:informational_update_versions].present?
+
+          args << "--informational-update-versions=#{cli_options[:informational_update_versions]}"
+        end
 
         # -o <output-path>        Path to filename for the generated appcast (allowed
         #                         when only one will be created).
+        def output_path(args)
+          return unless cli_options[:output_path].present?
 
-        # -f <private-dsa-key-file> Path to the private DSA key file. Only use this
-        #                           option for transitioning to EdDSA from older updates.
-        # Note: only for supporting a legacy app that used DSA keys.  Check if the
-        # default DSA key exists in `sparkle/config/dsa_priv.pem` and if it does,
-        # add it to the command.
-        if File.exist?(legacy_private_key_path)
-          App.info 'Sparkle', "Also signing with legacy DSA key at #{legacy_private_key_path}"
-          args << "-f=#{legacy_private_key_path}"
-        end
-
-        args << "-o=#{appcast_filename}" if appcast_filename.present?
-
-        App.info 'Executing', [generate_appcast_app, *args, path.to_s].join(' ')
-
-        results, status = Open3.capture2e(generate_appcast_app, *args, path.to_s)
-
-        App.info('Sparkle', "Saved appcast to `#{appcast_filename}`") if status.success?
-        puts results.indent(11)
-
-        return unless status.success?
-
-        puts
-        puts "SUFeedURL     : #{feed_url}".indent(11)
-        puts "SUPublicEDKey : #{public_EdDSA_key}".indent(11)
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-
-      def generate_appcast_help
-        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
-        results, _status = Open3.capture2e(generate_appcast_app, '--help')
-        puts results
-      end
-
-      def create_release_notes
-        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}" unless File.exist?(release_notes_template_path)
-
-        create_release_folder
-
-        File.open(release_notes_path.to_s, 'w') do |f|
-          template = File.read(release_notes_template_path)
-          f << ERB.new(template).result(binding)
-        end
-
-        App.info 'Create', "./#{release_notes_path}"
-      end
-
-      def release_notes_template_path
-        sparkle_config_path.join('release_notes.template.erb')
-      end
-
-      def release_notes_content_path
-        sparkle_config_path.join('release_notes.content.html')
-      end
-
-      def release_notes_path
-        sparkle_release_path + (appcast.notes_filename || "#{app_name}.#{@config.short_version}.html")
-      end
-
-      def release_notes_content
-        if File.exist?(release_notes_content_path)
-          File.read(release_notes_content_path)
-        else
-          App.fail "Missing #{release_notes_content_path}"
-        end
-      end
-
-      def release_notes_html
-        release_notes_content
-      end
-
-      class Appcast
-        attr_accessor :base_url,
-                      :feed_base_url,
-                      :feed_filename,
-                      :notes_filename,
-                      :package_filename,
-                      :archive_folder,
-                      :use_exported_private_key
-        attr_writer   :notes_base_url,
-                      :package_base_url
-
-        def initialize
-          @feed_base_url = nil
-          @feed_filename = 'releases.xml'
-          @notes_base_url = nil
-          @notes_filename = nil
-          @package_base_url = nil
-          @package_filename = nil
-          @base_url = nil
-          @archive_folder = nil
-          @use_exported_private_key = false
-        end
-
-        def feed_url
-          "#{feed_base_url || base_url}#{feed_filename}"
-        end
-
-        def notes_base_url
-          @notes_base_url || base_url
-        end
-
-        def package_base_url
-          @package_base_url || base_url
+          args << "-o=#{cli_options[:output_path]}"
         end
       end
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/motion/project/project.rb

@@ -10,6 +10,7 @@ module Motion
       def sparkle(&block)
         @sparkle ||= Motion::Project::Sparkle.new(self)
         @sparkle.instance_eval(&block) if block
+        @sparkle.after_initialize
         @sparkle
       end
     end

data/lib/motion/project/rake_tasks.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
 # Sparkle specific rake tasks
+# rubocop:disable Metrics/BlockLength
 namespace :sparkle do
   desc 'Sparkle Help'
   task :help do
     puts <<~HELP
+
+
       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
-      `rake sparkle:package`
+
+      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
 
@@ -40,6 +46,13 @@ namespace :sparkle do
     sparkle.sign_package
   end
 
+  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_to_release
+  end
+
   desc "Generate the appcast xml feed using Sparkle's `generate_appcast`"
   task :generate_appcast do
     App.config_without_setup.build_mode = :release
@@ -83,3 +96,4 @@ namespace :clean do
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/motion/project/setup.rb

@@ -27,7 +27,7 @@ module Motion
       end
 
       def check_public_key
-        return true if public_EdDSA_key.present?
+        return true if public_ed_dsa_key.present?
 
         App.fail 'Sparkle :public_key is nil or blank. Please check your Rakefile.'
       end
@@ -45,7 +45,7 @@ module Motion
           App.fail "Missing `#{private_key_path}`. Please run `rake sparkle:setup_certificates` or check the docs to know where to put them."
         end
 
-        unless public_EdDSA_key.present?
+        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`"

data/lib/motion/project/sparkle.rb

@@ -15,29 +15,22 @@ module Motion
         # verify_installation
       end
 
+      def after_initialize
+        self.feed_url = appcast.feed_url
+      end
+
       def appcast
-        @appcast ||= Appcast.new
+        @appcast ||= Appcast.new(self)
       end
 
       def publish(key, value)
+        return if appcast.process_option(key, value)
+
         case key
         when :public_key
-          self.public_EdDSA_key = value
-        when :base_url
-          appcast.base_url = value
-          self.feed_url = appcast.feed_url
-        when :feed_base_url
-          appcast.feed_base_url = value
-          self.feed_url = appcast.feed_url
-        when :feed_filename
-          appcast.feed_filename = value
-          self.feed_url = appcast.feed_url
+          self.public_ed_dsa_key = value
         when :version
-          version value
-        when :package_base_url, :package_filename, :notes_base_url, :notes_filename, :use_exported_private_key
-          appcast.send "#{key}=", value
-        when :archive_folder
-          appcast.archive_folder = value
+          version(value)
         else
           raise "Unknown Sparkle config option #{key}"
         end
@@ -61,15 +54,13 @@ module Motion
         @config.info_plist['SUFeedURL'] = url
       end
 
-      # rubocop:disable Naming/MethodName
-      def public_EdDSA_key
+      def public_ed_dsa_key
         @config.info_plist['SUPublicEDKey']
       end
 
-      def public_EdDSA_key=(key)
+      def public_ed_dsa_key=(key)
         @config.info_plist['SUPublicEDKey'] = key
       end
-      # rubocop:enable Naming/MethodName
 
       # File manipulation and certificates
 
@@ -109,7 +100,7 @@ module Motion
 
         if appcast.use_exported_private_key && File.exist?(private_key_path)
           App.info 'Sparkle', "Private key already exported at `#{private_key_path}` and will be used."
-          if public_EdDSA_key.present?
+          if public_ed_dsa_key.present?
             App.info '', <<~EXISTS
               SUPublicEDKey already set
 
@@ -139,12 +130,12 @@ module Motion
           return
         end
 
-        results, status = Open3.capture2e(generate_keys_app, '-p')
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
         if status.success?
-          App.info 'Sparkle', 'Public/private keys found in the keychain'
+          App.info 'Sparkle', "Public/private keys found in the keychain for account #{appcast.cli_options[:account]}"
 
-          if results.strip == public_EdDSA_key
+          if results.strip == public_ed_dsa_key
             App.info 'Sparkle', 'Keychain public key matches `SUPublicEDKey`'
 
             if appcast.use_exported_private_key && !File.exist?(private_key_path)
@@ -155,7 +146,7 @@ module Motion
               Keychain public key DOES NOT match `SUPublicEDKey`
 
                   Keychain public key:      #{results.strip}
-                  SUPublicEDKey public key: #{public_EdDSA_key}
+                  SUPublicEDKey public key: #{public_ed_dsa_key}
 
             NOT_MATCHED
               .indent(11, skip_first_line: true)
@@ -173,7 +164,7 @@ module Motion
       def create_private_key
         App.info 'Sparkle',
                  'Generating a new signing key into the Keychain. This may take a moment, depending on your machine.'
-        results, status = Open3.capture2e(generate_keys_app)
+        results, status = Open3.capture2e(generate_keys_app, '--account', appcast.cli_options[:account])
 
         App.fail 'Sparkle could not generate keys' unless status.success?
 
@@ -181,7 +172,7 @@ module Motion
         puts results.lines[1..].join.indent(11)
 
         # Extract the public key so we can use it in message
-        results, status = Open3.capture2e(generate_keys_app, '-p')
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
         App.fail 'Unable to read public key' unless status.success?
 
@@ -199,7 +190,7 @@ module Motion
 
       # Export the private key from the keychain
       def export_private_key
-        _results, status = Open3.capture2e(generate_keys_app, '-x', private_key_path.to_s)
+        _results, status = Open3.capture2e(generate_keys_app, '-x', private_key_path.to_s, '--account', appcast.cli_options[:account])
 
         App.fail 'Unable to export private key' unless status.success?
 
@@ -216,6 +207,92 @@ module Motion
           .indent(11)
       end
 
+      # 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
+
+        [release_notes_path, zip_file_path].each do |file|
+          FileUtils.cp(file, "#{path}/")
+          App.info 'Copied', "./#{path}/#{file}"
+        end
+      end
+
+      # Generate the appcast.
+      # Note: We do not support the old DSA keys, only the newer EdDSA keys.
+      #       See https://sparkle-project.org/documentation/eddsa-migration
+      def generate_appcast
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        path = (project_path + releases_folder).realpath
+        appcast_filename = (path + appcast.feed_filename)
+        appcast.cli_options[:output_path] = appcast_filename
+
+        FileUtils.mkdir_p(path) unless File.exist?(path)
+
+        App.info('Sparkle', "Generating appcast using `#{generate_appcast_app}`")
+        puts "from files in `#{path}`...".indent(11)
+
+        args = appcast.prepare_args
+
+        App.info 'Executing', [generate_appcast_app, *args, path.to_s].join(' ')
+
+        results, status = Open3.capture2e(generate_appcast_app, *args, path.to_s)
+
+        App.info('Sparkle', "Saved appcast to `#{appcast_filename}`") if status.success?
+        puts results.indent(11)
+
+        return unless status.success?
+
+        puts
+        puts "SUFeedURL     : #{feed_url}".indent(11)
+        puts "SUPublicEDKey : #{public_ed_dsa_key}".indent(11)
+      end
+
+      def generate_appcast_help
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        results, _status = Open3.capture2e(generate_appcast_app, '--help')
+
+        puts results
+      end
+
+      def create_release_notes
+        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}" unless File.exist?(release_notes_template_path)
+
+        create_release_folder
+
+        File.open(release_notes_path.to_s, 'w') do |f|
+          template = File.read(release_notes_template_path)
+          f << ERB.new(template).result(binding)
+        end
+
+        App.info 'Create', "./#{release_notes_path}"
+      end
+
+      def release_notes_template_path
+        sparkle_config_path.join('release_notes.template.erb')
+      end
+
+      def release_notes_content_path
+        sparkle_config_path.join('release_notes.content.html')
+      end
+
+      def release_notes_path
+        sparkle_release_path + (appcast.notes_filename || "#{app_name}.#{@config.short_version}.html")
+      end
+
+      def release_notes_content
+        if File.exist?(release_notes_content_path)
+          File.read(release_notes_content_path)
+        else
+          App.fail "Missing #{release_notes_content_path}"
+        end
+      end
+
+      def release_notes_html
+        release_notes_content
+      end
+
       # A few helpers
 
       def project_path
@@ -242,10 +319,6 @@ module Motion
         sparkle_config_path.join(EDDSA_PRIV_KEY)
       end
 
-      def legacy_private_key_path
-        sparkle_config_path.join(DSA_PRIV_KEY)
-      end
-
       def app_bundle_path
         Pathname.new(@config.app_bundle_raw('MacOSX'))
       end
@@ -262,8 +335,8 @@ module Motion
         appcast.package_filename || "#{app_name}.#{@config.short_version}.zip"
       end
 
-      def archive_folder
-        appcast.archive_folder
+      def releases_folder
+        appcast.releases_folder
       end
 
       def app_file

data/lib/motion-sparkle-sandbox/version.rb

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

data/sample-app/.gitignore

@@ -7,3 +7,4 @@ vendor
 
 sparkle/release
 sparkle/config
+sparkle/config/eddsa_priv.key

data/sample-app/Rakefile

@@ -25,8 +25,8 @@ Motion::Project::App.setup do |app|
 
   app.sparkle do
     publish :base_url, 'http://example.com/your_app_folder/releases/'
-    publish :public_key, '06Iq4HGJFToJrA8lqWWG0SCqqtGXLuEN1Wgy/CVJBnI='
-    publish :archive_folder, '../published/releases/v2.2/'
+    publish :public_key, '1/eJupmw4JH+iFQIlh99nS2qvwYealJsNzFN3LL6FFE=x'
+    publish :releases_folder, 'tmp/releases/v2.2/'
 
     # Appcast Feed
     # publish :feed_base_url, 'http://downloads.example.com/releases' # defaults to base_url
@@ -40,5 +40,8 @@ Motion::Project::App.setup do |app|
     # publish :package_base_url, 'http://downloads.example.com/releases/' # defaults to base_url
 
     # publish :use_exported_private_key, true
+
+    publish :account, 'motion-sparkle-sandbox.sample-app'
+    publish :full_release_notes_url, 'http://example.com/full_release_notes_changed_again.html'
   end
 end

data/spec/appcast_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.expand_path('spec_utils', __dir__)
+
+describe 'Appcast' do
+  describe 'arguments' do
+    before do
+      @appcast = Motion::Project::Sparkle::Appcast.new(nil)
+    end
+
+    it 'defaults to empty' do
+      args = @appcast.prepare_args
+
+      expect(args).to eq []
+    end
+
+    it 'sets all command line options' do
+      expected_results = [
+        '--account=test1',
+        '-s=test2',
+        '--download-url-prefix=test3',
+        '--release-notes-url-prefix=test4',
+        '--full-release-notes-url=test5',
+        '--link=test6',
+        '--versions=test7',
+        '--maximum-deltas=test8',
+        '--delta-compression=test9',
+        '--delta-compression-level=test10',
+        '--channel=test11',
+        '--major-version=test12',
+        '--ignore-skipped-upgrades-below-version=test13',
+        '--phased-rollout-interval=test14',
+        '--critical-update-version=test15',
+        '--informational-update-versions=test16',
+        '-o=test17'
+      ]
+
+      @appcast.process_option(:account, 'test1')
+      @appcast.process_option(:private_eddsa_key, 'test2')
+      @appcast.process_option(:download_url_prefix, 'test3')
+      @appcast.process_option(:release_notes_url_prefix, 'test4')
+      @appcast.process_option(:full_release_notes_url, 'test5')
+      @appcast.process_option(:link, 'test6')
+      @appcast.process_option(:versions, 'test7')
+      @appcast.process_option(:maximum_deltas, 'test8')
+      @appcast.process_option(:delta_compression, 'test9')
+      @appcast.process_option(:delta_compression_level, 'test10')
+      @appcast.process_option(:channel, 'test11')
+      @appcast.process_option(:major_version, 'test12')
+      @appcast.process_option(:ignore_skipped_upgrades_below_version, 'test13')
+      @appcast.process_option(:phased_rollout_interval, 'test14')
+      @appcast.process_option(:critical_update_version, 'test15')
+      @appcast.process_option(:informational_update_versions, 'test16')
+      @appcast.process_option(:output_path, 'test17')
+      args = @appcast.prepare_args
+
+      expect(args).to match_array expected_results
+    end
+  end
+end

data/spec/sparkle_spec.rb

@@ -29,6 +29,7 @@ describe 'motion-sparkle-sandbox' do
 
       it 'uses feed_base_url' do
         @config.sparkle.publish(:feed_base_url, 'http://rss.example.com/')
+        @config.sparkle.after_initialize
 
         expect(@config.info_plist['SUFeedURL']).to eq 'http://rss.example.com/releases.xml'
       end
@@ -36,6 +37,7 @@ describe 'motion-sparkle-sandbox' do
       it 'uses feed_filename' do
         @config.sparkle.publish(:feed_base_url, 'http://rss.example.com/')
         @config.sparkle.publish(:feed_filename, 'example.xml')
+        @config.sparkle.after_initialize
 
         expect(@config.info_plist['SUFeedURL']).to eq 'http://rss.example.com/example.xml'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-sparkle-sandbox
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Brett Walker
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-28 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: motion-cocoapods
@@ -95,6 +95,7 @@ files:
 - sample-app/resources/Assets.xcassets/Contents.json
 - sample-app/resources/Credits.rtf
 - sample-app/spec/main_spec.rb
+- spec/appcast_spec.rb
 - spec/setup_spec.rb
 - spec/sparkle_spec.rb
 - spec/spec_helper.rb
@@ -124,6 +125,7 @@ signing_key:
 specification_version: 4
 summary: Sparkle (sandboxed) integration for Rubymotion projects
 test_files:
+- spec/appcast_spec.rb
 - spec/spec_helper.rb
 - spec/sparkle_spec.rb
 - spec/setup_spec.rb