Class: Rails::Paths::Root

Inherits:
Object
  • Object
show all
Defined in:
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 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path) ⇒ Root

Returns a new instance of Root.



49
50
51
52
 
# File 'lib/rails/paths.rb', line 49

def initialize(path)
  @path = path
  @root = {}
end

Instance Attribute Details

#path ⇒ Object

Returns the value of attribute path.



47
48
49
 
# File 'lib/rails/paths.rb', line 47

def path
  @path
end

Instance Method Details

#[](path) ⇒ Object 



64
65
66
 
# File 'lib/rails/paths.rb', line 64

def [](path)
  @root[path]
end

#[]=(path, value) ⇒ Object 



54
55
56
57
 
# File 'lib/rails/paths.rb', line 54

def []=(path, value)
  glob = self[path] ? self[path].glob : nil
  add(path, with: value, glob: glob)
end

#add(path, options = {}) ⇒ Object 



59
60
61
62
 
# File 'lib/rails/paths.rb', line 59

def add(path, options = {})
  with = Array(options.fetch(:with, path))
  @root[path] = Path.new(self, path, with, options)
end

#all_paths ⇒ Object 



80
81
82
 
# File 'lib/rails/paths.rb', line 80

def all_paths
  values.tap(&:uniq!)
end

#autoload_once ⇒ Object 



84
85
86
 
# File 'lib/rails/paths.rb', line 84

def autoload_once
  filter_by(&:autoload_once?)
end

#autoload_paths ⇒ Object 



92
93
94
 
# File 'lib/rails/paths.rb', line 92

def autoload_paths
  filter_by(&:autoload?)
end

#eager_load ⇒ Object 



88
89
90
 
# File 'lib/rails/paths.rb', line 88

def eager_load
  filter_by(&:eager_load?)
end

#keys ⇒ Object 



72
73
74
 
# File 'lib/rails/paths.rb', line 72

def keys
  @root.keys
end

#load_paths ⇒ Object 



96
97
98
 
# File 'lib/rails/paths.rb', line 96

def load_paths
  filter_by(&:load_path?)
end

#values ⇒ Object 



68
69
70
 
# File 'lib/rails/paths.rb', line 68

def values
  @root.values
end

#values_at(*list) ⇒ Object 



76
77
78
 
# File 'lib/rails/paths.rb', line 76

def values_at(*list)
  @root.values_at(*list)
end