How to set up local configuration files with Anyway Config?

Anyway Config supports local files like .local.yml, which are ignored by version control. In development, it automatically loads these if use_local_files is true, allowing per-user overrides without affecting the main config, as detailed in the Local files section.

Anyway Config vs. Figaro for Rails configuration?

Anyway Config offers more features like multi-source loading, type coercion, and configuration classes, whereas Figaro is simpler and focuses only on environment variables. Anyway Config is better for complex setups requiring structure, but Figaro might be easier for basic environment variable management.

Does Anyway Config support environment variable type casting?

Yes, it automatically coerces environment variable strings to Ruby types like integers, booleans, and arrays, with customizable rules via the coerce_types DSL. For example, ENV['MYAPP_PORT']='8080' becomes an integer.

Can I use Anyway Config without Rails?

Absolutely, Anyway Config works with pure Ruby applications by loading from YAML files and environment variables, though some Rails-specific features like credentials won't be available. You need to set Anyway::Settings.current_environment for environment-aware YAML loading.

How to validate configuration with Anyway Config?

Use the required method to specify mandatory parameters and on_load callbacks for custom validation logic, with support for environment-specific validations. For instance, required :api_key, env: :production ensures the key is present only in production.

What are the breaking changes in Anyway Config v2?

Version 2.x changes how attr_config accessors work, moving away from instance variables to super-based overrides, and introduces features like pattern matching and RBS support. This requires updates to existing code, especially for custom reader/writer methods.

Open-Awesome

AnywayConfig

MITRubyv2.8.0

A Ruby configuration library that unifies settings from YAML, environment variables, credentials, and other sources into structured classes.

GitHub

912 stars62 forks0 contributors

What is AnywayConfig?

Anyway Config is a Ruby library that simplifies configuration management for gems and applications by unifying settings from multiple sources like YAML files, environment variables, and Rails credentials into structured classes. It solves the problem of scattered configuration code and provides a consistent, testable way to handle settings across different environments.

Target Audience

Ruby gem authors and application developers who need robust, maintainable configuration management, especially those working with Rails applications or building distributable gems.

Value Proposition

Developers choose Anyway Config because it eliminates configuration boilerplate, provides automatic multi-source loading with sensible precedence, and makes configuration testable and explicit through Ruby classes, all while maintaining full compatibility with Rails and pure Ruby projects.

Overview

Configuration library for Ruby gems and applications

Use Cases

Best For

Ruby gem authors wanting to provide clean configuration APIs for their users
Rails applications needing to organize settings beyond environment variables
Projects requiring configuration values from multiple sources (YAML, ENV, credentials)
Teams wanting type-safe configuration with coercion and validation
Development environments where developers need personal configuration overrides
Debugging configuration issues by tracing value origins

Not Ideal For

Projects using non-Ruby languages or frameworks
Simple scripts or microservices where a single .env or YAML file suffices
Teams preferring minimal dependencies and avoiding DSLs for configuration
Applications requiring frequent real-time configuration updates without reloading

Pros & Cons

Pros

Multi-Source Integration

Automatically loads settings from YAML files, environment variables, Rails credentials, and custom loaders, eliminating scattered configuration code and providing a unified interface.

Structured Configuration Classes

Uses a DSL to define configuration schemas with defaults, validations, and helper methods, making configuration explicit, testable, and reusable across environments.

Type Coercion and Validation

Converts environment variable strings to appropriate Ruby types like integers and booleans, and offers required field validation with environment-specific rules via the required method.

Rails Ecosystem Integration

Includes generators, autoloading for configs in Rails, and seamless integration with Rails credentials and environments, reducing setup time for Rails applications.

Cons

Breaking Changes in v2.x

Version 2.x introduced significant changes, such as modifying how attr_config accessors work away from instance variables, requiring code updates and migration efforts from 1.x users.

Complexity Overhead

The multi-loader system and class-based DSL add setup complexity that may be overkill for simple projects, where basic Rails config or .env files would suffice.

Rails Dependency for Full Features

While functional without Rails, advanced features like credentials loading and generators are Rails-specific, limiting its utility in pure Ruby or non-Rails environments.

Frequently Asked Questions

Related Projects

dotenv

A Ruby gem to load environment variables from `.env`.

Stars6,766

Forks513

Last commit1 month ago

Figaro

Simple Rails app configuration

Stars3,747

Forks279

Last commit1 year ago

Config

Easiest way to add multi-environment yaml settings to Rails, Sinatra, Padrino and other Ruby projects.

Stars2,168

Forks230

Last commit5 months ago

Configatron

A super cool, simple, and feature rich configuration system for Ruby apps.

Stars594

Forks74

Last commit2 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub