[Awesome Ruby Gem] Use dry-configurable gem to add thread-safe configuration behaviour to your Ruby classes

Posted on 2021-02-13 Edited on 2024-09-12 In Programming Language , Ruby , Awesome Ruby Gem Views: Word count in article: 3k Reading time ≈ 3 mins.

dry-configurable

dry-configurable is a simple mixin to add thread-safe configuration behaviour to your classes. There are many libraries that make use of configuration, and each seemed to have their own implementation with a similar or duplicate interface, so we thought it was strange that this behaviour had not already been encapsulated into a reusable gem, hence dry-configurable was born.

Installation

You can install it as a gem:

1	$ gem install dry-configurable

or add it into a Gemfile (Bundler):

1
2
3

# Gemfile

gem 'dry-configurable', `0.12.1'

Then, run bundle install.

1	$ bundle install

Usages

dry-configurable is extremely simple to use, just extend the mixin and use the setting macro to add configuration options.

class App
  extend Dry::Configurable

  # Pass a block for nested configuration (works to any depth)
  setting :database do
    # Can pass a default value
    setting :dsn, 'sqlite:memory'
  end
  # Defaults to nil if no default value is given
  setting :adapter
  # Pre-process values
  setting(:path, 'test') { |value| Pathname(value) }
  # Passing the reader option as true will create attr_reader method for the class
  setting :pool, 5, reader: true
  # Passing the reader attributes works with nested configuration
  setting :uploader, reader: true do
    setting :bucket, 'dev'
  end
end

App.config.database.dsn
# => "sqlite:memory"

App.config.database.dsn = 'jdbc:sqlite:memory'
App.config.database.dsn
# => "jdbc:sqlite:memory"
App.config.adapter
# => nil
App.config.path
# => #<Pathname:test>
App.pool
# => 5
App.uploader.bucket
# => 'dev'

Just extend the mixin and use the setting macro to add configuration options:

You can use it either on ruby module on a class or an instance.

Module level

On the module level, you need to extend the Dry::Configurable module and you can safely use all features it provides. Here I set the api_url to hanamimastery.com

require 'dry-configurable'

module App
  extend Dry::Configurable

  setting :api_url
end

App.config.api_url = 'https://hanamimastery.com'
App.config.api_url # => 'https://hanamimastery.com'

Class level

On the class level, nothing changes, you can use it exactly in the same way.

require 'dry-configurable'

class App
  extend Dry::Configurable

  setting :api_url
end

App.config.api_url = 'https://example2.com'
App.config.api_url

Instance level

If you want to use it on the instance of the class, however, the only difference is that you need to include the Dry::Configurable module instead of extending it.

class App
  include Dry::Configurable

  setting :api_url
end

app1 = App.new.config.api_url = 'https://example3.com'
app1.config.api_url

app2 = App.new.config.api_url
app2.config.api_url