method

load_plugin

v1.0.0 - Show latest stable - 0 notes - Class: Rails::Initializer

1.0.0 (0)
1.1.6 (0)
1.2.6 (0)
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

load_plugin(directory) protected

Load the plugin at path unless already loaded.

Each plugin is initialized:

add its lib directory, if present, to the beginning of the load path
evaluate init.rb if present

Returns true if the plugin is successfully loaded or false if it is already loaded (similar to Kernel#require). Raises LoadError if the plugin is not found.

Show source

# File railties/lib/initializer.rb, line 292
      def load_plugin(directory)
        name = File.basename(directory)
        return false if loaded_plugins.include?(name)

        # Catch nonexistent and empty plugins.
        raise LoadError, "No such plugin: #{directory}" unless plugin_path?(directory)

        lib_path  = File.join(directory, 'lib')
        init_path = File.join(directory, 'init.rb')
        has_lib   = File.directory?(lib_path)
        has_init  = File.file?(init_path)

        # Add lib to load path.
        $LOAD_PATH.unshift(lib_path) if has_lib
        
        # Allow plugins to reference the current configuration object
        config = configuration 

        # Evaluate init.rb.
        silence_warnings { eval(IO.read(init_path), binding, init_path) } if has_init

        # Add to set of loaded plugins.
        loaded_plugins << name
        true
      end

load_plugin

Related methods