如何在Rails项目指定Rake任务中引入未在Gemfile声明的Gem？

我希望在Rake任务中使用rmagick这款Gem，但不想将其加入开发环境的Gemfile中——这款Gem安装速度慢，且在M2芯片的Mac上兼容性不佳，因此仅想在需要它的Rake任务中按需引入。

我的示例代码如下：

namespace :utility do
  task contrived_test_funct: :environment do
    begin
      gem 'rmagick'
    rescue LoadError
      system("gem install rmagick")
      gem 'rmagick'
    end

    require 'RMagick'
    file_names = Dir.glob(File.join("/tmp", "**", "*"))
    file_names = file_names.select { |f| f.include?(".pdf") }
    file_names.each do |file_name|
      im = Magick::Image.read(file_name)
      im[0].write(filename.gsub(".pdf",".jpg"))
    end
  end
end

代码本应将/tmp目录下所有PDF文件转为JPG格式。当把该Gem加入Gemfile并移除begin/rescue块时，本地运行正常；但移除Gemfile中的配置并启用begin/rescue块后，出现报错：

Gem::LoadError: rmagick is not part of the bundle. Add it to your Gemfile.

解决方法 #

Rails默认会启用Bundler的依赖隔离机制，直接调用gem 'rmagick'会被Bundler拦截，要求Gem必须声明在Gemfile内。要绕过这个限制，可以用以下两种实用方式：

方式一：用Bundler.with_unbundled_env隔离任务环境

将需要使用外部Gem的代码块包裹在Bundler.with_unbundled_env中，就能脱离Bundler的约束，直接调用系统全局安装的Gem：

namespace :utility do
  task contrived_test_funct: :environment do
    Bundler.with_unbundled_env do
      begin
        require 'RMagick'
      rescue LoadError
        # 加上--no-document可以加快安装速度
        system("gem install rmagick --no-document")
        require 'RMagick'
      end

      file_names = Dir.glob(File.join("/tmp", "**", "*"))
      file_names = file_names.select { |f| f.include?(".pdf") }
      file_names.each do |file_name|
        im = Magick::Image.read(file_name)
        # 修复原代码笔误：filename改为file_name
        im[0].write(file_name.gsub(".pdf", ".jpg"))
      end
    end
  end
end

方式二：重置Gem路径绕过Bundler检查

通过Gem.clear_paths重置Ruby的Gem查找路径，让它优先读取系统全局安装的Gem，而非Bundler管理的本地依赖：

namespace :utility do
  task contrived_test_funct: :environment do
    begin
      Gem.clear_paths
      gem 'rmagick'
      require 'RMagick'
    rescue LoadError
      system("gem install rmagick --no-document")
      Gem.clear_paths
      gem 'rmagick'
      require 'RMagick'
    end

    file_names = Dir.glob(File.join("/tmp", "**", "*"))
    file_names = file_names.select { |f| f.include?(".pdf") }
    file_names.each do |file_name|
      im = Magick::Image.read(file_name)
      im[0].write(file_name.gsub(".pdf", ".jpg"))
    end
  end
end

额外提示

• 原代码存在笔误：filename.gsub应为file_name.gsub，否则会触发变量未定义错误；
• 若团队内有其他开发者，建议在任务注释中说明该任务依赖rmagick，或让安装命令自动处理依赖。

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