nifty_settings 1.1.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c4cd283e57e135e322311d816dee8a29df9da4b
-  data.tar.gz: a354ba55bb47ad7b8d6915e820e87a6a2d5ca36a
+  metadata.gz: d295420005dfbdfaa51b187c0b0fd2586c036fee
+  data.tar.gz: 8dd9664844c4074cb72b7ef44e12af70c699c316
 SHA512:
-  metadata.gz: e16f56f7ada98619ec65977970c94e607f1bf910442a5a085f6e35528ec315adc48513077bb1e4d9c30d0f512f3f5bae7016f38a038e63c35ca74ccc801d8820
-  data.tar.gz: 3d3ce608e8d4664b7cb218f8902bc05ef252645206e8a48f6b85bfe456f62fc8c9f4e436f6840aab43233f8296ee52fc7b8276999be5a422df772bbc4bb07979
+  metadata.gz: abf8e34f7edb80a87c94a04fda3b3a7d42f9ce00e362ec3cfb24ef79ae497daeaf5566a962de1303959731f03b338c56561dad64cb1af7c3e69ee43e790f5bde
+  data.tar.gz: 1f5748a556ecae8c4f58da8cf20f58734e268c3705e8d3c18049b277ca1b2fd68b7722f60e8062e68322f36ee5667227c1fd1ef21e497af6853f240c813cd74e

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 1.9
   - 2.0
   - 2.1
+  - 2.2
   - jruby

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-# 1.1.6 - 2014-07-15
+# 2.0.0
+
+* Drop support for Ruby 1.9
+* Add support for loading files from settings dir
+
+# 1.1.7
+
+* Fix merging env settings
+
+# 1.1.6
 
 * Enable setting a custom settings file path via `NiftySettings::Settings.settings_path = '...'`
 * Don't throw an exception when settings file is empty

data/README.md

@@ -90,12 +90,15 @@ true
 
 ## Configuration
 
-### Specify configuration file
+### File locations
 
-By default NiftySettings looks for settings in `config/settings.yml`, but this can be changed by setting the path in an initializer.
+NiftySettings loads settings from a default file (`config/settings.yml`) and all YAML files in a default folder (`config/settings/*.yml`). This allows you to put simple settings in the default file but group related settings in dedicated files in the default folder.
+
+Both locations can be customized:
 
 ```ruby
-Settings.settings_path = '/home/shared/other_settings.yml'
+NiftySettings.configuration.settings_file = '/home/shared/other_settings.yml'
+NiftySettings.configuration.settings_folder = Rails.root.join('config', 'my_settings')
 ```
 
 ### Namespacing

data/lib/nifty_settings.rb

@@ -1,4 +1,12 @@
+require 'gem_config'
+
 module NiftySettings
+  include GemConfig::Base
+
+  with_configuration do
+    has :settings_file, classes: [String, Pathname]
+    has :settings_dir, classes: [String, Pathname]
+  end
 end
 
 require 'nifty_settings/version'

data/lib/nifty_settings/settings.rb

@@ -53,7 +53,7 @@ module NiftySettings
     end
     alias_method :nil?, :empty?
 
-    def method_missing(name, *args, &blk)
+    def method_missing(name, *args, &block)
       name = name.to_s
       key, modifier = name[0..-2], name[-1, 1]
       case
@@ -63,56 +63,53 @@ module NiftySettings
       end
     end
 
-    def respond_to?(name, key = false)
+    def respond_to?(name, include_all = false)
       true
     end
 
     class << self
-      def setup(value = nil, &blk)
-        @@setup_callback = (blk || value)
-      end
-
-      def settings_path
-        @@settings_path ||= root.join('config', 'settings.yml').to_s
-      end
+      def load
+        files = []
 
-      def settings_path=(value)
-        @@settings_path = value
-      end
+        settings_file = NiftySettings.configuration.settings_file || self.root.join('config', 'settings.yml')
+        if File.file?(settings_file)
+          files << settings_file
+        end
 
-      def load_from_file
-        if !File.readable?(settings_path)
-          $stderr.puts "Unable to load settings from #{settings_path} - Please check it exists and is readable."
-          return {}
+        settings_dir = NiftySettings.configuration.settings_dir || self.root.join('config', 'settings')
+        if File.directory?(settings_dir)
+          files.concat Dir[File.join(settings_dir, '*.yml')]
         end
-        # Otherwise, try loading...
-        contents = File.read(settings_path)
-        contents = ERB.new(contents).result
-        contents = YAML.load(contents) || {}
-        if env.nil?
-          contents
-        else
-          (contents['default'] || {}).deep_merge(contents[env] || {})
+
+        return {} if files.empty?
+
+        files.inject({}) do |hash, file|
+          contents = File.read(file)
+          contents = ERB.new(contents).result
+          contents = YAML.load(contents) || {}
+          if env
+            contents = (contents['default'] || {}).deep_merge(contents[env] || {})
+          end
+          hash.deep_merge contents
         end
       end
 
       def default
-        @@default ||= new(load_from_file)
+        @@default ||= self.new(self.load)
       end
 
       def reset!
         @@default = nil
         default # Force us to reload the settings
         # If a setup block is defined, call it post configuration.
