将目录添加到 $LOAD_PATH (Ruby)

Question

我见过两种常用的技术，用于将当前正在执行的文件的目录添加到 $LOAD_PATH（或 $:）。 我看到了这样做的好处，以防您不使用 gem。 显然，其中一个似乎比另一个更冗长，但是有理由选择其中一个而不是另一个吗？

第一种，冗长的方法（可能有点过分）：

$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))

以及更直接，快速和肮脏的方法：

$:.unshift File.dirname(__FILE__)

有什么理由选择其中一个而不是另一个？

Answer 1

Ruby 加载路径通常写为 $: ，但仅仅因为它很短，并不能使它变得更好。 如果你更喜欢清晰而不是聪明，或者如果简洁本身就让你心痒痒，那么你不必因为其他人都这样做而这样做。
向......打招呼

$LOAD_PATH

，向......说再见

# I don't quite understand what this is doing...
$:

Answer 2

我会说使用 $:.unshift File.dirname(__FILE__) 而不是另一个，因为我在代码中看到它比 $LOAD_PATH 一，而且还更短！

Answer 3

我不太喜欢“快速而肮脏”的方式。
任何刚接触 Ruby 的人都会思考 $:. 是什么。

我觉得这一点更明显。

libdir = File.dirname(__FILE__)
$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)

或者如果我关心完整路径...

libdir = File.expand_path(File.dirname(__FILE__))
$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)

更新 2009/09/10

截至最近我一直在做以下事情：

$:.unshift(File.expand_path(File.dirname(__FILE__))) unless
    $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))

我在一大堆不同的红宝石项目中看到了它浏览 GitHub。

好像是约定俗成的？

Answer 4

我在使用 Rspec 时遇到的最好的情况是通过相对路径添加目录。 我发现它足够冗长，但仍然是一个很好的衬里。

$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

Answer 5

如果您在 Rails 项目中输入 script/console 并输入 $:，您将获得一个数组，其中包含加载 Ruby 所需的所有目录。 这个小练习的要点是 $: 是一个数组。 既然如此，您可以对其执行函数，例如使用 unshift 方法或 << 运算符在其他目录前面添加。 正如您在声明中所暗示的 $: 和 $LOAD_PATH 是相同的。

正如您提到的那样，以快速而肮脏的方式执行此操作的缺点是：如果您的引导路径中已有该目录，则它会重复自身。

示例：

我创建了一个名为 todo 的插件。 我的目录结构如下：

/---vendor
  |
  |---/plugins
        |
        |---/todo
              |
              |---/lib
                    |
                    |---/app
                          |
                          |---/models
                          |---/controllers
              |
              |---/rails
                    |
                    |---init.rb

在 init.rb 文件中，我输入了以下代码：

## In vendor/plugins/todo/rails/init.rb
    %w{ models controllers models }.each do |dir|
      path = File.expand_path(File.join(File.dirname(__FILE__), '../lib', 'app', dir))
      $LOAD_PATH << path
      ActiveSupport::Dependencies.load_paths << path
      ActiveSupport::Dependencies.load_once_paths.delete(path)
    end 

请注意我如何告诉代码块对字符串“models”、“controllers”和“models”执行块内的操作，其中我重复“模型”。 （仅供参考，%w{ ... } 只是告诉 Ruby 保存字符串数组的另一种方式）。 当我运行 script/console 时，我键入以下内容：

>> puts $:

我键入此内容是为了更轻松地读取字符串中的内容。 我得到的输出是：

...
...
./Users/Me/mySites/myRailsApp/vendor/plugins/todo/lib/app/models
./Users/Me/mySites/myRailsApp/vendor/plugins/todo/lib/app/controllers
./Users/Me/mySites/myRailsApp/vendor/plugins/todo/lib/app/models

正如您所看到的，虽然这是我在使用我当前正在处理的项目时可以创建的简单示例，但如果您不小心，这种快速而肮脏的方式将导致重复的路径。 较长的方法将检查重复的路径并确保它们不会发生。

如果您是一位经验丰富的 Rails 程序员，您可能非常清楚自己在做什么，并且可能不会犯重复路径的错误。 如果你是新手，我会走更长的路，直到你真正理解你在做什么。

Answer 6

有一个 gem 可以让您使用更好、更干净的代码设置加载路径。 看看这个：https://github.com/nayyara-samuel/load-path 。

它还有很好的文档

Answer 7

我的 2 美分：我喜欢 $LOAD_PATH 而不是 $:。 我已经老了……我已经学习了 92,000 种语言。 我发现很难掌握所有的习俗和习语。

我开始厌恶命名空间污染。

最后，当我处理路径时，我总是删除然后附加或前置 - 这取决于我希望搜索如何进行。 因此，我这样做：

1.times do
  models_dir = "#{File.expand_path(File.dirname(__FILE__))}/models"
  $LOAD_PATH.delete(models_dir)
  $LOAD_PATH.unshift(models_dir)
end

Answer 8

您可以执行以下操作：

$LOAD_PATH.unshift __dir__

甚至：

$LOAD_PATH.unshift *Dir.glob(File.join(__dir__, "*", "lib"))

Answer 9

我知道自从第一次问这个问题以来已经过去很长时间了，但我还有一个想要分享的答案。

我有几个 Ruby 应用程序，这些应用程序是由另一位程序员花了几年时间开发的，尽管它们可能访问相同的数据库，但它们在不同的应用程序中重复使用相同的类。 由于这违反了 DRY 规则，因此我决定创建一个由所有 Ruby 应用程序共享的类库。 我本可以将它放在主 Ruby 库中，但这会将自定义代码隐藏在公共代码库中，这是我不想做的。

我遇到了一个问题，即已定义的名称“profile.rb”与我正在使用的类之间存在名称冲突。 在我尝试创建公共代码库之前，这种冲突并不是问题。 通常，Ruby 首先搜索应用程序位置，然后转到 $LOAD_PATH 位置。

application_controller.rb 找不到我创建的类，并在原始定义上抛出错误，因为它不是一个类。 由于我从应用程序的 app/models 部分删除了类定义，Ruby 无法在那里找到它，因此在 Ruby 路径中查找它。

因此，我修改了 $LOAD_PATH 变量以包含我正在使用的库目录的路径。 这可以在初始化时在environment.rb 文件中完成。

即使将新目录添加到搜索路径中，Ruby 也会抛出错误，因为它优先考虑系统定义的文件。 $LOAD_PATH 变量中的搜索路径优先搜索 Ruby 路径。

因此，我需要更改搜索顺序，以便 Ruby 在搜索内置库之前先找到我的公共库中的类。

这段代码在environment.rb文件中完成了它：

Rails::Initializer.run do |config|

* * * * *

path = []
path.concat($LOAD_PATH)
$LOAD_PATH.clear
$LOAD_PATH << 'C:\web\common\lib'
$LOAD_PATH << 'C:\web\common'
$LOAD_PATH.concat(path)

* * * * *

end

我认为您不能在这个级别使用之前给出的任何高级编码结构，但如果您想在应用程序的初始化时设置某些内容，它就可以很好地工作。 当原始 $LOAD_PATH 变量添加回新变量时，您必须保持其原始顺序，否则一些主要 Ruby 类会丢失。

在 application_controller.rb 文件中，我只需使用 a

require 'profile'
require 'etc' #etc

即可加载整个应用程序的自定义库文件，即我不必在每个控制器中使用 require 命令。

对我来说，这就是我正在寻找的解决方案，我想我会将其添加到这个答案中以传递信息。