dynamic_variable 1.0.0 → 1.1.0

data/ChangeLog.md

@@ -0,0 +1,9 @@
+# dynamic_variable 1.1.0 2010-09-12
+
+* Add DynamicVariable#default_variable attribute.
+* Add DynamicVariable::Mixin.
+* Remove DynamicVariable#with_module.
+
+# dynamic_variable 1.0.0 2010-09-09
+
+* First release.

data/README.md

@@ -4,6 +4,12 @@ Occasionally a method's behavior should depend on the context in which it is cal
 
 DynamicVariable is similar to [dynamic scope](http://c2.com/cgi/wiki?DynamicScoping), [fluid-let](http://www.megasolutions.net/scheme/fluid-binding-25366.aspx), [SRFI 39 parameters](http://srfi.schemers.org/srfi-39/srfi-39.html), [cflow pointcuts](http://www.eclipse.org/aspectj/doc/released/progguide/semantics-pointcuts.html#d0e5410), even [Scala has its own DynamicVariable](http://www.scala-lang.org/api/current/scala/util/DynamicVariable.html).
 
+# Install
+
+Nothing fancy:
+
+	> sudo gem install dynamic_variable
+
 # Example: Context Dependent Debugging
 
 Suppose we have a method which is `frequently_called`.  It works fine except when called from `source_of_the_trouble`.  Suppose further that `source_of_the_trouble` doesn't directly invoke `frequently_called` instead there's a method `in_the_middle`.  Our setup looks like this:
@@ -75,6 +81,33 @@ A DynamicVariable storing one `:value` and then `:another`:
 	  dv.value.should == 2
 	end
 
+# DynamicVariable::Mixin
+
+The Mixin module adds a dynamic variable quality to any class:
+
+	class MixinExample
+	  include DynamicVariable::Mixin
+	  
+	  attr_accessor :x
+	  
+	  def try
+	    self.x = 4
+	    x.should == 4
+	    with(:x, 3) do
+	      x.should == 3
+	      self.x = 2
+	      x.should == 2
+	      with(:x, 1) do
+	        x.should == 1
+	      end
+	      x.should == 2
+	    end
+	    x.should == 4
+	  end
+	end
+	
+	MixinExample.new.try
+
 # Why have a library?
 
 Isn't it easy to set and reset a flag as the context changes?  Sure, just watch out for raise, throw, and nesting:

data/Rakefile

@@ -11,5 +11,4 @@ begin
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"
-end
-  
+end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/doc/readme_code/03mixin.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__)+'/../../lib/dynamic_variable'
+
+describe 'DynamicVariable::Mixin' do it "should behave" do
+
+class MixinExample
+  include DynamicVariable::Mixin
+
+  attr_accessor :x
+
+  def try
+    self.x = 4
+    x.should == 4
+    with(:x, 3) do
+      x.should == 3
+      self.x = 2
+      x.should == 2
+      with(:x, 1) do
+        x.should == 1
+      end
+      x.should == 2
+    end
+    x.should == 4
+  end
+end
+
+MixinExample.new.try
+
+end end

data/doc/readme_code/{03simple_with.rb → 04simple_with.rb}

@@ -7,7 +7,7 @@ ensure
 end
 
 
-describe '#simple_with' do it 'should behave' do
+describe '#simple_with' do it "should behave" do
 
 simple_with(3) do
   simple_with(4) do

data/dynamic_variable.gemspec

