defaultable 0.0.4 → 0.0.5

data/lib/defaultable/registry.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/hash'
+
+module Defaultable
+	class Registry
+		def initialize
+			@table = {}
+		end
+
+		def add(key, value)
+			@table[key] = value
+		end
+
+		def as_hash
+			@table.inject({}) do |hash, (key, val)|
+        if val.kind_of?(Defaultable::Settings)
+          val = val.registry.as_hash
+        else
+          val
+        end
+
+        hash[key] = val
+        hash
+      end
+		end
+
+		# def diff(defaults)
+		# 	settings = self.as_hash
+
+		# 	settings.diff(defaults)
+		# end
+	end
+end

data/lib/defaultable/serialization.rb

@@ -5,7 +5,7 @@ module Defaultable
 	  # Called to deserialize data to ruby object.
 	  def load(data)
 	  	if data
-	    	obj = YAML.load(data)
+	    	obj = raw_load(data)
 
 	    	raise TypeError, "Deserialized object is not of type #{self.class.settings_class.name}. Got #{obj.class}" unless obj.is_a?(self.class.settings_class)
 
@@ -19,7 +19,13 @@ module Defaultable
 	  # Called to convert from ruby object to serialized data.
 	  def dump(obj)
 	  	raise TypeError, "Serialization failed: Object is not of type #{self.class.settings_class.name}." unless obj.is_a?(self.class.settings_class)
-	    obj.to_yaml if obj
+
+	  	# We need to use the registry because we don't want to store defaults that weren't overwritten
+	    obj.class.new(obj.registry.as_hash).to_yaml if obj
+	  end
+
+	  def raw_load(data)
+	  	YAML.load(data)
 	  end
 	end
 end

data/lib/defaultable/settings.rb

@@ -1,17 +1,22 @@
 module Defaultable
 	class Settings
     class_attribute :defaults
-    attr_accessor :root_key, :parent
+    attr_accessor :registry_enabled
+    attr_reader   :registry
 
-    def initialize(hash=nil, root_key=nil, parent=nil, skip_defaults=false)
-      @table = {}
+    attr_accessor :parent, :root_key
 
-      self.root_key = root_key if root_key
-      self.parent = parent if parent
+    def initialize(hash=nil, skip_defaults=false, enable_registry=true)
+      @table    = {}
+      @registry = Registry.new
 
       if !skip_defaults && !self.class.defaults.nil?
+      	self.registry_enabled = false
         recursive_hash_assignment self.class.defaults
       end
+
+      # Enable the registry so we know what actually was set beyond defaults
+      self.registry_enabled = enable_registry
       
       if !hash.nil? && hash.kind_of?(Hash)
         recursive_hash_assignment hash
@@ -29,9 +34,18 @@ module Defaultable
         key = message.to_s.gsub(/=$/, '')
         value = args.first
 
+        if self.registry_enabled
+        	self.registry.add(key, value)
+        end
+
         if value.kind_of?(Defaultable::Settings)
-          value.parent   = self
-          value.root_key = key
+        	value.root_key = key
+        	value.parent   = self
+        end
+
+        if self.parent && self.parent.registry_enabled
+        	self.registry.add(key, value)
+        	self.parent.registry.add(self.root_key, self.class.new(self.registry.as_hash))
         end
 
         @table[key] = value
@@ -51,10 +65,6 @@ module Defaultable
       end
     end
 
-    def has_parent?
-      !!self.parent
-    end
-
     def recursive_hash_assignment(hash)
       hash.each do |key, value|
         if value.kind_of?(Hash)
@@ -76,7 +86,7 @@ module Defaultable
           self.send("#{key}=", hash)
         end
       else
-        self.send("#{key}=", self.class.new(hash, key, self, true))
+        self.send("#{key}=", self.class.new(hash, true, self.registry_enabled))
       end
     end
     

data/lib/defaultable/version.rb

@@ -1,3 +1,3 @@
 module Defaultable
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/defaultable.rb

@@ -5,4 +5,5 @@ require 'active_support/core_ext/class/attribute'
 module Defaultable
   autoload :Serialization, 'defaultable/serialization'
   autoload :Settings, 'defaultable/settings'
+  autoload :Registry, 'defaultable/registry'
 end

data/spec/defaultable_spec.rb

@@ -5,11 +5,6 @@ describe Defaultable::Settings do
     Defaultable::Settings.set_defaults({})
   end
 
-  it "should not have a parent" do
-    setting = Defaultable::Settings.new
-    setting.has_parent?.should be_false
-  end
-
   it "should initialize with a hash" do
     setting = Defaultable::Settings.new({:child => 'Bobert'})
     setting.child.should eq('Bobert')
@@ -178,4 +173,46 @@ describe Defaultable::Settings do
       setting = DummySetting.new(:movie => { :genre => 'asdf' })
     end
   end
