cubus-settingslogic 2.0.6

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -0,0 +1,27 @@
+== 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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Johnson of Binary Logic (binarylogic.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,145 @@
+= Settingslogic
+
+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
+*	<b>Repository:</b> http://github.com/binarylogic/settingslogic/tree/master
+* <b>Issues:</b> http://github.com/binarylogic/settingslogic/issues
+
+== 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.
+
+== Usage
+
+=== 1. Define your class
+
+Instead of defining a Settings constant for you, that task is left to you. Simply create a class in your application
+that looks like:
+
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/application.yml"
+    namespace Rails.env
+  end
+
+Name it Settings, name it Config, name it whatever you want. Add as many or as few as you like. A good place to put
+this file in a rails app is app/models/settings.rb
+
+I felt adding a settings file in your app was more straightforward, less tricky, and more flexible.
+
+=== 2. Create your settings
+
+Notice above we specified an absolute path to our settings file called "application.yml". This is just a typical YAML file.
+Also notice above that we specified a namespace for our environment.  A namespace is just an optional string that corresponds
+to a key in the YAML file.
+
+Using a namespace allows us to change our configuration depending on our environment:
+
+  # app/config/application.yml
+  defaults: &defaults
+    cool:
+      saweet: nested settings
+    neat_setting: 24
+    awesome_setting: <%= "Did you know 5 + 5 = #{5 + 5}?" %>
+  
+  development:
+    <<: *defaults
+    neat_setting: 800
+
+  test:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+
+=== 3. Access your settings
+
+  >> Rails.env
+  => "development"
+
+  >> 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:  
+
+  class Post < ActiveRecord::Base
+    self.per_page = Settings.pagination.posts_per_page
+  end
+
+=== 4. Optional / dynamic settings
+
+Often, you will want to handle defaults in your application logic itself, to reduce the number of settings
+you need to put in your YAML file.  You can access an optional setting by using Hash notation:
+
+  >> Settings.messaging.queue_name
+  => Exception: Missing setting 'queue_name' in 'message' section in 'application.yml'
+
+  >> Settings.messaging['queue_name']
+  => nil
+
+  >> Settings.messaging['queue_name'] ||= 'user_mail'
+  => "user_mail"
+
+  >> Settings.messaging.queue_name
+  => "user_mail"
+
+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.
+
+== Note on Sinatra / Capistrano / Vlad
+
+Each of these frameworks uses a +set+ convention for settings, which actually defines methods
+in the global Object namespace:
+
+  set :application, "myapp"  # does "def application" globally
+
+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
+    load!
+  end
+
+It's probably always safest to add load! to your class, since this guarantees settings will be
+loaded at that time, rather than lazily later via method_missing.
+
+Finally, you can reload all your settings later as well:
+
+  Settings.reload!
+
+This is useful if you want to support changing your settings YAML without restarting your app.
+
+== Author
+
+Copyright (c) 2008-2010 {Ben Johnson}[http://github.com/binarylogic] of {Binary Logic}[http://www.binarylogic.com],
+released under the MIT license.  Support for optional settings and reloading by {Nate Wiger}[http://nate.wiger.org].

data/Rakefile

@@ -0,0 +1,32 @@
+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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION.yml

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

data/init.rb

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

data/lib/settingslogic.rb

@@ -0,0 +1,126 @@
+require "yaml"
+require "erb"
+
+# A simple settings solution using a YAML file. See README for more information.
+class Settingslogic < Hash
+  class MissingSetting < StandardError; end
+  
+  class << self
+    def name # :nodoc:
+      instance.key?("name") ? instance.name : super
+    end
+    
+    def source(value = nil)
+      if value.nil?
+        @source
+      else
+        @source = value
+      end
+    end
+
+    def namespace(value = nil)
+      if value.nil?
+        @namespace
+      else
+        @namespace = value
+      end
+    end
+    
+    def key_by_path(key_path, separator = ".")
+      # Settings.get_nested_key('some.nested.setting')
+      tmp = instance
+      key_path.split(separator).each do |k|
+        if tmp[k].respond_to?("[]") && !tmp[k].nil?
+          tmp = tmp[k]
+        else
+          return nil
+        end
+      end
+      tmp
+    end
+    
+    def [](key)
+      # Setting.key.value or Setting[:key][:value] or Setting['key']['value']
+      fetch(key.to_s,nil)
+    end
+
+    def []=(key,val)
+      # Setting[:key] = 'value' for dynamic settings
+      store(key.to_s,val)
+    end
+    
+    def load!
+      instance
+      true
+    end
+    
+    def reload!
+      @instance = nil
+      load!
+    end
+    
+    private
+      def instance
+        @instance ||= new
+      end
+      
+      def method_missing(name, *args, &block)
+        instance.send(name, *args, &block)
+      end
+  end
+
+  # Initializes a new settings object. You can initialize an object in any of the following ways:
+  #
+  #   Settings.new(:application) # will look for config/application.yml
+  #   Settings.new("application.yaml") # will look for application.yaml
+  #   Settings.new("/var/configs/application.yml") # will look for /var/configs/application.yml
+  #   Settings.new(:config1 => 1, :config2 => 2)
+  #
+  # Basically if you pass a symbol it will look for that file in the configs directory of your rails app,
+  # if you are using this in rails. If you pass a string it should be an absolute path to your settings file.
+  # Then you can pass a hash, and it just allows you to access the hash via methods.
+  def initialize(hash_or_file = self.class.source, section = nil)
+    case hash_or_file
+    when 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
+      self.replace hash
+    end
+    @section = section || hash_or_file  # so end of error says "in application.yml"
+    create_accessors!
+  end
+
+  # Called for dynamically-defined keys, and also the first key deferenced at the top-level, if load! is not used.
+  # Otherwise, create_accessors! (called by new) will have created actual methods for each key.
+  def method_missing(key, *args, &block)
+    begin
+      value = fetch(key.to_s)
+    rescue IndexError
+      raise MissingSetting, "Missing setting '#{key}' in #{@section}"
+    end
+    value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
+  end
+
+  private
+    # 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"),
+    # rather than the app_yml['deploy_to'] hash.  Jeezus.
+    def create_accessors!
+      self.each do |key,val|
+        # Use instance_eval/class_eval because they're actually more efficient than define_method{}
+        # http://stackoverflow.com/questions/185947/ruby-definemethod-vs-def
+        # http://bmorearty.wordpress.com/2009/01/09/fun-with-rubys-instance_eval-and-class_eval/
+        self.class.class_eval <<-EndEval
+          def #{key}
+            return @#{key} if @#{key}  # cache (performance)
+            value = fetch('#{key}')
+            @#{key} = value.is_a?(Hash) ? self.class.new(value, "'#{key}' section in #{@section}") : value
+          end
+        EndEval
+      end
+    end
+
+end

data/rails/init.rb

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

data/settingslogic.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cubus-settingslogic"
+  s.version = "2.0.6"
+
+  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-01}
+  s.email = %q{bjohnson@binarylogic.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "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 = [
+    "spec/settings.rb",
+     "spec/settings2.rb",
+     "spec/settings3.rb",
+     "spec/settingslogic_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/spec/settings.rb

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

data/spec/settings.yml

@@ -0,0 +1,19 @@
+setting1:
+  setting1_child: saweet
+  deep:
+    another: my value
+    child:
+      value: 2
+
+setting2: 5
+setting3: <%= 5 * 5 %>
+name: test
+
+language:
+  haskell:
+    paradigm: functional
+  smalltalk:
+    paradigm: object oriented 
+
+collides:
+  does: not

data/spec/settings2.rb

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

data/spec/settings3.rb

@@ -0,0 +1,4 @@
+class Settings3 < Settingslogic
+  source "#{File.dirname(__FILE__)}/settings.yml"
+  load!  # test of load
+end

data/spec/settingslogic_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "Settingslogic" do
+  it "should access settings" do
+    Settings.setting2.should == 5
+  end
+  
+  it "should access nested settings" do
+    Settings.setting1.setting1_child.should == "saweet"
+  end
+  
+  it "should access deep nested settings" do
+    Settings.setting1.deep.another.should == "my value"
+  end
+
+  it "should access extra deep nested settings" do
+    Settings.setting1.deep.child.value.should == 2
+  end
+
+  it "should enable erb" do
+    Settings.setting3.should == 25
+  end
+  
+  it "should namespace settings" do
+    Settings2.setting1_child.should == "saweet"
+    Settings2.deep.another.should == "my value"
+  end
+
+  it "should return the namespace" do
+    Settings.namespace.should be_nil
+    Settings2.namespace.should == 'setting1'
+  end
+
+  it "should get a key by a path" do
+    Settings.key_by_path("language.haskell.paradigm").should == "functional"
+  end
+
+  it "should distinguish nested keys" do
+    Settings.language.haskell.paradigm.should == 'functional'
+    Settings.language.smalltalk.paradigm.should == 'object oriented'
+  end
+  
+  it "should not collide with global methods" do
+    Settings3.collides.does.should == 'not'
+  end
+  
+  it "should raise a helpful error message" do
+    e = nil
+    begin
+      Settings.missing
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'missing' in/
+    
+    e = nil
+    begin
+      Settings.language.missing
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'missing' in 'language' section/
+  end
+
+  it "should handle optional / dynamic settings" do
+    e = nil
+    begin
+      Settings.language.erlang
+    rescue => e
+      e.should be_kind_of Settingslogic::MissingSetting
+    end
+    e.should_not be_nil
+    e.message.should =~ /Missing setting 'erlang' in 'language' section/
+    
+    Settings.language['erlang'].should be_nil
+    Settings.language['erlang'] ||= 5
+    Settings.language['erlang'].should == 5
+
+    Settings.language['erlang'] = {'paradigm' => 'functional'}
+    Settings.language.erlang.paradigm.should == 'functional'
+
+    Settings.reload!
+    Settings.language['erlang'].should be_nil
+  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

@@ -0,0 +1,18 @@
+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 'settingslogic'
+require 'settings'
+require 'settings2'
+require 'settings3'
+
+# Needed to test Settings3
+def collides
+  'collision'
+end
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: cubus-settingslogic
+version: !ruby/object:Gem::Version 
+  version: 2.0.6
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-01 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/binarylogic/settingslogic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+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