Maid 开源项目教程

Maid 开源项目教程

maid Be lazy. Let Maid clean up after you, based on rules you define. Think of it as "Hazel for hackers". 项目地址: https://gitcode.com/gh_mirrors/mai/maid

1. 项目介绍

Maid 是一个基于规则的文件清理工具，旨在帮助用户自动化管理文件和目录。它类似于 Mac OS X 上的 Hazel 工具，但专为开发者设计。Maid 允许用户通过定义 Ruby 脚本来创建清理规则，从而自动处理下载文件、临时文件等。Maid 不仅适用于日常文件管理，还可以作为高级文件重命名工具使用。

2. 项目快速启动

2.1 安装

Maid 是一个 Ruby gem，因此可以通过以下命令进行安装：

gem install maid

2.2 生成示例规则文件

安装完成后，可以通过以下命令生成一个示例规则文件：

maid sample

2.3 编写规则

在生成的示例规则文件中，可以编写自己的清理规则。例如，以下是一个简单的规则示例：

Maid.rules do
  rule 'Old files downloaded while developing/testing' do
    dir('~/Downloads/*').each do |path|
      if downloaded_from(path).any? { |u| u.match('http://localhost') } && 1.week.since(accessed_at(path))
        trash(path)
      end
    end
  end
end

2.4 测试和运行规则

在运行规则之前，可以先进行测试，查看规则的效果：

maid clean --dry-run

如果测试无误，可以实际运行规则：

maid clean -f

3. 应用案例和最佳实践

3.1 自动清理下载文件

假设你经常从本地服务器下载文件进行测试，这些文件在下载后一周内未被访问，可以自动删除。可以使用以下规则：

Maid.rules do
  rule 'Clean up old local downloads' do
    dir('~/Downloads/*').each do |path|
      if downloaded_from(path).any? { |u| u.match('http://localhost') } && 1.week.since(accessed_at(path))
        trash(path)
      end
    end
  end
end

3.2 自动分类图片

假设你希望将下载的图片按照尺寸自动分类到不同的文件夹中，可以使用以下规则：

Maid.rules do
  rule 'Organize images by dimensions' do
    dir('~/Downloads/*.{jpg,png,gif}').each do |image|
      width, height = dimensions_px(image)
      move(image, mkdir("~/Pictures/#{width}x#{height}"))
    end
  end
end

4. 典型生态项目

4.1 RVM 和 Maid 结合使用

如果你使用 RVM 管理 Ruby 版本，可以为 Maid 创建一个独立的 gemset，以便更好地管理依赖：

rvm install ruby-3.2 && rvm use 3.2 && rvm gemset create maid && rvm alias create maid ruby-3.2@maid
rvm use maid && gem install maid

4.2 使用 Cron 自动运行 Maid

你可以使用 Cron 定时任务来自动运行 Maid，例如每天凌晨1点运行一次：

0 1 * * * /bin/bash -li -c "maid clean --force --silent"

4.3 使用 Daemon 模式

Maid 支持 Daemon 模式，可以实时监控指定目录的变化并自动执行规则。例如，监控 ~/Downloads 目录的变化：

Maid.rules do
  watch '~/Downloads' do
    rule 'Clean up new downloads' do
      dir('~/Downloads/*').each do |path|
        if downloaded_from(path).any? { |u| u.match('http://localhost') } && 1.week.since(accessed_at(path))
          trash(path)
        end
      end
    end
  end
end

启动 Daemon 模式：

maid daemon

maid Be lazy. Let Maid clean up after you, based on rules you define. Think of it as "Hazel for hackers". 项目地址: https://gitcode.com/gh_mirrors/mai/maid