konfigurator 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.rdb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss Kowalik
+
+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,72 @@
+= Konfigurator
+
+Konfigurator is a configuration toolkit strongly inspired by Sinatra framework
+settings. Thanks to it you can easy implement configuration options to your apps, 
+modules or classes. Take a look at simple example. 
+
+== Installation
+
+You can install Konfigurator simply using rubygems:
+
+  sudo gem install konfigurator
+  
+...or install it from source:
+
+  git clone git://github.com/nu7hatch/konfigurator.git
+  cd konfigurator
+  rake install  
+
+== Basic usage
+
+Konfigurator is very easy to use. Take a look at simple example. 
+
+  class MyClass do 
+    include Konfigurator
+  
+    set :foo, "bar"
+    enable :bar
+    disable :bla
+
+    configure :production
+      enable :bla
+      set :spam, "eggs!"
+    end
+  end
+
+Now you can get configured options directly from your class:
+
+  MyClass.foo # => "bar"
+  MyClass.bar # => true
+  MyClass.bla # => false
+
+... or when current environment is set to <tt>:production</tt>:
+
+  MyClass.bla  # => true
+  MyClass.spam # => "eggs!"
+
+All settings are also available from objects via <tt>#settings</tt> method:
+
+  obj = MyObject.new
+  obj.settings.foo # => "bar"
+  obk.settings.bar # => true
+
+<b>Remember!</b> when option is not set then <tt>NoMethodError</tt> will be
+raised after try to get it direcly from class, eg:
+
+  MyObject.set :exist
+  MyObject.exist      # => true
+  MyObject.not_exist  # => will raise NoMethodError
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kriss 'nu7hatch' Kowalik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "konfigurator"
+    gem.summary = %Q{Configuration toolkit inspired by Sinatra settings.}
+    gem.description = <<-DESCR
+      Konfigurator is a configuration toolkit strongly ispired by Sinatra framework
+      settings. Thanks to it you can easy implement configuration options to your apps, 
+      modules or classes. 
+    DESCR
+    gem.email = "kriss.kowalik@gmail.com"
+    gem.homepage = "http://github.com/nu7hatch/konfigurator"
+    gem.authors = ["Kriss 'nu7hatch' Kowalik"]
+    gem.add_development_dependency "contest", ">= 0.1.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Trolley #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/konfigurator.rb

@@ -0,0 +1,141 @@
+require "yaml"
+
+# Konfigurator is a configuration toolkit strongly inspired by Sinatra framework
+# settings. Thanks to it you can easy implement configuration options to your apps, 
+# modules or classes. Take a look at simple example. 
+#
+#   class MyClass do 
+#     set :foo, "bar"
+#     enable :bar
+#     disable :bla
+#
+#     configure :production
+#       enable :bla
+#       set :spam, "eggs!"
+#     end
+#   end
+#
+# Now you can get configured options directly from your class:
+#
+#   MyClass.foo # => "bar"
+#   MyClass.bar # => true
+#   MyClass.bla # => false
+#
+# ... or when current environment is set to <tt>:production</tt>:
+#
+#   MyClass.bla  # => true
+#   MyClass.spam # => "eggs!"
+#
+# All settings are also available from objects via <tt>#settings</tt> method:
+#
+#   obj = MyObject.new
+#   obj.settings.foo # => "bar"
+#   obk.settings.bar # => true
+#
+# <b>Remember!</b> when option is not set then <tt>NoMethodError</tt> will be
+# raised after try to get it direcly from class, eg:
+#
+#   MyObject.set :exist
+#   MyObject.exist      # => true
+#   MyObject.not_exist  # => will raise NoMethodError
+module Konfigurator
+
+  def self.included(base) # :nodoc:
+    base.send(:extend, ClassMethods)
+    base.send(:include, InstanceMethods)
+  end
+  
+  module InstanceMethods
+    # Access to configuration options is defined in the class methods, so it's
+    # only syntactic sugar for <tt>self.class</tt>.
+    def settings
+      self.class
+    end
+    alias :config :settings
+  end # InstanceMethods
+  
+  module ClassMethods
+    # Run once, at startup, in any environment. To add an option use the 
+    # <tt>set</tt> method (For boolean values You can use <tt>#enable</tt> and 
+    # <tt>#disable</tt> methods):
+    # 
+    #   configure do
+    #     set :foo, 'bar'
+    #     enable :bar
+    #     disable :yadayada
+    #   end
+    #   
+    # Run only when the environment (or the <tt>APP_ENV</tt> env variable)is set 
+    # to <tt>:production</tt>:
+    # 
+    #   configure :production do
+    #     ...
+    #   end
+    #
+    # Run when the environment is set to either <tt>:production</tt> or <tt>:test</tt>:
+    # 
+    #   configure :production, :test do
+    #     ...
+    #   end
+    def configure(*envs, &block)
+      class_eval(&block) if envs.empty? || envs.include?(env.to_sym)   
+    end
+    
+    # It loads settings from given <tt>.yml</tt> file. File should have structure
+    # like this one:
+    #
+    #   development:
+    #     foo: bar
+    #     bar: true
+    #   production: 
+    #     bla: foobar
+    def load_settings(fname)
+      conf = YAML.load_file(fname)
+      conf[env.to_s].each {|k,v| set k.to_sym, v }
+    end
+
+    # Returns hash with defined configuration options. 
+    def settings
+      @settings ||= {}
+    end
+    alias :config :settings
+    
+    # It "enables" given setting. It means that it assigns <tt>true</tt> value
+    # to the specified setting key.
+    #
+    #   enable :foo # => set :foo, true
+    def enable(name)
+      set(name, true)
+    end
+
+    # It "disables" given setting. It means that it assigns <tt>false</tt> value
+    # to the specified setting key.
+    #
+    #   disable :foo # => set :foo, false
+    def disable(name)
+      set(name, false)
+    end
+    
+    # Assigns given value to the specified setting key. 
+    #
+    #   set :foo, "YadaYadaYaday!"
+    #   set :bae, true
+    #
+    # See also shortcuts for boolean settings: <tt>#enable</tt> and 
+    # <tt>#disable</tt> methods. 
+    def set(name, value)
+      name = name.to_sym
+      unless self.respond_to?(name)
+        meta = class << self; self; end
+        meta.send(:define_method, name) { settings[name] }
+      end 
+      settings[name] = value
+    end
+    
+    # It returns name of current environment.
+    def environment
+      settings[:environment] ||= settings[:env] || ENV["APP_ENV"] || :development
+    end
+    alias :env :environment
+  end # ClassMethods
+end # Konfigurator

