如何开发可自动复制文件及文件夹的Ruby Gem？

核心思路 #

不要手动写复制粘贴逻辑，利用Gem的打包机制+Bundler钩子来实现自动同步，同时避免路径错误问题。

步骤1：在Gem中组织待同步的文件结构 #

在Gem根目录创建templates/目录，把需要同步到项目的文件夹、文件都放在这里，比如：

your_gem/
├── templates/
│   ├── config/
│   │   └── your_gem.yml
│   └── assets/
│       └── your_gem.css
├── lib/
└── your_gem.gemspec

步骤2：编写安装钩子实现自动复制 #

1. 在lib/your_gem/installer.rb中写复制逻辑：

module YourGemName
  class Installer
    def self.run
      # 用绝对路径获取Gem内的templates目录，避免相对路径错误
      template_root = File.expand_path("../../templates", __FILE__)
      # 目标路径为当前项目根目录
      project_root = Dir.pwd

      # 复制所有模板文件到项目，跳过已存在的文件（可根据需求修改）
      Dir.glob("#{template_root}/**/*").each do |source_path|
        next unless File.file?(source_path)
        relative_path = source_path.sub("#{template_root}/", "")
        target_path = File.join(project_root, relative_path)

        unless File.exist?(target_path)
          FileUtils.mkdir_p(File.dirname(target_path))
          FileUtils.cp(source_path, target_path, preserve: true)
        end
      end
    end
  end
end

2. 在lib/your_gem.rb中触发钩子：

require "your_gem/installer"

# 仅在Bundler执行install命令时运行
if defined?(Bundler) && Bundler.current_running_command == "install"
  YourGemName::Installer.run
end

步骤3：确保模板文件被打包进Gem #

在your_gem.gemspec中添加以下代码，把templates目录包含到Gem包中：

spec.files += Dir["templates/**/*"]

这是解决「路径不存在」错误的关键——如果模板目录没被打包，安装后Gem里根本找不到这些文件。

常见问题排查 #

• 之前的路径错误：大多是因为用了相对路径，或者模板目录没被加入Gem打包列表，用File.expand_path结合__FILE__获取绝对路径是可靠方案。
• 文件覆盖问题：如果需要覆盖已存在的文件，去掉代码中的unless File.exist?(target_path)判断即可，但建议保留避免误改用户文件。

内容的提问来源于stack exchange，提问作者Mohamed Turki