QAMenuUtils 0.6.0

QAMenuUtils 0.6.0

Hans Seiffert 维护。



  • 作者
  • Hans Seiffert

QAMenu

CocoaPods compatible License Platform Language: Swift 5 iOS: 10.0+ codecov

您是否曾想快速

  • 在测试您的应用程序时访问内部调试信息?
  • 在您的应用程序中提供内部快捷方式,例如重置通常不可访问的状态?
  • 暴露并覆盖可用的功能开关?
  • 测试您的崩溃报告器是否仍然有效?
  • ...

如果是这样,那么您可以停止担心所需的编码工作量、UI代码、视图模型等等。

QAMenu 正是为了帮助您而来。它是一个基于简化的数据模型驱动的布局渲染器,专门用于 QAMenus、调试菜单和仅在内部使用的设置屏幕。与系统设置应用程序包不同,它直接存在于您的应用程序中,并且是交互式的。您可以直接检索信息和执行操作。

您可以将它视为您调试菜单的设计系统。

QAMenu附带了一个小型目录,其中包含一些通用的模型,例如显示应用程序版本、暴露Info.plist内容或执行崩溃。虽然其主要重点是提供一个框架,以便您在日常生活中添加定制的调试信息/操作,但只需付出最小的努力,而无需接触UI代码(如果不是绝对必要的话)。

介绍就到这里。这个展示为您提供了一个预览。您看到的是一个QAMenu实例。所有示例中的内容都是基于(几乎是UI)的数据模型结构。

Screenshot of showcase example Animated gif of showcase example

您可以通过在Examples/Example-iOS中运行示例应用程序并选择展示菜单来亲自尝试。

视野

QAMenu 基于以下愿景

您应用程序中的调试功能应该是您团队工作流程的有机组成部分。它们应该永久易于整个团队访问,开发者应该始终能够迅速添加更多,无需担心没有足够的时间这样做。

以下原则源于此愿景。

有关每个原则的详细描述,请参阅原则

用法

QAMenu以独立窗口的形式呈现。可以通过调用方法show()或摇动设备来打开。

可以在应用程序启动时进行配置。要创建QA菜单,您需要传递菜单结构。除代理之外,大多数数据模型类型都封装为Dynamic<T>,它可以存储纯值、闭包或键路径。QAMenu及其UI渲染器仅在实际需要时解包内容。这可以实现实时行为。

通常,QAMenu可以在应用代理中存储和初始化。

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

  // You need to keep a reference to QAMenu, otherwise it will be released from memory
  var qaMenu: QAMenu?

  ...
  
  private func setupQAMenu() {
   let groups: [Group] = [
      QAMenu.Catalog.AppInfo.group(),
      self.cacheGroup,
      QAMenu.Catalog.Preferences.group()
    ]
    self.qaMenu = QAMenu(
      pane: RootPane(title: .static("Simple Project"), groups: groups),
      presenterType: QAMenuUIKitPresenter.self
    )
    self.qaMenu?.setTrigger([.shake], mode: .initialValue)
  }
  
  private var cacheGroup: [Group] {
    let group = ItemGroup(title: .static("App Cache"), items: .static([
      BoolItem(
        title: .static("Enable cache"),
        value: .computed({ [weak self] in
            return self?.simpleProjectCacheEnabled ?? false
        }),
        onValueChange: { [weak self] value, _, result in
            guard let self = self else {
              result(.failure("Object was released from memory"))
              return
            }
            self.simpleProjectCacheEnabled = value
            result(.success)
        }
      ),
      StringItem(
        title: .static("Cached images"),
        value: .computed({ [weak self] in
          return String(describing: self?.cache.imagesCount ?? 0)
        })
      ),
      ButtonItem(
        title: .static("Reset image cache"),
        action: { [weak self] (item: ButtonItem, _) in
          item.status = .progress("Deleting cache")
          DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
            self?.simpleProjectCachedImagesCount = 0
            item.status = .idle
            item.parentGroup?.invalidate()
          }
        }
      )
    ]))
    return group
  }
}

此截图显示了生成的QAMenu。您还可以在位于Examples/Example-iOS的示例应用中找到并使用代码。

路线图

支持的数据类型 - 布局

  • 面板(也称为屏幕/控制器)
  • 嵌套面板(也称为子面板)
  • 选择器组

支持的数据类型 - 项目

  • 字符串(可编辑)
  • 按钮
  • 布尔值(可编辑)
  • 页脚
  • 选择字符串
  • 进度项目
  • 步进项目
  • 滑块项目

功能

  • 长按项目以共享
  • 面板中的搜索
  • 项目、组和面板的失效(重新加载)
  • 在组中动态添加/删除项目
  • 编辑字符串(单行)
  • 编辑字符串(多行)
  • 异步加载操作(项目)
  • 异步加载操作(组)
  • 用于在项目和组上触发对话框的接口

有关更多信息,请参阅数据结构

渲染器

  • UIKit(针对iPhone优化)
  • UIKit(针对iPad优化)
  • SwiftUI(针对iPhone优化)
  • SwiftUI(针对iPad优化)

测试

  • 单元测试
  • UI测试
  • UI快照测试

CI

  • 在PR中运行单元测试
  • 在PR中编译示例应用
  • 在PR中运行lint
  • 在PR中运行UI测试

文档

  • README
  • 源代码中的文档
  • 更详细集成和公共API描述的Wiki

QAMenu 目录

QAMenu 提供了一个名为 QAMenuCatalog 的独立框架,其中包含一些非常基本的调试项目。它充当使用示例和这些基本项目的可重用配置。

一些示例截图

查看 目录 和示例应用以获取更多详情。

安装

CocoaPods

CocoaPods 是 Cocoa项目的依赖项管理器。你可以使用以下命令安装它

$ gem install cocoapods

要使用 CocoaPods 将 QAMenu 集成到你的 Xcode 项目中,在 Podfile 中指定它

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'QAMenuUIKit'
end

然后,运行以下命令

$ pod install

手动集成

要直接从源代码集成 QAMenu,遵循常规集成步骤。你可以使用 Examples/Example-iOS 作为现实生活中的示例。