Class: Rails::Paths::Root
Relationships & Source Files | |
Inherits: | Object |
Defined in: | railties/lib/rails/paths.rb |
Overview
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 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"]. # => ["/rails/app/controllers"]
root["app/controllers"].existent # => ["/rails/app/controllers"]
Check the Path
documentation for more information.
Class Method Summary
- .new(path) ⇒ Root constructor
Instance Attribute Summary
- #path rw
Instance Method Summary
Constructor Details
.new(path) ⇒ Root
Instance Attribute Details
#path (rw)
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 52
attr_accessor :path
Instance Method Details
#[](path)
[ GitHub ]#[]=(path, value)
[ GitHub ]#add(path, options = {})
[ GitHub ]#all_paths
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 85
def all_paths values.tap(&:uniq!) end
#autoload_once
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 89
def autoload_once filter_by(&:autoload_once?) end
#autoload_paths
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 97
def autoload_paths filter_by(&:autoload?) end
#eager_load
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 93
def eager_load filter_by(&:eager_load?) end
#keys
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 77
def keys @root.keys end
#load_paths
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 101
def load_paths filter_by(&:load_path?) end
#values
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 73
def values @root.values end
#values_at(*list)
[ GitHub ]# File 'railties/lib/rails/paths.rb', line 81
def values_at(*list) @root.values_at(*list) end