nested_config 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+rdoc
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@nested_config --create

data/.simplecov

@@ -0,0 +1,7 @@
+require 'simplecov-rcov'
+
+SimpleCov.coverage_dir "tmp/coverage"
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter if ENV['CI']
+SimpleCov.start do
+  add_filter '/test/'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'simplecov',        :require => false
+  gem 'simplecov-rcov',   :require => false
+end

data/README.rdoc

@@ -0,0 +1,76 @@
+= nested_config
+
+Simple, static, nested application configuration
+
+== Usage
+
+  require 'nested_config'
+
+  class MyApp
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= MyConfig.new
+    end
+
+    class MyConfig < NestedConfig.new
+    end
+  end
+
+=== Basic
+
+  MyApp.configure do |config|
+    config.coins = 1000
+    config.user do |user|
+      user.max = 5
+    end
+    config.queue do |queue|
+      queue.workers do |workers|
+        workers.max = 2
+        workers.timeout = 60.seconds
+      end
+    end
+  end
+
+  MyApp.config.coins # => 1000
+  MyApp.config.queue.workers.timeout # => 60
+
+
+=== EvaluateOnce
+
+With the module +EvaluateOnce+ you can define config value which will be evaluated lazily. Once.
+
+  class MyConfig
+    include NestedConfig::EvaluateOnce
+  end
+
+  MyApp.configure do |config|
+    config.country_list = proc { Country.all }
+  end
+
+  MyApp.config.country_list # => [List of countries]
+  MyApp.config.country_list # => [List of countries] (cached)
+
+The initial access to key +country_list+ calls (via +call+ method) the proc and replaces the value.
+Subsequent calls just fetch the replaced value.
+
+
+=== Key names
+
+*Note*: NestedConfig is not a blank slate so you CANNOT use defined method names as keys like +object_id+.
+
+== Installation
+
+  gem install nested_config
+
+== Test
+
+  rake test
+  COVERAGE=1 rake test
+
+== Release
+
+  edit lib/nested_config/version.rb
+  rake release

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+# Test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/*_test.rb')
+  test.libs << 'test'
+  test.verbose = true
+end
+
+# RDoc
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'nested config'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/nested_config/evaluate_once.rb

@@ -0,0 +1,30 @@
+class NestedConfig
+  # Evaluates a config value once replacing the original value
+  # if the value responds to method +call+.
+  #
+  # == Example
+  #
+  #   class MyConfig < NestedConfig
+  #     include NestedConfig::EvaluateOnce
+  #   end
+  #
+  #   config = MyConfig.new
+  #   config.startup_time = proc { Time.now }
+  #   config.env = proc { |env| env.to_s.upcase }
+  #
+  #   config.startup_time # => 2012-06-05 15:57:36 +0200
+  #   config.startup_time # => 2012-06-05 15:57:36 +0200
+  #
+  #   config.env(:development) # => DEVELOPMENT
+  #   config.env               # => DEVELOPMENT
+  module EvaluateOnce
+    def [](key, *args)
+      value = super
+      if value.respond_to?(:call)
+        self[key] = value.call(*args)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/nested_config/version.rb

@@ -0,0 +1,3 @@
+class NestedConfig
+  VERSION = "0.2.0"
+end

data/lib/nested_config.rb

@@ -0,0 +1,43 @@
+require 'nested_config/version'
+
+class NestedConfig
+  autoload :EvaluateOnce, 'nested_config/evaluate_once'
+
+  def initialize
+    @hash = {}
+  end
+
+  def [](name, *args)
+    @hash[name.to_s]
+  end
+
+  def []=(name, value)
+    @hash[name.to_s] = value
+  end
+
+  def __hash__
+    @hash
+  end
+
+  def inspect
+    @hash
+  end
+
+  def method_missing(name, *args)
+    if block_given?
+      config = self[name] ||= self.class.new
+      yield config
+    else
+      key = name.to_s.gsub(/=$/, '')
+      if $& == '='
+        self[key] = args.first
+      else
+        self[key, *args]
+      end
+    end
+  end
+
+  def respond_to?(name, include_private=false)
+    __hash__.key?(name.to_s) || super
+  end
+end

data/nested_config.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nested_config/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nested_config"
+  s.version     = NestedConfig::VERSION
+  s.authors     = ["Peter Suschlik"]
+  s.email       = ["ps@neopoly.de"]
+  s.homepage    = "https://github.com/neopoly/nested_config"
+  s.summary     = %q{Simple, static, nested config}
+  s.description = %q{}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+# simplecov
+require 'simplecov' if ENV['COVERAGE']
+
+require 'rubygems'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'nested_config'
+
+class NestedConfigSpec < MiniTest::Spec
+  class << self
+    alias :test :it
+    alias :context :describe
+  end
+end

