defaultable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--drb
+--format=nested

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in defaultable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Defaultable
+#### Defaultable allows you to create settings with defaults easily
+
+```
+setting = Defaultable::Settings.new
+setting.site_name = 'Example'
+setting.site_name # => Example
+```
+
+## Creating your own defaultable settings class
+
+To create a settings class, just extend Defaultable::Settings
+
+```
+class MySetting < Defaultable::Settings
+	set_defaults :site_name => 'Example'
+end
+
+setting = MySetting.new
+setting.site_name # => Example
+
+setting.site_name = 'Different Name'
+setting.site_name # => Different Name
+```
+
+## Creating your own defaultable settings from a YAML file
+
+```
+class MySetting < Defaultable::Settings
+	set_defaults "#{Rails.root}/config/settings.yml"
+end
+
+class MySetting < Defaultable::Settings
+	set_defaults "#{Rails.root}/config/settings.yml", Rails.env
+end
+
+```
+
+The second parameter of ```set_defaults``` is the environment variable you'd like to use from the file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/defaultable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/defaultable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Ross"]
+  gem.email         = ["robert@maintainedauto.com"]
+  gem.description   = %q{Defaultable is an extendable class to allow easy method chaining for settings along with defaults.}
+  gem.summary       = %q{Settings made easy.}
+  gem.homepage      = "https://github.com/bobbytables/defaultable"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "defaultable"
+  gem.require_paths = ["lib"]
+  gem.version       = Defaultable::VERSION
+
+  gem.add_dependency("activesupport", "~> 3.1")
+
+  gem.add_development_dependency("rspec", "~> 2.7")
+  gem.add_development_dependency("pry")
+end

data/lib/defaultable.rb

@@ -0,0 +1,87 @@
+require "defaultable/version"
+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 = Defaultable::Settings.new(settings)
+        when String
+          yaml = YAML.load_file(settings)
+          yaml = yaml[env] if env
+          self.defaults = Defaultable::Settings.new(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

@@ -0,0 +1,3 @@
+module Defaultable
+  VERSION = "0.0.1"
+end

data/spec/defaultable_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Defaultable::Settings do
+  before :each 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')
+  end
+
+  it "should be able to set nonexsistent keys" do
+    setting = Defaultable::Settings.new
+    setting.child = 'Bri Bri'
+    setting.child.should eq('Bri Bri')
+  end
+
+  it "should be able to set nonexsistent keys to another setting" do
+    setting = Defaultable::Settings.new
+    setting.child = Defaultable::Settings.new
+    setting.child.name = 'Mocha'
+    setting.child.name.should eq('Mocha')
+  end
+
+  it "should accept nested hashes" do
+    setting = Defaultable::Settings.new({:parent => {:child => 'Rob'}})
+    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)
+  end
+
+  it "should have a default setting for a key" do
+    Defaultable::Settings.set_defaults File.expand_path('../', __FILE__) + '/test.yml'
+
+    setting = Defaultable::Settings.new
+    setting.grandparent.should be_kind_of Defaultable::Settings
+  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'
+
+    setting = Defaultable::Settings.new({
+      :grandparent => {
+        :child => {
+          :grandchild3 => 'hurdur'
+        }
+      }
+    })
+
+    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'
+
+    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
+
+  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.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'
+
+    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'
+
+    setting = Defaultable::Settings.new
+    setting.setting_key.should eq('somevalue')
+  end
+
+  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
+
+  describe "Hashes" do
+    it ".as_hash should return a hash" do
+      Defaultable::Settings.set_defaults :child => 'sxephil'
+      setting = Defaultable::Settings.new
+
+      setting.name = 'Robert'
+      setting.as_hash.should be_kind_of Hash
+    end
+
+    it ".as_hash should return a hash with the correct keys" do
+      Defaultable::Settings.set_defaults :child => 'sxephil'
+      setting = Defaultable::Settings.new
+
+      setting.name = 'Robert'
+      setting.as_hash['name'].should eq('Robert')
+    end
+  end
+end

data/spec/env_test.yml

@@ -0,0 +1,2 @@
+development:
+  setting_key: somevalue

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'defaultable'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/test.yml

@@ -0,0 +1,4 @@
+grandparent:
+  child:
+    grandchild1: robert
+    grandchild2: brian

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: defaultable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70195091793420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70195091793420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70195091791660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70195091791660
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70195091790800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195091790800
+description: Defaultable is an extendable class to allow easy method chaining for
+  settings along with defaults.
+email:
+- robert@maintainedauto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- defaultable.gemspec
+- lib/defaultable.rb
+- lib/defaultable/version.rb
+- spec/defaultable_spec.rb
+- spec/env_test.yml
+- spec/spec_helper.rb
+- spec/test.yml
+homepage: https://github.com/bobbytables/defaultable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Settings made easy.
+test_files:
+- spec/defaultable_spec.rb
+- spec/env_test.yml
+- spec/spec_helper.rb
+- spec/test.yml