Allow lib/vmdb/logging.rb to be required without needing Rails autoloading
#15376
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When doing the following:
Dir.glob(File.join(File.dirname(__FILE__), "loggers", "*")).each { |f| require f }
We are including a bunch of classes do the following:
module Vmdb::Loggers
class MyLogger < VmdbLogger
end
end
This works fine when the module Vmdb::Loggers has been defined, but when
requiring `lib/vmdb/loggers.rb` directly, this is usually not the case.
By pushing the requires of the child loggers to the bottom of the file,
we ensure that the `Vmdb` module has been defined, and it's child,
`Loggers`, has also been defined.
This allows the following:
require "vmdb/loggers"
require "vmdb/logging"
To work with minimal prerequisites and doesn't require autoloading from
rails.
|
@miq-bot assign @gtanzillo @gtanzillo I figured I would assign this to you, and you can assign any additional reviewers as you see fit. Hope that makes sense. |
Allows us to load vmdb/logging without needed to require `active_support/dependencies` to included the `delegation` class method onto modules/objects. This doesn't save us much space, and reduces the dependency on rails incase we need to load the logging earlier and possibly without rails/active_support. Included some comments to allow greping for the method definitions via a `git grep "def log\?"` or something similar.
NickLaMuro
force-pushed
the
vmdb_logging_without_autoloading
branch
from
6b546da
to
5d9c4ec
Compare
|
Checked commits NickLaMuro/manageiq@0dfc016~...5d9c4ec with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tl; dr;
Allows the following to work:
$ bundle exec ruby -I lib -e 'require "manageiq-gems-pending"; require "vmdb/logging"; Vmdb::Loggers.init'Summary
Through black magic, or some load order/autoloading secret sauce, we are able to include "vmdb/logging", or even "vmdb/logger", without issue when booting our application so that we don't run into errors like
undefined constant Loggers for Vmdband such. But when loading on it's own, it was impossible.This PR makes some changes to not only make autoloading function, but make the "vmdb/logging" lib less dependent on Rails for it's functionality.
Links
manageiq-coregem (working title) contents and plan.Steps for Testing/QA