@@ -5,24 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dynamic_variable}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["William Taysom"]
-  s.date = %q{2010-09-09}
+  s.date = %q{2010-09-12}
   s.description = %q{Occasionally a method's behavior should depend on the context in which it is called. What is happening above me on the stack? DynamicVariable helps you in these context dependent situations.}
   s.email = %q{wtaysom@gmail.com}
   s.extra_rdoc_files = [
-    "README.md"
+    "ChangeLog.md",
+     "README.md"
   ]
   s.files = [
     ".gitignore",
+     "ChangeLog.md",
      "README.md",
      "Rakefile",
      "VERSION",
      "doc/readme_code/01example_at_start.rb",
      "doc/readme_code/02example_with_debug.rb",
-     "doc/readme_code/03simple_with.rb",
+     "doc/readme_code/03mixin.rb",
+     "doc/readme_code/04simple_with.rb",
      "dynamic_variable.gemspec",
      "lib/dynamic_variable.rb",
      "spec/dynamic_variable_spec.rb"

data/lib/dynamic_variable.rb

@@ -1,7 +1,8 @@
 class DynamicVariable
-  @@un = Object.new
+  attr_accessor :default_variable
   
   def initialize(*pairs, &block)
+    self.default_variable = :value
     @bindings = []
     if block_given?
       with(*pairs, &block)
@@ -23,38 +24,29 @@ class DynamicVariable
   
   ##
   # with {}
-  #   varible defaults to :value
+  #   varible defaults to default_variable
   #   value defaults to nil
   #
   # with(value) { block }
-  #   variable defaults to :value
+  #   variable defaults to default_variable
   #
   # with(variable, value) { block }
   #
   # with(variable_1, value_1, ..., variable_n_1, value_n_1, value_n) { block }
-  #   variable_n defaults to :value
+  #   variable_n defaults to default_variable
   #
   # with(variable_1, value_1, ..., variable_n, value_n) { block }
   #
   def with(*pairs)
     pairs = [nil] if pairs.empty?
-    push_pairs(pairs)
     begin
+      push_pairs(pairs)
       yield(self)
     ensure
       pop_pairs(pairs)
     end
   end
   
-  def with_module
-    this = self
-    mod = Module.new
-    mod.send(:define_method, :with) do |*args, &block|
-      this.with(*args, &block)
-    end
-    mod
-  end
-  
   def [](variable)
     find_binding(variable)[1]
   end
@@ -70,7 +62,8 @@ class DynamicVariable
     else
       writer = variable
       unless args.size == 1 and writer.to_s =~ /(.*)=/
-        raise NoMethodError, "undefined method `#{writer}' for #{self.inspect}"
+        raise NoMethodError,
+          "undefined method `#{writer}' for #{self.inspect}"
       end
       variable = $1.to_sym
       self[variable] = args[0]
@@ -89,8 +82,8 @@ class DynamicVariable
     variables.each{|variable, value| self[variable] = value}
   end
   
-  def bindings(variable = @@un)
-    if variable == @@un
+  def bindings(variable = (un = true))
+    if un
       @bindings.map{|pair| pair.clone}
     else
       @bindings.select{|var, value| var == variable}.map!{|var, value| value}
@@ -101,8 +94,8 @@ class DynamicVariable
     set_bindings(bindings)
   end
   
-  def set_bindings(variable, bindings = @@un)
-    if bindings == @@un
+  def set_bindings(variable, bindings = (un = true))
+    if un
       bindings = variable
       @bindings = bindings.map do |pair|
         unless pair.is_a? Array and pair.size == 2
@@ -138,6 +131,86 @@ class DynamicVariable
     bindings
   end
   
+  module Mixin
+    class MixedDynamicVariable < DynamicVariable
+      def initialize(mix)
+        super()
+        @mix = mix
+      end
+      
+      def push(variable, value)
+        old_value = @mix.send(variable)
+        begin
+          pair = begin
+            find_binding(variable)
+          rescue ArgumentError
+            super
+          end
+          pair[1] = old_value
+        
+          @mix.send(variable.to_s+"=", value)
+          super
+        rescue Exception
+          @bindings.pop
+          raise
+        end
+      end
+      
+      def pop(variable)
+        value = super
+        begin
+          old_value = find_binding(variable)[1]
+        rescue ArgumentError
+          return value
+        end
+        @mix.send(variable.to_s+"=", old_value)
+        value
+      ensure
+        if @bindings.count{|var, value| var == variable} == 1
+          super
+        end
+      end
+      
+      def [](variable)
+        find_binding(variable)[1] = @mix.send(variable)
+      end
+      
+      def []=(variable, value)
+        @mix.send(variable.to_s+"=", super)
+      end
+      
+      alias original_variables variables
+      private :original_variables
+      
+      def variables
+        variables = super
+        variables.each_key do |variable|
+          variables[variable] = self[variable]
+        end
+      end
+      
+      def bindings(*args)
+        variables
+        super
+      end
+      
+      def set_bindings(*args)
+        bindings = super
+        self.variables = original_variables
+        bindings
+      end
+    end
+    
+    def dynamic_variable
+      @dynamic_variable_mixin__dynamic_variable ||=
+        MixedDynamicVariable.new(self)
+    end
+    
+    def with(*pairs, &block)
+      dynamic_variable.with(*pairs, &block)
+    end
+  end
+  
 private
   
   def find_binding(variable)
@@ -153,7 +226,7 @@ private
   end
   
   def push_pairs(pairs)
-    pairs.insert(-2, :value) if pairs.size.odd?
+    pairs.insert(-2, default_variable) if pairs.size.odd?
     each_pair(pairs) {|variable, value| push(variable, value)}
   end
   

data/spec/dynamic_variable_spec.rb

@@ -3,10 +3,6 @@ require 'dynamic_variable'
 describe DynamicVariable do
   subject { DynamicVariable.new }
   
-  before do
-    extend subject.with_module
-  end
-  
   ### Utilities ###
   
   def x_and_y_bindings
@@ -195,27 +191,28 @@ describe DynamicVariable do
   
   describe '#with' do
     it "should make bindings and clean up when done" do
-      with(:key, :value) do
+      subject.with(:key, :value) do
         subject.bindings.should == [[:key, :value]]
       end
       bindings_should_be_empty
     end
     
     it "should yield self to the block" do
-      with do |dv|
+      subject.with do |dv|
         dv.should == subject
       end
     end
     
     it "should return the result of its block" do
-      with{:result}.should == :result
+      subject.with{:result}.should == :result
     end
     
     it "should nest nicely" do
-      with(:value) do
+      subject.with(:value) do
         subject.bindings.should == [[:value, :value]]
-        with(:second_value) do
-          subject.bindings.should == [[:value, :value], [:value, :second_value]]
+        subject.with(:second_value) do
+          subject.bindings.should == [[:value, :value],
+            [:value, :second_value]]
         end
         subject.bindings.should == [[:value, :value]]
       end
@@ -224,7 +221,7 @@ describe DynamicVariable do
     
     it "should be exception safe" do
       expect do
-        with(:value) do
+        subject.with(:value) do
           subject.bindings.should == [[:value, :value]]
           raise
         end
@@ -235,7 +232,7 @@ describe DynamicVariable do
     context "when called" do
       context "with no arguments" do
         it "should bind :value to nil" do
-          with do
+          subject.with do
             subject.bindings.should == [[:value, nil]]
           end
         end
@@ -243,7 +240,7 @@ describe DynamicVariable do
       
       context "with one argument" do
         it "should bind :value to argument" do
-          with(:argument) do
+          subject.with(:argument) do
             subject.bindings.should == [[:value, :argument]]
           end
         end
@@ -251,7 +248,7 @@ describe DynamicVariable do
       
       context "with two arguments" do
         it "should bind the first to the second" do
-          with(:first, :second) do
+          subject.with(:first, :second) do
             subject.bindings.should == [[:first, :second]]
           end
         end
@@ -259,7 +256,7 @@ describe DynamicVariable do
       
       context "with an odd number of arguments" do
         it "should bind :value to the second to last" do
-          with(:first, :second, :last) do
+          subject.with(:first, :second, :last) do
             subject.bindings.should == [[:first, :second], [:value, :last]]
           end
         end
@@ -267,7 +264,7 @@ describe DynamicVariable do
       
       context "with an even number of arguments" do
         it "should bind variable, value pairs" do
-          with(:var1, :val1, :var2, :val2, :var3, :val3) do
+          subject.with(:var1, :val1, :var2, :val2, :var3, :val3) do
             subject.bindings.should ==
               [[:var1, :val1], [:var2, :val2], [:var3, :val3]]
           end
@@ -276,7 +273,7 @@ describe DynamicVariable do
       
       context "with a variable repeated more than once" do
         it "should bind the variable twice and unbind when done" do
-          with(:var, 1, :var, 2) do
+          subject.with(:var, 1, :var, 2) do
             subject.bindings.should == [[:var, 1], [:var, 2]]
           end
           subject.bindings.should == []
@@ -294,12 +291,25 @@ describe DynamicVariable do
     end
   end
   
-  describe '#with_module' do
-    it "should return a Module with a #with method" do
-      mod = subject.with_module
-      mod.should be_a Module
-      methods = mod.instance_methods(false)
-      methods.map(&:to_sym).should == [:with]
+  describe '#default_variable' do
+    it 'should default to :value' do
+      subject.default_variable.should == :value
+    end
+  end
+  
+  describe '#default_variable=' do
+    context 'when #with is called' do
+      it 'should use default_variable for 0 and odd numbers of bindings' do
+        subject.default_variable = :v
+        subject.with do
+          subject.with(1) do
+            subject.with(:v, 2, 3) do
+              subject.bindings.should ==
+                [[:v, nil], [:v, 1], [:v, 2], [:v, 3]]
+            end
+          end
+        end
+      end
     end
   end
   
@@ -577,4 +587,165 @@ describe DynamicVariable do
       end   
     end
   end
+  
+  describe DynamicVariable::Mixin do
+    class MixinExample
+      include DynamicVariable::Mixin
+      
+      attr_accessor :x, :y
+    end
+    
+    subject { MixinExample.new }
+    
+    describe '#with' do
+      it "should bind attributes dynamically" do
+        subject.x = 5
+        subject.with(:x, 4, :y, 3) do
+          subject.x.should == 4
+          subject.y.should == 3
+          subject.y = 2
+          subject.y.should == 2
+          subject.with(:x, 1, :y, 0) do
+            subject.x.should == 1
+            subject.y.should == 0
+          end
+          subject.x.should == 4
+          subject.y.should == 2
+        end
+        subject.x.should == 5
+        subject.y.should == nil
+      end
+      
+      context "when readers and writers raise errors" do
+        context "when reader raises during push" do
+          it "should unbind bound variables" do
+            subject.x = 5
+            
+            class <<subject
+              def y
+                raise "oops"
+              end
+            end
+            
+            did_call_block = false
+            expect do
+              subject.with(:x, 4, :y, 3) do
+                did_call_block = true
+              end
+            end.should raise_error("oops")
+            
+            subject.x.should == 5
+            subject.dynamic_variable.bindings.should == []
+            did_call_block.should be_false
+          end
+        end
+        
+        context "when writer raises during push" do
+          it "should unbind bound variables" do
+            subject.x = 5
+            
+            class <<subject
+              def x=(x)
+                raise "oops"
+              end
+            end
+            
+            did_call_block = false
+            expect do
+              subject.with(:x, 4, :y, 3) do
+                did_call_block = true
+              end
+            end.should raise_error("oops")
+            
+            subject.x.should == 5
+            subject.dynamic_variable.bindings.should == []
+            did_call_block.should be_false
+          end
+        end
+        
+        context "when writer raises during pop" do
+          it "should unbind bound variables" do
+            subject.x = 5
+            
+            did_call_block = false
+            expect do
+              subject.with(:x, 4, :y, 3) do
+                did_call_block = true
+                
+                class <<subject
+                  def y=(y)
+                    raise "oops"
+                  end
+                end
+              end
+            end.should raise_error("oops")
+            
+            subject.x.should == 5
+            subject.dynamic_variable.bindings.should == []
+            did_call_block.should be_true
+          end
+        end
+      end
+    end
+    
+    describe '#dynamic_variable' do
+      context "when reading a variable through" do
+        def self.it_should_be_up_to_date
+          it "should be up to date" do
+            subject.with(:x, 4, :y, 3) do
+              subject.x = 2
+              subject.y = 1
+
+              yield(subject.dynamic_variable)
+            end
+          end
+        end
+        
+        context "#[]" do
+          it_should_be_up_to_date do |dv|
+            dv.x.should == 2
+          end
+        end
+        
+        context "#variables" do
+          it_should_be_up_to_date do |dv|
+            dv.variables.should == {:x => 2, :y => 1}
+          end
+        end
+        
+        context "#bindings" do
+          it_should_be_up_to_date do |dv|
+            dv.bindings.should == [[:x, nil], [:x, 2], [:y, nil], [:y, 1]]
+          end
+        end
+      end
+
+      context "when writing variable through" do
+        def self.it_should_be_updated
+          it "should be updated" do
+            subject.with(:x, 4, :y, 3) do
+              yield(subject, subject.dynamic_variable)
+            end
+          end
+        end
+        
+        context "#[]=" do
+          it_should_be_updated do |subject, dv|
+            dv.x = 2
+            subject.x.should == 2
+          end
+        end
+        
+        context "#bindings=" do
+          it_should_be_updated do |subject, dv|
+            dv.bindings.should == [[:x, nil], [:x, 4], [:y, nil], [:y, 3]]
+            
+            dv.bindings = [[:x, nil], [:x, 2], [:y, nil], [:y, 1]]
+            subject.x.should == 2
+            subject.y.should == 1
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dynamic_variable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - William Taysom
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 +08:00
+date: 2010-09-12 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -26,15 +26,18 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- ChangeLog.md
 - README.md
 files: 
 - .gitignore
+- ChangeLog.md
 - README.md
 - Rakefile
 - VERSION
 - doc/readme_code/01example_at_start.rb
 - doc/readme_code/02example_with_debug.rb
-- doc/readme_code/03simple_with.rb
+- doc/readme_code/03mixin.rb
+- doc/readme_code/04simple_with.rb
 - dynamic_variable.gemspec
 - lib/dynamic_variable.rb
 - spec/dynamic_variable_spec.rb