settingable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44dd382347efa4660d7eb7329684165b25a9326b
-  data.tar.gz: 7516072936d6a315e5bbf2322721bf17d39f7e86
+  metadata.gz: 3a0a903c881eea9d4884ecea2b35bbab704eee6e
+  data.tar.gz: 63b5b9419e6eb8f4afb0781009c61182c14516be
 SHA512:
-  metadata.gz: 5625c2068e64528122c1fe8d3e927e52a1b431629093c1d079bdb7d4b81fba78dd49a7c517dc6443df8f061f58f087e4bdef8e7656aab0d0abf25d3fde60fd70
-  data.tar.gz: 0b8a3f1bf9c29345be135fdee6ec86fc76bd219e79d1132ab035e972d33173e3d2efc9bc901141e53f38a7324afa24f2e7be4e35f9d877ac3331d44ddeba08aa
+  metadata.gz: 8f5c6eed43a3b4ca3af56e393ad665f5c6c3088aade3b155494cd5c9a0e0fa00468287b83e286664f1dfa9bfe1512a309ccb64f89924c2d66180950c22b0a285
+  data.tar.gz: a43f6490d4254b812bb845d064e5a89debada8491f7d114d2c9cd28bca5b6d3b7a2dd03cad3bc48e2e3a2e1f5b6ad905319ea43229a2cdae82adfa3d739b0c3e

data/.rspec

@@ -1 +1,3 @@
---colour --format documentation
+--colour
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -1,5 +1,8 @@
-Style/ClassAndModuleChildren:
-  Enabled: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+Style/Encoding:
+  Enabled: true
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+Metrics/MethodLength:
+  Max: 15

data/lib/settingable.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+
 require "settingable/version"
+require "settingable/deep_merge"
 require "settingable/settings"
 
 # Contains the Setting module.

data/lib/settingable/deep_merge.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+module Settingable
+  # A module to handle the merging of a hash.
+  module DeepMerge
+    module_function
+
+    # Merges the source into the destination.  This is non-destructive
+    # to the destination.  If a block is given, it's called if both
+    # the source and destination have a non-mergable value.  Both the
+    # values must be a hash for it to be merged.  If it is a
+    # non-mergable, and the either the destination doesn't have the
+    # key, or no block was given, the default is to overwrite the
+    # destination with the new value.
+    #
+    # @param (see .deep_merge!)
+    # @return (see .deep_merge!)
+    # @yield (see .deep_merge!)
+    def deep_merge(destination, source, &block)
+      deep_merge!(destination.dup, source, &block)
+    end
+
+    # Merges the source into the destination.  This is destructive to
+    # the destination.  If a block is given, it's called if both the
+    # source and destination have a non-mergable value.  Both the
+    # values must be a hash in order for it to be merged.  If it is
+    # a non-mergable value, and either the destination doesn't have
+    # the key, or no block was given, the default is to overwrite the
+    # destination with the new value.
+    #
+    # @param destination [Hash] The destination hash.
+    # @param source [Hash] The source hash.
+    # @yield [key, destination_value, source_value] Yields to
+    #   determine the action that should be taken to merge the two.
+    # @return [Hash] The destination.
+    def deep_merge!(destination, source, &block)
+      source.each do |key, value|
+        dvalue = destination[key]
+        destination[key] = case
+                           when value.is_a?(Hash) && dvalue.is_a?(Hash)
+                             deep_merge(dvalue, value, &block)
+                           when block && destination.key?(key)
+                             block.call(key, dvalue, value)
+                           else
+                             value
+                           end
+      end
+
+      destination
+    end
+  end
+end

data/lib/settingable/settings.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "forwardable"
 
 module Settingable
@@ -51,7 +53,7 @@ module Settingable
     #
     # @param settings [Hash] The initial settings.
     def initialize(settings = {})
-      @settings = self.class.default_settings.merge(settings)
+      @settings = DeepMerge.deep_merge(self.class.default_settings, settings)
     end
 
     # Builds the settings construct.  It yields itself, and then returns

data/lib/settingable/version.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+
+# :nodoc:
 module Settingable
   # settingable version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/settingable.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "yard"
+
+  gem.add_dependency "deep_merge"
 end

data/spec/settingable/deep_merge_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+RSpec.describe Settingable::DeepMerge do
+  let(:destination) { { foo: { bar: "baz" }, hello: "world" } }
+  let(:source) { { foo: { bar: "ham" } } }
+
+  describe "#deep_merge" do
+    subject { Settingable::DeepMerge.deep_merge(destination, source) }
+
+    it "merges without modification" do
+      expect(subject).to eq foo: { bar: "ham" }, hello: "world"
+      expect(destination).to eq foo: { bar: "baz" }, hello: "world"
+      expect(source).to eq foo: { bar: "ham" }
+    end
+  end
+
+  describe "#deep_merge!" do
+    subject { Settingable::DeepMerge.deep_merge!(destination, source) }
+
+    it "merges with modification" do
+      expect(subject).to eq foo: { bar: "ham" }, hello: "world"
+      expect(destination).to eq foo: { bar: "ham" }, hello: "world"
+      expect(source).to eq foo: { bar: "ham" }
+    end
+
+    it "yields" do
+      expect do |y|
+        Settingable::DeepMerge.deep_merge!(destination, source, &y)
+      end.to yield_control
+    end
+  end
+end

data/spec/settingable/settings_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+# encoding: utf-8
 
 # Test module for Setting.
 class Configuration
@@ -60,6 +60,17 @@ RSpec.describe Settingable::Settings do
       subject[:hello] = "you"
       expect(defaults[:hello]).to eq "world"
     end
+
+    context "with recursive settings" do
+      let(:defaults) { { hello: { foo: "bar", world: "baz" } }.freeze }
+      let(:settings) { { hello: { world: "hello" }, foo: "bar" }.freeze }
+
+      it "merges the settings" do
+        expect(subject[:hello][:world]).to eq "hello"
+        expect(defaults[:hello][:world]).to eq "baz"
+        expect(subject[:foo]).to eq "bar"
+      end
+    end
   end
 
   describe "#method_missing" do

data/spec/settingable_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 require "settingable"
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "rspec"
 require "settingable"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Rodi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Handles configuring your gems.
 email: redjazz96@gmail.com
 executables: []
@@ -83,9 +97,11 @@ files:
 - README.md
 - Rakefile
 - lib/settingable.rb
+- lib/settingable/deep_merge.rb
 - lib/settingable/settings.rb
 - lib/settingable/version.rb
 - settingable.gemspec
+- spec/settingable/deep_merge_spec.rb
 - spec/settingable/settings_spec.rb
 - spec/settingable_spec.rb
 - spec/spec_helper.rb
@@ -114,6 +130,7 @@ signing_key:
 specification_version: 4
 summary: Handles configuring your gems.
 test_files:
+- spec/settingable/deep_merge_spec.rb
 - spec/settingable/settings_spec.rb
 - spec/settingable_spec.rb
 - spec/spec_helper.rb