Orthoses::Config

Orthoses extension for Config. Orthoses::Config automatically generates RBS for methods added by Config.

# config/settings.yml
foo:
  bar: 'bar'

class Object
  Settings: Config::Options & Config::_Options_Root
end

interface Config::_Options_Root
  def foo: () -> (Config::Options & Config::_Options_Root_foo)
end

interface Config::_Options_Root_foo
  def bar: () -> String
end

Settings         #=> Config::Options & Config::_Options_Root
Settings.foo     #=> Config::Options & Config::_Options_Root_foo
Settings.foo.bar #=> String

Install the gem and add to the application's Gemfile by executing:

bundle add orthoses-config

If bundler is not being used to manage dependencies, install the gem by executing:

gem install orthoses-config

It can be used as orthoses middleware.

require 'orthoses/config'

use Orthoses::Config, except_keys: %w[ignore_key]

• except_keys is optional. You can specify root keys to be excluded from generation.

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/orthoses-config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Orthoses::Config project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.