appship 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 512f49f01b45fb318992c5dff4df86626d61aea2c57818556763fc869ecee047
+  data.tar.gz: 949c652229a3c30bf38d1e0727fb30be191b93e9198da561a7648592a0ca2687
+SHA512:
+  metadata.gz: 4884ca69b0efaf1ab59bd0ecd660d755b93c762545b578b6e30547c613d77ee8e65972efa6783aca244c27951980b45506f09cb4005bf27f2f5fa4905220521e
+  data.tar.gz: 7a108e44ed054b191a7d6dd5f78316a2cccc49b2298a6f18135d408aecf87e2c8370480ad640c3a1baa6bc2cbbad406f327c1a8b3c34705794838a6717902533

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YJExpand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# Appship
+
+Appship 是一款面向 iOS 开发者的命令行自动化工具，旨在简化应用从构建、打包到内测分发的完整流程。
+
+它支持自动构建和导出 IPA，并将应用上传至蒲公英（Pgyer）或 fir.im，同时提供 API Key、访问密码和项目配置管理。上传完成后，终端会输出应用版本、密码状态及下载链接，方便团队快速进行测试和分发。
+
+### 构建耗时对比
+
+```mermaid
+gantt
+    title IPA 构建耗时对比
+    dateFormat X
+    axisFormat %S 秒
+    section 构建方式
+    使用真机缓存包（39.91 秒） :cache, 0, 40
+    重新构建（4 分 1.42 秒）    :rebuild, 0, 241
+```
+
+使用真机缓存包约 ​**39.91 秒**​，重新构建约 ​**4 分 1.42 秒**​，缓存模式约快 ​**6 倍**​。
+
+## 安装
+
+```
+gem install appship
+
+export PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"
+```
+
+### 环境依赖
+
+如果需要图标角标，还需要 ImageMagick：
+
+```bash
+brew install imagemagick
+```
+
+检查环境：
+
+```bash
+appship doctor
+```
+
+## 快速开始
+
+在 Xcode 工程目录执行：
+
+```bash
+appship pgyer
+或
+appship fir
+```
+
+等待片刻...
+
+```
+=======================================================
+                   🎉 发布完成 🎉
+=======================================================
+分发平台: fir.im
+应用名称: Demo
+应用类型: iOS
+版本信息: 1.0.0(42)
+更新描述: xxx
+访问密码: xxx
+下载链接: https://fir.im/abc123
+=======================================================
+```
+
+## 其他用法
+
+更换安装密码
+
+```
+appship pgyer -password xxx
+或
+appship fir -password xxx
+```
+
+更换上传秘钥
+
+```
+appship pgyer -key xxx
+或
+appship fir -key xxx
+```
+
+## 待办
+
+```
+1、补充消息机器人
+2、自定义消息格式
+3、其他分发平台
+...
+```

data/exe/appship

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "appship"
+
+Appship::CLI.start(ARGV)

data/lib/appship/badger.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Appship
+  module Badger
+    module_function
+
+    def apply!(app, assets:, app_icon:, text:, runner: Runner.new)
+      raise ConfigurationError, ".app 不存在: #{app}" unless File.directory?(app)
+
+      magick = Runner.which("magick") || Runner.which("convert")
+      unless magick
+        raise ConfigurationError, "添加图标角标需要 ImageMagick（brew install imagemagick）"
+      end
+      runner.require_command!("xcrun", "需要安装 Xcode")
+
+      font = resolve_font
+      raise ConfigurationError, "未找到可用字体文件，无法生成图标角标" unless font
+
+      label = text.to_s.strip
+      raise ConfigurationError, "角标文字不能为空" if label.empty?
+
+      modified = regenerate_assets_car!(app, assets, app_icon || "AppIcon", label, magick, font, runner)
+      modified ||= badge_loose_icons!(app, label, magick, font, runner)
+      raise Error, "未能修改 AppIcon" unless modified
+
+      resign!(app, runner)
+      puts "✅ 已添加 #{label} 图标角标并重新签名"
+      true
+    end
+
+    def regenerate_assets_car!(app, assets, app_icon, text, magick, font, runner)
+      return false unless assets && File.directory?(assets) && File.file?(File.join(app, "Assets.car"))
+      runner.capture!(["xcrun", "--find", "actool"])
+
+      root = Dir.mktmpdir("appship-assets-")
+      begin
+        catalog_name = File.basename(File.expand_path(assets))
+        copied_catalog = File.join(root, catalog_name)
+        FileUtils.cp_r(File.expand_path(assets), copied_catalog)
+        icon_set = locate_icon_set(copied_catalog, app_icon)
+        return false unless icon_set
+
+        count = 0
+        Dir[File.join(icon_set, "*.png")].each do |png|
+          count += 1 if badge_png!(png, text, magick, font, root)
+        end
+        return false if count.zero?
+
+        compiled = File.join(root, "compiled")
+        FileUtils.mkdir_p(compiled)
+        partial = File.join(root, "partial.plist")
+        runner.run!(["xcrun", "actool", "--output-format", "human-readable-text", "--app-icon", app_icon,
+                     "--compile", compiled, "--platform", "iphoneos", "--minimum-deployment-target", "13.0",
+                     "--target-device", "iphone", "--target-device", "ipad", "--compress-pngs",
+                     "--output-partial-info-plist", partial, copied_catalog])
+        return false unless File.file?(File.join(compiled, "Assets.car"))
+
+        FileUtils.cp(File.join(compiled, "Assets.car"), File.join(app, "Assets.car"))
+        Dir[File.join(compiled, "AppIcon*.png")].each do |png|
+          FileUtils.cp(png, app)
+        end
+        puts "   ✅ Assets.car 已重新编译（#{count} 个图标尺寸）"
+        true
+      rescue CommandError
+        puts "   ⚠️ Assets.car 重编失败，将尝试处理 IPA 内的松散图标"
+        false
+      ensure
+        FileUtils.rm_rf(root)
+      end
+    end
+
+    def badge_loose_icons!(app, text, magick, font, runner)
+      work = Dir.mktmpdir("appship-icon-")
+      count = 0
+      Dir[File.join(app, "**", "AppIcon*.png")].each do |png|
+        count += 1 if badge_png!(png, text, magick, font, work)
+      end
+      puts "   ℹ️ 已处理 #{count} 个松散 AppIcon PNG" if count.positive?
+      count.positive?
+    ensure
+      FileUtils.rm_rf(work) if work
+    end
+
+    def locate_icon_set(catalog, app_icon)
+      candidate = File.join(catalog, "#{app_icon}.appiconset")
+      return candidate if File.directory?(candidate)
+
+      Dir[File.join(catalog, "**", "*.appiconset")].first
+    end
+
+    def badge_png!(png, text, magick, font, work)
+      FileUtils.mkdir_p(work)
+      normalized = File.join(work, "normalized-#{Process.pid}-#{File.basename(png)}")
+      label = File.join(work, "label-#{Process.pid}-#{File.basename(png)}")
+      rotated = File.join(work, "rotated-#{Process.pid}-#{File.basename(png)}")
+
+      # pngcrush 不是所有 Xcode 环境都提供；ImageMagick 可直接处理普通 PNG。
+      FileUtils.cp(png, normalized)
+      dimension_output, dimension_status = Open3.capture2(magick, "-format", "%w %h", normalized, "info:")
+      return false unless dimension_status.success?
+      dimensions = dimension_output.split.map(&:to_i)
+      image_width = dimensions[0]
+      return false unless image_width && image_width.positive?
+
+      band_width = [(image_width * 0.60).to_i, 1].max
+      band_height = [(image_width * 0.16).to_i, 1].max
+      point_size = [(image_width * 0.10).to_i, 8].max
+      debug_x = (image_width * 0.60).to_i
+      debug_y = -(band_height * 0.8).to_i
+
+      unless system(magick, "-background", "#4CAF50", "-size", "#{band_width}x#{band_height}", "-pointsize", point_size.to_s,
+                    "-fill", "white", "-font", font, "-gravity", "center", "caption:#{text}", label,
+                    out: File::NULL, err: File::NULL)
+        return false
+      end
+      unless system(magick, "-background", "none", label, "-rotate", "45", rotated,
+                    out: File::NULL, err: File::NULL)
+        return false
+      end
+      unless system(magick, normalized, rotated, "-geometry", "+#{debug_x}+#{debug_y}", "-composite", "-alpha", "remove", png,
+                    out: File::NULL, err: File::NULL)
+        return false
+      end
+      true
+    ensure
+      [normalized, label, rotated].compact.each { |file| FileUtils.rm_f(file) }
+    end
+
+    def resolve_font
+      candidates = [
+        "/System/Library/Fonts/Supplemental/Arial Bold.ttf",
+        "/System/Library/Fonts/HelveticaNeue.ttc",
+        "/System/Library/Fonts/Helvetica.ttc",
+        "/System/Library/Fonts/SFNS.ttf",
+        "/Library/Fonts/Arial.ttf"
+      ]
+      candidates.find { |file| File.file?(file) }
+    end
+
+    def resign!(app, runner)
+      codesign_stdout, codesign_stderr, codesign_status = Open3.capture3("codesign", "-dvv", app)
+      unless codesign_status.success?
+        raise CommandError, "无法读取 App 签名信息: #{codesign_stderr}"
+      end
+      authority = (codesign_stdout + codesign_stderr).lines.find { |line| line.start_with?("Authority=") }&.split("=", 2)&.last&.strip
+      identities = runner.capture!(["security", "find-identity", "-v", "-p", "codesigning"]).lines.filter_map do |line|
+        match = line.match(/([0-9A-F]{40})\s+"([^"]+)"/)
+        match && { sha: match[1], name: match[2] }
+      end
+      identity = identities.find { |item| authority && item[:name].include?(authority) } || identities.first
+      raise ConfigurationError, "找不到可用的代码签名身份，无法重新签名" unless identity
+
+      puts "   🔏 重新签名: #{identity[:name]}"
+      entitlements = File.join(Dir.mktmpdir("appship-entitlements-"), "entitlements.plist")
+      begin
+        stdout, _stderr, status = Open3.capture3("codesign", "-d", "--entitlements", ":-", app)
+        File.write(entitlements, stdout) if status.success? && !stdout.strip.empty?
+
+        nested = Dir[File.join(app, "Frameworks", "*")] + Dir[File.join(app, "PlugIns", "*")]
+        nested.select! { |path| File.file?(path) || File.directory?(path) }
+        nested.sort_by { |path| -path.count(File::SEPARATOR) }.each do |path|
+          runner.run!(["codesign", "--force", "--sign", identity[:sha], "--timestamp=none", path])
+        end
+
+        args = ["codesign", "--force", "--sign", identity[:sha], "--timestamp=none"]
+        args += ["--entitlements", entitlements] if File.file?(entitlements) && !File.zero?(entitlements)
+        args << app
+        runner.run!(args)
+        runner.run!(["codesign", "--verify", "--deep", "--strict", app])
+      ensure
+        FileUtils.rm_rf(File.dirname(entitlements))
+      end
+    end
+  end
+end

data/lib/appship/builder.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+module Appship
+  class Builder
+    attr_reader :runner
+
+    def initialize(runner: Runner.new)
+      @runner = runner
+    end
+
+    def build!(options)
+      target = target_options(options)
+      scheme = required!(options[:scheme], "--scheme 或配置 scheme")
+      configuration = options[:configuration] || "Debug"
+      sdk = options[:sdk] || "iphoneos"
+      output = File.expand_path(options[:output] || File.join("build", "#{scheme}-#{configuration}.ipa"))
+      temp_root = nil
+      managed_paths = []
+
+      if options[:archive_path]
+        archive_path = File.expand_path(options[:archive_path])
+      else
+        temp_root = Dir.mktmpdir("appship-")
+        archive_path = File.join(temp_root, "#{scheme}.xcarchive")
+        managed_paths << archive_path
+      end
+
+      if options[:export_path]
+        export_path = File.expand_path(options[:export_path])
+      else
+        temp_root ||= Dir.mktmpdir("appship-")
+        export_path = File.join(temp_root, "export")
+        managed_paths << export_path
+      end
+
+      begin
+        runner.require_command!("xcodebuild", "需要安装 Xcode 命令行工具")
+        FileUtils.rm_rf(archive_path) if File.exist?(archive_path) && options.fetch(:clean, true)
+        FileUtils.rm_rf(export_path) if File.exist?(export_path) && options.fetch(:clean, true)
+        FileUtils.mkdir_p(File.dirname(archive_path))
+        FileUtils.mkdir_p(export_path)
+
+        archive!(target, scheme, configuration, sdk, archive_path, options)
+        export!(archive_path, export_path, options)
+
+        ipa = Dir[File.join(export_path, "*.ipa")].first
+        raise CommandError, "导出完成但未找到 IPA: #{export_path}" unless ipa
+
+        final_ipa = File.expand_path(ipa)
+        if options[:badge]
+          Ipa.apply_badge!(final_ipa, assets: options[:assets], app_icon: options[:app_icon], text: options[:badge], runner: runner)
+        end
+
+        FileUtils.mkdir_p(File.dirname(output))
+        unless File.expand_path(output) == final_ipa
+          FileUtils.rm_f(output) if File.exist?(output)
+          FileUtils.mv(final_ipa, output)
+        end
+        puts "✅ IPA 已生成: #{output}"
+
+        upload_if_requested!(output, options)
+        output
+      ensure
+        FileUtils.rm_rf(temp_root) if temp_root && !options[:keep_temporary]
+      end
+    end
+
+    def find_cached_app!(options)
+      target = target_options(options)
+      scheme = required!(options[:scheme], "--scheme 或缓存中的 project_name")
+      sdk = options[:sdk] || "iphoneos"
+      app_name = required!(options[:app_name], "缓存中的 app_name 或 --app-name")
+
+      runner.require_command!("xcodebuild", "需要安装 Xcode 命令行工具")
+      target_flag = target.keys.first == :workspace ? "-workspace" : "-project"
+      configurations = [options[:configuration], "Debug", "Release"].compact.uniq
+      configurations.each do |configuration|
+        begin
+          settings = runner.capture!(["xcodebuild", target_flag, target.values.first, "-scheme", scheme,
+                                      "-configuration", configuration, "-sdk", sdk, "-showBuildSettings"])
+        rescue CommandError
+          next
+        end
+        products_dir = settings.lines.filter_map do |line|
+          next unless line.include?("BUILT_PRODUCTS_DIR") && line.include?("=")
+
+          line.split("=", 2).last.strip
+        end.first
+        next if products_dir.to_s.empty?
+
+        app_path = File.join(products_dir, "#{app_name}.app")
+        next unless File.directory?(app_path)
+
+        options[:configuration] = configuration
+        return app_path
+      end
+
+      raise CommandError, "未找到缓存 App（已检查配置: #{configurations.join(", ")}）"
+    end
+
+    def package!(options)
+      app = File.expand_path(required!(options[:app], "--app"))
+      raise ConfigurationError, ".app 不存在: #{app}" unless File.directory?(app)
+
+      output = File.expand_path(options[:output] || File.join(Dir.pwd, "#{File.basename(app, ".app")}.ipa"))
+      runner.require_command!("zip", "macOS 通常自带 zip")
+      runner.require_command!("unzip", "macOS 通常自带 unzip") if options[:badge]
+      Ipa.package!(app, output: output, badge: options[:badge], assets: options[:assets], app_icon: options[:app_icon], runner: runner)
+      puts "✅ IPA 已生成: #{output}"
+      upload_if_requested!(output, options)
+      output
+    end
+
+    def upload!(options)
+      file = File.expand_path(required!(options[:file], "IPA 文件路径"))
+      raise ConfigurationError, "文件不存在: #{file}" unless File.file?(file)
+
+      result = Uploader.new(options).upload!(file)
+      Display.upload_result(result, file: file, options: options)
+      result
+    end
+
+    private
+
+    def target_options(options)
+      workspace = options[:workspace]
+      project = options[:project]
+      if workspace && project
+        raise ConfigurationError, "--workspace 和 --project 不能同时指定"
+      end
+      if workspace.nil? && project.nil?
+        raise ConfigurationError, "请指定 --workspace 或 --project"
+      end
+
+      key = workspace ? :workspace : :project
+      path = File.expand_path(options[key])
+      raise ConfigurationError, "工程文件不存在: #{path}" unless File.exist?(path)
+      { key => path }
+    end
+
+    def archive!(target, scheme, configuration, sdk, archive_path, options)
+      argv = ["xcodebuild", "archive", target.keys.first == :workspace ? "-workspace" : "-project", target.values.first,
+              "-scheme", scheme, "-configuration", configuration, "-sdk", sdk,
+              "-destination", "generic/platform=iOS", "-archivePath", archive_path]
+      argv += ["-allowProvisioningUpdates"] if options.fetch(:allow_provisioning_updates, true)
+      argv += ["-skipPackagePluginValidation"] if options.fetch(:skip_package_plugin_validation, true)
+      argv += ["-skipMacroValidation"] if options.fetch(:skip_macro_validation, true)
+      argv << "BUILD_ACTIVE_RESOURCES_ONLY=NO"
+      puts "🔨 开始归档 #{scheme} (#{configuration})..."
+      runner.run!(argv)
+    end
+
+    def export!(archive_path, export_path, options)
+      plist_path = options[:export_options_plist]
+      temporary_plist = nil
+      unless plist_path
+        temporary_plist = Tempfile.new(["appship-export-options", ".plist"])
+        temporary_plist.write(export_options_plist(options))
+        temporary_plist.close
+        plist_path = temporary_plist.path
+      end
+
+      argv = ["xcodebuild", "-exportArchive", "-archivePath", archive_path, "-exportPath", export_path,
+              "-exportOptionsPlist", File.expand_path(plist_path)]
+      argv << "-allowProvisioningUpdates" if options.fetch(:allow_provisioning_updates, true)
+      puts "📦 导出 IPA..."
+      runner.run!(argv)
+    ensure
+      temporary_plist&.unlink
+    end
+
+    def export_options_plist(options)
+      method = options[:export_method] || "development"
+      team_id = options[:team_id]
+      team_xml = team_id ? "\n\t<key>teamID</key>\n\t<string>#{xml_escape(team_id)}</string>" : ""
+      <<~PLIST
+        <?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>
+        \t<key>method</key>
+        \t<string>#{xml_escape(method)}</string>
+        \t<key>signingStyle</key>
+        \t<string>#{options[:signing_style] || "automatic"}</string>
+        \t<key>compileBitcode</key>
+        \t<false/>
+        \t<key>thinning</key>
+        \t<string>&lt;none&gt;</string>#{team_xml}
+        </dict>
+        </plist>
+      PLIST
+    end
+
+    def upload_if_requested!(file, options)
+      return unless options[:upload]
+
+      result = Uploader.new(options).upload!(file)
+      Display.upload_result(result, file: file, options: options)
+    end
+
+    def required!(value, name)
+      return value unless value.nil? || value.to_s.empty?
+
+      raise ConfigurationError, "缺少参数: #{name}"
+    end
+
+    def xml_escape(value)
+      value.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;").gsub('"', "&quot;").gsub("'", "&apos;")
+    end
+  end
+
+  module Display
+    module_function
+
+    def upload_result(result, file:, options: {})
+      if result.is_a?(Hash) && result["provider"] == "fir"
+        fir_upload_result(result, file: file, options: options)
+        return
+      end
+
+      data = result.is_a?(Hash) ? (result["data"] || result) : {}
+      key = deep_find(data, "buildKey")
+      name = deep_find(data, "buildName") || options[:app_name] || File.basename(file, File.extname(file))
+      build_type = deep_find(data, "buildType") || File.extname(file).delete_prefix(".").downcase
+      build_type_name = %w[2 apk android].include?(build_type.to_s.downcase) ? "Android" : "iOS"
+      version = deep_find(data, "buildVersion")
+      build_version = deep_find(data, "buildBuildVersion")
+      version_info = if version && !version.to_s.empty?
+                       build_version && !build_version.to_s.empty? ? "#{version}(#{build_version})" : version.to_s
+                     end
+      build_file_size = deep_find(data, "buildFileSize")
+      build_size_mb = if build_file_size && !build_file_size.to_s.empty?
+                        format("%.1fMB", build_file_size.to_f / 1_048_576)
+                      end
+      build_updated = deep_find(data, "buildUpdated")
+      configuration = options[:configuration] || "未知"
+      description = options[:interactive_content] || options[:description] || ""
+      password = options[:password]
+      password ||= ENV[options[:password_env]] if options[:password_env]
+      password ||= "未设置"
+      url = key ? "https://www.pgyer.com/#{key}" : "https://www.pgyer.com/"
+
+      puts ""
+      puts "======================================================="
+      puts "                   🎉 发布完成 🎉                      "
+      puts "======================================================="
+      puts "应用名称: #{name}"
+      puts "应用类型: #{build_type_name}"
+      puts "版本信息: #{version_info}" if version_info
+      puts "构建模式: #{configuration}"
+      puts "应用大小: #{build_size_mb}" if build_size_mb
+      puts "更新时间: #{build_updated}" if build_updated && !build_updated.to_s.empty?
+      puts "更新描述: #{description}"
+      puts "安装密码: #{password}"
+      puts "下载链接: #{url}"
+      puts "======================================================="
+    end
+
+    def fir_upload_result(result, file:, options: {})
+      data = result["data"].is_a?(Hash) ? result["data"] : result
+      name = data["name"] || options[:app_name] || File.basename(file, File.extname(file))
+      type = data["type"].to_s == "android" ? "Android" : "iOS"
+      version = data["version"]
+      build = data["build"]
+      version_info = if version && !version.to_s.empty?
+                       build && !build.to_s.empty? ? "#{version}(#{build})" : version.to_s
+                     end
+
+      puts ""
+      puts "======================================================="
+      puts "                   🎉 发布完成 🎉                      "
+      puts "======================================================="
+      puts "分发平台: fir.im"
+      puts "应用名称: #{name}"
+      puts "应用类型: #{type}"
+      puts "版本信息: #{version_info}" if version_info
+      puts "更新描述: #{options[:description] || ""}"
+      puts "访问密码: #{data["password_protected"] ? "已设置" : "未设置"}"
+      puts "下载链接: #{result["url"]}"
+      puts "======================================================="
+    end
+
+    def deep_find(value, wanted_key)
+      return nil unless value.is_a?(Hash) || value.is_a?(Array)
+      return value[wanted_key] if value.is_a?(Hash) && value.key?(wanted_key)
+
+      enum = value.is_a?(Hash) ? value.values : value
+      enum.each do |child|
+        found = deep_find(child, wanted_key)
+        return found unless found.nil?
+      end
+      nil
+    end
+  end
+end