Add option to specify environment (default: RAILS_ENV)

.gitignore

@@ -14,3 +14,4 @@ tmp
 .sass-cache
 Gemfile.lock
 *.gem
+.byebug_history

Appraisals

@@ -31,7 +31,7 @@ end
 appraise 'rails-5.2' do
   gem 'activerecord-jdbcsqlite3-adapter', '~> 52.5', platform: :jruby
   gem 'bootsnap', '~> 1.4'
-  gem 'rails', '5.2.4.3'
+  gem 'rails', '5.2.5'
   gem 'rspec-rails', '~> 3.7'
   gem 'sqlite3', '< 1.4.0', platform: :ruby
 end
@@ -41,14 +41,28 @@ if (RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.5.0') || RUBY_ENGINE != 'ruby'
   appraise 'rails-6.0' do
     gem 'activerecord-jdbcsqlite3-adapter', '~> 60.1', platform: :jruby
     gem 'bootsnap', '~> 1.4'
-    gem 'rails', '6.0.3.1'
+    gem 'rails', '6.0.3.6'
     gem 'rspec-rails', '~> 3.7'
     gem 'sqlite3', '~> 1.4.0', platform: :ruby
   end
 else
   puts 'Skipping rails-6.0 for Ruby < 2.5'
 end
 
+# Rails 6.x requires Ruby >= 2.5.0
+if (RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '2.5.0') || RUBY_ENGINE != 'ruby'
+  appraise 'rails-6.1' do
+    gem 'activerecord-jdbcsqlite3-adapter', '~> 60.1', platform: :jruby
+    gem 'bootsnap', '~> 1.4'
+    gem 'rails', '6.1.3.1'
+    gem 'rspec-rails', '~> 3.7'
+    gem 'sqlite3', '~> 1.4.0', platform: :ruby
+  end
+else
+  puts 'Skipping rails-6.0 for Ruby < 2.5'
+end
+
+
 appraise 'sinatra' do
   gem 'sinatra', '2.0.8.1'
 end

CHANGELOG.md

@@ -45,6 +45,7 @@
 
 ### Changes
 
+* Add option to specify environment (default: `RAILS_ENV`) ([#290](https://github.com/rubyconfig/config/pull/290))
 * Add JRuby 9.2 to the test matrix ([#228](https://github.com/railsconfig/config/issues/228))
 * Add exit! to reserved keywords ([#289](https://github.com/railsconfig/config/issues/289))
 

README.md

@@ -12,25 +12,25 @@ Config helps you easily manage environment specific settings in an easy and usab
 
 ## Features
 
-* simple YAML config files
-* config files support ERB
-* config files support inheritance and multiple environments
-* access config information via convenient object member notation
-* support for multi-level settings (`Settings.group.subgroup.setting`)
-* local developer settings ignored when committing the code
+- simple YAML config files
+- config files support ERB
+- config files support inheritance and multiple environments
+- access config information via convenient object member notation
+- support for multi-level settings (`Settings.group.subgroup.setting`)
+- local developer settings ignored when committing the code
 
 ## Compatibility
 
 Current version supports and is [tested](.github/workflows/tests.yml#L19) for the following interpreters and frameworks:
 
-* Interpreters
-  * [Ruby](https://www.ruby-lang.org) `>= 2.4`
-  * [JRuby](https://www.jruby.org) `>= 9.2`
-  * [TruffleRuby](https://github.com/oracle/truffleruby) `>= 19.3`
-* Application frameworks
-  * Rails `>= 4.2`, `5` and `6`
-  * Padrino
-  * Sinatra
+- Interpreters
+  - [Ruby](https://www.ruby-lang.org) `>= 2.4`
+  - [JRuby](https://www.jruby.org) `>= 9.2`
+  - [TruffleRuby](https://github.com/oracle/truffleruby) `>= 19.3`
+- Application frameworks
+  - Rails `>= 4.2`, `5` and `6`
+  - Padrino
+  - Sinatra
 
 For Ruby `2.0` to `2.3` or Rails `3` to `4.1` use version `1.x` of this gem. For older versions of Rails or Ruby use [AppConfig](http://github.com/fredwu/app_config).
 
@@ -52,6 +52,8 @@ which will generate customizable config file `config/initializers/config.rb` and
 
 You can now edit them to adjust to your needs.
 
+> Note: By default, the config environment will match the Rails environment (`Rails.env`). This can be changed by setting `config.environment`.
+
 ### Installing on Padrino
 
 Add the gem to your `Gemfile` and run `bundle install` to install it. Then edit `app.rb` and register `Config`
@@ -209,21 +211,21 @@ Embedded Ruby is allowed in the YAML configuration files. ERB will be evaluated
 
 Consider the two following config files.
 
-* ```#{Rails.root}/config/settings.yml```
+- `#{Rails.root}/config/settings.yml`
 
 ```yaml
 size: 1
 server: google.com
 ```
 
-* ```#{Rails.root}/config/environments/development.yml```
+- `#{Rails.root}/config/environments/development.yml`
 
 ```yaml
 size: 2
 computed: <%= 1 + 2 + 3 %>
 section:
   size: 3
-  servers: [ {name: yahoo.com}, {name: amazon.com} ]
+  servers: [{ name: yahoo.com }, { name: amazon.com }]
 ```
 
 Notice that the environment specific config entries overwrite the common entries.
@@ -267,15 +269,16 @@ After installing `Config` in Rails, you will find automatically generated file t
 
 ### General
 
-* `const_name` - name of the object holing you settings. Default: `'Settings'`
-* `evaluate_erb_in_yaml` - evaluate ERB in YAML config files. Set to false if the config file contains ERB that should not be evaluated at load time. Default: `true`
+- `const_name` - name of the object holding you settings. Default: `'Settings'`
+- `environment` - define current environment, affecting which settings file will be loaded. Default: `Rails.env`
+- `evaluate_erb_in_yaml` - evaluate ERB in YAML config files. Set to false if the config file contains ERB that should not be evaluated at load time. Default: `true`
 
 ### Merge customization
 
-* `overwrite_arrays` - overwrite arrays found in previously loaded settings file. Default: `true`
-* `merge_hash_arrays` - merge hashes inside of arrays from previously loaded settings files. Makes sense only when `overwrite_arrays = false`. Default: `false`
-* `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Makes sense only when `overwrite_arrays = false`, otherwise array settings would be overwritten by default. Default: `nil`
-* `merge_nil_values` - `nil` values will overwrite an existing value when merging configs. Default: `true`.
+- `overwrite_arrays` - overwrite arrays found in previously loaded settings file. Default: `true`
+- `merge_hash_arrays` - merge hashes inside of arrays from previously loaded settings files. Makes sense only when `overwrite_arrays = false`. Default: `false`
+- `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Makes sense only when `overwrite_arrays = false`, otherwise array settings would be overwritten by default. Default: `nil`
+- `merge_nil_values` - `nil` values will overwrite an existing value when merging configs. Default: `true`.
 
 ```ruby
 # merge_nil_values is true by default
@@ -448,12 +451,12 @@ To upload your local values to Heroku you could ran `bundle exec rake config:her
 
 You can customize how environment variables are processed:
 
-* `env_prefix` (default: `const_name`) - load only ENV variables starting with this prefix (case-sensitive)
-* `env_separator` (default: `'.'`)  - what string to use as level separator - default value of `.` works well with   Heroku, but you might want to change it for example for `__` to easy override settings from command line, where using   dots in variable names might not be allowed (eg. Bash)
-* `env_converter` (default: `:downcase`)  - how to process variables names:
-  * `nil` - no change
-  * `:downcase` - convert to lower case
-* `env_parse_values` (default: `true`) - try to parse values to a correct type (`Boolean`, `Integer`, `Float`, `String`)
+- `env_prefix` (default: `const_name`) - load only ENV variables starting with this prefix (case-sensitive)
+- `env_separator` (default: `'.'`) - what string to use as level separator - default value of `.` works well with Heroku, but you might want to change it for example for `__` to easy override settings from command line, where using dots in variable names might not be allowed (eg. Bash)
+- `env_converter` (default: `:downcase`) - how to process variables names:
+  - `nil` - no change
+  - `:downcase` - convert to lower case
+- `env_parse_values` (default: `true`) - try to parse values to a correct type (`Boolean`, `Integer`, `Float`, `String`)
 
 For instance, given the following environment:
 
@@ -492,7 +495,7 @@ For example, the plaintext secret might look like this:
 ```json
 {
   "Settings.foo": "hello",
-  "Settings.bar": "world",
+  "Settings.bar": "world"
 }
 ```
 
@@ -535,10 +538,10 @@ Any and all contributions offered in any form, past present or future are unders
 
 ## Authors
 
-* [Piotr Kuczynski](http://github.com/pkuczynski)
-* [Fred Wu](http://github.com/fredwu)
-* [Jacques Crocker](http://github.com/railsjedi)
-* Inherited from [AppConfig](http://github.com/cjbottaro/app_config) by [Christopher J. Bottaro](http://github.com/cjbottaro)
+- [Piotr Kuczynski](http://github.com/pkuczynski)
+- [Fred Wu](http://github.com/fredwu)
+- [Jacques Crocker](http://github.com/railsjedi)
+- Inherited from [AppConfig](http://github.com/cjbottaro/app_config) by [Christopher J. Bottaro](http://github.com/cjbottaro)
 
 ## Contributors
 

config.gemspec

@@ -37,9 +37,12 @@ Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
 
   # Default RSpec run will test against latest Rails app
   unless ENV['APPRAISAL_INITIALIZED'] || ENV['GITHUB_ACTIONS']
-    gems_to_install = /gem "(.*?)", "(.*?)"(?!, platform: (?!\[:ruby\]))/
-    File.read(Dir['gemfiles/rails*.gemfile'].sort.last).scan(gems_to_install) do |name, version|
-      s.add_development_dependency name, version
+    gems_to_install = /gem "(.*?)", "(.*?)"(?:, platform: \:(.*))?/
+
+    File.read(Dir['gemfiles/rails*.gemfile'].sort.last).scan(gems_to_install) do |name, version, platform|
+      if platform.nil? || platform.to_s == RUBY_ENGINE
+        s.add_development_dependency name, version
+      end
     end
   end
 
@@ -50,5 +53,6 @@ Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
     # Static code analysis to be used locally
     s.add_development_dependency 'mdl', '~> 0.9', '>= 0.9.0'
     s.add_development_dependency 'rubocop', '~> 0.85.0'
+    s.add_development_dependency 'byebug', '~> 11.1.3'
   end
 end

gemfiles/rails_5.2.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "activerecord-jdbcsqlite3-adapter", "~> 52.5", platform: :jruby
 gem "bootsnap", "~> 1.4"
-gem "rails", "5.2.4.3"
+gem "rails", "5.2.5"
 gem "rspec-rails", "~> 3.7"
 gem "sqlite3", "< 1.4.0", platform: :ruby
 

gemfiles/rails_6.0.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "activerecord-jdbcsqlite3-adapter", "~> 60.1", platform: :jruby
 gem "bootsnap", "~> 1.4"
-gem "rails", "6.0.3.1"
+gem "rails", "6.0.3.6"
 gem "rspec-rails", "~> 3.7"
 gem "sqlite3", "~> 1.4.0", platform: :ruby
 

gemfiles/rails_6.1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord-jdbcsqlite3-adapter", "~> 60.1", platform: :jruby
+gem "bootsnap", "~> 1.4"
+gem "rails", "6.1.3.1"
+gem "rspec-rails", "~> 3.7"
+gem "sqlite3", "~> 1.4.0", platform: :ruby
+
+gemspec path: "../"

lib/config.rb

@@ -25,6 +25,7 @@ module Config
     overwrite_arrays: true,
     merge_hash_arrays: false,
     validation_contract: nil,
+    environment: nil,
     evaluate_erb_in_yaml: true
   )
 
@@ -44,7 +45,6 @@ def self.load_files(*files)
     end
 
     config.add_source!(Sources::EnvSource.new(ENV)) if Config.use_env
-
     config.load!
     config
   end

lib/config/integrations/rails/railtie.rb

@@ -9,7 +9,7 @@ def preload
 
           # Parse the settings before any of the initializers
           Config.load_and_set_settings(
-            Config.setting_files(::Rails.root.join('config'), ::Rails.env)
+            Config.setting_files(::Rails.root.join('config'), Config.environment.nil? ? ::Rails.env : Config.environment.to_sym)
           )
         end
 

lib/generators/config/templates/config.rb

@@ -15,6 +15,10 @@
   #
   # config.overwrite_arrays = true
 
+  # Defines current environment, affecting which settings file will be loaded.
+  # Default: `::Rails.env`
+  # config.environment = ENV.fetch('ENVIRONMENT', :development)
+
   # Load environment variables from the `ENV` object and override any settings defined in files.
   #
   # config.use_env = false

spec/app/rails_4.2/config/database.yml

@@ -11,15 +11,15 @@ default: &default
 
 development:
   <<: *default
-  database: <%= Settings.databases.development.database %>
+  database: db/development.sqlite3
 
 # Warning: The database defined as "test" will be erased and
 # re-generated from your development database when you run "rake".
 # Do not set this db to the same as development or production.
 test:
   <<: *default
-  database: <%= Settings.databases.test.database %>
+  database: db/test.sqlite3
 
 production:
   <<: *default
-  database: <%= Settings.databases.production.database %>
+  database: db/production.sqlite3

spec/app/rails_4.2/config/initializers/config.rb

@@ -0,0 +1,8 @@
+# This is how you would initialize the config object
+# when not using the default rails environments
+
+Config.setup do |config|
+  config.environment = 'any_env'
+  config.const_name = 'RailtieSettings'
+  config.env_parse_values = true
+end

spec/app/rails_4.2/config/settings/any_env.yml

@@ -0,0 +1,8 @@
+#
+# An environment file that doesn't follow
+# the default rails environments
+#
+some_api:
+  scheme: https
+  host: some-non-rails-environment
+  path: /some-path

spec/app/rails_5.0/config/initializers/config.rb

@@ -0,0 +1,8 @@
+# This is how you would initialize the config object
+# when not using the default rails environments
+
+Config.setup do |config|
+  config.environment = 'any_env'
+  config.const_name = 'RailtieSettings'
+  config.env_parse_values = true
+end

spec/app/rails_5.0/config/settings/any_env.yml

@@ -0,0 +1,8 @@
+#
+# An environment file that doesn't follow
+# the default rails environments
+#
+some_api:
+  scheme: https
+  host: some-non-rails-environment
+  path: /some-path

spec/app/rails_5.1/config/initializers/config.rb

@@ -0,0 +1,8 @@
+# This is how you would initialize the config object
+# when not using the default rails environments
+
+Config.setup do |config|
+  config.environment = 'any_env'
+  config.const_name = 'RailtieSettings'
+  config.env_parse_values = true
+end

spec/app/rails_5.1/config/settings/any_env.yml

@@ -0,0 +1,8 @@
+#
+# An environment file that doesn't follow
+# the default rails environments
+#
+some_api:
+  scheme: https
+  host: some-non-rails-environment
+  path: /some-path

spec/app/rails_5.2/config/initializers/config.rb

@@ -0,0 +1,8 @@
+# This is how you would initialize the config object
+# when not using the default rails environments
+
+Config.setup do |config|
+  config.environment = 'any_env'
+  config.const_name = 'RailtieSettings'
+  config.env_parse_values = true
+end

spec/app/rails_5.2/config/settings/any_env.yml

@@ -0,0 +1,8 @@
+#
+# An environment file that doesn't follow
+# the default rails environments
+#
+some_api:
+  scheme: https
+  host: some-non-rails-environment
+  path: /some-path

spec/app/rails_6.0/config/initializers/config.rb

@@ -0,0 +1,9 @@
+# This is how you would initialize the config object
+# when not using the default rails environments
+
+Config.setup do |config|
+  config.environment = 'any_env'
+  config.const_name = 'RailtieSettings'
+  config.env_parse_values = true
+end
+

spec/app/rails_6.0/config/settings/any_env.yml

@@ -0,0 +1,8 @@
+#
+# An environment file that doesn't follow
+# the default rails environments
+#
+some_api:
+  scheme: https
+  host: some-non-rails-environment
+  path: /some-path