data/test/neopoly_config_evaluate_once_test.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class NestedConfigEvaluateOnceTest < NestedConfigSpec
+  let(:config) do
+    Class.new(NestedConfig) do
+      include NestedConfig::EvaluateOnce
+    end.new
+  end
+
+  context "evaluates once w/o argument" do
+    context "w/o argument" do
+      before do
+        config.startup_time = proc { Time.now }
+      end
+
+      test "has time value" do
+        assert_instance_of Time, config.startup_time
+      end
+
+      test "value does not change" do
+        n = config.startup_time
+        assert_same n, config.startup_time
+      end
+    end
+
+    context "with argument" do
+      before do
+        config.env = proc { |e| e.to_s.upcase }
+        config.env(:development)
+      end
+
+      test "replaces original value" do
+        assert_equal "DEVELOPMENT", config.env
+      end
+
+      test "value does not change" do
+        env = config.env
+        assert_same env, config.env
+      end
+    end
+  end
+end

data/test/nested_config_evaluate_once_test.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class NestedConfigEvaluateOnceTest < NestedConfigSpec
+  let(:config) do
+    Class.new(NestedConfig) do
+      include NestedConfig::EvaluateOnce
+    end.new
+  end
+
+  context "evaluates once w/o argument" do
+    context "w/o argument" do
+      before do
+        config.startup_time = proc { Time.now }
+      end
+
+      test "has time value" do
+        assert_instance_of Time, config.startup_time
+      end
+
+      test "value does not change" do
+        n = config.startup_time
+        assert_same n, config.startup_time
+      end
+    end
+
+    context "with argument" do
+      before do
+        config.env = proc { |e| e.to_s.upcase }
+        config.env(:development)
+      end
+
+      test "replaces original value" do
+        assert_equal "DEVELOPMENT", config.env
+      end
+
+      test "value does not change" do
+        env = config.env
+        assert_same env, config.env
+      end
+    end
+  end
+end

data/test/nested_config_test.rb

@@ -0,0 +1,128 @@
+require 'helper'
+
+class NestedConfigTest < NestedConfigSpec
+
+  context "basic" do
+    let(:config) { NestedConfig.new }
+
+    test "empty" do
+      assert config.__hash__.empty?
+    end
+
+    test "is NOT a blank slate right now" do
+      Object.instance_methods.each do |method|
+        assert config.respond_to?(method)
+      end
+    end
+
+    test "inspect retrives __hash__" do
+      c = config.tap { |c| c.foo = :bar }
+      assert_same c.inspect, c.__hash__
+    end
+
+    test "cannot use defined method names as keys" do
+      c = config.tap do |c|
+        c.object_id = :foo
+        c.class     = :bar
+      end
+      refute_equal :foo, c.object_id
+      refute_equal :bar, c.class
+    end
+
+    test "sets values" do
+      c = config.tap do |c|
+        c.foo = :bar
+        c.bar = :baz
+      end
+
+      assert_equal :bar, c.foo
+      assert_equal :baz, c.bar
+      assert_nil c.unknown
+    end
+
+    test "sets deep values" do
+      c = config.tap do |c|
+        c.deep do |deep|
+          deep.key = :foo
+          deep.deeper do |deeper|
+            deeper.key = :bar
+          end
+        end
+        c.deep2 do |deep2|
+          deep2.key = :baz
+        end
+      end
+
+      assert_equal :foo, c.deep.key
+      assert_equal :bar, c.deep.deeper.key
+      assert_equal :baz, c.deep2.key
+    end
+
+    test "sets arrays as value" do
+      c = config.tap do |c|
+        c.ary   = [ :foo, :bar ]
+        c.ary2  = :foo, :bar
+      end
+
+      assert_equal [ :foo, :bar ], c.ary
+      assert_equal [ :foo, :bar ], c.ary2
+    end
+
+    test "cannot nest nil" do
+      c = config.tap do |c|
+        c.key = :foo
+      end
+
+      e = assert_raises NoMethodError do
+        c.deep.deeper.key
+      end
+      assert_match /NilClass/, e.message
+    end
+
+    test "respond_to?" do
+      c = config.tap do |c|
+        c.foo = :bar
+      end
+
+      assert_respond_to c, :foo
+    end
+
+    test "re-use already defined nested config" do
+      c = config.tap do |c|
+        c.users do |users|
+          users.max = 23
+        end
+        c.users do |users|
+          users.min = 5
+        end
+      end
+
+      assert_equal 23, c.users.max
+      assert_equal 5, c.users.min
+    end
+
+    context "subclass" do
+      let(:subclassed_config) do
+        Class.new(NestedConfig) do
+          def foo?
+            :bar!
+          end
+        end.new
+      end
+
+      test "has foo?" do
+        assert_equal :bar!, subclassed_config.foo?
+      end
+
+      test "nests subclassed config" do
+        c = subclassed_config.tap do |c|
+          c.users do |users|
+            users.max = 23
+          end
+        end
+
+        assert_equal :bar!, c.users.foo?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: nested_config
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ps@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .simplecov
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/nested_config.rb
+- lib/nested_config/evaluate_once.rb
+- lib/nested_config/version.rb
+- nested_config.gemspec
+- test/helper.rb
+- test/neopoly_config_evaluate_once_test.rb
+- test/nested_config_evaluate_once_test.rb
+- test/nested_config_test.rb
+homepage: https://github.com/neopoly/nested_config
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple, static, nested config
+test_files: []