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 by 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 command above creates a new root object and add “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 array and allows you to easily
add extra paths:
path.is_a?(Array) # => true path.inspect # => ["app/controllers"] path << "lib/controllers" path.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.
# File lib/rails/paths.rb, line 49 def initialize(path) raise "Argument should be a String of the physical root path" if path.is_a?(Array) @current = nil @path = path @root = self super() end
# File lib/rails/paths.rb, line 57 def []=(path, value) value = Path.new(self, path, value) unless value.is_a?(Path) super(path, value) end
# File lib/rails/paths.rb, line 62 def add(path, options={}) with = options[:with] || path self[path] = Path.new(self, path, with, options) end
# File lib/rails/paths.rb, line 67 def all_paths values.tap { |v| v.uniq! } end
# File lib/rails/paths.rb, line 71 def autoload_once filter_by(:autoload_once?) end
# File lib/rails/paths.rb, line 79 def autoload_paths filter_by(:autoload?) end
# File lib/rails/paths.rb, line 75 def eager_load filter_by(:eager_load?) end
# File lib/rails/paths.rb, line 83 def load_paths filter_by(:load_path?) end
# File lib/rails/paths.rb, line 89 def filter_by(constraint) all = [] all_paths.each do |path| if path.send(constraint) paths = path.existent paths -= path.children.map { |p| p.send(constraint) ? [] : p.existent }.flatten all.concat(paths) end end all.uniq! all end