-        @setup_callback.call if defined?(@setup_callback) && @setup_callback
         true
       end
 
-      def method_missing(name, *args, &blk)
-        default.send(name, *args, &blk)
+      def method_missing(name, *args, &block)
+        default.send(name, *args, &block)
       end
 
-      def respond_to?(name, key = false)
+      def respond_to?(name, include_all = false)
         true
       end
 

data/lib/nifty_settings/version.rb

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

data/nifty_settings.gemspec

@@ -19,15 +19,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r(^(test|spec|features)/))
   gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
-  gem.add_development_dependency 'rb-fsevent', '~> 0.9.0'
-  if RUBY_VERSION < '1.9.3'
-    # Use older Guard version that uses older Listen version since
-    # Listen >= 2.0.0 only works with Ruby >= 1.9.3
-    gem.add_development_dependency 'guard-rspec', '~> 3.1.0'
-    gem.add_development_dependency 'listen', '< 2.0.0' if RUBY_VERSION < '1.9.3'
-  else
-    gem.add_development_dependency 'guard-rspec', '~> 4.2.0'
-  end
+  gem.add_dependency 'gem_config', '~> 0.3'
+  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'rspec', '~> 3.2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.5'
 end

data/spec/nifty_settings/settings_spec.rb

@@ -86,42 +86,82 @@ describe NiftySettings::Settings do
     end
   end
 
-  describe '.load_from_file' do
+  describe '.load' do
     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
+        # 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
-
-      it 'loads the settings from the default location' do
-        # Reset settings path in case it has been modified
-        NiftySettings::Settings.settings_path = nil
-
-        # 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
-
-        settings = NiftySettings::Settings.load_from_file
-        expect(settings).to eq('foo' => 'bar')
-
-        # Delete settings file again
-        FileUtils.rm default_settings_file
-      end
-
-      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({})
+        FileUtils.mkdir_p settings_dir
+      end
+
+      after do
+        Dir[File.join(settings_dir, '*.yml')].unshift(settings_file).each do |file|
+          File.delete file if File.exist?(file)
+        end
+        %i(settings_file settings_dir).each do |config|
+          NiftySettings.configuration.unset config
+        end
+      end
+
+      let(:settings_file) { File.expand_path('../../../config/settings.yml', __FILE__) }
+      let(:settings_dir)  { File.expand_path('../../../config/settings', __FILE__) }
+      1.upto(3).each do |i|
+        let(:"support_settings_file_#{i}") { File.expand_path("../../support/settings#{i}.yml", __FILE__) }
+      end
+
+      context 'when only the settings file exists' do
+        context 'in the default location' do
+          before do
+            FileUtils.cp support_settings_file_1, settings_file
+          end
+
+          it 'loads the settings' do
+            settings = NiftySettings::Settings.load
+            expect(settings).to eq('foo' => 'bar')
+          end
+        end
+
+        context 'in a custom location' do
+          before do
+            NiftySettings.configuration.settings_file = support_settings_file_1
+          end
+
+          it 'loads the settings' do
+            settings = NiftySettings::Settings.load
+            expect(settings).to eq('foo' => 'bar')
+          end
+        end
+      end
+
+      context 'when only a file in the settings dir exists' do
+        before do
+          FileUtils.cp support_settings_file_1, settings_dir
+        end
+
+        it 'loads the settings' do
+          settings = NiftySettings::Settings.load
+          expect(settings).to eq('foo' => 'bar')
+        end
+      end
+
+      context 'when the settings file and files in the settings dir exist' do
+        before do
+          FileUtils.cp support_settings_file_1, settings_file
+          FileUtils.cp support_settings_file_2, settings_dir
+          FileUtils.cp support_settings_file_3, settings_dir
+        end
+
+        it 'loads the settings' do
+          settings = NiftySettings::Settings.load
+          expect(settings).to eq(
+            'foo'   => 'bar',
+            'pelle' => 'fant',
+            'zing'  => 'zang'
+          )
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'nifty_settings'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'

data/spec/support/settings2.yml

@@ -0,0 +1 @@
+pelle: fant

data/spec/support/settings3.yml

@@ -0,0 +1 @@
+zing: zang

metadata

@@ -1,77 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: nifty_settings
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: gem_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.5'
 description: A nifty way to save and access application-wide settings.
 email: manuel@krautcomputing.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -87,8 +88,9 @@ files:
 - nifty_settings.gemspec
 - spec/nifty_settings/settings_spec.rb
 - spec/spec_helper.rb
-- spec/support/settings.yml
-- spec/support/settings_empty.yml
+- spec/support/settings1.yml
+- spec/support/settings2.yml
+- spec/support/settings3.yml
 homepage: http://krautcomputing.github.io/nifty_settings/
 licenses:
 - MIT
@@ -109,13 +111,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A nifty way to save and access application-wide settings.
 test_files:
 - spec/nifty_settings/settings_spec.rb
 - spec/spec_helper.rb
-- spec/support/settings.yml
-- spec/support/settings_empty.yml
+- spec/support/settings1.yml
+- spec/support/settings2.yml
+- spec/support/settings3.yml
 has_rdoc: