-
Notifications
You must be signed in to change notification settings - Fork 3.2k
fix: Faker::Config.lazy_loading configuration must be respected (WIP)
#3256
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
thdaraujo
wants to merge
2
commits into
main
Choose a base branch
from
ta/fix-lazy-loading-bug
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−34
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -288,46 +288,60 @@ def disable_enforce_available_locales | |
| end | ||
| end | ||
|
|
||
| if Faker::Config.lazy_loading? | ||
| def self.load_path(*constants) | ||
| constants.map do |class_name| | ||
| class_name | ||
| .to_s | ||
| .gsub('::', '/') | ||
| .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2') | ||
| .gsub(/([a-z\d])([A-Z])/, '\1_\2') | ||
| .tr('-', '_') | ||
| .downcase | ||
| end.join('/') | ||
| end | ||
| def self.load_path(*constants) | ||
| constants.map do |class_name| | ||
| class_name | ||
| .to_s | ||
| .gsub('::', '/') | ||
| .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2') | ||
| .gsub(/([a-z\d])([A-Z])/, '\1_\2') | ||
| .tr('-', '_') | ||
| .downcase | ||
| end.join('/') | ||
| end | ||
|
|
||
| def self.lazy_load(klass) | ||
| def klass.const_missing(class_name) | ||
| load_path = case class_name | ||
| when :DnD | ||
| Faker.load_path('faker/games/dnd') | ||
| else | ||
| Faker.load_path(name, class_name) | ||
| end | ||
|
|
||
| begin | ||
| require(load_path) | ||
| rescue LoadError | ||
| require(load_path.gsub('faker/', 'faker/default/')) | ||
| end | ||
| # TODO: refactor this | ||
|
|
||
| const_get(class_name) | ||
| def self.resolve_const(context_name, class_name) | ||
| load_path = case class_name | ||
| when :DnD | ||
| load_path('faker/games/dnd') | ||
| else | ||
| load_path(context_name, class_name) | ||
| end | ||
|
|
||
| begin | ||
| require(load_path) | ||
| rescue LoadError | ||
| require(load_path.gsub('faker/', 'faker/default/')) | ||
| end | ||
| end | ||
|
|
||
| EAGER_LOAD_MUTEX = Mutex.new | ||
| private_constant :EAGER_LOAD_MUTEX | ||
|
|
||
| # initial usage determines lazy loading or eager loading | ||
| # TODO: this can be a bit surprising and error-prone | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this sets up loading the first time a generator is called, which could be a bit surprising/unexpected. maybe it's a good enough solution for letting folks test it? in the future, we aim to make lazy loading default, so this wouldn't be a problem anymore, in my view. |
||
| def self.const_missing(class_name) | ||
| EAGER_LOAD_MUTEX.synchronize do | ||
| if Config.lazy_loading? | ||
| resolve_const(name, class_name) | ||
| elsif !@eager_load | ||
| @eager_load = true | ||
| Dir.glob(["#{__dir__}/faker/*.rb", "#{__dir__}/faker/**/*.rb"]).each { |f| require f } | ||
| end | ||
| end | ||
|
|
||
| lazy_load(self) | ||
| const_get(class_name) | ||
| end | ||
| end | ||
|
|
||
| unless Faker::Config.lazy_loading? | ||
| rb_files = [] | ||
| rb_files << File.join(mydir, 'faker', '*.rb') | ||
| rb_files << File.join(mydir, 'faker', '/**/*.rb') | ||
| def self.lazy_load(klass) | ||
| mutex = Mutex.new | ||
|
|
||
| klass.define_singleton_method(:const_missing) do |class_name| | ||
| mutex.synchronize { Faker.resolve_const(name, class_name) } | ||
|
|
||
| Dir.glob(rb_files).each { |file| require file } | ||
| const_get(class_name) | ||
| end | ||
| end | ||
| end | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we can move this out to a lazy loading class or module