binarylogic-settingslogic 1.0.4

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -0,0 +1,19 @@
+== 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,86 @@
+= 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.
+
+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>Repository:</b> http://github.com/binarylogic/settingslogic/tree/master
+* <b>Bugs / feature suggestions:</b> http://binarylogic.lighthouseapp.com/projects/19028-settingslogic
+
+== Install and use
+
+  sudo gem install settingslogic
+
+For rails, as a gem (recommended):
+
+  # config/environment.rb
+  config.gem "settingslogic"
+
+Or as a plugin (for older versions of rails)
+
+  script/plugin install git://github.com/binarylogic/settingslogic.git
+
+== Create your settings
+
+By default Settingslogic tries to load config/application.yml. This is just a typical YAML file, notice ERB is allowed.
+
+  # 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
+
+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"
+  
+  >> Settings.cool
+  => "#<Settingslogic::Settings ... >"
+  
+  >> Settings.cool.saweet
+  => "nested settings"
+  
+  >> Settings.neat_setting
+  => 800
+  
+  >> 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

@@ -0,0 +1,49 @@
+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"]
+    gem.rubyforge_project = "settingslogic"
+    gem.add_dependency "activesupport"
+  end
+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
+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
+end
+
+task :default => :test
+
+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

data/VERSION.yml

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

data/init.rb

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

data/lib/settingslogic.rb

@@ -0,0 +1,13 @@
+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)

data/lib/settingslogic/config.rb

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,80 @@
+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/rails/init.rb

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

data/test/application.yml

@@ -0,0 +1,6 @@
+setting1:
+  setting1_child: saweet
+
+setting2: 5
+setting3: <%= 5 * 5 %>
+name: test

data/test/application2.yml

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

data/test/application3.yml

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

data/test/config_test.rb

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,63 @@
+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

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: binarylogic-settingslogic
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07: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: 
+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
+- lib/settingslogic/config.rb
+- lib/settingslogic/settings.rb
+- rails/init.rb
+- test/application.yml
+- test/application2.yml
+- test/application3.yml
+- test/config_test.rb
+- test/setting_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/binarylogic/settingslogic
+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: settingslogic
+rubygems_version: 1.2.0
+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