cascading_classes 0.3.0 → 0.6.0

data/spec/basics/inherit_spec.rb

@@ -0,0 +1,339 @@
+begin
+  require_relative '../helper_spec'
+rescue NameError
+  require File.expand_path('../helper_spec', __FILE__)
+end
+
+# todo: update --> when you do :inherit => false this means NO INHERITANCE
+
+describe "inherit" do
+  before do
+    A = Class.new{extend CC}
+    B = Class.new(A)
+    C = Class.new(B)
+  end
+
+  after do
+    Object.send :remove_const, :A
+    Object.send :remove_const, :B
+    Object.send :remove_const, :C
+  end
+
+  describe "defaults" do
+    before do
+      @props = A.cascade do
+        location :default => "south side"
+        score :default => 32.18
+        num :default => 12        
+        weather :default => :sunny
+        available :default => false
+        mood :default => Proc.new{|me| me.weather == :sunny ? "content" : "depressed"}
+        color :default => Proc.new{|me| me.mood == "content" ? "rosy" : "blue"}
+        name :default => {:first => 'jon', :last => 'smith'}
+        groceries :default => [:ice, :lemons, :splenda]
+        ingredients :default => Set.new([:sugar, :butter, :flour, :eggs])
+      end
+    end
+
+    describe "descendents" do
+      it "inherits symbols strings, fixnums, floats, and bools (by default)" do
+        @props[:location][:inherit].must_equal true
+        @props[:weather][:inherit].must_equal true
+        @props[:num][:inherit].must_equal true
+        @props[:score][:inherit].must_equal true
+        @props[:available][:inherit].must_equal true
+
+        B.location.must_equal "south side"
+        C.location.must_equal "south side"
+
+        B.weather.must_equal :sunny
+        C.weather.must_equal :sunny
+
+        B.num.must_equal 12
+        C.num.must_equal 12
+
+        B.score.must_equal 32.18
+        C.score.must_equal 32.18
+
+        B.available.must_equal false
+        C.available.must_equal false
+      end
+
+      it "doesn't inherit containers like hashes, arrays, and sets (by default)" do
+        @props[:name][:inherit].must_equal false
+        @props[:groceries][:inherit].must_equal false
+
+        B.name.must_equal Hash.new
+        C.name.must_equal Hash.new
+
+        B.groceries.must_equal Array.new
+        C.groceries.must_equal Array.new
+
+        B.ingredients.must_equal Set.new
+        C.ingredients.must_equal Set.new
+      end
+
+      it "inherits properties of type ':Proc'" do
+        @props[:mood][:inherit].must_equal true
+
+        A.weather = :sunny
+        B.weather = :rainy
+
+        C.weather.must_equal :rainy  
+
+        A.mood.must_equal "content"
+        B.mood.must_equal "depressed"
+        C.mood.must_equal "depressed"
+
+        C.weather = :sunny
+        C.mood.must_equal "content"
+      end
+    end
+  end
+
+  describe "syntax" do
+    describe "overriding the default 'inherit' age" do
+      describe "manual override" do
+        before do
+          A.cascade do
+            location :default => "south side"
+            score :default => 32.18
+            num :default => 12        
+            weather :default => :sunny
+            available :default => false
+            mood :default => Proc.new{|me| me.weather == :sunny ? "content" : "depressed"}
+            color :default => Proc.new{|me| me.mood == "content" ? "rosy" : "blue"}
+            name :default => {:first => 'jon', :last => 'smith'}
+            groceries :default => [:ice, :lemons, :splenda]
+            ingredients :default => Set.new([:sugar, :butter, :flour, :eggs])
+          end
+
+          B.color = Proc.new{|me| me.mood == "content" ? "#{me}: rosy" : "#{me}: blue"}
+        end
+
+        it "allows 'false', 'nil' and '0' to force no inheritance" do
+          B.location(false).must_equal ""
+          C.location(false).must_equal ""
+
+          B.score(nil).must_equal nil
+          C.score(nil).must_equal nil
+
+          B.weather(0).must_equal nil
+          C.weather(0).must_equal nil
+        end
+
+        it "allows 'true', '-1' to force full, inifinte max inheritance" do
+          B.num(true).must_equal 12
+          C.num(true).must_equal 12
+
+          B.groceries(-1).must_equal [:ice, :lemons, :splenda]
+          C.groceries(-1).must_equal [:ice, :lemons, :splenda]
+        end
+
+        it "allows '<fixnum>' value to indicate max inheritance age" do
+          B.score(0).must_equal nil
+          B.score(1).must_equal 32.18
+          B.score(2).must_equal 32.18
+          C.score(1).must_equal nil
+          C.score(2).must_equal 32.18
+
+          B.name(0).must_equal Hash.new
+          B.name(1).must_equal({:first => 'jon', :last => 'smith'})
+          C.name(0).must_equal Hash.new
+          C.name(1).must_equal Hash.new
+          C.name(2).must_equal({:first => 'jon', :last => 'smith'})
+        end
+
+        it "allows ':inherit => false' and ':inherit => nil' syntax" do
+          B.location(:inherit => false).must_equal ""
+          c_location = C.location :inherit => false
+          c_location.must_equal ""
+
+          B.weather(:inherit => nil).must_equal nil
+          c_weather = C.weather :inherit => nil
+          c_weather.must_equal nil
+        end
+
+        it "allows ':inhert, false' and ':inherit, nil' syntax" do
+          B.num(:inherit, false).must_equal nil
+          c_num = C.num :inherit, false
+          c_num.must_equal nil
+
+          B.score(:inherit, nil).must_equal nil
+          c_score = C.score :inherit, nil
+          c_score.must_equal nil
+        end
+
+        it "allows ':inherit => true' and ':inherit => -1' syntax" do
+          B.name(:inherit => true).must_equal({:first => 'jon', :last => 'smith'})
+          c_name = C.name :inherit => true
+          c_name.must_equal({:first => 'jon', :last => 'smith'})
+
+          B.groceries(:inherit => -1).must_equal [:ice, :lemons, :splenda]
+          c_groceries = C.groceries :inherit => -1
+          c_groceries.must_equal [:ice, :lemons, :splenda]
+        end
+
+        it "allows ':inherit, true' and ':inherit, -1' syntax" do
+          B.ingredients(:inherit, true).must_equal Set.new([:sugar, :butter, :flour, :eggs])
+          c_ingredients = C.ingredients :inherit, true
+          c_ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+
+          B.name(:inherit, -1).must_equal({:first => 'jon', :last => 'smith'})
+          c_name = C.name :inherit, -1
+          c_name.must_equal({:first => 'jon', :last => 'smith'})
+        end
+
+        it "allows ':inherit => <n>' (n: fixnum) syntax" do
+          B.location(:inherit => 0).must_equal ''
+          B.location(:inherit => 1).must_equal "south side"
+
+          c_loc_0 = C.location :inherit => 0
+          c_loc_1 = C.location :inherit => 1
+          c_loc_2 = C.location :inherit => 2
+
+          c_loc_0.must_equal ''
+          c_loc_1.must_equal ''
+          c_loc_2.must_equal "south side"
+
+          B.groceries(:inherit => 0).must_equal []
+          B.groceries(:inherit => 1).must_equal [:ice, :lemons, :splenda]
+
+          c_groc_0 = C.groceries :inherit => 0
+          c_groc_1 = C.groceries :inherit => 1
+          c_groc_2 = C.groceries :inherit => 2
+
+          c_groc_0.must_equal []
+          c_groc_1.must_equal []
+          c_groc_2.must_equal [:ice, :lemons, :splenda]
+        end
+
+        it "allows ':inherit, <n>' (n: fixnum) syntax" do
+          B.score(:inherit, 0).must_equal nil
+          B.score(:inherit, 1).must_equal 32.18
+
+          c_score_0 = C.score :inherit, 0
+          c_score_1 = C.score :inherit, 1
+          c_score_2 = C.score :inherit, 2
+
+          c_score_0.must_equal nil
+          c_score_1.must_equal nil
+          c_score_2.must_equal 32.18
+
+          B.ingredients(:inherit, 0).must_equal Set.new([])
+          B.ingredients(:inherit, 1).must_equal Set.new([:sugar, :butter, :flour, :eggs])
+
+          c_ingr_0 = C.ingredients :inherit, 0
+          c_ingr_1 = C.ingredients :inherit, 1
+          c_ingr_2 = C.ingredients :inherit, 2
+
+          c_ingr_0.must_equal Set.new([])
+          c_ingr_1.must_equal Set.new([])
+          c_ingr_2.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+        end
+      end
+
+      describe "property-wide inherit age override" do
+        before do
+          @props = A.cascade do
+            location :default => "south side", :inherit => false
+            score :default => 32.18, :inherit => false
+            num :default => 12, :inherit => false        
+            weather :default => :sunny, :inherit => false
+            available :default => false, :inherit => false
+            mood :default => Proc.new{|me| me.weather == :sunny ? "content" : "depressed"}, :inherit => false
+            color :default => Proc.new{|me| me.mood == "content" ? "rosy" : "blue"}, :inherit => false
+            name :default => {:first => 'jon', :last => 'smith'}, :inherit => false
+            groceries :default => [:ice, :lemons, :splenda], :inherit => false
+            ingredients :default => Set.new([:sugar, :butter, :flour, :eggs]), :inherit => false
+          end
+
+          B.color = Proc.new{|me| me.mood == "content" ? "#{me}: rosy" : "#{me}: blue"}
+        end
+
+        it "all should not inherit" do
+          @props[:location][:inherit].must_equal false
+          @props[:score][:inherit].must_equal false
+          @props[:num][:inherit].must_equal false
+          @props[:weather][:inherit].must_equal false
+          @props[:available][:inherit].must_equal false
+          @props[:mood][:inherit].must_equal false
+          @props[:color][:inherit].must_equal false
+          @props[:groceries][:inherit].must_equal false
+          @props[:ingredients][:inherit].must_equal false
+
+          A.location.must_equal "south side"
+          B.location.must_equal ''
+          C.location.must_equal ''
+
+          A.score.must_equal 32.18
+          B.score.must_equal nil
+          C.score.must_equal nil
+
+          A.num.must_equal 12
+          B.num.must_equal nil
+          C.num.must_equal nil
+
+          A.weather.must_equal :sunny
+          B.weather.must_equal nil
+          C.weather.must_equal nil
+
+          A.available.must_equal false
+          B.available.must_equal nil
+          C.available.must_equal nil
+
+          A.mood.must_equal "content"
+          B.mood.must_equal "depressed"
+          C.mood.must_equal "depressed"
+
+          A.color.must_equal "rosy"
+          B.color.must_equal "B: blue"
+          C.color.must_equal "blue"
+
+          A.name.must_equal({:first => 'jon', :last => 'smith'})
+          B.name.must_equal Hash.new
+          C.name.must_equal Hash.new
+
+          A.groceries.must_equal [:ice, :lemons, :splenda]
+          B.groceries.must_equal Array.new
+          C.groceries.must_equal Array.new
+
+          A.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+          B.ingredients.must_equal Set.new
+          C.ingredients.must_equal Set.new
+        end
+
+        describe "manual inheritance age override" do
+          it "allows 'true' and '-1' syntax" do
+            B.location(true).must_equal "south side"
+            C.location(true).must_equal "south side"
+
+            B.score(-1).must_equal 32.18
+            C.score(-1).must_equal 32.18
+
+            B.ingredients(true).must_equal Set.new([:sugar, :butter, :flour, :eggs])
+            C.ingredients(true).must_equal Set.new([:sugar, :butter, :flour, :eggs])
+          end
+
+          it "allows <fixnum> (n > 0) syntax to indicate max inheritance age" do
+            B.weather(0).must_equal nil
+            B.weather(1).must_equal :sunny
+            B.weather(2).must_equal :sunny
+            C.weather(0).must_equal nil
+            C.weather(1).must_equal nil
+            C.weather(2).must_equal :sunny
+            C.weather(3).must_equal :sunny
+
+            B.groceries(0).must_equal Array.new
+            B.groceries(1).must_equal [:ice, :lemons, :splenda]
+            B.groceries(2).must_equal [:ice, :lemons, :splenda]
+            C.groceries(0).must_equal Array.new
+            C.groceries(1).must_equal Array.new
+            C.groceries(2).must_equal Array.new [:ice, :lemons, :splenda]
+            C.groceries(3).must_equal Array.new [:ice, :lemons, :splenda]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/basics/proc_spec.rb

