konfigurator 0.1.1 → 0.2.0

data/.gitignore

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

data/README.rdoc

@@ -62,38 +62,71 @@ Not there is also possible to use nice-looking DSL syntax provided by
 <tt>Konfigurator::DSL</tt>. It allow you to configure your apps/classes 
 such like here:
 
-    Foo.configure do 
-      host "127.0.0.1"
-      port 8080
-      password "secret"
-    end
+  Foo.configure do 
+    host "127.0.0.1"
+    port 8080
+    password "secret"
+  end
 
 But what's important in this kind of configuration, you have to define all possible
 options first. You can define configuration attributes easy using <tt>#attr_config</tt> 
 (or <tt>#attr_setting</tt> alias). 
 
-   class Foo 
-     include Konfigurator::DSL
+  class Foo 
+    include Konfigurator::DSL
 
-     attr_config :host, :port
-     attr_config :password
-   end
+    attr_config :host, :port
+    attr_config :password
+  end
 
 Other use cases behave almost the same as with Konfigurator::Simple:
 
-   Foo.host # => "127.0.0.1"
-   Foo.port # => 8080
+  Foo.host # => "127.0.0.1"
+  Foo.port # => 8080
+
+  Foo.env :production
+  Foo.configure :production do 
+    host "production.com"
+    port 80
+  end
 
-   Foo.env :production
-   Foo.configure :production do 
-     host "production.com"
-     port 80
-   end
+  foo = Foo.new
+  foo.settings.host # => "production.com"
+  foo.settings.port # => 80
 
-   foo = Foo.new
-   foo.settings.host # => "production.com"
-   foo.settings.port # => 80
+== Configuring Rails 3 application
+
+You can easily mix Konfigurator with your Rails 3 app. Add this line to your <tt>config/application.rb</tt>:
   
+  require 'konfigurator/railtie'
+
+... and now you can set your own configuration, eg:
+
+  module MyApp
+    class Application < Rails::Application
+      set :foo, "Foo"
+      set :bat, "Bar"
+      enable :foobar
+
+      # ...
+    end
+  end
+
+Now you can use it in controllers... 
+
+  class UsersController
+    def index
+      if settings.foobar and settings.foo == "Foo"
+        # ...
+      end
+    end
+  end
+
+... and views...
+
+  <h1><%= settings.foo %></h1>
+  <p><%= settings.bar %></p>
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,52 +1,40 @@
-require 'rubygems'
-require 'rake'
+# -*- ruby -*-
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "konfigurator"
-    gem.summary = %Q{Small and flexible Configuration toolkit inspired i.a. by Sinatra settings.}
-    gem.description = <<-DESCR
-      Konfigurator is a small and flexible configuration toolkit, which allow you 
-      to configure your apps, classes or modules with DSL-style or Sinatra-like settings.
-    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
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'konfigurator/version'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %q[-c -b]
 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
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rspec_opts = %q[-c -b]
+  t.rcov_opts = %q[-T -x "spec"]
 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 = "Konfigurator #{version}"
+  rdoc.title = "Konfigurator #{Konfigurator.version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :default => :spec
+
+desc "Build current version as a rubygem"
+task :build do
+  `gem build konfigurator.gemspec`
+  `mv konfigurator-*.gem pkg/`
+end
+
+desc "Relase current version to rubygems.org"
+task :release => :build do
+  `git tag -am "Version bump to #{Konfigurator.version}" v#{Konfigurator.version}`
+  `git push origin master`
+  `git push origin master --tags`
+  `gem push pkg/konfigurator-#{Konfigurator.version}.gem`
+end

data/konfigurator.gemspec

@@ -1,59 +1,19 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# -*- ruby -*-
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'konfigurator/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{konfigurator}
-  s.version = "0.1.1"
+  s.name             = 'konfigurator'
+  s.version          = Konfigurator.version
+  s.homepage         = 'http://github.com/nu7hatch/konfigurator'
+  s.email            = ['chris@nu7hat.ch']
+  s.authors          = ['Chris Kowalik']
+  s.summary          = %q{Small and flexible Configuration toolkit inspired i.a. by Sinatra settings.}
+  s.description      = %q{Konfigurator is a small and flexible configuration toolkit, which allow you to configure your apps, classes or modules with DSL-style or Sinatra-like settings.}
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths    = %w[lib]
+  s.extra_rdoc_files = %w[LICENSE README.rdoc]
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kriss 'nu7hatch' Kowalik"]
-  s.date = %q{2010-10-29}
-  s.description = %q{      Konfigurator is a small and flexible configuration toolkit, which allow you 
-      to configure your apps, classes or modules with DSL-style or Sinatra-like settings.
-}
-  s.email = %q{kriss.kowalik@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "konfigurator.gemspec",
-     "lib/konfigurator.rb",
-     "lib/konfigurator/dsl.rb",
-     "lib/konfigurator/simple.rb",
-     "test/helper.rb",
-     "test/test_dsl.rb",
-     "test/test_simple.rb"
-  ]
-  s.homepage = %q{http://github.com/nu7hatch/konfigurator}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Small and flexible Configuration toolkit inspired i.a. by Sinatra settings.}
-  s.test_files = [
-    "test/test_dsl.rb",
-     "test/test_simple.rb",
-     "test/helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<contest>, [">= 0.1.2"])
-    else
-      s.add_dependency(%q<contest>, [">= 0.1.2"])
-    end
-  else
-    s.add_dependency(%q<contest>, [">= 0.1.2"])
-  end
+  s.add_development_dependency 'contest',     [">= 0.1.2"]
 end
-

data/lib/konfigurator.rb

@@ -51,11 +51,10 @@ module Konfigurator
       def settings
         @settings ||= {}
       end
-      alias :config :settings
       
       # It returns name of current environment.
       def environment
-        settings[:environment] ||= settings[:env] || ENV["APP_ENV"] || :development
+        settings[:environment] ||= settings[:env] || ENV["RAILS_ENV"] || ENV["APP_ENV"] || :development
       end
       alias :env :environment
     end # ClassMethods

data/lib/konfigurator/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails'
+require 'konfigurator'
+
+module Konfigurator
+  module Helpers
+    module ActionController
+      def self.included(base)
+        base.send :extend, self
+        base.helper_method :settings
+      end
+
+      def settings
+        Rails.application.settings
+      end
+    end # ActionController
+  end # Helpers
+end # Konfigurator
+
+Rails::Application.send     :include, Konfigurator::Simple
+ActionController::Base.send :include, Konfigurator::Helpers::ActionController

data/lib/konfigurator/version.rb

@@ -0,0 +1,12 @@
+module Konfigurator
+  module Version # :nodoc:
+    MAJOR  = 0
+    MINOR  = 2
+    PATCH  = 0
+    STRING = [MAJOR, MINOR, PATCH].join('.')
+  end
+  
+  def self.version # :nodoc:
+    Version::STRING
+  end
+end # Konfigurator

data/spec/dsl_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Object configured with Konfigurator::DSL" do 
+  subject do
+    ConfiguredWithDSL
+  end
+  
+  it_should_behave_like "configured"
+
+  it "responds to #attr_config and #attr_setting" do 
+    subject.should respond_to(:attr_config)
+    subject.should respond_to(:attr_setting)
+  end
+  
+  it "responds to defined #foo and #bar settings" do 
+    subject.should respond_to(:foo)
+    subject.should respond_to(:bar)
+  end
+  
+  it "allows to set config option value with DSL-style syntax" do 
+    subject.foo :bar
+    subject.foo.should == :bar
+  end
+  
+  it "allows for quick access to current environment name" do 
+    subject.environment :production
+    subject.environment.should == :production
+  end
+  
+  it "allows to load settings from yaml file" do 
+    with_conf_file do |fname|
+      subject.environment :production
+      subject.attr_config :bla
+      subject.load_settings(fname)
+      
+      subject.bla.should be
+      subject.foo.should == "bar"
+    end
+  end
+  
+  it "allows to define configuration specific for current env" do 
+    subject.attr_config :prod, :dev, :bar
+    subject.environment :development
+    subject.prod false
+    subject.configure(:production) { prod true }
+    subject.configure(:development) { dev true }
+    subject.configure(:development, :production) { bar :foo }
+    
+    subject.dev.should be
+    subject.prod.should_not be
+    subject.bar.should == :foo
+  end
+end

data/spec/simple_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Konfigurator::Simple" do 
+  subject do
+    ConfiguredWithSimple
+  end
+  
+  it_should_behave_like "configured"
+  
+  it "responds to #set" do 
+    subject.should respond_to(:set)
+  end
+  
+  it "responds to #enable" do
+    subject.should respond_to(:enable)
+  end
+  
+  it "responds to #disable" do 
+    subject.should respond_to(:disable)
+  end
+  
+  it "allows to set given option" do 
+    subject.set(:foo, "bar").should == "bar"
+    subject.settings[:foo].should == "bar"
+  end
+  
+  it "allows to quick disable given option" do 
+    subject.disable(:foo).should_not be
+    subject.foo.should_not be
+  end 
+  
+  it "allows to quick enable given option" do 
+    subject.enable(:foo).should be
+    subject.foo.should be
+  end
+  
+  it "allows for quick access to current environment name" do 
+    subject.set :environment, :production
+    subject.environment.should == :production
+  end
+  
+  it "allows to define configuration specific for current env" do 
+    subject.set :environment, :development
+    subject.disable :prod
+    subject.configure(:production) { enable :prod }
+    subject.configure(:development) { enable :dev }
+    subject.configure(:development, :production) { set :bar, :foo }
+    
+    subject.dev.should be
+    subject.prod.should_not be
+    subject.bar.should == :foo
+  end
+  
+  it "allows to load settings from yaml file" do 
+    with_conf_file do |fname|
+      subject.set :environment, :production
+      subject.load_settings(fname)
+
+      subject.bla.should be
+      subject.foo.should == "bar"
+    end
+  end
+  
+  it "not uses envs when use_envs is false" do
+    with_conf_file do |fname|
+      subject.set :environment, :production
+      subject.load_settings(fname, false)
+
+      subject.production.should be_kind_of(Hash)
+      subject.production['foo'].should == "bar"
+    end
+  end
+end
+
+describe "Object configured with Konfigurator::Simple" do 
+  subject do
+    ConfiguredWithSimple  
+  end
+  
+  it "responds to #settings and #config" do 
+    @configured = subject.new
+    @configured.should respond_to(:settings)
+    @configured.should respond_to(:config)
+  end
+  
+  it "#settings works properly" do 
+    subject.set(:fooo, :bar)
+    @configured = subject.new
+    @configured.settings.fooo.should == :bar
+  end 
+end

data/{test/helper.rb → spec/spec_helper.rb}

@@ -1,36 +1,38 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require "rubygems"
-require "test/unit"
-require "contest"
+require "rspec"
+require "mocha"
 require "fileutils"
 require "konfigurator"
 
-COMMON_TESTS = <<-EVAL
-  should "respond to #environment and #env" do 
-    assert subject.respond_to?(:environment)
-    assert subject.respond_to?(:env)
-  end
-  
-  should "respond to #settings and #config" do 
-    assert subject.respond_to?(:settings)
-    assert subject.respond_to?(:config)
-  end
-  
-  should "respond to #configure" do 
-    assert subject.respond_to?(:configure)
-  end
-EVAL
+RSpec.configure do |conf|
+  conf.mock_with :mocha
+end
 
-CONFIG_FILE_CONTENT = <<-CONTENT
+CONFIG_FILE_CONTENT = <<-YAML
 production:
   foo: bar
   bla: true
 development: 
   foo: bla
   bla: false
-CONTENT
+YAML
+
+shared_examples_for "configured" do
+  it "responds to #environment and #env" do 
+    subject.should respond_to(:environment)
+    subject.should respond_to(:env)
+  end
+  
+  it "responds to #settings and #config" do 
+    subject.should respond_to(:settings)
+    subject.should respond_to(:config)
+  end
+  
+  it "responds to #configure" do 
+    subject.should respond_to(:configure)
+  end
+end
 
 class ConfiguredWithSimple
   include Konfigurator::Simple

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: konfigurator
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
-- Kriss 'nu7hatch' Kowalik
+- Chris Kowalik
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2011-01-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,8 +34,9 @@ dependencies:
         version: 0.1.2
   type: :development
   version_requirements: *id001
-description: "      Konfigurator is a small and flexible configuration toolkit, which allow you \n      to configure your apps, classes or modules with DSL-style or Sinatra-like settings.\n"
-email: kriss.kowalik@gmail.com
+description: Konfigurator is a small and flexible configuration toolkit, which allow you to configure your apps, classes or modules with DSL-style or Sinatra-like settings.
+email: 
+- chris@nu7hat.ch
 executables: []
 
 extensions: []
@@ -48,21 +49,22 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - konfigurator.gemspec
 - lib/konfigurator.rb
 - lib/konfigurator/dsl.rb
+- lib/konfigurator/railtie.rb
 - lib/konfigurator/simple.rb
-- test/helper.rb
-- test/test_dsl.rb
-- test/test_simple.rb
+- lib/konfigurator/version.rb
+- spec/dsl_spec.rb
+- spec/simple_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/nu7hatch/konfigurator
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,7 +92,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Small and flexible Configuration toolkit inspired i.a. by Sinatra settings.
-test_files: 
-- test/test_dsl.rb
-- test/test_simple.rb
-- test/helper.rb
+test_files: []
+

data/VERSION

@@ -1 +0,0 @@
-0.1.1

data/test/test_dsl.rb

@@ -1,53 +0,0 @@
-require "helper"
-
-class TestDSL < Test::Unit::TestCase
-  describe "Object configured with Konfigurator::DSL" do 
-    def subject
-      ConfiguredWithDSL
-    end
-    
-    instance_eval COMMON_TESTS
-  
-    should "respond to #attr_config and #attr_setting" do 
-      assert subject.respond_to?(:attr_config)
-      assert subject.respond_to?(:attr_setting)
-    end
-    
-    should "respond to defined #foo and #bar settings" do 
-      assert subject.respond_to?(:foo)
-      assert subject.respond_to?(:bar)
-    end
-    
-    should "allow to set config option value with DSL-style syntax" do 
-      subject.foo :bar
-      assert_equal :bar, subject.foo
-    end
-    
-    should "allow for quick access to current environment name" do 
-      subject.environment :production
-      assert_equal :production, subject.environment
-    end
-    
-    should "allow to load settings from yaml file" do 
-      with_conf_file do |fname|
-        subject.environment :production
-        subject.attr_config :bla
-        subject.load_settings(fname)
-        assert subject.bla
-        assert_equal "bar", subject.foo
-      end
-    end
-    
-    should "allow to define configuration specific for current env" do 
-      subject.attr_config :prod, :dev, :bar
-      subject.environment :development
-      subject.prod false
-      subject.configure(:production) { prod true }
-      subject.configure(:development) { dev true }
-      subject.configure(:development, :production) { bar :foo }
-      assert subject.dev
-      assert !subject.prod
-      assert_equal :foo, subject.bar
-    end
-  end
-end

data/test/test_simple.rb

@@ -1,93 +0,0 @@
-require "helper"
-
-class TestSimple < Test::Unit::TestCase
-  describe "Konfigurator::Simple" do 
-    def subject
-      ConfiguredWithSimple
-    end
-    
-    instance_eval COMMON_TESTS
-    
-    should "respond to #set" do 
-      assert subject.respond_to?(:set)
-    end
-    
-    should "respond to #enable" do
-      assert subject.respond_to?(:enable)
-    end
-    
-    should "respond to #disable" do 
-      assert subject.respond_to?(:disable)
-    end
-    
-    should "allow to set given option" do 
-      assert_equal "bar", subject.set(:foo, "bar")
-      assert_equal "bar", subject.settings[:foo]
-    end
-    
-    should "allow to quick disable given option" do 
-      assert !subject.disable(:foo)
-      assert !subject.foo
-    end 
-    
-    should "allow to quick enable given option" do 
-      assert subject.enable(:foo)
-      assert subject.foo
-    end
-    
-    should "allow for quick access to current environment name" do 
-      subject.set :environment, :production
-      assert_equal :production, subject.environment
-    end
-    
-    should "allow to define configuration specific for current env" do 
-      subject.set :environment, :development
-      subject.disable :prod
-      subject.configure(:production) { enable :prod }
-      subject.configure(:development) { enable :dev }
-      subject.configure(:development, :production) { set :bar, :foo }
-      assert subject.dev
-      assert !subject.prod
-      assert_equal :foo, subject.bar
-    end
-    
-    should "allow to load settings from yaml file" do 
-      with_conf_file do |fname|
-        subject.set :environment, :production
-        subject.load_settings(fname)
-        assert subject.bla
-        assert_equal "bar", subject.foo
-      end
-    end
-    
-    should "not use envs when use_envs is false" do
-      with_conf_file do |fname|
-        subject.set :environment, :production
-        subject.load_settings(fname, false)
-        assert subject.production
-        assert_equal "bar", subject.production['foo']
-      end
-    end
-  end
-  
-  describe "Object configured with Konfigurator::Simple" do 
-    def subject
-      ConfiguredWithSimple  
-    end
-    
-    setup do 
-      @configured = subject.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 
-      subject.set(:fooo, :bar)
-      @configured = subject.new
-      assert_equal :bar, @configured.settings.fooo
-    end 
-  end
-end