nifty_settings 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d69c55980e686ed5ccc21d0d8fd7de395167016c
-  data.tar.gz: a4c73431de6fe4842197714100f6c2de742506ce
+  metadata.gz: 8c4cd283e57e135e322311d816dee8a29df9da4b
+  data.tar.gz: a354ba55bb47ad7b8d6915e820e87a6a2d5ca36a
 SHA512:
-  metadata.gz: e98c48636bb4061f903d5c5bed4094125b55e21de576cd754f47e90cb1ccd0a730d2e47ea8f159d513c102db987aa7fe00227ad02b9ff55ace828a1bfe068b6e
-  data.tar.gz: 739d7a10134c442bc00b3bec378d36725a3ca93111ec42271fa71051fcbb98e056c7816450600da16cd5bc97c803a0f1f4ed86392e376ef40fe0174bef3ca61a
+  metadata.gz: e16f56f7ada98619ec65977970c94e607f1bf910442a5a085f6e35528ec315adc48513077bb1e4d9c30d0f512f3f5bae7016f38a038e63c35ca74ccc801d8820
+  data.tar.gz: 3d3ce608e8d4664b7cb218f8902bc05ef252645206e8a48f6b85bfe456f62fc8c9f4e436f6840aab43233f8296ee52fc7b8276999be5a422df772bbc4bb07979

data/README.md

