elmassimo/better_settings

⚙ Settings for Ruby apps – fast, immutable, better.

blog . twitter . about

Projects 🛠

My current focus is development experience, and how it can help us achieve increased productivity.

Vite.js

• îles: 🏝 The joyful site generator! Islands of interactivity with Vue in Vite.js
• vite-plugin-image-presets: 🖼 Image presets for Vite.js apps
• vite-plugin-environment: Easily expose environment variables in Vite.js
• vite-plugin-full-reload: ♻️ Automatically reload the page when files are modified
• vite-plugin-bugsnag: Report builds and upload source maps to Bugsnag

Vite.js with Ruby

• vite_ruby: ⚡️♦️ Vite.js in Ruby - bringing joy to your JavaScript experience
• jekyll-vite: ⚡️🩸 Use Vite.js in Jekyll as your assets pipeline
• vite-plugin-erb: Use ERB files in Vite.js projects with a Ruby backend
• vite-plugin-stimulus-hmr: HMR for Stimulus controllers in Vite.js
• stimulus-vite-helpers: Helpers to easily load all your Stimulus - controllers when using Vite.js

Vue.js

• vuex-stores: 🗄 Store objects for Vuex, a simple and more fluid API for state-management.

Rails

• js_from_routes: 🛣️ Generate path helpers and API methods from your Rails routes
• oj_serializers: ⚡️ Faster JSON serialization for Ruby on Rails. Easily migrate away from Active Model Serializers
• types_from_serializers: ✅ Generate TypeScript interfaces from your JSON serializers
• presenter_rails: 🔭 Expose your view models in a convenient way
• queryable: ❔ Gives your queries a home and avoid tucking scopes inside your models
• resourcerer: ✨ Works like magic to dry up your controllers
• request_store_rails: 📦 Per-request global storage for Rails prepared for multi-threaded apps

Ruby

• better_settings: ⚙ Settings for Ruby apps – fast, immutable, better
• capybara-compose: ✅ Easily write fluent integration tests with Capybara
• i18n_multitenant: 🌎 Provides a convenient way to use tenant-specific translations
• pakiderm: 🐘 Pakiderm will never forget the return value

Demos / Templates / App Starters

• pingcrm-vite: PingCRM on Vite Rails - A Vite.js + Inertia.js + Rails demo
• jumpstart-vite: Jumpstart a new Rails app with Vite.js + Turbo + Stimulus, and more
• vite_rails_docker_example: An example of how to run Vite Rails in Docker

Podcasts & Talks 📣

• Frontend Joy in Ruby on Rails
• Islands Architecture in Vue
• Using Vite.js with Ruby Apps
• TypeScript from Ruby Serializers

Writing ✍️

Here are some articles I've written:

• A Rubyist's Guide to Vite.js
• Vue Components as Custom Elements
• Debugging Libraries: Ruby Edition
• Debugging Libraries: Node.js Edition
• Documentation is a Great Investment
• Generating a JS API from Rails Routes
• Practical Applications of the Singleton Class in Ruby
• Avoiding the N+1 problem in Mongoid

better_settings's Issues

1.0.2 breaks ruby compatibility <= 3.1

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?

Rails 7 Won't allow Settings inside initilaizers

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:

Output

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.

Ruby 3.1 compatibility

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