Merge pull request #137 from Fryguy/overwrite_arrays

Add overwrite_arrays option

README.md

@@ -273,6 +273,8 @@ located at `config/initializers/config.rb`.
 
 * `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Default: `nil`
 
+* `overwrite_arrays` - ability to replace an entire array set in earlier loaded settings file. Default: `false`
+
 Check [Deep Merge](https://github.com/danielsdeleo/deep_merge) for more details.
 
 ### Environment variables

config.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
 
   s.add_dependency 'activesupport',           '>= 3.0'
-  s.add_dependency 'deep_merge',              '~> 1.0',   '>= 1.0.1'
+  s.add_dependency 'deep_merge',              '~> 1.1.1'
 
   s.add_development_dependency 'bundler',     '~> 1.11',  '>= 1.11.2'
   s.add_development_dependency 'rake',        '~> 11.1',  '>= 11.1.2'

lib/config.rb

@@ -20,8 +20,9 @@ module Config
   @@env_parse_values = true
 
   # deep_merge options
-  mattr_accessor :knockout_prefix
+  mattr_accessor :knockout_prefix, :overwrite_arrays
   @@knockout_prefix = nil
+  @@overwrite_arrays = false
 
   def self.setup
     yield self if @@_ran_once == false

lib/config/options.rb

@@ -72,7 +72,8 @@ def reload!
           DeepMerge.deep_merge!(source_conf,
                                 conf,
                                 preserve_unmergeables: false,
-                                knockout_prefix:       Config.knockout_prefix)
+                                knockout_prefix:       Config.knockout_prefix,
+                                overwrite_arrays:      Config.overwrite_arrays)
         end
       end
 
@@ -116,7 +117,10 @@ def to_json(*args)
 
     def merge!(hash)
       current = to_hash
-      DeepMerge.deep_merge!(hash.dup, current)
+      DeepMerge.deep_merge!(hash.dup,
+                            current,
+                            preserve_unmergeables: false,
+                            overwrite_arrays:      Config.overwrite_arrays)
       marshal_load(__convert(current).marshal_dump)
       self
     end

spec/config_spec.rb

@@ -320,5 +320,37 @@
         end
       end
     end
+
+    context 'using overwrite_arrays' do
+      context 'in configuration phase' do
+        it 'should be able to assign a different overwrite_arrays value' do
+          Config.reset
+          Config.overwrite_arrays = true
+
+          expect(Config.overwrite_arrays).to eq(true)
+        end
+
+        it 'should have the default overwrite_arrays value equal false' do
+          Config.reset
+
+          expect(Config.overwrite_arrays).to eq(false)
+        end
+      end
+
+      context 'overwriting' do
+        let(:config) do
+          Config.overwrite_arrays = true
+          Config.load_files(["#{fixture_path}/overwrite_arrays/config1.yml",
+                             "#{fixture_path}/overwrite_arrays/config2.yml",
+                             "#{fixture_path}/overwrite_arrays/config3.yml"])
+        end
+
+        it 'should remove elements from settings' do
+          expect(config.array1).to eq(['item4', 'item5', 'item6'])
+          expect(config.array2.inner).to eq(['item4', 'item5', 'item6'])
+          expect(config.array3).to eq([])
+        end
+      end
+    end
   end
 end

spec/fixtures/overwrite_arrays/config1.yml

@@ -0,0 +1,17 @@
+array1:
+  - item1
+  - item2
+  - item3
+  - item4
+
+array2:
+  inner:
+    - item1
+    - item2
+    - item3
+    - item4
+
+array3:
+  - item1
+  - item2
+  - item3

spec/fixtures/overwrite_arrays/config2.yml

@@ -0,0 +1,12 @@
+array1:
+  - item2
+  - item4
+  - item5
+
+array2:
+  inner:
+    - item2
+    - item4
+    - item5
+
+array3: []

spec/fixtures/overwrite_arrays/config3.yml

@@ -0,0 +1,10 @@
+array1:
+  - item4
+  - item5
+  - item6
+
+array2:
+  inner:
+    - item4
+    - item5
+    - item6

spec/spec_helper.rb

@@ -43,9 +43,10 @@
 
       # Extend Config module with ability to reset configuration to the default values
       def self.reset
-        self.const_name      = 'Settings'
-        self.use_env         = false
-        self.knockout_prefix = nil
+        self.const_name       = 'Settings'
+        self.use_env          = false
+        self.knockout_prefix  = nil
+        self.overwrite_arrays = false
       end
     end
   end