nested_config 0.3.0 → 0.4.0

data/README.rdoc

@@ -1,11 +1,10 @@
-= nested_config
+= nested_config {<img src="https://secure.travis-ci.org/neopoly/nested_config.png?branch=master" alt="Build Status" />}[http://travis-ci.org/neopoly/nested_config]
 
 Simple, static, nested application configuration
 
 Gem[https://rubygems.org/gems/nested_config] |
 Source[https://github.com/neopoly/nested_config] |
-RDoc[http://rubydoc.info/github/neopoly/nested_config/master/file/README.rdoc] |
-{<img src="https://secure.travis-ci.org/neopoly/nested_config.png?branch=master" alt="Build Status" />}[http://travis-ci.org/neopoly/nested_config]
+RDoc[http://rubydoc.info/github/neopoly/nested_config/master/file/README.rdoc]
 
 == Usage
 
@@ -62,17 +61,6 @@ The initial access to key +country_list+ calls (via +call+ method) the proc and
 Subsequent calls just fetch the replaced value.
 
 
-=== Cloning
-
-NestedConfig can be cloned:
-
-  clone = MyApp.config.__clone__
-  clone.coins = 2000
-  MyApp.config.conins # => 1000
-
-*Note*: Proc values CANNOT be cloned.
-
-
 === Modifying config using NestedConfig::WithConfig
 
 Values of NestedConfig can be temporalily modified.
@@ -84,22 +72,32 @@ This can be used in tests modifying a global application config inside a block:
   class MyCase < MiniTest::TestCase
     include NestedConfig::WithConfig
 
-    def with_app_config(key, &block)
-      with_config(MyApp.config, key, &block)
+    def app_config
+      MyApp.config # global
     end
   end
 
   class SomeCase < MyCase
     def setup
       app_config.tap do |config|
-        config.workers do |workers|
-          workers.max = 5
+        config.coins = 1000
+        config.queue do |queue|
+          queue.workers do |workers|
+            workers.max = 5
+          end
         end
       end
     end
 
-    def test_with_config
-      with_app_config(:workers) do |workers|
+    def test_with_basic_value
+      with_config(app_config) do |config|
+        config.coins = 500
+      end
+      # global config reset to previous config
+    end
+
+    def test_queue_with_changed_workers
+      with_config(app_config, :queue, :workers) do |workers|
         workers.max = 1
         # do stuff with modified config max value
       end

data/Rakefile

@@ -6,7 +6,7 @@ task :default => :test
 # Test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.test_files = FileList.new('test/*_test.rb')
+  test.test_files = FileList.new('test/**/*_test.rb')
   test.libs << 'test'
   test.verbose = true
 end

data/lib/nested_config/version.rb

@@ -1,3 +1,3 @@
 class NestedConfig
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/nested_config/with_config.rb

@@ -16,14 +16,24 @@ class NestedConfig
   #   class SomeCase < MyCase
   #     def setup
   #       app_config.tap do |config|
-  #         config.workers do |workers|
-  #           workers.max = 5
+  #         config.coins = 1000
+  #         config.queue do |queue|
+  #           queue.workers do |workers|
+  #             workers.max = 5
+  #           end
   #         end
   #       end
   #     end
   #
-  #     def test_with_config
-  #       with_config(app_config, :workers) do |workers|
+  #     def test_with_basic_value
+  #       with_config(app_config) do |config|
+  #         config.coins = 500
+  #       end
+  #       # global config reset to previous config
+  #     end
+  #
+  #     def test_queue_with_changed_workers
+  #       with_config(app_config, :queue, :workers) do |workers|
   #         workers.max = 1
   #         # do stuff with modified config max value
   #       end
@@ -31,12 +41,18 @@ class NestedConfig
   #     end
   #   end
   module WithConfig
-    def with_config(config, key)
-      current = config[key]
-      backup  = current.__clone__
-      yield current
-    ensure
-      config[key] = backup
+    def with_config(config, *keys, &block)
+      current = config
+      while key = keys.shift
+        current = current[key]
+        unless current
+          raise ArgumentError, "nested key #{key.inspect} not found"
+        end
+      end
+      unless current.respond_to?(:__with_cloned__)
+        raise ArgumentError, "config #{current.inspect} can't be cloned"
+      end
+      current.__with_cloned__(&block)
     end
   end
 end

data/lib/nested_config.rb

@@ -19,8 +19,11 @@ class NestedConfig
     @hash
   end
 
-  def __clone__
-    Marshal.load(Marshal.dump(self))
+  def __with_cloned__
+    backup = Marshal.load(Marshal.dump(@hash))
+    yield(self)
+  ensure
+    @hash = backup
   end
 
   def inspect

data/test/nested_config/with_config_test.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+class NestedConfigWithConfigTest < NestedConfigSpec
+  require 'nested_config/with_config'
+  include NestedConfig::WithConfig
+
+  context "with_config" do
+    let(:config) do
+      NestedConfig.new.tap do |config|
+        config.basic = 23
+        config.nest do |nest|
+          nest.level = 1
+          nest.deep do |deep|
+            deep.level = 2
+          end
+        end
+      end
+    end
+
+    test "one key" do
+      refute_change 'config.nest.level' do
+        with_config(config, :nest) do |nest|
+          nest.level = 2
+          assert_equal 2, config.nest.level
+        end
+      end
+    end
+
+    context "without a key" do
+      test "restore unnested" do
+        refute_change 'config.basic' do
+          with_config(config) do |c|
+            c.basic = 5
+            assert_equal 5, config.basic
+          end
+        end
+      end
+
+      test "restore nested" do
+        refute_change 'config.nest.level' do
+          with_config(config) do |c|
+            c.nest.level = 2
+            assert_equal 2, config.nest.level
+          end
+        end
+      end
+    end
+
+    context "with nested keys" do
+      test "restore valid nested key" do
+        refute_change 'config.nest.deep.level' do
+          with_config(config, :nest, :deep) do |c|
+            c.level = 23
+            assert_equal 23, config.nest.deep.level
+          end
+        end
+      end
+
+      test "key not found raises ArgumentError" do
+        error = assert_raises ArgumentError do
+          with_config(config, :some_key, :not_found) {}
+        end
+        assert_match %r{not found}, error.message
+      end
+
+      test "can't change basic value" do
+        error = assert_raises ArgumentError do
+          with_config(config, :basic) {}
+        end
+        assert_match %r{can't be cloned}, error.message
+      end
+    end
+  end
+
+  private
+
+  def refute_change(code)
+    before = eval(code)
+    yield
+  ensure
+    after = eval(code)
+    assert_equal before, after, "#{code} has changed to #{mu_pp(after)} from #{mu_pp(before)}"
+  end
+end

data/test/nested_config_test.rb

@@ -125,9 +125,10 @@ class NestedConfigTest < NestedConfigSpec
       end
     end
 
-    context "clone" do
+    context "__with_cloned__" do
       let(:config) do
         NestedConfig.new.tap do |config|
+          config.top_level = 1
           config.nest do |nest|
             nest.level = 1
             nest.deep do |deep|
@@ -137,20 +138,20 @@ class NestedConfigTest < NestedConfigSpec
         end
       end
 
-      test "deep" do
-        clone = config.__clone__
-        clone.nest.level = 23
-        clone.nest.deep.level = 5
-
-        assert_equal 1, config.nest.level
-        assert_equal 2, config.nest.deep.level
+      test "top level" do
+        config.__with_cloned__ do |c|
+          c.top_level = 2
+          assert_equal 2, config.top_level
+        end
+        assert_equal 1, config.top_level
       end
 
-      test "cannot clone procs" do
-        config.proc = proc {}
-        assert_raises TypeError do
-          config.__clone__
+      test "nested" do
+        config.__with_cloned__ do |c|
+          c.nest.deep.level = 23
+          assert_equal 23, config.nest.deep.level
         end
+        assert_equal 2, config.nest.deep.level
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nested_config
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,9 +79,9 @@ files:
 - lib/nested_config/with_config.rb
 - nested_config.gemspec
 - test/helper.rb
-- test/nested_config_evaluate_once_test.rb
+- test/nested_config/evaluate_once_test.rb
+- test/nested_config/with_config_test.rb
 - test/nested_config_test.rb
-- test/nested_config_with_config_test.rb
 homepage: https://rubygems.org/gems/nested_config
 licenses: []
 post_install_message: 

data/test/nested_config_with_config_test.rb

@@ -1,28 +0,0 @@
-require 'helper'
-
-class NestedConfigWithConfigTest < NestedConfigSpec
-  require 'nested_config/with_config'
-  include NestedConfig::WithConfig
-
-  let(:config) do
-    NestedConfig.new.tap do |config|
-      config.nest do |nest|
-        nest.level = 1
-        nest.deep do |deep|
-          deep.level = 2
-        end
-      end
-    end
-  end
-
-  test "with_config with one key" do
-    assert_equal 1, config.nest.level
-
-    with_config(config, :nest) do |nest|
-      nest.level = 2
-      assert_equal 2, config.nest.level
-    end
-
-    assert_equal 1, config.nest.level
-  end
-end