elmassimo / better_settings Goto Github PK

The new ruby 3.1 use as default gem psych 4.0.3, with this version there is problem to load alias, i receive this error message
Unknown alias: defaults
To fix the problem you can change your yaml_to_hash method in this way:

    # Internal: Parses a yml file that can optionally use ERB templating.
    def yaml_to_hash(file_name)
      return {} if (content = File.open(file_name).read).empty?
      if Psych::VERSION > '4.0'
        YAML.load(ERB.new(content).result, aliases: true).to_hash
      else
        YAML.load(ERB.new(content).result).to_hash
      end
    end

In this way it works with ruby 3.1 and keep backwards compatibility

Description 📖

When upgrading to Rails 7 from Rails 6.1 I am unable to load Settings in initializers.

Reproduction 🐞

bundle exec rake zeitwerk:check 
rake aborted!
NameError: uninitialized constant Settings
Did you mean?  String
/core/config/initializers/sidekiq.rb:10:in `<main>'

# config/initilizers/sidekiq.rb
...
redis_host_string = "#{Settings.redis.scheme}://#{Settings.redis.host}:#{Settings.redis.port}/#{Settings.redis.sidekiq_db}"

Logs 📜

Error output or similar when the error occurs:

bundle exec rake zeitwerk:check                                                                        ─╯
rake aborted!
NameError: uninitialized constant Settings
Did you mean?  String
/Users/tom/Workspace/core/config/initializers/sidekiq.rb:10:in `<main>'
/Users/tom/Workspace/core/config/environment.rb:5:in `<main>'
/Users/tom/.rbenv/versions/3.0.3/bin/bundle:23:in `load'
/Users/tom/.rbenv/versions/3.0.3/bin/bundle:23:in `<main>'
Tasks: TOP => zeitwerk:check => environment
(See full trace by running task with --trace)

Screenshots 📷

Provide console or browser screenshots of the problem.

If this gem is going to be ruby 3.1 only that should not be released as part of a patch release. Perhaps releasing it as 2.0.0 would be better to denote the scope of the breaking changes?