@@ -4,3 +4,100 @@
 [![Build Status](https://secure.travis-ci.org/krautcomputing/nifty_settings.png)](http://travis-ci.org/krautcomputing/nifty_settings)
 [![Dependency Status](https://gemnasium.com/krautcomputing/nifty_settings.png)](https://gemnasium.com/krautcomputing/nifty_settings)
 [![Code Climate](https://codeclimate.com/github/krautcomputing/nifty_settings.png)](https://codeclimate.com/github/krautcomputing/nifty_settings)
+
+A nifty way to save and access application-wide settings. Great for managing different configurations for different Rails/Rack environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nifty_settings'
+```
+
+Add your settings in YAML format to `config/settings.yml`
+
+## Usage
+
+Let's say we have the following settings file:
+
+```yaml
+default:
+  some_service:
+    use_live?: false
+
+development:
+  foo: bar_dev
+  wibble:
+    wobble: wubble
+  some_collection:
+    - first
+    - second
+
+test:
+  foo: bar_test
+
+production:
+  foo: bar
+  some_service:
+    use_live?: true
+    key: my_secret_key
+    timeout: 20
+```
+
+We can access the settings by using `Settings.key_name`. A combination of default values and environment specific settings can be used. NiftySettings will use the correct setting based on your current environment.
+
+Let's use the above settings in a development environment:
+
+```ruby
+=> Settings.foo
+"bar_dev"
+=> Settings.some_collection
+["first", "second"]
+```
+
+Settings can be nested:
+
+```ruby
+=> Settings.wibble.wobble
+"wubble"
+```
+
+If a setting isn't defined for the current environment, it will fall back to the default value:
+
+```ruby
+=> Settings.some_service.use_live?
+false
+```
+
+And if the setting doesn't exist at all, it just returns `nil`:
+
+```ruby
+=> Settings.fizzbuzz
+nil
+```
+
+Using the same settings in a production environment, it picks up the environment specific settings:
+
+```ruby
+=> Settings.foo
+"bar"
+=> Settings.some_service.use_live?
+true
+=> Settings.some_service.timeout
+20
+```
+
+## Configuration
+
+### Specify configuration file
+
+By default NiftySettings looks for settings in `config/settings.yml`, but this can be changed by setting the path in an initializer.
+
+```ruby
+Settings.settings_path = '/home/shared/other_settings.yml'
+```
+
+### Namespacing
+
+During initialization, NiftySettings checks if there already is a `Settings` module. If it finds one (e.g. if you have a Rails model called `Settings`), NiftySettings doesn't touch it and your settings are available as `NiftySettings::Settings` in your application. If a `Settings` module is not found, `NiftySettings` uses it and you can access your Settings as `Settings`.

data/lib/nifty_settings/settings.rb

@@ -162,10 +162,13 @@ unless Hash.new.respond_to?(:deep_merge)
       self.dup.tap do |this_hash|
         other_hash.each_pair do |k, v|
           tv = this_hash[k]
-          if tv.is_a?(Hash) && v.is_a?(Hash)
-            this_hash[k] = tv.deep_merge(v, &block)
+          this_hash[k] = case
+          when tv.is_a?(Hash) && v.is_a?(Hash)
+            tv.deep_merge(v, &block)
+          when block_given? && tv
+            block.call(k, tv, v)
           else
-            this_hash[k] = block && tv ? block.call(k, tv, v) : v
+            v
           end
         end
       end

data/lib/nifty_settings/version.rb

@@ -1,3 +1,3 @@
 module NiftySettings
-  VERSION = '1.1.6'
+  VERSION = '1.1.7'
 end

data/nifty_settings.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |gem|
   gem.platform      = Gem::Platform::RUBY
   gem.author        = 'Manuel Meurer'
   gem.email         = 'manuel@krautcomputing.com'
-  gem.summary       = 'Settings'
-  gem.description   = 'Settings'
-  gem.homepage      = 'http://krautcomputing.github.io/nifty_settings'
+  gem.summary       = 'A nifty way to save and access application-wide settings.'
+  gem.description   = 'A nifty way to save and access application-wide settings.'
+  gem.homepage      = 'http://krautcomputing.github.io/nifty_settings/'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)

data/spec/nifty_settings/settings_spec.rb

@@ -87,33 +87,42 @@ describe NiftySettings::Settings do
   end
 
   describe '.load_from_file' do
-    it 'loads the settings from the default location' do
-      # Reset settings path in case it has been modified
-      NiftySettings::Settings.settings_path = nil
+    context 'without Rails and RACK_ENV' do
+      before do
+        # Make sure `ENV['RACK_ENV']` is not set and Rails is not loaded
+        # so that the loaded settings are not scoped to the env
+        ENV['RACK_ENV'] = nil
+        raise 'Rails should not be loaded.' if defined?(Rails)
+      end
 
-      # Copy settings file to default location
-      settings_file = File.expand_path('../../support/settings.yml', __FILE__)
-      config_dir    = File.expand_path('../../../config', __FILE__)
-      FileUtils.mkdir_p config_dir
-      FileUtils.cp settings_file, config_dir
+      it 'loads the settings from the default location' do
+        # Reset settings path in case it has been modified
+        NiftySettings::Settings.settings_path = nil
 
-      settings = NiftySettings::Settings.load_from_file
-      expect(settings).to eq('foo' => 'bar')
+        # Copy settings file to default location
+        settings_file         = File.expand_path('../../support/settings.yml', __FILE__)
+        default_settings_file = File.expand_path('../../../config/settings.yml', __FILE__)
+        FileUtils.mkdir_p File.dirname(default_settings_file)
+        FileUtils.cp settings_file, default_settings_file
 
-      # Delete settings file again
-      FileUtils.rm File.join(config_dir, 'settings.yml')
-    end
+        settings = NiftySettings::Settings.load_from_file
+        expect(settings).to eq('foo' => 'bar')
 
-    it 'can load the settings from a custom location' do
-      NiftySettings::Settings.settings_path = File.expand_path('../../support/settings.yml', __FILE__)
-      settings = NiftySettings::Settings.load_from_file
-      expect(settings).to eq('foo' => 'bar')
-    end
+        # Delete settings file again
+        FileUtils.rm default_settings_file
+      end
 
-    it 'can load empty settings' do
-      NiftySettings::Settings.settings_path = File.expand_path('../../support/settings_empty.yml', __FILE__)
-      settings = NiftySettings::Settings.load_from_file
-      expect(settings).to eq({})
+      it 'can load the settings from a custom location' do
+        NiftySettings::Settings.settings_path = File.expand_path('../../support/settings.yml', __FILE__)
+        settings = NiftySettings::Settings.load_from_file
+        expect(settings).to eq('foo' => 'bar')
+      end
+
+      it 'can load empty settings' do
+        NiftySettings::Settings.settings_path = File.expand_path('../../support/settings_empty.yml', __FILE__)
+        settings = NiftySettings::Settings.load_from_file
+        expect(settings).to eq({})
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nifty_settings
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
-description: Settings
+description: A nifty way to save and access application-wide settings.
 email: manuel@krautcomputing.com
 executables: []
 extensions: []
@@ -79,6 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/.gitkeep
 - lib/nifty_settings.rb
 - lib/nifty_settings/railtie.rb
 - lib/nifty_settings/settings.rb
@@ -88,7 +89,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/settings.yml
 - spec/support/settings_empty.yml
-homepage: http://krautcomputing.github.io/nifty_settings
+homepage: http://krautcomputing.github.io/nifty_settings/
 licenses:
 - MIT
 metadata: {}
@@ -111,7 +112,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Settings
+summary: A nifty way to save and access application-wide settings.
 test_files:
 - spec/nifty_settings/settings_spec.rb
 - spec/spec_helper.rb