data/test/conf.yml

@@ -0,0 +1,6 @@
+production:
+  foo: bar
+  bla: true
+development: 
+  foo: bla
+  bla: false

data/test/helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require "test/unit"
+require "contest"
+require "konfigurator"
+

data/test/test_konfigurator.rb

@@ -0,0 +1,96 @@
+require "helper"
+
+class Configured
+  include Konfigurator
+end
+
+class TestKonfigurator < Test::Unit::TestCase
+  describe "Configured class" do 
+    should "respond to #set" do 
+      assert Configured.respond_to?(:set)
+    end
+    
+    should "respond to #enable" do
+      assert Configured.respond_to?(:enable)
+    end
+    
+    should "respond to #disable" do 
+      assert Configured.respond_to?(:disable)
+    end
+    
+    should "respond to #environment and #env" do 
+      assert Configured.respond_to?(:environment)
+      assert Configured.respond_to?(:env)
+    end
+    
+    should "respond to #settings and #config" do 
+      assert Configured.respond_to?(:settings)
+      assert Configured.respond_to?(:config)
+    end
+    
+    should "respond to #configure" do 
+      assert Configured.respond_to?(:configure)
+    end
+    
+    should "allow to set given option" do 
+      assert_equal "bar", Configured.set(:foo, "bar")
+      assert_equal "bar", Configured.settings[:foo]
+    end
+    
+    should "allow to quick disable given option" do 
+      assert !Configured.disable(:foo)
+      assert !Configured.foo
+    end 
+    
+    should "allow to quick enable given option" do 
+      assert Configured.enable(:foo)
+      assert Configured.foo
+    end
+    
+    should "allow for quick access to current environment name" do 
+      Configured.set :environment, :production
+      assert_equal :production, Configured.environment
+    end
+    
+    should "allow to define configuration specific for current env" do 
+      Configured.set :environment, :development
+      Configured.disable :prod
+      Configured.configure :production do 
+        enable :prod
+      end
+      Configured.configure :development do 
+        enable :dev
+      end
+      Configured.configure :development, :production do
+        set :bar, :foo
+      end
+      assert Configured.dev
+      assert !Configured.prod
+      assert_equal :foo, Configured.bar
+    end
+    
+    should "allow to load settings from yaml file" do 
+      Configured.set :environment, :production
+      Configured.load_settings(File.dirname(__FILE__)+"/conf.yml")
+      assert Configured.bla
+      assert_equal "bar", Configured.foo
+    end
+  end
+  
+  describe "Configured object" do 
+    setup do 
+      @configured = Configured.new
+    end
+    
+    should "respond to #settings and #config" do 
+      assert @configured.respond_to?(:settings)
+      assert @configured.respond_to?(:config)
+    end
+    
+    should "#settings works properly" do 
+      Configured.set(:fooo, :bar)
+      @configured = Configured.new
+      assert_equal :bar, @configured.settings.fooo
+    end 
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: konfigurator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kriss 'nu7hatch' Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id001
+description: "      Konfigurator is a configuration toolkit strongly ispired by Sinatra framework\n      settings. Thanks to it you can easy implement configuration options to your apps, \n      modules or classes. \n"
+email: kriss.kowalik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/konfigurator.rb
+- test/conf.yml
+- test/helper.rb
+- test/test_konfigurator.rb
+has_rdoc: true
+homepage: http://github.com/nu7hatch/konfigurator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Configuration toolkit inspired by Sinatra settings.
+test_files: 
+- test/test_konfigurator.rb
+- test/helper.rb