@@ -0,0 +1,343 @@
+begin
+  require_relative '../helper_spec'
+rescue NameError
+  require File.expand_path('../helper_spec', __FILE__)
+end
+
+# known error: defining a proc property with do ... end syntax
+#   A.cascade do
+#     mood :default => Proc.new do |me|
+#       me.weather == :sunny ? "content" : "depressed"
+#     end
+#   end
+
+
+describe "proc properties" do
+  before do
+    A = Class.new{include CC}
+    B = Class.new(A)
+    C = Class.new(B)
+
+    @props = A.cascade do
+      weather :default => :sunny
+      mood :default => Proc.new{|me|
+        me.weather == :sunny ? "content" : "depressed"
+      }
+      color :default => Proc.new{|me|
+        me.mood == "content" ? "rosy" : "blue"
+      }
+    end
+  end
+
+  after do
+    Object.send :remove_const, :A
+    Object.send :remove_const, :B
+    Object.send :remove_const, :C
+  end
+
+  it "inherits by default" do
+    @props[:weather][:inherit].must_equal true    # sanity
+    @props[:mood][:inherit].must_equal true
+    @props[:color][:inherit].must_equal true
+  end
+
+  describe "a property of type :Proc" do
+    it "evaluates the proc on each invocation of the property" do
+      A.weather.must_equal :sunny
+      A.mood.must_equal "content"
+      A.color.must_equal "rosy"
+
+      A.weather = :rainy
+      A.mood.must_equal "depressed"
+      A.color.must_equal "blue"
+    end
+
+    it "has second parameter that is a list of parents" do
+      A.mood = Proc.new{|me, parents| parents}
+
+      A.mood.must_equal []
+      B.mood.must_equal [A]
+      C.mood.must_equal [B, A]
+
+      A.new.mood.must_equal [A]
+      B.new.mood.must_equal [B, A]
+      C.new.mood.must_equal [C, B, A]
+    end
+
+    describe "blank descendents" do
+      it "inherits from its nearest non-blank ancestor" do
+        B.mood_is_blank?.must_equal true
+        C.mood_is_blank?.must_equal true
+
+        A.weather = :sunny
+        B.mood.must_equal "content"
+        C.mood.must_equal "content"
+        B.color.must_equal "rosy"
+        C.color.must_equal "rosy"
+
+        A.weather = :rainy
+
+        B.mood.must_equal "depressed"
+        C.mood.must_equal "depressed"
+        B.color.must_equal "blue"
+        C.color.must_equal "blue"
+      end
+
+      it "uses its own proc if not blank" do
+        B.mood = Proc.new{ "angry" }
+
+        B.mood.must_equal "angry"
+        B.color.must_equal "blue"
+      end
+
+      describe "the parent redefines the proc property" do
+        before do
+          A.color = Proc.new{|me| me.mood == "content" ? "#{me}: rosy" : "#{me}: blue"}
+        end
+
+        it "cascades down to descendents whose property is blank, just as before" do
+          A.weather = :sunny
+          B.weather = :rainy
+          
+          A.color.must_equal "A: rosy"
+          B.color.must_equal "B: blue"
+          C.color.must_equal "C: blue"
+        end
+      end
+
+      describe "a descendent changes its proc property" do
+        before do
+          B.mood = Proc.new{ "angry" }
+          B.color = Proc.new{|me, parents| me.mood == "content" ? "#{me}: rosy" : "#{me}: blue"}
+        end
+
+        describe "descendents of the descendent" do
+          it "inherits the new proc by default" do
+            A.weather = :sunny
+
+            A.mood.must_equal "content"
+            B.mood.must_equal "angry"
+            C.mood.must_equal "angry"
+
+            A.color.must_equal "rosy"
+            B.color.must_equal "B: blue"
+            C.color.must_equal "C: blue"
+          end
+
+          describe "descendents can any inheritance, using the default instead" do
+            it "accepts ':default' syntax" do
+              A.weather = :sunny
+
+              A.mood.must_equal "content"
+              B.mood.must_equal "angry"
+              C.mood(:default).must_equal "content"
+            end
+
+            it "accepts ':inherit => false' syntax" do
+              A.weather = :sunny
+
+              A.mood.must_equal "content"
+              B.mood.must_equal "angry"
+              C.mood(:inherit => false).must_equal "content"
+
+              A.color.must_equal "rosy"
+              B.color.must_equal "B: blue"
+              C.color(:inherit => false).must_equal "blue"  # ***** take note: C.mood = "depressed" *****
+            end
+
+            it "accepts ':inherit, false' syntax" do
+              A.weather = :sunny
+
+              A.mood.must_equal "content"
+              B.mood.must_equal "angry"
+              C.mood(:inherit, false).must_equal "content"
+
+              A.color.must_equal "rosy"
+              B.color.must_equal "B: blue"
+              C.color(:inherit, false).must_equal "blue"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe "a property of type :Proc with property-level inheritance override" do
+    before do
+      @props = A.cascade do
+        weather :default => :sunny
+        mood :default => Proc.new{|me| me.weather == :sunny ? "content" : "depressed"}, :inherit => false
+        color :default => Proc.new{|me| me.mood == "content" ? "#{me}: rosy" : "#{me}: blue"}, :inherit => false
+      end
+
+      B.mood = Proc.new{ "angry" }
+    end
+
+    it "does not inherit" do
+      @props[:weather][:inherit].must_equal true  # sanity
+      @props[:mood][:inherit].must_equal false
+      @props[:color][:inherit].must_equal false
+    end
+
+    describe "descendents" do
+      it "propogates the initial proc value, but not any descendents' proc" do
+        B.color_is_blank?.must_equal true
+        C.mood_is_blank?.must_equal true
+
+        A.weather.must_equal :sunny    # sanity
+        B.weather.must_equal :sunny    # sanity
+        C.weather.must_equal :sunny
+
+        A.mood.must_equal "content"    # sanity
+        B.mood.must_equal "angry"      # sanity
+        C.mood.must_equal "content"
+
+        A.color.must_equal "A: rosy"    # sanity
+        B.color.must_equal "B: blue"    # sanity
+        C.color.must_equal "C: rosy"
+      end
+    end
+  end
+
+  describe "an inherited property not of type :Proc" do
+    before do
+      @props = A.cascade do
+        ingredients :default => Set.new([:sugar, :butter, :flour, :eggs]), :inherit => true
+        sweet_tooth :default => false
+      end
+    end
+
+    it "inherits the property" do
+      @props[:ingredients][:inherit].must_equal true
+      @props[:sweet_tooth][:inherit].must_equal true
+
+      A.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+      B.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+      C.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+
+      A.sweet_tooth.must_equal false
+      B.sweet_tooth.must_equal false
+      C.sweet_tooth.must_equal false
+    end
+
+    describe "a descendent redefines the property with a proc" do
+      before do
+        class D < C; end
+        
+        B.cascade do
+          diabetic :default => false
+        end
+
+        B.ingredients = Proc.new do |me, parents|
+          me.diabetic ? parents.first.ingredients.dup.delete(:sugar) << :splenda :
+            parents.first.ingredients.dup.delete(:splenda) << :sugar
+        end
+
+        B.sweet_tooth = Proc.new{|me, parents| me.ingredients.include? :sugar}
+      end
+
+      after do
+        Object.send :remove_const, :D
+      end
+
+      it "further descendents inherit the proc" do
+        C.diabetic = true
+        D.diabetic = false
+
+        B.diabetic.must_equal false
+        C.diabetic.must_equal true
+        D.diabetic.must_equal false
+
+        B.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+        C.ingredients.must_equal Set.new([:splenda, :butter, :flour, :eggs])
+        D.ingredients.must_equal Set.new([:sugar, :butter, :flour, :eggs])
+
+        A.sweet_tooth.must_equal false
+        B.sweet_tooth.must_equal true
+        C.sweet_tooth.must_equal false
+        D.sweet_tooth.must_equal true
+      end
+
+      describe "descendents redefine the property, but not to a proc" do
+        before do
+          C.ingredients = Set.new([:equal, :butter, :flour, :eggs])
+          C.sweet_tooth = false
+        end
+
+        it "descendents reflect the new 'static' settings" do
+          C.ingredients.must_equal Set.new([:equal, :butter, :flour, :eggs])
+          D.ingredients.must_equal Set.new([:equal, :butter, :flour, :eggs])
+
+          C.sweet_tooth.must_equal false
+          D.sweet_tooth.must_equal false
+        end
+      end
+    end
+  end
+
+  describe "syntax" do
+    it "takes two params: self, parent classes" do
+      who_am_i, which_parents = nil, nil
+
+      B.color = Proc.new{|me, parents|
+        who_am_i = me
+        which_parents = parents
+        "green"
+      }
+
+      B.color.must_equal("green")
+      who_am_i.must_equal(B)
+      which_parents.must_equal([A])
+    end
+
+    it "evaluates to the property value" do
+      B.color = Proc.new{ "green" }
+      B.color.must_equal "green"
+
+      C.color = Proc.new{|me, parents|
+        "#{me} #{parents.first.color.capitalize}"
+      }
+      C.color.must_equal "C Green"
+    end
+  end
+end
+
+describe "examples" do
+  before do
+    class A; extend CC; end
+    class B < A; end
+    class C < B; end
+  end
+
+  after do
+    Object.send :remove_const, :A
+    Object.send :remove_const, :B
+    Object.send :remove_const, :C
+  end
+
+  describe "merge: hash property" do
+    before do
+      A.cascade do
+        opts :default => {:color => "black", :music => ["Rolling Stones"]}
+        merged_opts :proc => true
+      end
+
+      A.merged_opts = Proc.new do |me, parents|
+        parents.reverse.inject({}){|r, child|
+          r.merge(child.opts)
+        }.merge(me.opts)
+      end
+
+      B.opts[:music] = ["Arcade Fire"]
+      C.opts[:color] = "blond"
+    end
+
+    it "works" do
+      A.merged_opts.must_equal({:color => "black", :music => ["Rolling Stones"]})
+      B.merged_opts.must_equal({:color => "black", :music => ["Arcade Fire"]})
+      C.merged_opts.must_equal({:color => "blond", :music => ["Arcade Fire"]})
+    end
+  end
+end
+
+