Initial commit

Author: binarylogic

.gitignore

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

CHANGELOG.rdoc

@@ -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.

MIT-LICENSE

@@ -0,0 +1,13 @@
+CHANGELOG.rdoc
+init.rb
+lib/settingasm/config.rb
+lib/settingasm/setting.rb
+lib/settingasm/version.rb
+lib/settingasm.rb
+MIT-LICENSE
+Rakefile
+README.rdoc
+test/test_config.rb
+test/test_helper.rb
+test/test_setting.rb
+Manifest

Manifest

@@ -0,0 +1,73 @@
+= Settingasm
+
+Settingasm is my personal solution to application wide settings that uses an ERB enabled YAML file. It's pretty simple and straightforward, which is why I like it. I decided to go ahead and share it with the world. 
+
+So here is my question to you.....is Settingasm a great settings solution or the greatest?
+
+== 1. Configure
+
+Configuration is optional. See Settingasm::Config for more details.
+
+  # config/initializers/settingasm.rb
+  Settingasm::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.yaml
+    
+    config.class_name = "Setting" # use Setting.my_setting instead of Settingasm::Setting.my_setting
+  end
+
+== 2. Create your settings
+
+This is typical YAML file, notice ERB is allowed.
+
+  # app/config/application.yml
+  defaults: &defaults
+    cool_setting: this is 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
+
+== Access your settings
+
+I use Setting because I specified it in my configuration. Otherwise you would have to use Settingasm::Setting. Since Setting is such a generic name I let you specify your own in the configuration. You could use anything you want.
+
+  >> RAILS_ENV
+  => "development"
+  
+  >> Setting.cool
+  => "this is cool"
+  
+  >> Setting.cool.saweet
+  => "nested settings"
+  
+  >> Setting.new_setting
+  => 800
+  
+  >> Setting.awesome_setting
+  => "Did you know 5 + 5 = 10?"
+
+== Multiple settings
+
+  settings1 = Setting.new(:settings1) # looks for config/settings1.yml
+  settings2 = Setting.new("setting2.yaml") # looks for config/settings2.yml
+  settings3 = Setting.new(:some_setting => "some value")
+  
+== Helpful links
+
+*	<b>Documentation:</b> http://settingasm.rubyforge.org
+* <b>Bugs / feature suggestions:</b> http://binarylogic.lighthouseapp.com/projects/19028-settingasm
+
+
+Copyright (c) 2008 {Ben Johnson}[http://github.com/binarylogic] of {Binary Logic}[http://www.binarylogic.com], released under the MIT license 

README.rdoc

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'echoe'
+
+require File.dirname(__FILE__) << "/lib/settingasm/version"
+
+Echoe.new 'settingasm' do |p|
+  p.version = Settingasm::Version::STRING
+  p.author = "Ben Johnson of Binary Logic"
+  p.email  = 'bjohnson@binarylogic.com'
+  p.project = 'settingasm'
+  p.summary = "Simple and straightforward application wide settings"
+  p.url = "http://github.com/binarylogic/settingasm"
+  p.dependencies = []
+  p.include_rakefile = true
+end

Rakefile

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

init.rb

@@ -0,0 +1,4 @@
+require "yaml"
+require "erb"
+require File.dirname(__FILE__) + "/settingasm/config"
+require File.dirname(__FILE__) + "/settingasm/setting"

lib/settingasm.rb

@@ -0,0 +1,39 @@
+module Settingasm
+  # = Config
+  # Sets configuration on Settingasm.
+  class Config
+    class << self
+      def configure
+        yield self
+      end
+    
+      # The name of the class you want to use to access your settings. Maybe you don't like "Setting" or maybe it will conflict with a model you have. Just set this to "AppSetting" or "Config", whatever you want.
+      #
+      # * <tt>Default:</tt> "Setting"
+      # * <tt>Accepts:</tt> Symbol or String
+      def class_name
+        @class_name
+      end
+      
+      def class_name=(value) # :nodoc:
+        eval("::#{value} = Setting")
+        @class_name = value
+      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:
+      #
+      #   Setting.setting1
+      #   Setting.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

lib/settingasm/config.rb

@@ -0,0 +1,80 @@
+module Settingasm
+  # = Setting
+  #
+  # A simple settings solution using a YAML file. See README for more information.
+  class Setting
+    class << self
+      def name # :nodoc:
+        if instance._settings.key?("name")
+          instance.name
+        else
+          super
+        end
+      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 could 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:
+    #
+    #   Setting.new(:application) # will look for config/application.yml
+    #   Setting.new("application.yaml") # will look for application.yaml
+    #   Setting.new("/var/configs/application.yml") # will look for /var/configs/application.yml
+    #   Setting.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._settings = 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._settings = YAML.load(ERB.new(File.read(file_path)).result)
+        self._settings = _settings[RAILS_ENV] if defined?(RAILS_ENV)
+      else
+        raise ArgumentError.new("Your settings must be a hash or a name of a file via a String or a Symbol")
+      end
+      define_settings!
+    end
+    
+    private
+      def method_missing(name, *args, &block)
+        raise NoMethodError.new("no configuration was specified for #{name}")
+      end
+      
+      def define_settings!
+        _settings.each do |key, value|
+          case value
+          when Hash
+            instance_eval <<-"end_eval", __FILE__, __LINE__
+              def #{key}
+                @#{key} ||= self.class.new(_settings["#{key}"])
+              end
+            end_eval
+          else
+            instance_eval <<-"end_eval", __FILE__, __LINE__
+              def #{key}
+                @#{key} ||= _settings["#{key}"]
+              end
+            end_eval
+          end
+        end
+      end
+  end
+end

lib/settingasm/setting.rb

@@ -0,0 +1,79 @@
+# (The MIT License)
+# 
+# Copyright (c) 2008 Jamis Buck <jamis@37signals.com>,
+#               with modifications by Bruce Williams <bruce@fiveruns.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.
+module Settingasm
+  # = Version
+  #
+  # A class for describing the current version of a library. The version
+  # consists of three parts: the +major+ number, the +minor+ number, and the
+  # +tiny+ (or +patch+) number.
+  class Version
+    
+    include Comparable
+  
+    # A convenience method for instantiating a new Version instance with the
+    # given +major+, +minor+, and +tiny+ components.
+    def self.[](major, minor, tiny)
+      new(major, minor, tiny)
+    end
+
+    attr_reader :major, :minor, :tiny
+
+    # Create a new Version object with the given components.
+    def initialize(major, minor, tiny)
+      @major, @minor, @tiny = major, minor, tiny
+    end
+
+    # Compare this version to the given +version+ object.
+    def <=>(version)
+      to_i <=> version.to_i
+    end
+
+    # Converts this version object to a string, where each of the three
+    # version components are joined by the '.' character. E.g., 2.0.0.
+    def to_s
+      @to_s ||= [@major, @minor, @tiny].join(".")
+    end
+
+    # Converts this version to a canonical integer that may be compared
+    # against other version objects.
+    def to_i
+      @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+    end
+    
+    def to_a
+      [@major, @minor, @tiny]
+    end
+
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 0
+
+    # The current version as a Version instance
+    CURRENT = new(MAJOR, MINOR, TINY)
+    # The current version as a String
+    STRING = CURRENT.to_s
+    
+  end
+  
+end

lib/settingasm/version.rb

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

test/application.yml

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

test/application2.yml

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestConfig < Test::Unit::TestCase
+  def test_class_name
+    Settingasm::Config.configure do |config|
+      config.class_name = "Conf"
+    end
+    
+    assert_equal Conf, Conf.setting1.class
+    assert_equal "saweet", Conf.setting1.setting1_child
+    assert_equal 5, Conf.setting2
+    assert_equal 25, Conf.setting3
+  end
+  
+  def test_settings_file
+    Settingasm::Config.configure do |config|
+      config.settings_file = File.dirname(__FILE__) + '/application2.yml'
+    end
+    
+    Setting.reset!
+    assert_equal "BenJohnson", Setting.neat.cool.awesome
+    assert_equal 5, Setting.silly
+    assert_equal 25, Setting.fun
+  end
+end