将目录添加到$ 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一个要$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时，我在许多不同的ruby项目中都看到了它。

似乎是惯例？

Answer 4

如果在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”执行代码块内的动作，在其中重复“ 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 5

最好我遇到了使用Rspec时通过相对路径添加目录的问题。 我觉得它很详细，但仍然是一个不错的选择。

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

Answer 6

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

它也有很好的文档

Answer 7

我知道第一次提出这个问题已经有很长时间了，但是我还有一个要分享的答案。

我有另一位程序员几年来开发的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文件中，我只是使用

require 'profile'
require 'etc' #etc

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

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