defaultable 0.0.3 → 0.0.4

data/defaultable.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Defaultable::VERSION
 
-  gem.add_dependency("activesupport", "3.0")
+  gem.add_dependency("activesupport", ">= 3.0")
 
   gem.add_development_dependency("rspec", "~> 2.7")
   gem.add_development_dependency("pry")

data/lib/defaultable/serialization.rb

@@ -0,0 +1,25 @@
+module Defaultable
+	class Serialization
+		class_attribute :settings_class
+
+	  # Called to deserialize data to ruby object.
+	  def load(data)
+	  	if data
+	    	obj = YAML.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)
+
+	    	# The reason we do the following is because defaults may have changed
+	    	# after the point of serialization. To avoid not having them, we instantiate the class
+	    	# again, we the previous values. This prevents not having data.
+	    	obj.class.new(obj.as_hash)
+	    end
+	  end
+
+	  # 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
+	  end
+	end
+end

data/lib/defaultable/settings.rb

@@ -0,0 +1,98 @@
+module Defaultable
+	class Settings
+    class_attribute :defaults
+    attr_accessor :root_key, :parent
+
+    def initialize(hash=nil, root_key=nil, parent=nil, skip_defaults=false)
+      @table = {}
+
+      self.root_key = root_key if root_key
+      self.parent = parent if parent
+
+      if !skip_defaults && !self.class.defaults.nil?
+        recursive_hash_assignment self.class.defaults
+      end
+      
+      if !hash.nil? && hash.kind_of?(Hash)
+        recursive_hash_assignment hash
+      end
+    end
+    
+    def method_missing(message, *args, &block)
+      # puts "Message: #{message}", "Args: #{args}", "\n"
+
+      if !(message.to_s =~ /^(.*)=$/) && @table.has_key?(message.to_s)
+        @table[message.to_s]
+      elsif message.to_s =~ /^(.*)\?$/
+        @table.has_key?(message.to_s.gsub(/\?$/, ''))
+      elsif message.to_s =~ /^(.*)=$/
+        key = message.to_s.gsub(/=$/, '')
+        value = args.first
+
+        if value.kind_of?(Defaultable::Settings)
+          value.parent   = self
+          value.root_key = key
+        end
+
+        @table[key] = value
+      end
+    end
+    
+    def as_hash
+      @table.inject({}) do |hash, (key, val)|
+        if val.kind_of?(Defaultable::Settings)
+          val = val.as_hash
+        else
+          val
+        end
+
+        hash[key] = val
+        hash
+      end
+    end
+
+    def has_parent?
+      !!self.parent
+    end
+
+    def recursive_hash_assignment(hash)
+      hash.each do |key, value|
+        if value.kind_of?(Hash)
+          key_aware_assignment(key, value)
+        else
+          self.send("#{key}=", value)
+        end
+      end
+    end
+
+    def key_aware_assignment(key, hash)
+      if self.send("#{key}?")
+        instance = self.send(key)
+
+        if instance.kind_of?(Defaultable::Settings)
+          instance.recursive_hash_assignment(hash)
+          self.send("#{key}=", instance)
+        else
+          self.send("#{key}=", hash)
+        end
+      else
+        self.send("#{key}=", self.class.new(hash, key, self, true))
+      end
+    end
+    
+    class << self
+      def set_defaults(settings, env=nil)
+        case settings
+        when Hash
+          self.defaults = settings
+        when String
+          yaml = YAML.load_file(settings)
+          yaml = yaml[env] if env
+          self.defaults = yaml
+        else
+          raise ArgumentError, "You must supply a hash or a file name for default settings"
+        end
+      end
+    end
+  end
+end

data/lib/defaultable/version.rb

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

data/lib/defaultable.rb

@@ -3,85 +3,6 @@ require 'yaml'
 require 'active_support/core_ext/class/attribute'
 
 module Defaultable
-  class Settings
-    class_attribute :defaults
-    attr_accessor :root_key, :parent
-
-    def initialize(hash=nil, root_key=nil, parent=nil)
-      @table = {}
-
-      if root_key
-        self.root_key = root_key
-      end
-
-      if parent
-        self.parent = parent
-      end
-      
-      if !hash.nil? && hash.kind_of?(Hash)
-        hash.each do |key, value|
-          if value.kind_of?(Hash)
-            send("#{key}=", Defaultable::Settings.new(value, key, self))
-          else
-            self.send("#{key}=", value)
-          end
-        end
-      end
-    end
-    
-    def method_missing(message, *args, &block)
-      # puts "Message: #{message}", "Args: #{args}", "\n"
-
-      if !(message.to_s =~ /^(.*)=$/) && @table.has_key?(message.to_s)
-        @table[message.to_s]
-      elsif message.to_s =~ /^(.*)=$/
-        @table[message.to_s.gsub(/=$/, '')] = args.first
-      elsif !(message.to_s =~ /^(.*)=$/)
-        # We're looking for a default
-        default_settings = self.class.defaults
-
-        # If we have a parent, we need to traverse to the top of all of the method calls (root_keys), then go back down them
-        if self.parent
-          root_keys = []
-          current_parent = self
-          while current_parent.has_parent? do
-            root_keys << current_parent.root_key
-            current_parent = current_parent.parent
-          end
-
-          root_keys.reverse.each do |key|
-            default_settings = default_settings.send(key)
-          end
-
-          return default_settings.send(message)
-        # If don't have a parent, just send the message to the defaults outright 
-        else
-          default_settings.send(message)
-        end
-      end
-    end
-    
-    def as_hash
-      @table
-    end
-
-    def has_parent?
-      !!self.parent
-    end
-    
-    class << self
-      def set_defaults(settings, env=nil)
-        case settings
-        when Hash
-          self.defaults = self.new(settings)
-        when String
-          yaml = YAML.load_file(settings)
-          yaml = yaml[env] if env
-          self.defaults = self.new(yaml)
-        else
-          raise ArgumentError, "You must supply a hash or a file name for default settings"
-        end
-      end
-    end
-  end
+  autoload :Serialization, 'defaultable/serialization'
+  autoload :Settings, 'defaultable/settings'
 end

data/spec/defaultable_spec.rb

@@ -33,93 +33,110 @@ describe Defaultable::Settings do
     setting.parent.child.should eq('Rob')
   end
 
-  it "should have default settings" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
-    Defaultable::Settings.defaults.should be_kind_of(Defaultable::Settings)
+  it "should have a question mark method for keys" do
+    setting = Defaultable::Settings.new(:foo => 'bar')
+    setting.foo?.should be_true
   end
 
-  it "should have a default setting for a key" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+  describe "Defaults" do
+    it "should have default settings" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+      Defaultable::Settings.defaults.should be_kind_of(Hash)
+    end
 
-    setting = Defaultable::Settings.new
-    setting.grandparent.should be_kind_of Defaultable::Settings
-  end
+    it "should have a default setting for a key" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
 
-  it "should have another key for another setting" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+      setting = Defaultable::Settings.new
+      setting.grandparent.should be_kind_of Defaultable::Settings
+    end
 
-    setting = Defaultable::Settings.new
-    setting.grandparent.child.grandchild1.should eq('robert')
-  end
+    it "should have another key for another setting" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+
+      setting = Defaultable::Settings.new
+      setting.grandparent.child.grandchild1.should eq('robert')
+    end
 
-  it "should set a key but still have defaults" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+    it "should set a key but still have defaults" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
 
-    setting = Defaultable::Settings.new({
-      :grandparent => {
-        :child => {
-          :grandchild3 => 'hurdur'
+      setting = Defaultable::Settings.new({
+        :grandparent => {
+          :child => {
+            :grandchild3 => 'hurdur'
+          }
         }
-      }
-    })
+      })
 
-    setting.grandparent.child.grandchild3.should eq('hurdur')
-    setting.grandparent.child.grandchild2.should eq('brian')
-  end
+      setting.grandparent.child.grandchild3.should eq('hurdur')
+      setting.grandparent.child.grandchild2.should eq('brian')
+    end
 
-  it "should be able to overwrite a default" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+    it "should be able to overwrite a default" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
 
-    setting = Defaultable::Settings.new({
-      :grandparent => {
-        :child => {
-          :grandchild3 => 'hurdur'
+      setting = Defaultable::Settings.new({
+        :grandparent => {
+          :child => {
+            :grandchild3 => 'hurdur'
+          }
         }
-      }
-    })
+      })
 
-    setting.grandparent.child.grandchild3.should eq('hurdur')
-    setting.grandparent.child.grandchild2 = 'drpepper'
-    setting.grandparent.child.grandchild2.should eq('drpepper')
-  end
+      setting.grandparent.child.grandchild3.should eq('hurdur')
+      setting.grandparent.child.grandchild2 = 'drpepper'
+      setting.grandparent.child.grandchild2.should eq('drpepper')
+    end
 
-  it "should be able to set a key in the middle of defaults" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+    it "should be able to set a key in the middle of defaults" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
 
-    setting = Defaultable::Settings.new({
-      :grandparent => {
-        :child => {
-          :grandchild3 => 'hurdur'
+      setting = Defaultable::Settings.new({
+        :grandparent => {
+          :child => {
+            :grandchild3 => 'hurdur'
+          }
         }
-      }
-    })
+      })
 
-    setting.grandparent.child.grandchild3.should eq('hurdur')
-    setting.grandparent.someotherkey = 'saweet'
-    setting.grandparent.someotherkey.should eq('saweet')
-  end
+      setting.grandparent.child.grandchild3.should eq('hurdur')
+      setting.grandparent.someotherkey = 'saweet'
+      setting.grandparent.someotherkey.should eq('saweet')
+    end
 
-  it "should be able to set a hash for defaults" do
-    Defaultable::Settings.set_defaults :child => 'sxephil'
+    it "should be able to set a hash for defaults" do
+      Defaultable::Settings.set_defaults :child => 'sxephil'
 
-    setting = Defaultable::Settings.new
-    setting.child.should eq('sxephil')
-  end
+      setting = Defaultable::Settings.new
+      setting.child.should eq('sxephil')
+    end
 
-  it "should accept a filename with an environment" do
-    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/env_test.yml', 'development'
+    it "should accept a filename with an environment" do
+      Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/env_test.yml', 'development'
 
-    setting = Defaultable::Settings.new
-    setting.setting_key.should eq('somevalue')
+      setting = Defaultable::Settings.new
+      setting.setting_key.should eq('somevalue')
+    end
   end
 
-  it "should be extendable" do
-    class DummySetting < Defaultable::Settings
-      set_defaults :movie => 'Iron Man'
+  describe "Extendable" do
+    it "should be extendable" do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => 'Iron Man'
+      end
+
+      setting = DummySetting.new
+      setting.movie.should eq('Iron Man')
     end
 
-    setting = DummySetting.new
-    setting.movie.should eq('Iron Man')
+    it "should return settings the same class of the extension for detauls" do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => 'Iron Man'
+      end
+
+      DummySetting.defaults.should be_a Hash
+    end
   end
 
   describe "Hashes" do
@@ -139,4 +156,26 @@ describe Defaultable::Settings do
       setting.as_hash['name'].should eq('Robert')
     end
   end
+
+  describe "Defaults" do
+    before(:each) do
+      class DummySetting < Defaultable::Settings
+        set_defaults :movie => {:name => 'Iron Man' }
+      end
+    end
+
+    it "should have a key from defaults on initialization" do
+      setting = DummySetting.new
+      setting.movie?.should be_true
+    end
+
+    it "should have a hash with a length from defaults on initialization" do
+      setting = DummySetting.new
+      setting.as_hash.length.should eq(1)
+    end
+
+    it "should mash defaults together with new settings" do
+      setting = DummySetting.new(:movie => { :genre => 'asdf' })
+    end
+  end
 end

data/spec/serialization_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Defaultable::Serialization do
+	before(:each) do
+		class DummySetting < Defaultable::Settings; end
+		Defaultable::Serialization.settings_class = DummySetting
+	end
+
+	it "should set a class for settings" do
+		Defaultable::Serialization.settings_class.should eq(DummySetting)
+	end
+
+	it "should serialize a settings object" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized = encoder.dump(settings)
+		serialized.should be_a String
+	end
+
+	it "should deserialize a settings object back to a kind of Defaultable::Settings" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized = encoder.dump(settings)
+
+		encoder.load(serialized).should be_kind_of Defaultable::Settings
+	end
+
+	it "should throw an exception when the class doesn't match the settings class on load" do
+		encoder = Defaultable::Serialization.new
+
+		lambda { encoder.load('adfghjsfjdhg') }.should raise_error TypeError
+	end
+
+	it "should throw an exception when the class doesn't match the settings class on dump" do
+		encoder = Defaultable::Serialization.new
+
+		lambda { encoder.dump('adfghjsfjdhg'.to_yaml) }.should raise_error TypeError
+	end
+
+	it "should load with keys still in tact" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized   = encoder.dump(settings)
+		unserialized = encoder.load(serialized)
+
+		unserialized.foo.should eq('bar')
+	end
+
+	it "should load defaults in after the fact" do
+		encoder  = Defaultable::Serialization.new
+		settings = DummySetting.new
+
+		settings.foo = 'bar'
+		serialized = encoder.dump(settings)
+
+		DummySetting.set_defaults :bobby => 'tables'
+
+		unserialized = encoder.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.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2011-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70138640817240 !ruby/object:Gem::Requirement
+  requirement: &70278791694720 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70138640817240
+  version_requirements: *70278791694720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70138640816040 !ruby/object:Gem::Requirement
+  requirement: &70278791693100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70138640816040
+  version_requirements: *70278791693100
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70138640815100 !ruby/object:Gem::Requirement
+  requirement: &70278791692600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138640815100
+  version_requirements: *70278791692600
 description: Defaultable is an extendable class to allow easy method chaining for
   settings along with defaults.
 email:
@@ -59,9 +59,12 @@ files:
 - Rakefile
 - defaultable.gemspec
 - lib/defaultable.rb
+- lib/defaultable/serialization.rb
+- lib/defaultable/settings.rb
 - lib/defaultable/version.rb
 - spec/defaultable_spec.rb
 - spec/env_test.yml
+- spec/serialization_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml
 homepage: https://github.com/bobbytables/defaultable
@@ -91,5 +94,6 @@ summary: Settings made easy.
 test_files:
 - spec/defaultable_spec.rb
 - spec/env_test.yml
+- spec/serialization_spec.rb
 - spec/spec_helper.rb
 - spec/test.yml