settingslogic 0.9.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.9.0 released 2008-10-30
+
+* Initial release

data/MIT-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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG.rdoc
+init.rb
+lib/settingslogic/config.rb
+lib/settingslogic/settings.rb
+lib/settingslogic/version.rb
+lib/settingslogic.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+test/application.yml
+test/application2.yml
+test/test_config.rb
+test/test_helper.rb
+test/test_setting.rb

data/README.rdoc

@@ -0,0 +1,70 @@
+= 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. 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?
+
+== 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
+
+== 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.yaml
+  end
+
+== Helpful links
+
+*	<b>Documentation:</b> http://settingslogic.rubyforge.org
+* <b>Bugs / feature suggestions:</b> http://binarylogic.lighthouseapp.com/projects/19028-settingslogic
+
+
+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,15 @@
+require 'rubygems'
+require 'echoe'
+
+require File.dirname(__FILE__) << "/lib/settingslogic/version"
+
+Echoe.new 'settingslogic' do |p|
+  p.version = Settingslogic::Version::STRING
+  p.author = "Ben Johnson of Binary Logic"
+  p.email  = 'bjohnson@binarylogic.com'
+  p.project = 'settingslogic'
+  p.summary = "Simple and straightforward application wide settings"
+  p.url = "http://github.com/binarylogic/settingslogic"
+  p.dependencies = []
+  p.include_rakefile = true
+end

data/init.rb

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

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,26 @@
+module Settingslogic
+  # = Config
+  # 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,76 @@
+module Settingslogic
+  # = Setting
+  #
+  # A simple settings solution using a YAML file. See README for more information.
+  class Settings
+    class << self
+      def name # :nodoc:
+        instance._settings.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._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

data/lib/settingslogic/version.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 Settingslogic
+  # = 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

data/settingslogic.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name = %q{settingslogic}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Johnson of Binary Logic"]
+  s.date = %q{2008-11-02}
+  s.description = %q{Simple and straightforward application wide settings}
+  s.email = %q{bjohnson@binarylogic.com}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/settingslogic/config.rb", "lib/settingslogic/settings.rb", "lib/settingslogic/version.rb", "lib/settingslogic.rb", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "init.rb", "lib/settingslogic/config.rb", "lib/settingslogic/settings.rb", "lib/settingslogic/version.rb", "lib/settingslogic.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "test/application.yml", "test/application2.yml", "test/test_config.rb", "test/test_helper.rb", "test/test_setting.rb", "settingslogic.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/binarylogic/settingslogic}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Settingslogic", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{settingslogic}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Simple and straightforward application wide settings}
+  s.test_files = ["test/test_config.rb", "test/test_helper.rb", "test/test_setting.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/test/application.yml

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

data/test/application2.yml

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

data/test/test_config.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/test_helper.rb

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

data/test/test_setting.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSetting < Test::Unit::TestCase
+  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
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: settingslogic
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Ben Johnson of Binary Logic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-02 01:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple and straightforward application wide settings
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- lib/settingslogic/config.rb
+- lib/settingslogic/settings.rb
+- lib/settingslogic/version.rb
+- lib/settingslogic.rb
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- init.rb
+- lib/settingslogic/config.rb
+- lib/settingslogic/settings.rb
+- lib/settingslogic/version.rb
+- lib/settingslogic.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/application.yml
+- test/application2.yml
+- test/test_config.rb
+- test/test_helper.rb
+- test/test_setting.rb
+- settingslogic.gemspec
+has_rdoc: true
+homepage: http://github.com/binarylogic/settingslogic
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Settingslogic
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: settingslogic
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple and straightforward application wide settings
+test_files: 
+- test/test_config.rb
+- test/test_helper.rb
+- test/test_setting.rb