configatron 4.4.1 → 4.5.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 4.5.0
+
+* [backwards-incompatible] Switch from DeepClone to copy-on-write for temp. As part of the implementation, *values* are no longer cloned.
+
 === 4.4.1
 
 * Make lock!/unlock! support blocks

data/lib/configatron.rb

@@ -1,6 +1,5 @@
 require 'configatron/version'
 
-require 'configatron/deep_clone'
 require 'configatron/errors'
 require 'configatron/integrations'
 require 'configatron/root_store'

data/lib/configatron/root_store.rb

@@ -15,11 +15,41 @@ class Configatron::RootStore < BasicObject
     public :new
   end
 
+  @@cow = 0
+
   def initialize
     @locked = false
+    @cow = nil
     reset!
   end
 
+  def __cow
+    @cow
+  end
+
+  def __cow_path(path)
+    start = @store.__cow_clone
+
+    node = start
+    branch = path.map do |key|
+      node = node[key]
+      node.__cow_clone
+    end
+    nodes = [start] + branch
+
+    # [node1, node2, node3] with
+    # [node2, node3, node4] and
+    # ['key1', 'key2, 'key3']
+    nodes[0...-1].zip(nodes[1..-1], path) do |parent, child, key|
+      # These are all cow_clones, so won't trigger a further cow
+      # modification.
+      parent[key] = child
+    end
+
+    @store = nodes.first
+    nodes.last
+  end
+
   def method_missing(name, *args, &block)
     store.__send__(name, *args, &block)
   end
@@ -39,13 +69,19 @@ class Configatron::RootStore < BasicObject
   end
 
   def temp_start
-    @temp = ::Configatron::DeepClone.deep_clone(@store)
     @temp_locked = @locked
+    @temp_cow = @cow
+
+    # Just need to have a unique Copy-on-Write generation ID
+    @cow = @@cow += 1
+    @temp = @store
   end
 
   def temp_end
-    @store = @temp
     @locked = @temp_locked
+    @cow = @temp_cow
+
+    @store = @temp
   end
 
   def locked?

data/lib/configatron/store.rb

@@ -4,10 +4,38 @@ class Configatron
   class Store < BasicObject
     extend ::Forwardable
 
-    def initialize(root_store, name='configatron', attributes={})
+    def initialize(root_store, name='configatron', attributes={}, path=[])
       @root_store = root_store
       @name = name
       @attributes = attributes
+
+      # We could derive @name from @path, though this would break
+      # backwards-compatibility.
+      @path = path
+
+      @cow = root_store.__cow
+    end
+
+    def clone
+      Store.new(
+        @root_store,
+        @name,
+        @attributes.clone,
+        @path
+        )
+    end
+
+    def __cow
+      @cow
+    end
+
+    def __cow_clone
+      # A temp has started since the last time this was written
+      if @root_store.__cow != @cow
+        self.clone
+      else
+        self
+      end
     end
 
     def [](key)
@@ -15,7 +43,7 @@ class Configatron
         if @root_store.locked?
           ::Kernel.raise ::Configatron::UndefinedKeyError.new("Key not found: #{key} (for locked #{self})")
         end
-        ::Configatron::Store.new(@root_store, "#{@name}.#{key}")
+        ::Configatron::Store.new(@root_store, "#{@name}.#{key}", {}, @path + [key])
       end
       return val
     end
@@ -24,7 +52,16 @@ class Configatron
       if @root_store.locked?
         ::Kernel.raise ::Configatron::LockedError.new("Cannot set key #{key} for locked #{self}")
       end
-      @attributes[key.to_sym] = value
+
+      key = key.to_sym
+      if @root_store.__cow != @cow
+        copy = @root_store.__cow_path(@path)
+        # Cow should now match, so this won't recurse. (Note this is
+        # not particularly thread-safe.)
+        copy.store(key, value)
+      else
+        @attributes[key] = value
+      end
     end
 
     def fetch(key, default_value = nil, &block)
@@ -89,15 +126,6 @@ class Configatron
       do_lookup(name, *args, &block)
     end
 
-    # Needed for deep_clone to actually clone this object
-    def clone(cloned={})
-      root_store = DeepClone.deep_clone(@root_store, cloned)
-      name = DeepClone.deep_clone(@name, cloned)
-      attributes = DeepClone.deep_clone(@attributes, cloned)
-
-      Store.new(root_store, name, attributes)
-    end
-
     def to_h
       @attributes.each_with_object({}) do |(k, v), h|
         v = v.call if ::Configatron::Proc === v

data/lib/configatron/version.rb

@@ -1,3 +1,3 @@
 class Configatron
-  VERSION = "4.4.1"
+  VERSION = "4.5.0"
 end

