settingslogic 2.0.6 → 2.0.7

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'rake'
+gem 'jeweler'
+gem 'rspec', :require => 'spec'
+gem 'ruby-debug19'

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    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
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    rake (0.9.2.2)
+    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-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rspec
+  ruby-debug19

data/README.rdoc

@@ -48,7 +48,7 @@ to a key in the YAML file.
 
 Using a namespace allows us to change our configuration depending on our environment:
 
-  # app/config/application.yml
+  # config/application.yml
   defaults: &defaults
     cool:
       saweet: nested settings
@@ -65,6 +65,12 @@ 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.) 
+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'
+  YAML::ENGINE.yamler= 'syck'
+
 === 3. Access your settings
 
   >> Rails.env
@@ -114,6 +120,22 @@ Modifying our model example:
 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.
 
+=== 5. Suppressing Exceptions Conditionally
+
+Raising exceptions for missing settings helps highlight configuration problems.  However, in a
+Rails app it may make sense to suppress this in production and return nil for missing settings.
+While it's useful to stop and highlight an error in development or test environments, this is
+often not the right answer for production.
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml"
+    namespace Rails.env
+    suppress_errors Rails.env.production?
+  end
+
+  >> Settings.non_existent_key
+  => nil
+
 == Note on Sinatra / Capistrano / Vlad
 
 Each of these frameworks uses a +set+ convention for settings, which actually defines methods

data/Rakefile

@@ -27,6 +27,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
+#task :spec => :check_dependencies
 
 task :default => :spec

data/VERSION.yml

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

data/lib/settingslogic.rb

@@ -7,7 +7,7 @@ class Settingslogic < Hash
 
   class << self
     def name # :nodoc:
-      instance.key?("name") ? instance.name : super
+      self.superclass != Hash && instance.key?("name") ? instance.name : super
     end
 
     # Enables Settings.get('nested.key.name') for dynamic access
@@ -35,7 +35,15 @@ class Settingslogic < Hash
         @namespace = value
       end
     end
-    
+
+    def suppress_errors(value = nil)
+      if value.nil?
+        @suppress_errors
+      else
+        @suppress_errors = value
+      end
+    end
+
     def [](key)
       instance.fetch(key.to_s, nil)
     end
@@ -103,7 +111,9 @@ class Settingslogic < Hash
       self.replace hash_or_file
     else
       hash = YAML.load(ERB.new(File.read(hash_or_file)).result).to_hash
-      hash = hash[self.class.namespace] if self.class.namespace
+      if self.class.namespace
+        hash = hash[self.class.namespace] or return missing_key("Missing setting '#{self.class.namespace}' in #{hash_or_file}")
+      end
       self.replace hash
     end
     @section = section || self.class.source  # so end of error says "in application.yml"
@@ -114,7 +124,7 @@ class Settingslogic < Hash
   # Otherwise, create_accessors! (called by new) will have created actual methods for each key.
   def method_missing(name, *args, &block)
     key = name.to_s
-    raise MissingSetting, "Missing setting '#{key}' in #{@section}" unless has_key? key
+    return missing_key("Missing setting '#{key}' in #{@section}") unless has_key? key
     value = fetch(key)
     create_accessor_for(key)
     value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
@@ -150,10 +160,16 @@ class Settingslogic < Hash
     self.class.class_eval <<-EndEval
       def #{key}
         return @#{key} if @#{key}
-        raise MissingSetting, "Missing setting '#{key}' in #{@section}" unless has_key? '#{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
       end
     EndEval
   end
+
+  def missing_key(msg)
+    return nil if self.class.suppress_errors
+
+    raise MissingSetting, msg
+  end
 end

data/settingslogic.gemspec

@@ -1,59 +1,64 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{settingslogic}
-  s.version = "2.0.6"
+  s.name = "settingslogic"
+  s.version = "2.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2010-02-12}
-  s.email = %q{bjohnson@binarylogic.com}
+  s.date = "2012-01-06"
+  s.email = "bjohnson@binarylogic.com"
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG.rdoc",
-     "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/settingslogic_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/binarylogic/settingslogic}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern.}
-  s.test_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/settings2.rb",
-     "spec/settings3.rb",
-     "spec/settingslogic_spec.rb",
-     "spec/spec_helper.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
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_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<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<ruby-debug19>, [">= 0"])
   end
 end
 

data/spec/settings4.rb

@@ -0,0 +1,4 @@
+class Settings4 < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+  suppress_errors true
+end

data/spec/settingslogic_spec.rb

@@ -107,6 +107,10 @@ describe "Settingslogic" do
     e.should_not be_nil
   end
 
+  it "should allow suppressing errors" do
+    Settings4.non_existent_key.should be_nil
+  end
+
   # This one edge case currently does not pass, because it requires very
   # esoteric code in order to make it pass.  It was judged not worth fixing,
   # as it introduces significant complexity for minor gain.
@@ -133,9 +137,26 @@ describe "Settingslogic" do
     Settings.get('setting1.deep.child.value').should == 2
   end
 
+  # If .name is not a property, delegate to superclass
+  it "should respond with Module.name" do
+    Settings2.name.should == "Settings2"
+  end
+
+  # If .name is called on Settingslogic itself, handle appropriately
+  # by delegating to Hash
+  it "should have the parent class always respond with Module.name" do
+    Settingslogic.name.should == 'Settingslogic'
+  end
+
+  # If .name is a property, respond with that instead of delegating to superclass
+  it "should allow a name setting to be overriden" do
+    Settings.name.should == 'test'
+  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
+  
 end

data/spec/spec_helper.rb

@@ -1,18 +1,16 @@
-require 'spec'
-require 'rubygems'
-require 'ruby-debug' if RUBY_VERSION < '1.9'  # ruby-debug does not work on 1.9.1 yet
-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
 require 'settingslogic'
 require 'settings'
 require 'settings2'
 require 'settings3'
+require 'settings4'
 
 # Needed to test Settings3
 Object.send :define_method, 'collides' do
   'collision'
 end
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
 end

metadata

@@ -1,30 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: settingslogic
-version: !ruby/object:Gem::Version 
-  version: 2.0.6
+version: !ruby/object:Gem::Version
+  version: 2.0.7
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ben Johnson of Binary Logic
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-02-12 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
+date: 2012-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70310322933480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310322933480
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70310322933000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310322933000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70310322932520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310322932520
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70310322932040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310322932040
 description: 
 email: bjohnson@binarylogic.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
-- .gitignore
+files:
 - CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -37,39 +78,32 @@ files:
 - spec/settings.yml
 - spec/settings2.rb
 - spec/settings3.rb
+- spec/settings4.rb
 - spec/settingslogic_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/binarylogic/settingslogic
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+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.3.5
+rubygems_version: 1.8.10
 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: 
-- spec/settings.rb
-- spec/settings2.rb
-- spec/settings3.rb
-- spec/settingslogic_spec.rb
-- spec/spec_helper.rb
+summary: A simple and straightforward settings solution that uses an ERB enabled YAML
+  file and a singleton design pattern.
+test_files: []

data/.gitignore

@@ -1,8 +0,0 @@
-.DS_Store
-*.log
-*.sqlite3
-pkg/*
-coverage/*
-doc/*
-benchmarks/*
-