Anyway Config

Because attr_config accessors in v2.0+ do not populate instance variables, you should use super when overriding methods to ensure compatibility with the internal values store.

If you are writing a gem that needs to support both v1.x (which used instance variables) and v2.0+ (which uses super), check for the existence of the on_load class method.

class MyConfig < Anyway::Config
  attr_config :host, :port, :url

  # Correct way to override writer in v2.0+
  def meta=(val)
    super(JSON.parse(val))
  end

  # Correct way to override reader in v2.0+
  def url
    super || (self.url = "#{host}:#{port}")
  end

  # Compatibility pattern for gems supporting v1.x and v2.0+
  def url
    if respond_to?(:on_load)
      super || (self.url = "#{host}:#{port}")
    else
      @url ||= "#{host}:#{port}"
    end
  end
end

When using the on_load callback with a block, Anyway::Config uses instance_eval to switch the context. To ensure type checkers like Steep can correctly identify the context, you must provide a type hint (e.g., using a YARD annotation) inside the block.

class MyConfig < Anyway::Config
  on_load do
    # @type self : MyConfig
    raise_validation_error("host is invalid") if host.start_with?("localhost")
  end
end

Anyway Config can pull secrets from Doppler.

Automatic Setup: Set the DOPPLER_TOKEN environment variable with a Doppler service token.

Manual Setup: If you need to configure the loader manually, use the Anyway.loaders.append method.

Disabling: Set ANYWAY_CONFIG_DISABLE_DOPPLER=true to opt-out if a DOPPLER_TOKEN is present but should not be used by Anyway::Config.

# Add loader
Anyway.loaders.append :Doppler, Anyway::Loaders::Doppler

# Configure API URL and token
Anyway::Loaders::Doppler.download_url = "https://api.doppler.com/v3/configs/config/secrets/download"
Anyway::Loaders::Doppler.token = ENV["DOPPLER_TOKEN"]

You can store configuration in encrypted .ejson files. This requires the ejson executable to be in your PATH (recommended to install via the ejson gem).

Loading Order:

1. config/secrets.local.ejson
2. config/<environment>/secrets.ejson
3. config/secrets.ejson

Customizing Namespace: By default, the loader searches under a namespace matching the config name. Use loader_options to change this or disable it.

Disabling: Set ANYWAY_CONFIG_DISABLE_EJSON=true to opt-out.

class MyConfig < Anyway::Config
  # Look under the key "foo" instead of the default
  loader_options ejson_namespace: "foo"

  # Disable namespacing (search in root object)
  loader_options ejson_namespace: false
end

In non-Rails applications, anyway_config loads data from ./config/<config-name>.yml with the following priority:

1. YAML configuration files: ./config/<config-name>.yml.
   • To support environment-specific keys (e.g., development:, production:), you must set the current environment: Anyway::Settings.current_environment = "development" or use the ANYWAY_ENV=development environment variable.
   • If no environment is specified, it assumes the YAML contains global values.
   • ERB is supported if require "erb" is called before loading.
2. Environment variables: ENV['<CONFIG_NAME>_*'].

require "anyway_config"
require "erb"

Anyway::Settings.current_environment = "development"
# Or via ENV['ANYWAY_ENV'] = 'development'

# Lookup paths can be set via:
Anyway::Settings.default_config_path = "/etc/configs"

You can install Anyway Config by adding it to your Gemfile or your gem's .gemspec file.

For a Ruby project

Add it to your Gemfile:

gem "anyway_config", "~> 2.0"

For a Ruby gem

Add it as a dependency in your my-cool-gem.gemspec:

Gem::Specification.new do |spec|
  # ...
  spec.add_dependency "anyway_config", ">= 2.0.0"
  # ...
end

Supported Ruby versions

• Ruby (MRI) >= 2.7.0
• JRuby >= 9.3.0

# Gemfile
gem "anyway_config", "~> 2.0"

The with_env helper allows you to test code within the context of specific environment variables. It ensures variables are set during the block and reset to their original state afterward.

Availability:

• Automatically included in RSpec if RAILS_ENV or RACK_ENV is "test" and the test is tagged with type: :config or located in spec/configs/....
• To use manually, require "anyway/testing/helpers" and include Anyway::Testing::Helpers.

describe HerokuConfig, type: :config do
  subject { described_class.new }

  specify do
    with_env("HEROKU_APP_NAME" => "my-app") do
      expect(subject.app_name).to eq("my-app")
    end
  end
end

Anyway Config provides Ruby type signatures (RBS). To use them with the Steep type checker, add the following to your Steepfile:

library "pathname"
library "optparse"
library "anyway_config"