config 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d41f995d1fd8d3aee4387a3cb11760b1441bebaa
-  data.tar.gz: cfcf41a24aad2faf1f0dfd624084bfcc7a27e173
+  metadata.gz: 33b69a268cf5f3283b1d14ea01b4345fbd6433ef
+  data.tar.gz: 4ad2fb585182fd398877f53974bba1244eae8bea
 SHA512:
-  metadata.gz: 4ebe8a4086d0f1b2ab535bb580ef8abd256806bab29108cb1caff44750364b3c4cadbb36502eb1b418411970a1496da37cf1dd16329b9237cc2c9578c820a3c3
-  data.tar.gz: ec664ab9191b81f8d44f59f4e60a79e3bf2505b556be7cfaf4209ccbb9ba8574ff02c6afa14ecf3c140ee14a5a336547ba42e753cc2a49eec1d167dc0809e670
+  metadata.gz: a92ef95bc9265fcd182d29cffd3f37e2bd71f3b0e3d8ca4d0f540f62389c4aaab2fbddd4ba15b45fd11c782c9ed3836eabe35927c3ceb3bd54abdf4d616cb1cc
+  data.tar.gz: 58568bb221dd00b41b8b5305510c763bf1610b63e7904a41e38ef1b5305c79e9ca0cbb49f3177bbb33c8107075314e5349d1ebd9d26e3fe1b15810c71b46057e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.2.0
+
+* Add ability to load settings from ENV variables ([#108](https://github.com/railsconfig/config/issues/108) thanks @vinceve and @spalladino)
+* Removed Rails 5 deprecation warnings for prepend_before_filter ([#141](https://github.com/railsconfig/config/pull/141)
+
 ## 1.1.1
 
 * Downgrade minimum ruby version to 2.0.0 ([#136](https://github.com/railsconfig/config/issues/136))

data/LICENSE.md

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+# The MIT License (MIT)
 
 Copyright (c) 2010-2014 Jacques Crocker, Fred Wu, Piotr Kuczynski
 

data/README.md

@@ -1,3 +1,5 @@
+# Config
+
 [![Build Status](https://api.travis-ci.org/railsconfig/config.svg?branch=master)](http://travis-ci.org/railsconfig/config)
 [![Gem Version](https://badge.fury.io/rb/config.svg)](http://badge.fury.io/rb/config)
 [![Dependency Status](https://gemnasium.com/railsconfig/config.svg)](https://gemnasium.com/railsconfig/config)
@@ -5,8 +7,6 @@
 [![Issue Count](https://codeclimate.com/github/railsconfig/config/badges/issue_count.svg)](https://codeclimate.com/github/railsconfig/config)
 [![Test Coverage](https://codeclimate.com/github/railsconfig/config/badges/coverage.svg)](https://codeclimate.com/github/railsconfig/config/coverage)
 
-# Config
-
 ## Summary
 
 Config helps you easily manage environment specific settings in an easy and usable manner.
@@ -23,7 +23,7 @@ Config helps you easily manage environment specific settings in an easy and usab
 ## Compatibility
 
 * Ruby `2.x`
-* Rails `>= 3.1` and `4`
+* Rails `>= 3.1`, `4` and `5`
 * Padrino
 * Sinatra
 
@@ -31,7 +31,7 @@ For older versions of Rails or Ruby use [AppConfig](http://github.com/fredwu/app
 
 ## Installing
 
-### Installing on Rails 3 or 4
+### Installing on Rails 3, 4 or 5
 
 Add `gem 'config'` to your `Gemfile` and run `bundle install` to install it. Then run
 
@@ -252,51 +252,102 @@ Settings.section.servers[1].name # => amazon.com
 
 ## Configuration
 
-You can customize `Config` only once, preferably during application initialization phase:
+There are multiple configuration options available, however you can customize `Config` only once, preferably during
+application initialization phase:
 
 ```ruby
 Config.setup do |config|
   config.const_name = 'Settings'
-  config.knockout_prefix = nil
+  ...
 end
 ```
 
-After installing `Config` in Rails, you will find this configuration at `config/initializers/config.rb`.
+After installing `Config` in Rails, you will find automatically generated file that contains default configuration
+located at `config/initializers/config.rb`.
 
-Following options are available:
+### General
 
 * `const_name` - name of the object holing you settings. Default: `'Settings'`
 
-Inheritance customization (check [Deep Merge](https://github.com/danielsdeleo/deep_merge) for more details):
+### Merge customization
 
 * `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Default: `nil`
 
-## Working with Heroku
+Check [Deep Merge](https://github.com/danielsdeleo/deep_merge) for more details.
 
-Heroku uses ENV object to store sensitive settings which are like the local files described above. You cannot upload
-such files to Heroku because it's ephemeral filesystem gets recreated from the git sources on each instance refresh.
+### Environment variables
 
-To use config with Heroku just set the `use_env` var to `true` in your `config/initializers/config.rb` file. Eg:
+See section below for more details.
+
+## Working with environment variables
+
+To load environment variables from the `ENV` object, that will override any settings defined in files, set the `use_env`
+to true in your `config/initializers/config.rb` file:
 
 ```ruby
 Config.setup do |config|
-  config.const_name = 'AppSettings'
+  config.const_name = 'Settings'
   config.use_env = true
 end
 ```
 
 Now config would read values from the ENV object to the settings. For the example above it would look for keys starting
-with 'AppSettings'. Eg:
+with `Settings`:
 
 ```ruby
-ENV['AppSettings.section.size'] = 1
-ENV['AppSettings.section.server'] = 'google.com'
+ENV['Settings.section.size'] = 1
+ENV['Settings.section.server'] = 'google.com'
 ```
 
 It won't work with arrays, though.
 
+### Working with Heroku
+
+Heroku uses ENV object to store sensitive settings. You cannot upload such files to Heroku because it's ephemeral
+filesystem gets recreated from the git sources on each instance refresh. To use config with Heroku just set the
+`use_env` var to `true` as mentioned above.
+
 To upload your local values to Heroku you could ran `bundle exec rake config:heroku`.
 
+### Fine-tuning
+
+You can customize how environment variables are processed:
+
+* `env_prefix` - which variables to load into config
+* `env_separator` - what string to use as level separator instead of dots - 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` - how to process variables names:
+  * `nil` - no change
+  * `:downcase` - convert to lower case
+* `env_parse_values` - parse numeric values as integers instead of strings
+
+For instance, given the following environment:
+
+```bash
+SETTINGS__SECTION__SERVER_SIZE=1
+SETTINGS__SECTION__SERVER=google.com
+```
+
+And the following configuration:
+
+```ruby
+Config.setup do |config|
+  config.use_env = true
+  config.env_prefix = 'Settings'
+  config.env_separator = '__'
+  config.env_converter = :downcase
+  config.env_parse_values = true
+end
+```
+
+The following settings will be available:
+
+```ruby
+Settings.section.server_size # => 1
+Settings.section.server # => 'google.com'
+```
+
 ## Contributing
 
 Bootstrap
@@ -319,8 +370,8 @@ mdl --style .mdlstyle.rb *.md
 
 ## Authors
 
-* [Fred Wu](http://github.com/fredwu)
 * [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)
 

data/config.gemspec

@@ -1,50 +1,48 @@
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 
 # Maintain your gem's version:
 require 'config/version'
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name             = "config"
+  s.name             = 'config'
   s.version          = Config::VERSION
   s.date             = Time.now.strftime '%F'
-  s.authors          = ["Jacques Crocker", "Fred Wu", "Piotr Kuczynski"]
-  s.email            = ["railsjedi@gmail.com", "ifredwu@gmail.com", "piotr.kuczynski@gmail.com"]
-  s.summary          = "Effortless multi-environment settings in Rails, Sinatra, Pandrino and others"
-  s.description      = "Easiest way to manage multi-environment settings in any ruby project or framework: Rails, Sinatra, Pandrino and others"
-  s.homepage         = "https://github.com/railsconfig/config"
-  s.license          = "MIT"
-  s.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE.md"]
-  s.rdoc_options     = ["--charset=UTF-8"]
+  s.authors          = ['Piotr Kuczynski', 'Fred Wu', 'Jacques Crocker']
+  s.email            = %w(piotr.kuczynski@gmail.com ifredwu@gmail.com railsjedi@gmail.com)
+  s.summary          = 'Effortless multi-environment settings in Rails, Sinatra, Pandrino and others'
+  s.description      = 'Easiest way to manage multi-environment settings in any ruby project or framework: Rails, Sinatra, Pandrino and others'
+  s.homepage         = 'https://github.com/railsconfig/config'
+  s.license          = 'MIT'
+  s.extra_rdoc_files = %w(README.md CHANGELOG.md LICENSE.md)
+  s.rdoc_options     = ['--charset=UTF-8']
 
   s.files = `git ls-files`.split($/)
   s.files.select! { |file| /(^lib\/|\.md$|\.gemspec$)/ =~ file }
-  s.files += Dir.glob("doc/**/*")
+  s.files += Dir.glob('doc/**/*')
 
-  s.require_paths         = ["lib"]
-  s.required_ruby_version = ">= 2.0.0"
+  s.require_paths         = ['lib']
+  s.required_ruby_version = '>= 2.0.0'
 
-  s.add_dependency "activesupport",           ">= 3.0"
-  s.add_dependency "deep_merge",              "~> 1.0.1"
+  s.add_dependency 'activesupport',           '>= 3.0'
+  s.add_dependency 'deep_merge',              '~> 1.0',   '>= 1.0.1'
 
-  s.add_development_dependency "bundler",     "~> 1.11.2"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rdoc"
-  s.add_development_dependency "pry"
+  s.add_development_dependency 'bundler',     '~> 1.11',  '>= 1.11.2'
+  s.add_development_dependency 'rake',        '~> 11.1',  '>= 11.1.2'
 
   # Testing
-  s.add_development_dependency "appraisal",   "~> 2.1.0"
-  s.add_development_dependency "rails",       "~> 4.2.6"
-  s.add_development_dependency "rspec",       "~> 3.4.0"
-  s.add_development_dependency "rspec-rails", "~> 3.4.2"
-  s.add_development_dependency "test-unit",   "~> 3.1.7"
-  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'appraisal',   '~> 2.1',   '>= 2.1.0'
+  s.add_development_dependency 'rails',       '~> 4.2',   '>= 4.2.6'
+  s.add_development_dependency 'rspec',       '~> 3.4',   '>= 3.4.0'
+  s.add_development_dependency 'rspec-rails', '~> 3.4',   '>= 3.4.2'
+  s.add_development_dependency 'test-unit',   '~> 3.1',   '>= 3.1.7'
+  s.add_development_dependency 'sqlite3',     '~> 1.3',   '>= 1.3.11'
 
   # Static code analysis
-  s.add_development_dependency "mdl"
-  s.add_development_dependency "rubocop"
+  s.add_development_dependency 'mdl',         '~> 0.3',   '>= 0.3.1'
+  s.add_development_dependency 'rubocop',     '~> 0.40',  '>= 0.40.0'
 
   if ENV['TRAVIS']
-    s.add_development_dependency "codeclimate-test-reporter"
+    s.add_development_dependency 'codeclimate-test-reporter'
   end
 end

data/lib/config.rb

@@ -11,9 +11,13 @@ module Config
   # Ensures the setup only gets run once
   @@_ran_once = false
 
-  mattr_accessor :const_name, :use_env
-  @@const_name = "Settings"
+  mattr_accessor :const_name, :use_env, :env_prefix, :env_separator, :env_converter, :env_parse_values
+  @@const_name = 'Settings'
   @@use_env    = false
+  @@env_prefix = @@const_name
+  @@env_separator = '.'
+  @@env_converter = nil
+  @@env_parse_values = false
 
   # deep_merge options
   mattr_accessor :knockout_prefix

data/lib/config/integrations/rails/railtie.rb

@@ -25,7 +25,11 @@ module Config
           if ::Rails.env.development?
             initializer :config_reload_on_development do
               ActionController::Base.class_eval do
-                prepend_before_filter { ::Config.reload! }
+                if ::Rails::VERSION::MAJOR >= 4
+                  prepend_before_action { ::Config.reload! }
+                else
+                  prepend_before_filter { ::Config.reload! }
+                end
               end
             end
           end

data/lib/config/options.rb

@@ -31,15 +31,21 @@ module Config
       return self if ENV.nil? || ENV.empty?
       conf = Hash.new
       ENV.each do |key, value|
-        next unless key.to_s.index(Config.const_name) == 0
-        hash = value
-        key.to_s.split('.').reverse.each do |element|
+        next unless key.to_s.index(Config.env_prefix || Config.const_name) == 0
+        hash = Config.env_parse_values ? __value(value) : value
+        key.to_s.split(Config.env_separator).reverse[0...-1].each do |element|
+          element = case Config.env_converter
+          when :downcase then element.downcase
+          when nil then element
+          else raise "Invalid env converter: #{Config.env_converter}"
+          end
+
           hash = {element => hash}
         end
         DeepMerge.deep_merge!(hash, conf, :preserve_unmergeables => false)
       end
 
-      merge!(conf[Config.const_name] || {})
+      merge!(conf)
     end
 
     alias :load_env! :reload_env!
@@ -158,5 +164,10 @@ module Config
       end
       s
     end
+
+    # Return an integer if it looks like one
+    def __value(v)
+      Integer(v) rescue v
+    end
   end
 end

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/generators/config/templates/config.rb

@@ -1,7 +1,32 @@
 Config.setup do |config|
-  # Name of the constat exposing loaded settings
+  # Name of the constant exposing loaded settings
   config.const_name = 'Settings'
 
-  # Ability to remove elements of the array set in earlier loaded settings file. Default: nil
-  # config.knockout_prefix = '--'
+  # Ability to remove elements of the array set in earlier loaded settings file. For example value: '--'.
+  #
+  # config.knockout_prefix = nil
+
+  # Load environment variables from the `ENV` object and override any settings defined in files.
+  #
+  # config.use_env = false
+
+  # Define ENV variable prefix deciding which variables to load into config.
+  #
+  # config.env_prefix = 'Settings'
+
+  # What string to use as level separator for settings loaded from ENV variables. 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).
+  #
+  # config.env_separator = '.'
+
+  # Ability to process variables names:
+  #   * nil  - no change
+  #   * :downcase - convert to lower case
+  #
+  # config.env_converter = nil
+
+  # Parse numeric values as integers instead of strings.
+  #
+  # config.env_parse_values = false
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
-- Jacques Crocker
-- Fred Wu
 - Piotr Kuczynski
+- Fred Wu
+- Jacques Crocker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,6 +31,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
@@ -38,6 +41,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
@@ -45,6 +51,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.2
   type: :development
@@ -52,55 +61,39 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: '11.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.1.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
@@ -108,6 +101,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
@@ -115,6 +111,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.6
   type: :development
@@ -122,6 +121,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.6
 - !ruby/object:Gem::Dependency
@@ -129,6 +131,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
@@ -136,6 +141,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
@@ -143,6 +151,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.2
   type: :development
@@ -150,6 +161,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.2
 - !ruby/object:Gem::Dependency
@@ -157,6 +171,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.7
   type: :development
@@ -164,56 +181,77 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.7
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.11
 - !ruby/object:Gem::Dependency
   name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
 description: 'Easiest way to manage multi-environment settings in any ruby project
   or framework: Rails, Sinatra, Pandrino and others'
 email:
-- railsjedi@gmail.com
-- ifredwu@gmail.com
 - piotr.kuczynski@gmail.com
+- ifredwu@gmail.com
+- railsjedi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: