Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Revert "Deprecate the `eager_load_paths` configuration"

Because of the possibility of lib being unintentionally eager loaded
it's been agreed that we'll leave autoload paths and eager load paths
separate for Rails 4.0.

This reverts commit 0757b33.

Conflicts:
	railties/CHANGELOG.md
  • Loading branch information...
commit 9d9b22f47a1928bf2fde3b7b574e3d8d4b1cca92 1 parent 0122134
@pixeltrix pixeltrix authored
View
9 railties/CHANGELOG.md
@@ -24,15 +24,6 @@
*Jeremy W. Rowe*
-* Deprecate the `eager_load_paths` configuration and alias it to `autoload_paths`.
- Since the default in Rails 4.0 is to run in 'threadsafe' mode we need to eager
- load all of the paths in `autoload_paths`. This may have unintended consequences
- if you have added 'lib' to `autoload_paths` such as loading unneeded code or
- code intended only for development and/or test environments. If this applies to
- your application you should thoroughly check what is being eager loaded.
-
- *Andrew White*
-
* Restore Rails::Engine::Railties#engines with deprecation to ensure
compatibility with gems such as Thinking Sphinx
Fix #8551
View
12 railties/lib/rails/engine.rb
@@ -34,8 +34,9 @@ module Rails
# == Configuration
#
# Besides the +Railtie+ configuration which is shared across the application, in a
- # <tt>Rails::Engine</tt> you can access <tt>autoload_paths</tt> and <tt>autoload_once_paths</tt>,
- # which, differently from a <tt>Railtie</tt>, are scoped to the current engine.
+ # <tt>Rails::Engine</tt> you can access <tt>autoload_paths</tt>, <tt>eager_load_paths</tt>
+ # and <tt>autoload_once_paths</tt>, which, differently from a <tt>Railtie</tt>, are scoped to
+ # the current engine.
#
# class MyEngine < Rails::Engine
# # Add a load path for this specific Engine
@@ -455,9 +456,9 @@ def load_generators(app=self)
end
# Eager load the application by loading all ruby
- # files inside autoload_paths.
+ # files inside eager_load paths.
def eager_load!
- config.autoload_paths.each do |load_path|
+ config.eager_load_paths.each do |load_path|
matcher = /\A#{Regexp.escape(load_path)}\/(.*)\.rb\Z/
Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
require_dependency file.sub(matcher, '\1')
@@ -557,6 +558,7 @@ def load_seed
# Freeze so future modifications will fail rather than do nothing mysteriously
config.autoload_paths.freeze
+ config.eager_load_paths.freeze
config.autoload_once_paths.freeze
end
@@ -669,7 +671,7 @@ def _all_autoload_once_paths #:nodoc:
end
def _all_autoload_paths #:nodoc:
- @_all_autoload_paths ||= (config.autoload_paths + config.autoload_once_paths).uniq
+ @_all_autoload_paths ||= (config.autoload_paths + config.eager_load_paths + config.autoload_once_paths).uniq
end
def _all_load_paths #:nodoc:
View
24 railties/lib/rails/engine/configuration.rb
@@ -4,7 +4,7 @@ module Rails
class Engine
class Configuration < ::Rails::Railtie::Configuration
attr_reader :root
- attr_writer :middleware, :autoload_once_paths, :autoload_paths
+ attr_writer :middleware, :eager_load_paths, :autoload_once_paths, :autoload_paths
def initialize(root=nil)
super()
@@ -39,16 +39,16 @@ def paths
@paths ||= begin
paths = Rails::Paths::Root.new(@root)
- paths.add "app", autoload: true, glob: "*"
+ paths.add "app", eager_load: true, glob: "*"
paths.add "app/assets", glob: "*"
- paths.add "app/controllers", autoload: true
- paths.add "app/helpers", autoload: true
- paths.add "app/models", autoload: true
- paths.add "app/mailers", autoload: true
+ paths.add "app/controllers", eager_load: true
+ paths.add "app/helpers", eager_load: true
+ paths.add "app/models", eager_load: true
+ paths.add "app/mailers", eager_load: true
paths.add "app/views"
- paths.add "app/controllers/concerns", autoload: true
- paths.add "app/models/concerns", autoload: true
+ paths.add "app/controllers/concerns", eager_load: true
+ paths.add "app/models/concerns", eager_load: true
paths.add "lib", load_path: true
paths.add "lib/assets", glob: "*"
@@ -76,13 +76,7 @@ def root=(value)
end
def eager_load_paths
- ActiveSupport::Deprecation.warn "eager_load_paths is deprecated and all autoload_paths are now eagerly loaded."
- autoload_paths
- end
-
- def eager_load_paths=(paths)
- ActiveSupport::Deprecation.warn "eager_load_paths is deprecated and all autoload_paths are now eagerly loaded."
- self.autoload_paths = paths
+ @eager_load_paths ||= paths.eager_load
end
def autoload_once_paths
View
44 railties/lib/rails/paths.rb
@@ -5,13 +5,13 @@ module Paths
# paths by a Hash like API. It requires you to give a physical path on initialization.
#
# root = Root.new "/rails"
- # root.add "app/controllers", autoload: true
+ # 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 <tt>Rails::Paths::Path</tt> object back like below:
#
# path = root["app/controllers"]
- # path.autoload? # => true
+ # 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:
@@ -30,7 +30,7 @@ module Paths
# root["config/routes"].inspect # => ["config/routes.rb"]
#
# The +add+ method accepts the following options as arguments:
- # autoload, autoload_once and glob.
+ # eager_load, autoload, autoload_once and glob.
#
# Finally, the +Path+ object also provides a few helpers:
#
@@ -85,8 +85,7 @@ def autoload_once
end
def eager_load
- ActiveSupport::Deprecation.warn "eager_load is deprecated and all autoload_paths are now eagerly loaded."
- filter_by(:autoload?)
+ filter_by(:eager_load?)
end
def autoload_paths
@@ -125,13 +124,9 @@ def initialize(root, current, paths, options = {})
@glob = options[:glob]
options[:autoload_once] ? autoload_once! : skip_autoload_once!
+ options[:eager_load] ? eager_load! : skip_eager_load!
options[:autoload] ? autoload! : skip_autoload!
options[:load_path] ? load_path! : skip_load_path!
-
- if !options.key?(:autoload) && options.key?(:eager_load)
- ActiveSupport::Deprecation.warn "the :eager_load option is deprecated and all :autoload paths are now eagerly loaded."
- options[:eager_load] ? autoload! : skip_autoload!
- end
end
def children
@@ -148,37 +143,22 @@ def last
expanded.last
end
- %w(autoload_once autoload load_path).each do |m|
+ %w(autoload_once eager_load autoload load_path).each do |m|
class_eval <<-RUBY, __FILE__, __LINE__ + 1
- def #{m}! # def autoload!
- @#{m} = true # @autoload = true
+ def #{m}! # def eager_load!
+ @#{m} = true # @eager_load = true
end # end
#
- def skip_#{m}! # def skip_autoload!
- @#{m} = false # @autoload = false
+ def skip_#{m}! # def skip_eager_load!
+ @#{m} = false # @eager_load = false
end # end
#
- def #{m}? # def autoload?
- @#{m} # @autoload
+ def #{m}? # def eager_load?
+ @#{m} # @eager_load
end # end
RUBY
end
- def eager_load!
- ActiveSupport::Deprecation.warn "eager_load paths are deprecated and all autoload paths are now eagerly loaded."
- autoload!
- end
-
- def skip_eager_load!
- ActiveSupport::Deprecation.warn "eager_load paths are deprecated and all autoload paths are now eagerly loaded."
- skip_autoload!
- end
-
- def eager_load?
- ActiveSupport::Deprecation.warn "eager_load paths are deprecated and all autoload paths are now eagerly loaded."
- autoload?
- end
-
def each(&block)
@paths.each(&block)
end
View
2  railties/test/application/initializers/load_path_test.rb
@@ -64,7 +64,7 @@ module Zoo::ReptileHouse ; end
add_to_config <<-RUBY
config.root = "#{app_path}"
- config.autoload_paths << "#{app_path}/lib"
+ config.eager_load_paths << "#{app_path}/lib"
RUBY
require "#{app_path}/config/environment"
View
10 railties/test/application/paths_test.rb
@@ -54,11 +54,11 @@ def assert_not_in_load_path(*path)
assert_equal root("app", "controllers"), @paths["app/controllers"].expanded.first
end
- test "booting up Rails yields a list of paths that will be eager loaded" do
- autoload_paths = @paths.autoload_paths
- assert autoload_paths.include?(root("app/controllers"))
- assert autoload_paths.include?(root("app/helpers"))
- assert autoload_paths.include?(root("app/models"))
+ test "booting up Rails yields a list of paths that are eager" do
+ eager_load = @paths.eager_load
+ assert eager_load.include?(root("app/controllers"))
+ assert eager_load.include?(root("app/helpers"))
+ assert eager_load.include?(root("app/models"))
end
test "environments has a glob equal to the current environment" do
View
56 railties/test/paths_test.rb
@@ -135,48 +135,56 @@ def setup
assert_equal 2, @root.autoload_once.size
end
- test "marking a path as eager loaded is deprecated" do
+ test "it is possible to mark a path as eager loaded" do
@root["app"] = "/app"
- assert_deprecated{ @root["app"].eager_load! }
- assert_deprecated{ assert @root["app"].eager_load? }
- assert_deprecated{ assert @root.eager_load.include?(@root["app"].to_a.first) }
+ @root["app"].eager_load!
+ assert @root["app"].eager_load?
+ assert @root.eager_load.include?(@root["app"].to_a.first)
end
- test "skipping a path from eager loading is deprecated" do
+ test "it is possible to skip a path from eager loading" do
@root["app"] = "/app"
- assert_deprecated{ @root["app"].eager_load! }
- assert_deprecated{ assert @root["app"].eager_load? }
+ @root["app"].eager_load!
+ assert @root["app"].eager_load?
- assert_deprecated{ @root["app"].skip_eager_load! }
- assert_deprecated{ assert !@root["app"].eager_load? }
- assert_deprecated{ assert !@root.eager_load.include?(@root["app"].to_a.first) }
+ @root["app"].skip_eager_load!
+ assert !@root["app"].eager_load?
+ assert !@root.eager_load.include?(@root["app"].to_a.first)
end
- test "adding a path with eager_load option is deprecated" do
- assert_deprecated{ @root.add "app", with: "/app", eager_load: true }
- assert_deprecated{ assert @root["app"].eager_load? }
- assert_deprecated{ assert @root.eager_load.include?("/app") }
+ test "it is possible to add a path without assignment and mark it as eager" do
+ @root.add "app", with: "/app", eager_load: true
+ assert @root["app"].eager_load?
+ assert @root.eager_load.include?("/app")
end
- test "adding multiple paths with eager_load option is deprecated" do
- assert_deprecated{ @root.add "app", with: ["/app", "/app2"], eager_load: true }
- assert_deprecated{ assert @root["app"].eager_load? }
- assert_deprecated{ assert @root.eager_load.include?("/app") }
- assert_deprecated{ assert @root.eager_load.include?("/app2") }
+ test "it is possible to add multiple paths without assignment and mark them as eager" do
+ @root.add "app", with: ["/app", "/app2"], eager_load: true
+ assert @root["app"].eager_load?
+ assert @root.eager_load.include?("/app")
+ assert @root.eager_load.include?("/app2")
+ end
+
+ test "it is possible to create a path without assignment and mark it both as eager and load once" do
+ @root.add "app", with: "/app", eager_load: true, autoload_once: true
+ assert @root["app"].eager_load?
+ assert @root["app"].autoload_once?
+ assert @root.eager_load.include?("/app")
+ assert @root.autoload_once.include?("/app")
end
test "making a path eager more than once only includes it once in @root.eager_paths" do
@root["app"] = "/app"
- assert_deprecated{ @root["app"].eager_load! }
- assert_deprecated{ @root["app"].eager_load! }
- assert_deprecated{ assert_equal 1, @root.eager_load.select {|p| p == @root["app"].expanded.first }.size }
+ @root["app"].eager_load!
+ @root["app"].eager_load!
+ assert_equal 1, @root.eager_load.select {|p| p == @root["app"].expanded.first }.size
end
test "paths added to a eager_load path should be added to the eager_load collection" do
@root["app"] = "/app"
- assert_deprecated{ @root["app"].eager_load! }
+ @root["app"].eager_load!
@root["app"] << "/app2"
- assert_deprecated{ assert_equal 2, @root.eager_load.size }
+ assert_equal 2, @root.eager_load.size
end
test "it should be possible to add a path's default glob" do
Please sign in to comment.
Something went wrong with that request. Please try again.