class Rails::Paths::Root

This object is an extended hash that behaves as root of the Rails::Paths system. It allows you to collect information about how you want to structure your application paths through a Hash-like API. It requires you to give a physical path on initialization.

root = Root.new "/rails"
root.add "app/controllers", eager_load: true

The above command creates a new root object and adds “app/controllers” as a path. This means we can get a Rails::Paths::Path object back like below:

path = root["app/controllers"]
path.eager_load?               # => true
path.is_a?(Rails::Paths::Path) # => true

The Path object is simply an enumerable and allows you to easily add extra paths:

path.is_a?(Enumerable) # => true
path.to_ary.inspect    # => ["app/controllers"]

path << "lib/controllers"
path.to_ary.inspect    # => ["app/controllers", "lib/controllers"]

Notice that when you add a path using add, the Path object created already contains the path with the same path value given to add. In some situations, you may not want this behavior, so you can give :with as option.

root.add "config/routes", with: "config/routes.rb"
root["config/routes"].inspect # => ["config/routes.rb"]

The add method accepts the following options as arguments: eager_load, autoload, autoload_once, and glob.

Finally, the Path object also provides a few helpers:

root = Root.new "/rails"
root.add "app/controllers"

root["app/controllers"].expanded # => ["/rails/app/controllers"]
root["app/controllers"].existent # => ["/rails/app/controllers"]

Check the Rails::Paths::Path documentation for more information.

Attributes

path [RW]

Public Class Methods

new (path)

Source

# File lib/rails/paths.rb, line 54
def initialize(path)
  @path = path
  @root = {}
end

Public Instance Methods

[] (path)

Source

# File lib/rails/paths.rb, line 69
def [](path)
  @root[path]
end

[]= (path, value)

Source

# File lib/rails/paths.rb, line 59
def []=(path, value)
  glob = self[path] ? self[path].glob : nil
  add(path, with: value, glob: glob)
end

add (path, options = {})

Source

# File lib/rails/paths.rb, line 64
def add(path, options = {})
  with = Array(options.fetch(:with, path))
  @root[path] = Path.new(self, path, with, options)
end

all_paths ()

Source

# File lib/rails/paths.rb, line 85
def all_paths
  values.tap(&:uniq!)
end

autoload_once ()

Source

# File lib/rails/paths.rb, line 89
def autoload_once
  filter_by(&:autoload_once?)
end

autoload_paths ()

Source

# File lib/rails/paths.rb, line 97
def autoload_paths
  filter_by(&:autoload?)
end

eager_load ()

Source

# File lib/rails/paths.rb, line 93
def eager_load
  filter_by(&:eager_load?)
end

keys ()

Source

# File lib/rails/paths.rb, line 77
def keys
  @root.keys
end

load_paths ()

Source

# File lib/rails/paths.rb, line 101
def load_paths
  filter_by(&:load_path?)
end

values ()

Source

# File lib/rails/paths.rb, line 73
def values
  @root.values
end

values_at (*list)

Source

# File lib/rails/paths.rb, line 81
def values_at(*list)
  @root.values_at(*list)
end