+
+  describe Defaultable::Registry do
+    before(:each) do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => {:name => 'Iron Man' }
+      end
+    end
+
+    it "should not include defaults in the registry" do
+      setting = DummySetting.new
+      setting.registry.as_hash.has_key?(:movie).should be_false
+    end
+
+    it "should not include defaults in the registry unless overwritten" do
+      setting = DummySetting.new
+      setting.movie = 'asdf'
+      setting.registry.as_hash.has_key?(:movie).should be_false
+    end
+
+    it "should be able to overwrite nested defaults" do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => {:name => 'Iron Man', :genre => 'Action Adventure'}
+      end
+      setting = DummySetting.new
+      setting.movie.genre = 'Unable to put into mongodb gridfs'
+
+      setting.registry.as_hash['movie'].has_key?('genre').should be_true
+      setting.registry.as_hash['movie'].has_key?('name').should be_false
+    end
+
+    it "should be able to overwrite multiple nested defaults" do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => {:name => 'Iron Man', :genre => 'Action Adventure'}
+      end
+      setting = DummySetting.new
+      setting.movie.genre = 'Unable to put into mongodb gridfs'
+      setting.movie.name = 'Independence Day'
+
+      setting.registry.as_hash['movie'].has_key?('genre').should be_true
+      setting.registry.as_hash['movie'].has_key?('name').should be_true
+    end
+  end
 end

data/spec/registry_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Defaultable::Registry do
+	before(:each) do
+		class DummySetting < Defaultable::Settings; end
+	end
+
+	after(:each) do
+		DummySetting.set_defaults Hash.new
+	end
+
+	it "should log settings to the registry" do
+		setting = DummySetting.new
+		setting.blah = 'asdf'
+
+		setting.registry.as_hash.should have_key('blah')
+	end
+
+	it "should not log defaults to the registry" do
+		DummySetting.set_defaults :foo => 'bar'
+
+		setting = DummySetting.new
+		setting.registry.as_hash.should_not have_key('foo')
+	end
+
+	it "should set registry values for nested attributes" do
+		setting = DummySetting.new(:stuff => {:bar => 'foo'})
+		setting.registry.as_hash['stuff'].should have_key('bar')
+	end
+
+	it "should not set nested attributes registry values even in nested defaults" do
+		DummySetting.set_defaults :values => {:foo => 'bar'}
+
+		DummySetting.new.registry.as_hash.should_not have_key('values')
+	end
+
+	it "should set nested attributes registry values even in nested defaults" do
+		DummySetting.set_defaults :values => {:foo => 'bar'}
+
+		setting = DummySetting.new(:values => {:bar => 'foo'})
+		setting.registry.as_hash.should have_key('values')
+		setting.values.bar?.should be_true
+	end
+
+	it "should set nested attributes registry values and retain nested defaults" do
+		DummySetting.set_defaults :values => {:foo => 'bar'}
+
+		setting = DummySetting.new(:values => {:bar => 'foo'})
+		setting.registry.as_hash.should have_key('values')
+		setting.values.bar?.should be_true
+		setting.values.foo?.should be_true
+	end
+end

data/spec/serialization_spec.rb

@@ -6,6 +6,10 @@ describe Defaultable::Serialization do
 		Defaultable::Serialization.settings_class = DummySetting
 	end
 
+	after(:each) do
+		DummySetting.set_defaults Hash.new
+	end
+
 	it "should set a class for settings" do
 		Defaultable::Serialization.settings_class.should eq(DummySetting)
 	end
@@ -64,4 +68,42 @@ describe Defaultable::Serialization do
 		unserialized = encoder.load(serialized)
 		unserialized.bobby?.should be_true
 	end
+
+	it "should not serialize defaults that didn't get overwritten" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized = encoder.dump(settings)
+
+		DummySetting.set_defaults :bobby => 'tables'
+
+		unserialized = encoder.raw_load(serialized)
+		unserialized.bobby?.should be_false
+	end
+
+	it "should not serialize nested defaults that didn't get overwritten" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized = encoder.dump(settings)
+
+		DummySetting.set_defaults :bobby => {:effing => 'tables'}
+
+		unserialized = encoder.raw_load(serialized)
+		unserialized.bobby?.should be_false
+	end
+
+	it "should not serialize nested defaults that didn't get overwritten (but other values did)" do
+		encoder  = Defaultable::Serialization.new
+		DummySetting.set_defaults :bobby => {:effing => 'tables'}
+		settings = DummySetting.new
+
+		settings.bobby = 'tables'
+		serialized = encoder.dump(settings)
+
+		unserialized = encoder.raw_load(serialized)
+		unserialized.bobby?.should be_true
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defaultable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70278791694720 !ruby/object:Gem::Requirement
+  requirement: &70121466071200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278791694720
+  version_requirements: *70121466071200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70278791693100 !ruby/object:Gem::Requirement
+  requirement: &70121466070520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70278791693100
+  version_requirements: *70121466070520
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70278791692600 !ruby/object:Gem::Requirement
+  requirement: &70121466069920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70278791692600
+  version_requirements: *70121466069920
 description: Defaultable is an extendable class to allow easy method chaining for
   settings along with defaults.
 email:
@@ -59,11 +59,13 @@ files:
 - Rakefile
 - defaultable.gemspec
 - lib/defaultable.rb
+- lib/defaultable/registry.rb
 - lib/defaultable/serialization.rb
 - lib/defaultable/settings.rb
 - lib/defaultable/version.rb
 - spec/defaultable_spec.rb
 - spec/env_test.yml
+- spec/registry_spec.rb
 - spec/serialization_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml
@@ -94,6 +96,7 @@ summary: Settings made easy.
 test_files:
 - spec/defaultable_spec.rb
 - spec/env_test.yml
+- spec/registry_spec.rb
 - spec/serialization_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml