settingslogic 1.0.4 → 2.0.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 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.

data/README.rdoc

@@ -1,31 +1,45 @@
 = Settingslogic
 
-Settingslogic is an old library of mine that I decided to go ahead and share with the world. It's nothing crazy or new. Just a simple solution to a simple problem. Settingslogic provides globally accessible settings via an ERB enabled YAML file using a singleton design pattern. It has been great for my apps, maybe you will enjoy it too.
+Settingslogic is a simple configuration / settings solution that uses an ERB enabled YAML file. It has been great for my apps, maybe you will enjoy it too.
 
 So here is my question to you.....is Settingslogic a great settings solution or the greatest?
 
 == Helpful links
 
-*	<b>Documentation:</b> http://settingslogic.rubyforge.org
+*	<b>Documentation:</b> http://rdoc.info/projects/binarylogic/settingslogic
 *	<b>Repository:</b> http://github.com/binarylogic/settingslogic/tree/master
-* <b>Bugs / feature suggestions:</b> http://binarylogic.lighthouseapp.com/projects/19028-settingslogic
+* <b>Issues:</b> http://github.com/binarylogic/settingslogic/issues
 
 == Install and use
 
+Install from rubyforge:
+
   sudo gem install settingslogic
 
-For rails, as a gem (recommended):
+Install from github:
 
-  # config/environment.rb
-  config.gem "settingslogic"
+  sudo gem install binarylogic-settingslogic
 
-Or as a plugin (for older versions of rails)
+Or as a plugin
 
   script/plugin install git://github.com/binarylogic/settingslogic.git
 
-== Create your settings
+== 1. Define your constant
+
+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 models/settings.rb
+
+I felt adding a settings file in your app was more straightforward, less tricky, and more flexible.
+
+== 2. Create your settings
 
-By default Settingslogic tries to load config/application.yml. This is just a typical YAML file, notice ERB is allowed.
+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. This allows us to namespace our configuration depending on our environment:
 
   # app/config/application.yml
   defaults: &defaults
@@ -44,12 +58,10 @@ By default Settingslogic tries to load config/application.yml. This is just a ty
   production:
     <<: *defaults
 
-Take note of the environment namespacing. If your framework supports environments this is a good way to support environment specific settings. If you are using this in an area where there are no environment disregard the namespacing. It will work just fine without it.
-
 == Access your settings
 
-  >> RAILS_ENV
-  => "development"
+  >> Rails.env.development?
+  => true
   
   >> Settings.cool
   => "#<Settingslogic::Settings ... >"
@@ -63,24 +75,5 @@ Take note of the environment namespacing. If your framework supports environment
   >> Settings.awesome_setting
   => "Did you know 5 + 5 = 10?"
 
-== Multiple settings
-
-  settings1 = Settings.new(:settings1) # looks for config/settings1.yml
-  settings2 = Settings.new("settings2.yaml") # looks for settings2.yml
-  settings2 = Settings.new("/abs/path/settings2.yaml") # looks for /abs/path/settings2.yml
-  settings3 = Settings.new(:some_setting => "some value")
-
-== Configure
-
-Configuration is optional. See Settingslogic::Config for more details.
-
-  # config/initializers/settingslogic.rb
-  Settingslogic::Config.configure do |config|
-    config.file_name = :config # will look for config/config.yml
-    config.file_name = "config" # will look for config
-    config.file_name = "config.yaml" # will look for confg.yaml
-    config.file_name = "/absolute/path/config.yml" # will look for /absolute/path/config.yml
-  end
-
 
 Copyright (c) 2008 {Ben Johnson}[http://github.com/binarylogic] of {Binary Logic}[http://www.binarylogic.com], released under the MIT license 

data/Rakefile

@@ -10,40 +10,24 @@ begin
     gem.homepage = "http://github.com/binarylogic/settingslogic"
     gem.authors = ["Ben Johnson of Binary Logic"]
     gem.rubyforge_project = "settingslogic"
-    gem.add_dependency "activesupport"
   end
+  Jeweler::RubyforgeTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :spec => :check_dependencies
 
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-    desc "Release gem to RubyForge"
-    task :release => ["rubyforge:release:gem"]
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end
+task :default => :spec

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 4
-:major: 1
 :minor: 0
+:patch: 0
+:major: 2

data/lib/settingslogic.rb

@@ -1,13 +1,86 @@
 require "yaml"
 require "erb"
-require File.dirname(__FILE__) + "/settingslogic/config"
-require File.dirname(__FILE__) + "/settingslogic/settings"
 
-# Try to load conflicting Settings classes
-begin
-  Settings
-rescue(NameError)
-end
-
-# Since we don't have a Settings constant, lets go ahead and use it
-::Settings = Settingslogic::Settings unless defined?(Settings)
+# A simple settings solution using a YAML file. See README for more information.
+class Settingslogic < Hash
+  class UndefinedSetting < 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
+    
+    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)
+    case hash_or_file
+    when Hash
+      self.update hash_or_file
+    else
+      self.update YAML.load(ERB.new(File.read(hash_or_file)).result).to_hash
+      self.update self[self.class.namespace] if self.class.namespace
+    end
+    
+    define_settings!
+  end
+  
+  private
+    def method_missing(name, *args, &block)
+      raise UndefinedSetting.new("The '#{name}' was not found in your configuration file: #{self.class.source}")
+    end
+    
+    def define_settings!
+      self.each do |key, value|
+        case value
+        when Hash
+          instance_eval <<-"end_eval", __FILE__, __LINE__
+            def #{key}
+              @#{key} ||= self.class.new(self[#{key.inspect}])
+            end
+          end_eval
+        else
+          instance_eval <<-"end_eval", __FILE__, __LINE__
+            def #{key}
+              @#{key} ||= self[#{key.inspect}]
+            end
+            def #{key}=(value)
+              @#{key} = value
+            end
+          end_eval
+        end
+      end
+    end
+end

data/settingslogic.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{settingslogic}
-  s.version = "1.0.4"
+  s.version = "2.0.0"
 
   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{2009-06-28}
+  s.date = %q{2009-08-22}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -21,27 +24,25 @@ Gem::Specification.new do |s|
      "VERSION.yml",
      "init.rb",
      "lib/settingslogic.rb",
-     "lib/settingslogic/config.rb",
-     "lib/settingslogic/settings.rb",
      "rails/init.rb",
      "settingslogic.gemspec",
