config 0.0.1 → 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 742d8178dc47ffe14f3633331c1f6ddad2b8e2ff
+  data.tar.gz: 02001b77f2146124b531f0578eaa99362f62ebeb
+SHA512:
+  metadata.gz: c80b416f608bcf7ae0cac1163f26241f4d723bc3034d15967b466ae07eb07c102ac89930154f117189e784f81d2c37a517d337a4b2c3bab976ddef528d4f4a55
+  data.tar.gz: added79d112c09feae7211a5afec99bbda1f75412651dc7df3434242a737ebb79a0eaa5c39346fd2f041eb25ea0ce6427c1ec22ff4ffc5b063d564f079e1496f

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+languages:
+  Ruby: true
+  JavaScript: false
+  PHP: false
+# exclude_paths:
+# - "foo/bar.rb"

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+.rvmrc
+.idea
+.bundle
+gemfiles/*.lock
+log
+pkg
+spec/app/**/db/*.sqlite*
+spec/app/**/log/
+spec/app/**/tmp/
+spec/app/**/.sass-cache
+tmp
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+config

data/.ruby-version

@@ -0,0 +1 @@
+2.1.6

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+matrix:
+  exclude:
+    - rvm: 2.2.2
+      gemfile: gemfiles/rails_3.gemfile
+before_install:
+  - gem install bundler
+script:
+  - bundle exec rspec
+addons:
+  code_climate:
+    repo_token: 88c5452d41835351d037ce45781e2e88b1c0bdc8508ee9722746bac633bba88e

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-3" do
+  gem "rails", "3.2.22"
+end
+
+appraise "rails-4" do
+  gem "rails", "4.0.13"
+end
+
+appraise "rails-4.1" do
+  gem "rails", "4.1.12"
+end
+
+appraise "rails-4.2" do
+  gem "rails", "4.2.3"
+end

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# 0.5.0.beta1
+
+* Ability to use in Settings file keywords reserved for OpenStruct: select, collect ([#95](https://github.com/railsjedi/config/issues/95))
+* Made config work without Rails as a hard dependency ([#86](https://github.com/railsjedi/config/issues/86), [#88](https://github.com/railsjedi/config/issues/88))
+* Fix generate error when .gitignore is missing ([#85](https://github.com/railsjedi/config/issues/85))
+* Fix deprecation warning on File.exists? ([#81](https://github.com/railsjedi/config/issues/81))
+* Add a shortcut method for setting files ([#67](https://github.com/railsjedi/config/issues/67))
+* Improve YAMLSource load error message by outputting offending file path ([#88](https://github.com/railsjedi/config/issues/88))
+
+# 0.4.2
+* Ability to specify the app name when calling the Heroku rake task ([#75](https://github.com/railsjedi/config/issues/75))
+
+# 0.4.1
+
+* Fixed compatibility with Rails 4.1 ([#72](https://github.com/railsjedi/config/issues/72))
+* Testing suite verifies compatibility with Rails 3.2, 4.0 and 4.1
+
+# 0.4.0
+
+* Compatibility with Heroku ([#64](https://github.com/railsjedi/config/issues/64))
+
+# 0.3.4
+
+* Expose Settings in application.rb, so you don't have to duplicate configuration for each environment file ([#59](https://github.com/railsjedi/config/issues/59))
+* Adding support for Rails 4.1.0.rc ([#70](https://github.com/railsjedi/config/issues/70))

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in config.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/LICENSE.md

@@ -0,0 +1,27 @@
+The MIT License (MIT)
+
+Copyright (c) 2010-2014 Jacques Crocker, Fred Wu, Piotr Kuczynski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+Third-party materials and licenses:
+
+* Config contains Deep Merge (deep_merge.rb) which is governed by the MIT license
+  Copyright (C) 2008 Steve Midgley

data/README.md

@@ -0,0 +1,315 @@
+[![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)
+[![Code Climate](https://codeclimate.com/github/railsconfig/config/badges/gpa.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.
+
+## Features
+
+- simple YAML config files
+- config files support ERB
+- config files support inheritance
+- access config information via convenient object member notation
+
+## Compatibility
+
+- Ruby 2.x
+- Rails 3.x and 4.x
+- Padrino
+- Sinatra
+
+For older versions of Rails and other Ruby apps, use [AppConfig](http://github.com/fredwu/app_config).
+
+## Installing on Rails 3 or 4
+
+Add this to your `Gemfile`:
+
+```ruby
+gem "config"
+```
+
+If you want to use Settings before rails application initialization process you can load Config railtie manually:
+
+```ruby
+module Appname
+  class Application < Rails::Application
+
+    Bundler.require(*Rails.groups)
+    Config::Integration::Rails::Railtie.preload
+
+    # ...
+
+    config.time_zone = Settings.time_zone
+
+    # ...
+
+  end
+end
+```
+
+## Installing on Padrino
+
+Add this to your `Gemfile`:
+
+```ruby
+gem "config"
+```
+
+in your app.rb, you'll also need to register Config
+
+```ruby
+register Config
+```
+
+## Installing on Sinatra
+
+Add this to your `Gemfile`:
+
+```ruby
+gem "config"
+```
+
+in your app, you'll need to register Config. You'll also need to give it a root so it can find the config files.
+
+```ruby
+set :root, File.dirname(__FILE__)
+register Config
+```
+
+It's also possible to initialize it manually within your configure block if you want to just give it some yml paths to load from.
+
+```ruby
+Config.load_and_set_settings("/path/to/yaml1", "/path/to/yaml2", ...)
+```
+
+## Customizing Config
+
+You may customize the behavior of Config by generating an initializer file:
+
+    rails g config:install
+
+This will generate `config/initializers/config.rb` with a set of default settings as well as to generate a set of default settings files:
+
+    config/settings.yml
+    config/settings/development.yml
+    config/settings/production.yml
+    config/settings/test.yml
+
+## Accessing the Settings object
+
+After installing this plugin, the `Settings` object will be available globally. Entries are accessed via object member notation:
+
+```ruby
+Settings.my_config_entry
+```
+
+Nested entries are supported:
+
+```ruby
+Settings.my_section.some_entry
+```
+
+Alternatively, you can also use the `[]` operator if you don't know which exact setting you need to access ahead of time.
+
+```ruby
+# All the following are equivalent to Settings.my_section.some_entry
+Settings.my_section[:some_entry]
+Settings.my_section['some_entry']
+Settings[:my_section][:some_entry]
+```
+
+If you have set a different constant name for the object in the initializer file, use that instead.
+
+## Common config file
+
+Config entries are compiled from:
+
+    config/settings.yml
+    config/settings/#{environment}.yml
+    config/environments/#{environment}.yml
+
+    config/settings.local.yml
+    config/settings/#{environment}.local.yml
+    config/environments/#{environment}.local.yml
+
+Settings defined in files that are lower in the list override settings higher.
+
+### Reloading settings
+
+You can reload the Settings object at any time by running `Settings.reload!`.
+
+### Reloading settings and config files
+
+You can also reload the `Settings` object from different config files at runtime.
+
+For example, in your tests if you want to test the production settings, you can:
+
+```ruby
+Rails.env = "production"
+Settings.reload_from_files(
+  Rails.root.join("config", "settings.yml").to_s,
+  Rails.root.join("config", "settings", "#{Rails.env}.yml").to_s,
+  Rails.root.join("config", "environments", "#{Rails.env}.yml").to_s
+)
+```
+
+### Environment specific config files
+
+You can have environment specific config files. Environment specific config entries take precedence over common config entries.
+
+Example development environment config file:
+
+```ruby
+#{Rails.root}/config/environments/development.yml
+```
+
+Example production environment config file:
+
+```ruby
+#{Rails.root}/config/environments/production.yml
+```
+
+### Developer specific config files
+
+If you want to have local settings, specific to your machine or development environment,
+you can use the following files, which are automatically `.gitignored` :
+
+```ruby
+Rails.root.join("config", "settings.local.yml").to_s,
+Rails.root.join("config", "settings", "#{Rails.env}.local.yml").to_s,
+Rails.root.join("config", "environments", "#{Rails.env}.local.yml").to_s
+```
+
+### Adding sources at Runtime
+
+You can add new YAML config files at runtime. Just use:
+
+```ruby
+Settings.add_source!("/path/to/source.yml")
+Settings.reload!
+```
+
+This will use the given source.yml file and use its settings to overwrite any previous ones.
+
+On the other hand, you can prepend a YML file to the list of configuration files:
+
+```ruby
+Settings.prepend_source!("/path/to/source.yml")
+Settings.reload!
+```
+
+This will do the same as `add_source`, but the given YML file will be loaded first (instead of last) and its settings will be overwritten by any other configuration file.
+This is especially useful if you want to define defaults.
+
+One thing I like to do for my Rails projects is provide a local.yml config file that is .gitignored (so its independent per developer). Then I create a new initializer in `config/initializers/add_local_config.rb` with the contents
+
+```ruby
+Settings.add_source!("#{Rails.root}/config/settings/local.yml")
+Settings.reload!
+```
+
+> Note: this is an example usage, it is easier to just use the default local files `settings.local.yml, settings/#{Rails.env}.local.yml and environments/#{Rails.env}.local.yml` for your developer specific settings.
+
+## Embedded Ruby (ERB)
+
+Embedded Ruby is allowed in the configuration files. See examples below.
+
+## Accessing Configuration Settings
+
+Consider the two following config files.
+
+* ```#{Rails.root}/config/settings.yml```
+```yaml
+size: 1
+server: google.com
+```
+
+* ```#{Rails.root}/config/environments/development.yml```
+```yaml
+size: 2
+computed: <%= 1 + 2 + 3 %>
+section:
+  size: 3
+  servers: [ {name: yahoo.com}, {name: amazon.com} ]
+```
+
+Notice that the environment specific config entries overwrite the common entries.
+
+```ruby
+Settings.size   # => 2
+Settings.server # => google.com
+```
+
+Notice the embedded Ruby.
+
+```ruby
+Settings.computed # => 6
+```
+
+Notice that object member notation is maintained even in nested entries.
+
+```ruby
+Settings.section.size # => 3
+```
+
+Notice array notation and object member notation is maintained.
+
+```ruby
+Settings.section.servers[0].name # => yahoo.com
+Settings.section.servers[1].name # => amazon.com
+```
+
+## Working with Heroku
+
+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.
+
+To use config with Heroku just set the `use_env` var to `true` in your `config/initializers/config.rb` file. Eg:
+
+```ruby
+Config.setup do |config|
+  config.const_name = 'AppSettings'
+  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:
+
+```ruby
+ENV['AppSettings.section.size'] = 1
+ENV['AppSettings.section.server'] = 'google.com'
+```
+
+It won't work with arrays, though.
+
+To upload your local values to Heroku you could ran `bundle exec rake config:heroku`.
+
+## Contributing
+
+Bootstrap
+
+```bash
+$ appraisal install
+```
+
+Running the test suite
+
+```bash
+$ appraisal rspec
+```
+
+## Authors
+
+* [Jacques Crocker](http://github.com/railsjedi)
+- [Fred Wu](http://github.com/fredwu)
+* [Piotr Kuczynski](http://github.com/pkuczynski)
+- Inherited from [AppConfig](http://github.com/cjbottaro/app_config) by [Christopher J. Bottaro](http://github.com/cjbottaro)
+
+## License
+
+Config is released under the [MIT License](http://www.opensource.org/licenses/MIT).