settingslogic 2.0.8 → 2.0.9

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+*.log
+*.sqlite3
+pkg/*
+coverage/*
+doc/*
+benchmarks/*
+.bundle
+vendor/bundle
+.rvmrc

data/Gemfile

@@ -1,13 +1,2 @@
-source "http://rubygems.org"
-
-group :development do
-  gem 'rake'
-  gem 'jeweler'
-  gem 'rspec', :require => 'spec'
-  gem 'rcov'
-  if RUBY_VERSION < "1.9"
-    gem 'ruby-debug'
-  else
-    gem 'ruby-debug19'
-  end
-end
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -1,38 +1,26 @@
+PATH
+  remote: .
+  specs:
+    settingslogic (2.0.9)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    columnize (0.3.6)
     diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    linecache (0.46)
-      rbx-require-relative (> 0.0.4)
-    rake (0.9.2.2)
-    rbx-require-relative (0.0.5)
-    rcov (0.9.11)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler
   rake
-  rcov
   rspec
-  ruby-debug
+  settingslogic!

data/README.rdoc

@@ -3,8 +3,6 @@
 Settingslogic is a simple configuration / settings solution that uses an ERB enabled YAML file. It has been great for
 our apps, maybe you will enjoy it too.  Settingslogic works with Rails, Sinatra, or any Ruby project.
 
-So here is my question to you.....is Settingslogic a great settings solution or the greatest?
-
 == Helpful links
 
 *	<b>Documentation:</b> http://rdoc.info/projects/binarylogic/settingslogic
@@ -13,15 +11,7 @@ So here is my question to you.....is Settingslogic a great settings solution or
 
 == Installation
 
-Install from rubyforge/gemcutter:
-
-  sudo gem install settingslogic
-
-Or as a Rails plugin:
-
-  script/plugin install git://github.com/binarylogic/settingslogic.git
-
-Settingslogic does not have any dependencies on Rails.  Installing as a gem is recommended.
+  gem install settingslogic
 
 == Usage
 
@@ -54,7 +44,7 @@ Using a namespace allows us to change our configuration depending on our environ
       saweet: nested settings
     neat_setting: 24
     awesome_setting: <%= "Did you know 5 + 5 = #{5 + 5}?" %>
-  
+
   development:
     <<: *defaults
     neat_setting: 800
@@ -65,7 +55,7 @@ Using a namespace allows us to change our configuration depending on our environ
   production:
     <<: *defaults
 
-_Note_: Certain Ruby/Bundler versions include a version of the Psych YAML parser which incorrectly handles merges (the `<<` in the example above.) 
+_Note_: Certain Ruby/Bundler versions include a version of the Psych YAML parser which incorrectly handles merges (the `<<` in the example above.)
 If your default settings seem to be overwriting your environment-specific settings, including the following lines in your config/boot.rb file may solve the problem:
 
   require 'yaml'
@@ -78,17 +68,17 @@ If your default settings seem to be overwriting your environment-specific settin
 
   >> Settings.cool
   => "#<Settingslogic::Settings ... >"
-  
+
   >> Settings.cool.saweet
   => "nested settings"
-  
+
   >> Settings.neat_setting
   => 800
-  
+
   >> Settings.awesome_setting
   => "Did you know 5 + 5 = 10?"
 
-You can use these settings anywhere, for example in a model:  
+You can use these settings anywhere, for example in a model:
 
   class Post < ActiveRecord::Base
     self.per_page = Settings.pagination.posts_per_page
@@ -116,7 +106,7 @@ Modifying our model example:
   class Post < ActiveRecord::Base
     self.per_page = Settings.posts['per_page'] || Settings.pagination.per_page
   end
-  
+
 This would allow you to specify a custom value for per_page just for posts, or
 to fall back to your default value if not specified.
 
@@ -145,7 +135,7 @@ in the global Object namespace:
 
 This can cause collisions with Settingslogic, since those methods are global. Luckily, the
 solution is to just add a call to load! in your class:
- 
+
   class Settings < Settingslogic
     source "#{Rails.root}/config/application.yml"
     namespace Rails.env

data/Rakefile

@@ -1,26 +1,7 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "settingslogic"
-    gem.summary = "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
-    gem.email = "bjohnson@binarylogic.com"
-    gem.homepage = "http://github.com/binarylogic/settingslogic"
-    gem.authors = ["Ben Johnson of Binary Logic"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+RSpec::Core::RakeTask.new
 
-task :default => :spec
+task :default => :spec

data/lib/settingslogic.rb

@@ -1,5 +1,6 @@
 require "yaml"
 require "erb"
+require 'open-uri'
 
 # A simple settings solution using a YAML file. See README for more information.
 class Settingslogic < Hash
@@ -9,7 +10,7 @@ class Settingslogic < Hash
     def name # :nodoc:
       self.superclass != Hash && instance.key?("name") ? instance.name : super
     end
-
+        
     # Enables Settings.get('nested.key.name') for dynamic access
     def get(key)
       parts = key.split('.')
@@ -21,27 +22,15 @@ class Settingslogic < Hash
     end
 
     def source(value = nil)
-      if value.nil?
-        @source
-      else
-        @source = value
-      end
+      @source ||= value
     end
 
     def namespace(value = nil)
-      if value.nil?
-        @namespace
-      else
-        @namespace = value
-      end
+      @namespace ||= value
     end
 
     def suppress_errors(value = nil)
-      if value.nil?
-        @suppress_errors
-      else
-        @suppress_errors = value
-      end
+      @suppress_errors ||= value
     end
 
     def [](key)
@@ -59,12 +48,12 @@ class Settingslogic < Hash
       instance
       true
     end
-    
+
     def reload!
       @instance = nil
       load!
     end
-    
+
     private
       def instance
         return @instance if @instance
@@ -72,7 +61,7 @@ class Settingslogic < Hash
         create_accessors!
         @instance
       end
-      
+
       def method_missing(name, *args, &block)
         instance.send(name, *args, &block)
       end
@@ -110,7 +99,8 @@ class Settingslogic < Hash
     when Hash
       self.replace hash_or_file
     else
-      hash = YAML.load(ERB.new(File.read(hash_or_file)).result).to_hash
+      file_contents = open(hash_or_file).read
+      hash = file_contents.empty? ? {} : YAML.load(ERB.new(file_contents).result).to_hash
       if self.class.namespace
         hash = hash[self.class.namespace] or return missing_key("Missing setting '#{self.class.namespace}' in #{hash_or_file}")
       end
@@ -141,6 +131,11 @@ class Settingslogic < Hash
     create_accessor_for(key, val)
   end
 
+  # Returns an instance of a Hash object
+  def to_hash
+    Hash[self]
+  end
+
   # This handles naming collisions with Sinatra/Vlad/Capistrano. Since these use a set()
   # helper that defines methods in Object, ANY method_missing ANYWHERE picks up the Vlad/Sinatra
   # settings!  So settings.deploy_to title actually calls Object.deploy_to (from set :deploy_to, "host"),
@@ -156,17 +151,38 @@ class Settingslogic < Hash
   # http://bmorearty.wordpress.com/2009/01/09/fun-with-rubys-instance_eval-and-class_eval/
   def create_accessor_for(key, val=nil)
     return unless key.to_s =~ /^\w+$/  # could have "some-setting:" which blows up eval
-    instance_variable_set("@#{key}", val) if val
+    instance_variable_set("@#{key}", val)
     self.class.class_eval <<-EndEval
       def #{key}
         return @#{key} if @#{key}
         return missing_key("Missing setting '#{key}' in #{@section}") unless has_key? '#{key}'
         value = fetch('#{key}')
-        @#{key} = value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
+        @#{key} = if value.is_a?(Hash)
+          self.class.new(value, "'#{key}' section in #{@section}")
+        elsif value.is_a?(Array) && value.all?{|v| v.is_a? Hash}
+          value.map{|v| self.class.new(v)}
+        else
+          value
+        end
       end
     EndEval
   end
-
+  
+  def symbolize_keys
+    
+    inject({}) do |memo, tuple|
+      
+      k = (tuple.first.to_sym rescue tuple.first) || tuple.first
+            
+      v = k.is_a?(Symbol) ? send(k) : tuple.last # make sure the value is accessed the same way Settings.foo.bar works
+      
+      memo[k] = v && v.respond_to?(:symbolize_keys) ? v.symbolize_keys : v #recurse for nested hashes
+      
+      memo
+    end
+    
+  end
+  
   def missing_key(msg)
     return nil if self.class.suppress_errors
 

data/settingslogic.gemspec

@@ -1,67 +1,21 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = "settingslogic"
-  s.version = "2.0.8"
+  s.name        = "settingslogic"
+  s.version     = "2.0.9"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Johnson"]
+  s.email       = ["bjohnson@binarylogic.com"]
+  s.homepage    = "http://github.com/binarylogic/settingslogic"
+  s.summary     = %q{A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern.}
+  s.description = %q{A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern.}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = "2012-01-09"
-  s.email = "bjohnson@binarylogic.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG.rdoc",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION.yml",
-    "init.rb",
-    "lib/settingslogic.rb",
-    "rails/init.rb",
-    "settingslogic.gemspec",
-    "spec/settings.rb",
-    "spec/settings.yml",
-    "spec/settings2.rb",
-    "spec/settings3.rb",
-    "spec/settings4.rb",
-    "spec/settingslogic_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/binarylogic/settingslogic"
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
-    else
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<ruby-debug19>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<ruby-debug19>, [">= 0"])
-  end
-end
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
 
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/settings.yml

@@ -19,4 +19,10 @@ collides:
   does: not
 nested:
   collides:
-    does: not either
+    does: not either
+
+array:
+  -
+    name: first
+  -
+    name: second

data/spec/settings_empty.rb

@@ -0,0 +1,3 @@
+class SettingsEmpty < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings_empty.yml"
+end

data/spec/settingslogic_spec.rb

@@ -9,6 +9,10 @@ describe "Settingslogic" do
     Settings.setting1.setting1_child.should == "saweet"
   end
   
+  it "should access settings in nested arrays" do
+    Settings.array.first.name.should == "first"
+  end
+
   it "should access deep nested settings" do
     Settings.setting1.deep.another.should == "my value"
   end
@@ -126,6 +130,18 @@ describe "Settingslogic" do
     Settings.language['some-dash-setting#'].should == 'dashtastic'
   end
 
+  it "should handle settings with nil value" do
+    Settings["flag"] = true
+    Settings["flag"] = nil
+    Settings.flag.should == nil
+  end
+
+  it "should handle settings with false value" do
+    Settings["flag"] = true
+    Settings["flag"] = false
+    Settings.flag.should == false
+  end
+
   it "should support instance usage as well" do
     settings = SettingsInst.new(Settings.source)
     settings.setting1.setting1_child.should == "saweet"
@@ -152,11 +168,40 @@ describe "Settingslogic" do
   it "should allow a name setting to be overriden" do
     Settings.name.should == 'test'
   end
+  
+  it "should allow symbolize_keys" do
+    Settings.reload!
+    result = Settings.language.haskell.symbolize_keys 
+    result.class.should == Hash
+    result.should == {:paradigm => "functional"} 
+  end
+  
+  it "should allow symbolize_keys on nested hashes" do
+    Settings.reload!
+    result = Settings.language.symbolize_keys
+    result.class.should == Hash
+    result.should == {
+      :haskell => {:paradigm => "functional"},
+      :smalltalk => {:paradigm => "object oriented"}
+    }
+  end
+
+  it "should handle empty file" do
+    SettingsEmpty.keys.should eql([])
+  end
 
   # Put this test last or else call to .instance will load @instance,
   # masking bugs.
   it "should be a hash" do
     Settings.send(:instance).should be_is_a(Hash)
   end
-  
+
+  describe "#to_hash" do
+    it "should return a new instance of a Hash object" do
+      Settings.to_hash.should be_kind_of(Hash)
+      Settings.to_hash.class.name.should == "Hash"
+      Settings.to_hash.object_id.should_not == Settings.object_id
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'settings'
 require 'settings2'
 require 'settings3'
 require 'settings4'
+require 'settings_empty'
 
 # Needed to test Settings3
 Object.send :define_method, 'collides' do

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: settingslogic
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.9
   prerelease: 
 platform: ruby
 authors:
-- Ben Johnson of Binary Logic
+- Ben Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70269561842780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,32 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269561842780
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70269561838420 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70269561838420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70269561855380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70269561855380
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70269561854140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,42 +37,35 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269561854140
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70269561851960 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70269561851960
-description: 
-email: bjohnson@binarylogic.com
+description: A simple and straightforward settings solution that uses an ERB enabled
+  YAML file and a singleton design pattern.
+email:
+- bjohnson@binarylogic.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
-- CHANGELOG.rdoc
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
-- init.rb
 - lib/settingslogic.rb
-- rails/init.rb
 - settingslogic.gemspec
 - spec/settings.rb
 - spec/settings.yml
 - spec/settings2.rb
 - spec/settings3.rb
 - spec/settings4.rb
+- spec/settings_empty.rb
+- spec/settings_empty.yml
 - spec/settingslogic_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/binarylogic/settingslogic
@@ -112,9 +88,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple and straightforward settings solution that uses an ERB enabled YAML
   file and a singleton design pattern.
-test_files: []
+test_files:
+- spec/settings.rb
+- spec/settings.yml
+- spec/settings2.rb
+- spec/settings3.rb
+- spec/settings4.rb
+- spec/settings_empty.rb
+- spec/settings_empty.yml
+- spec/settingslogic_spec.rb
+- spec/spec_helper.rb

data/CHANGELOG.rdoc

@@ -1,27 +0,0 @@
-== 2.0.2 released 2009-08-22
-
-* Define methods during method_missing instead of during initialization. Allows for modification on the fly.
-
-== 2.0.0 released 2009-08-22
-
-* Less magic, instead of automatically defining a Settings constant, you should define your own constant. See the readme for an example.
-
-== 1.0.3 released 2009-04-23
-
-* Fix Settings initialized with a Hash to work with both symbol and string hash keys.
-
-== 1.0.2 released 2009-04-09
-
-* Call key? off of the self in the class level name method.
-
-== 1.0.1 released 2009-04-02
-
-* Inherit from hash.
-
-== 1.0.0 released 2008-12-05
-
-* Only define methods if we have settings.
-
-== 0.9.0 released 2008-10-30
-
-* Initial release

data/VERSION.yml

@@ -1,5 +0,0 @@
----
-:major: 2
-:minor: 0
-:patch: 8
-:build: 

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + "/rails/init.rb"

data/rails/init.rb

@@ -1 +0,0 @@
-require "settingslogic"