data/test/functional/configatron.rb

@@ -99,6 +99,24 @@ class Critic::Functional::ConfigatronTest < Critic::Functional::Test
         @kernel.unknown = 'known'
       end
     end
+
+    it 'locks during the block argument' do
+      @kernel.unlock!
+
+      @kernel.lock! do
+        assert(@kernel.locked?)
+      end
+
+      assert(!@kernel.locked?)
+    end
+
+    it 'executes a block argument' do
+      a = 1
+      @kernel.lock! do
+        a = 2
+      end
+      assert_equal(2, a)
+    end
   end
 
   describe 'name' do

data/test/unit/configatron/store.rb

@@ -66,7 +66,7 @@ class Critic::Unit::StoreTest < Critic::Unit::Test
 
     it "returns true if the key is a Configatron::Store" do
       assert_equal(false, @store.key?(:bar))
-      @store.bar = Configatron::Store.new(Configatron::RootStore)
+      @store.bar = Configatron::Store.new(Configatron::RootStore.new)
       assert_equal(true, @store.key?(:bar))
     end
   end
@@ -80,7 +80,7 @@ class Critic::Unit::StoreTest < Critic::Unit::Test
 
     it "returns true if the key is a Configatron::Store" do
       assert_equal(false, @store.has_key?(:bar))
-      @store.bar = Configatron::Store.new(Configatron::RootStore)
+      @store.bar = Configatron::Store.new(Configatron::RootStore.new)
       assert_equal(true, @store.has_key?(:bar))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configatron
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,7 +94,6 @@ files:
 - configatron.gemspec
 - lib/configatron.rb
 - lib/configatron/core.rb
-- lib/configatron/deep_clone.rb
 - lib/configatron/delayed.rb
 - lib/configatron/dynamic.rb
 - lib/configatron/errors.rb
@@ -138,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 630343520399706403
+      hash: -3612198204560107212
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 630343520399706403
+      hash: -3612198204560107212
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/configatron/deep_clone.rb

@@ -1,81 +0,0 @@
-module Configatron::DeepClone
-  # = DeepClone
-  #
-  # == Version
-  #  1.2006.05.23.configatron.1 (change of the first number means Big Change)
-  #
-  # == Description
-  #  Adds deep_clone method to an object which produces deep copy of it. It means
-  #  if you clone a Hash, every nested items and their nested items will be cloned.
-  #  Moreover deep_clone checks if the object is already cloned to prevent endless recursion.
-  #
-  # == Usage
-  #
-  #  (see examples directory under the ruby gems root directory)
-  #
-  #   require 'rubygems'
-  #   require 'deep_clone'
-  #
-  #   include DeepClone
-  #
-  #   obj = []
-  #   a = [ true, false, obj ]
-  #   b = a.deep_clone
-  #   obj.push( 'foo' )
-  #   p obj   # >> [ 'foo' ]
-  #   p b[2]  # >> []
-  #
-  # == Source
-  # http://simplypowerful.1984.cz/goodlibs/1.2006.05.23
-  #
-  # == Author
-  #  jan molic (/mig/at_sign/1984/dot/cz/)
-  #
-  # == Licence
-  #  You can redistribute it and/or modify it under the same terms of Ruby's license;
-  #  either the dual license version in 2003, or any later version.
-  def self.deep_clone( obj=self, cloned={} )
-    if Configatron::RootStore === obj
-      # We never actually want to have multiple copies of our
-      # Configatron::RootStore -- when making a temp, we just stick
-      # the state-to-revert-to into an ivar.
-      return obj
-    elsif Configatron::Store === obj
-      # Need to special-case this since it's a BasicObject, meaning it
-      # doesn't respond to all the usual ivar magic methods
-      cl = obj.clone(cloned)
-      cloned[obj.__id__] = cl
-      cloned[cl.__id__] = cl
-      return cl
-    elsif cloned.key?( obj.__id__ )
-      return cloned[obj.__id__]
-    else
-      begin
-        cl = obj.clone
-      rescue Exception
-        # unclonnable (TrueClass, Fixnum, ...)
-        cloned[obj.__id__] = obj
-        return obj
-      else
-        cloned[obj.__id__] = cl
-        cloned[cl.__id__] = cl
-        case
-        when Hash === cl
-          cl.clone.each do |k,v|
-            cl[k] = deep_clone( v, cloned )
-          end
-        when Array === cl
-          cl.collect! do |v|
-            deep_clone( v, cloned )
-          end
-        end
-        cl.instance_variables.each do |var|
-          v = cl.instance_eval( var.to_s )
-          v_cl = deep_clone( v, cloned )
-          cl.instance_eval( "#{var} = v_cl" )
-        end
-        return cl
-      end
-    end
-  end
-end