-     "test/application.yml",
-     "test/application2.yml",
-     "test/application3.yml",
-     "test/config_test.rb",
-     "test/setting_test.rb",
-     "test/test_helper.rb"
+     "spec/settings.rb",
+     "spec/settings.yml",
+     "spec/settings2.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.rubyforge_project = %q{settingslogic}
-  s.rubygems_version = %q{1.3.4}
+  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 = [
-    "test/config_test.rb",
-     "test/setting_test.rb",
-     "test/test_helper.rb"
+    "spec/settings.rb",
+     "spec/settings2.rb",
+     "spec/settingslogic_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -49,11 +50,8 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
     else
-      s.add_dependency(%q<activesupport>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 0"])
   end
 end

data/spec/settings.rb

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

data/spec/settings2.rb

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

data/spec/settingslogic_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "Settingslogic" do
+  it "should be a hash" do
+    Settings.send(:instance).should be_is_a(Hash)
+  end
+  
+  it "should access settings" do
+    Settings.setting1.should == {"setting1_child" => "saweet"}
+  end
+  
+  it "should access nested settings" do
+    Settings.setting1.setting1_child.should == "saweet"
+  end
+  
+  it "should enable erb" do
+    Settings.setting3.should == 25
+  end
+  
+  it "should raise an error for unfound settings" do
+    lambda { Settings.undefined }.should raise_error(Settingslogic::UndefinedSetting)
+  end
+  
+  it "should namespace settings" do
+    Settings2.setting1_child.should == "saweet"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'spec'
+require 'rubygems'
+require 'ruby-debug'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'settingslogic'
+require 'settings'
+require 'settings2'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: settingslogic
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-28 00:00:00 -04:00
+date: 2009-08-22 00:00:00 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: 
 email: bjohnson@binarylogic.com
 executables: []
@@ -40,16 +31,13 @@ files:
 - VERSION.yml
 - init.rb
 - lib/settingslogic.rb
-- lib/settingslogic/config.rb
-- lib/settingslogic/settings.rb
 - rails/init.rb
 - settingslogic.gemspec
-- test/application.yml
-- test/application2.yml
-- test/application3.yml
-- test/config_test.rb
-- test/setting_test.rb
-- test/test_helper.rb
+- spec/settings.rb
+- spec/settings.yml
+- spec/settings2.rb
+- spec/settingslogic_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/binarylogic/settingslogic
 licenses: []
@@ -74,11 +62,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: settingslogic
-rubygems_version: 1.3.4
+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: 
-- test/config_test.rb
-- test/setting_test.rb
-- test/test_helper.rb
+- spec/settings.rb
+- spec/settings2.rb
+- spec/settingslogic_spec.rb
+- spec/spec_helper.rb

data/lib/settingslogic/config.rb

@@ -1,25 +0,0 @@
-module Settingslogic
-  # Sets configuration on Settingslogic.
-  class Config
-    class << self
-      def configure
-        yield self
-      end
-      
-      # The name of the file that your settings will be stored for singleton access. Meaning the settings file that will be used when calling methods on the class level:
-      #
-      #   Settings.setting1
-      #   Settings.setting2
-      #   # etc...
-      #
-      # All that you need to do is specify the name of the file. It will automatically look in the config directory.
-      #
-      # * <tt>Default:</tt> :application
-      # * <tt>Accepts:</tt> Symbol or String
-      def settings_file
-        @settings_file ||= :application
-      end
-      attr_writer :settings_file
-    end
-  end
-end

data/lib/settingslogic/settings.rb

@@ -1,80 +0,0 @@
-module Settingslogic
-  # A simple settings solution using a YAML file. See README for more information.
-  class Settings < Hash
-    class << self
-      def name # :nodoc:
-        instance.key?("name") ? instance.name : super
-      end
-      
-      # Resets the singleton instance. Useful if you are changing the configuration on the fly. If you are changing the configuration on the fly you should consider creating instances.
-      def reset!
-        @instance = nil
-      end
-      
-      private
-        def instance
-          @instance ||= new
-        end
-        
-        def method_missing(name, *args, &block)
-          instance.send(name, *args, &block)
-        end
-    end
-    
-    attr_accessor :_settings
-    
-    # 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(name_or_hash = Config.settings_file)
-      case name_or_hash
-      when Hash
-        self.update name_or_hash
-      when String, Symbol
-        root_path = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config/" : ""
-        file_path = name_or_hash.is_a?(Symbol) ? "#{root_path}#{name_or_hash}.yml" : name_or_hash
-        self.update YAML.load(ERB.new(File.read(file_path)).result).to_hash
-      else
-        raise ArgumentError.new("Your settings must be a hash, a symbol representing the name of the .yml file in your config directory, or a string representing the abosolute path to your settings file.")
-      end
-      if defined?(RAILS_ENV)
-        rails_env = self.keys.include?(RAILS_ENV) ? RAILS_ENV : RAILS_ENV.to_sym
-        self.update self[rails_env] if self[rails_env]
-      end
-      define_settings!
-    end
-    
-    private
-      def method_missing(name, *args, &block)
-        raise NoMethodError.new("no configuration was specified for #{name}")
-      end
-      
-      def define_settings!
-        self.each do |key, value|
-          case value
-          when Hash
-            instance_eval <<-"end_eval", __FILE__, __LINE__
-              def #{key}
-                @#{key} ||= self.class.new(self[#{key.inspect}])
-              end
-            end_eval
-          else
-            instance_eval <<-"end_eval", __FILE__, __LINE__
-              def #{key}
-                @#{key} ||= self[#{key.inspect}]
-              end
-              def #{key}=(value)
-                @#{key} = value
-              end
-            end_eval
-          end
-        end
-      end
-  end
-end

data/test/application2.yml

@@ -1,6 +0,0 @@
-neat:
-  cool:
-    awesome: <%= "Ben" + "Johnson" %>
-
-silly: 5
-fun: <%= 5 * 5 %>

data/test/application3.yml

@@ -1,9 +0,0 @@
-neat:
-  cool:
-    awesome: <%= "Ben" + "Johnson" %>
-
-silly: 5
-fun: <%= 5 * 5 %>
-
-test:
-  silly: "test_specific"

data/test/config_test.rb

@@ -1,14 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestConfig < Test::Unit::TestCase
-  def test_settings_file
-    Settingslogic::Config.configure do |config|
-      config.settings_file = File.dirname(__FILE__) + '/application2.yml'
-    end
-    
-    Settings.reset!
-    assert_equal "BenJohnson", Settings.neat.cool.awesome
-    assert_equal 5, Settings.silly
-    assert_equal 25, Settings.fun
-  end
-end

data/test/setting_test.rb

@@ -1,63 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestSetting < Test::Unit::TestCase
-  def test_conflicting_class_methods
-    assert_equal "test", Settings.name
-  end
-  
-  def test_singleton_access
-    assert_equal Settings, Settings.setting1.class
-    assert_equal "saweet", Settings.setting1.setting1_child
-    assert_equal 5, Settings.setting2
-    assert_equal 25, Settings.setting3
-  end
-  
-  def test_instances
-    settings1 = Settings.new(File.dirname(__FILE__) + '/application.yml')
-    assert_equal "saweet", settings1.setting1.setting1_child
-    assert_equal 5, settings1.setting2
-    assert_equal 25, settings1.setting3
-    
-    settings2 = Settings.new(File.dirname(__FILE__) + '/application2.yml')
-    assert_equal "BenJohnson", settings2.neat.cool.awesome
-    assert_equal 5, settings2.silly
-    assert_equal 25, settings2.fun
-  end
-  
-  def test_method_missing
-    assert_raise(NoMethodError) { Settings.doesnt_exist }
-    settings1 = Settings.new(File.dirname(__FILE__) + '/application.yml')
-    assert_raise(NoMethodError) { settings1.doesnt_exist }
-  end
-  
-  def test_initialized_with_hash
-    settings1 = Settings.new(
-        :silly => 5,
-        'fun' => 25,
-        :neat => { 'cool' => { :awesome => "BenJohnson" } }
-      )
-    assert_equal "BenJohnson", settings1.neat.cool.awesome
-    assert_equal 5, settings1.silly
-    assert_equal 25, settings1.fun
-  end
-  
-  def test_environment_specific_settings
-    in_test_environment do
-      settings1 = Settings.new(File.dirname(__FILE__) + '/application3.yml')
-      assert_equal 25, settings1.fun
-      assert_equal "test_specific", settings1.silly
-    end
-  end
-  
-  def test_environment_specific_settings_when_initialized_with_hash
-    in_test_environment do
-      settings1 = Settings.new(
-          :silly => 5,
-          'fun' => 25,
-          :test => { :silly => "test_specific" }
-        )
-      assert_equal 25, settings1.fun
-      assert_equal "test_specific", settings1.silly
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,27 +0,0 @@
-require "test/unit"
-require "rubygems"
-require "ruby-debug"
-require File.dirname(__FILE__) + "/../lib/settingslogic"
-
-class Test::Unit::TestCase
-  def configure
-    Settingslogic::Config.configure do |config|
-      config.settings_file = File.dirname(__FILE__) + "/application.yml"
-    end
-  end
-  
-  def setup
-    configure
-  end
-  
-  def teardown
-    configure
-    Settingslogic::Settings.reset!
-  end
-  
-  def in_test_environment(&block)
-    Settingslogic::Settings.const_set :RAILS_ENV, "test"
-    block.call
-    Settingslogic::Settings.send :remove_const, :RAILS_ENV
-  end
-end