Rails/lib 模块和

我正在为 open_flash_chart插件编写一个自定义包装器。它被放置在 /lib中,并作为一个模块加载到 ApplicationController中。

但是,我有一些类层次结构或 smth 问题。

从任何控制器,我可以访问 open_flash_chart的功能作为 OpenFlashChartLine

但是,在 /lib模块中的类中,它不起作用!

有什么想法吗?

103706 次浏览

There are two ways that files get loaded in Rails:

  • It is registered in the autoload process, and you reference a constant that corresponds to the file name. For instance, if you have app/controllers/pages_controller.rb and reference PagesController, app/controllers/pages_controller.rb will automatically be loaded. This happens for a preset list of directories in the load path. This is a feature of Rails, and is not part of the normal Ruby load process.
  • Files are explicitly required. If a file is required, Ruby looks through the entire list of paths in your load paths, and find the first case where the file you required is in the load path. You can see the entire load path by inspecting $LOAD_PATH (an alias for $:).

Since lib is in your load path, you have two options: either name your files with the same names as the constants, so Rails will automatically pick them up when you reference the constant in question, or explicitly require the module.

I also notice that you might be confused about another thing. ApplicationController is not the root object in the system. Observe:

module MyModule
def im_awesome
puts "#{self} is so awesome"
end
end


class ApplicationController < ActionController::Base
include MyModule
end


class AnotherClass
end


AnotherClass.new.im_awesome
# NoMethodError: undefined method `im_awesome' for #<AnotherClass:0x101208ad0>

You will need to include the module into whatever class you want to use it in.

class AnotherClass
include MyModule
end


AnotherClass.new.im_awesome
# AnotherClass is so awesome

Of course, in order to be able to include the module in the first place, you'll need to have it available (using either of the techniques above).

In Rails 3 /lib modules are not loaded automatically.

This is because the line:

# config.autoload_paths += %W(#{config.root}/extras)

inside config/application.rb is commented.

You can try to uncomment this line or, (it worked even better for me), leave this commented (for future reference) and add this two lines:

config.autoload_paths += %W(#{config.root}/lib)
config.autoload_paths += Dir["#{config.root}/lib/**/"]

What worked for me, besides uncommenting config.autoload_paths (I’m on Rails 3.1.3), was to create a initializer like this:

#config/initializers/myapp_init.rb
require 'my_module'
include MyModule

This way I can call mymodule methods from anywhere and as class methods Model.mymodule_method or as instance methods mymodel.mymodule_method

Maybe some expert may explain the implications of this. By now, use it at your own risk.

Edit: Afterwards, I think a better approuch would be:

create a initializer like this:

#config/initializers/myapp_init.rb
require ‘my_module’

Include the module where needed, like this:

1) if you want to use it as "Class Methods" use "extend":

class Myclass < ActiveRecord::Base
extend MyModule
def self.method1
Myclass.my_module_method
end
end

2) if you want to use it as "Instance Methods" include it inside Class definition:

class Myclass < ActiveRecord::Base
include MyModule
def method1
self.my_module_method
end
end

3) remember that include MyModule refers to a file my_module.rb in your load path that must be required first

It might be the case that you want to explicitly load file(s) under lib directory at time of application initialization.
In my config/application.rb, I have an entry as,
config.autoload_paths += %W(#{config.root}/lib)

Also this might be the case that module name/hierarchy is not same as it is in file or location/name of file is not same as that hierarchy, so auto-load of that file is also not possible. So when I added an entry at bottom of config/application.rb as,
require "./lib/file_name_without_extention
it worked fine.

To use the module lib/my_module.rb in your models and controllers:

In config/application.rb:

config.watchable_dirs['lib'] = [:rb]

In your model (similar idea for your controller):

require_dependency 'my_module'


class MyModel < ActiveRecord::Base
include MyModule


MyModule.some_method
end

This method is described in more detail at http://hakunin.com/rails3-load-paths