- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0 (0)
- 3.0.9 (0)
- 3.1.0 (38)
- 3.2.1 (1)
- 3.2.8 (0)
- 3.2.13 (0)
- 4.0.2 (1)
- 4.1.8 (0)
- 4.2.1 (0)
- 4.2.7 (0)
- 4.2.9 (0)
- 5.0.0.1 (0)
- 5.1.7 (0)
- 5.2.3 (0)
- 6.0.0 (0)
- 6.1.3.1 (0)
- 6.1.7.7 (0)
- 7.0.0 (0)
- 7.1.3.2 (1)
- 7.1.3.4 (0)
- What's this?
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[rdoc-ref:Rails::Paths::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[rdoc-ref:Rails::Paths::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[rdoc-ref:Rails::Paths::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.