cascading_classes 0.2.0 → 0.3.0

data/README.md

@@ -12,27 +12,22 @@ This library allows you to easily create properties that cascade down a class tr
 
     class GrandChild < Child; end
 
-now create two properties that will cascade down all descendents
+now create properties that will cascade down all descendents
 
     Parent.cascade :eye_color, :hair_color
 
-set the properties on ```Parent```
+set a property on a parent class
 
     Parent.eye_color = "brown"
-    Parent.hair_color = "black"
 
 all child classes are affected
 
     p Child.eye_color        # => "brown"
     p GrandChild.eye_color   # => "brown"
 
-    p Child.hair_color       # => "black"
-    p GrandChild.hair_color  # => "black"
-
-now change the ```eye_color``` and ```hair_color``` properties on ```Child```
+now change the property on a descendent class
 
     Child.eye_color = "blue"     
-    Child.hair_color = "blond"
 
 only descendents of ```Child``` are affected
 
@@ -56,7 +51,7 @@ Assume the class structure from above:
 
 ## Setting default values
 
-Setting default values for cascaded properties are easy. The first method is to bracket them in Array pairs. For example:
+Setting default values for cascaded properties is easy. The first method is to bracket them in Array pairs. For example:
 
     Parent.cascade [:eye_color, "hazel"], [:hair_color, "brown"], :has_education
 
@@ -69,8 +64,8 @@ You also create cascaded properties via ```Parent.all!```
 
 For example, the following are equivalent:
 
-    Parent.cascade :arms, :legs, :head
-    Parent.all! :arms, :legs, :head
+    Parent.cascade :arms, :legs
+    Parent.all! :arms, :legs
 
 this initiates, but does not set, two cascading properties: ```arms```, ```legs```
 
@@ -82,7 +77,7 @@ since no default was given, all are nil
 
 Again, to set a default use brackets:
 
-    Parent.all! :arms, [:legs, 2], [:head, :none]
+    Parent.all! :arms, [:legs, 2]
 
 
 ### Alternative syntax: block arguments
@@ -136,7 +131,7 @@ You can also set a property in a block using ```set_property```
 
 ## Quick Summary
 
-Note: CC is equivalent to CascadingClasses
+NOTE: CC is equivalent to CascadingClasses
 
 require the gem
 
@@ -176,12 +171,12 @@ get and set the property on any descendent
 
 ## What's the difference between ```extend CC``` and ```include CC```?
 
-First, in either case you are dealing with class instance variables and class methods. 
+First, in either case you are dealing with class instance variables.
 
     A.cascade :eye_color
     A.eye_color = "blue"
 
-sets ```@eye_color``` on the singleton class of ```A```.
+sets ```@eye_color``` on ```A```.
 
 But if you also want the properties to cascade to instance variables, you have three options. The first is to ```include CC```, which, by default, creates the properties on instances too
 
@@ -198,7 +193,9 @@ But if you also want the properties to cascade to instance variables, you have t
     c = Child.new
     p c.one   # => 1
 
-The other two ways to ensure instances have cascaded properties is by including a third argument
+The other two ways to ensure instances have cascading properties uses an additional argument:
+
+either
 
     Parent.cascade [:hair_color, "blue", true]
 
@@ -208,6 +205,52 @@ or
       hair_color :default => "blue", :instances => true
     end
 
+will do the trick.
+
 In either case, even if you ```extend CC```, all instance variables of all descendents will have the ```hair_color``` property. 
 
-      
+## Custom getters and setters
+
+The easiest way to apply custom names for getting and setting a property is with the :getter/:setter options.
+
+    Parent.cascade do
+      eye_color :start => "brown", :getter => :eyes, :setter => :eyes=
+    end
+    Child.eyes = "blue"
+    
+now you cannot use ```:eye_color``` or ```:eye_color=``` methods to get or set the property.
+
+    p Parent.eyes         # => "brown"
+    p Parent.eye_color    # => NoMethodError
+
+    p Child.eyes          # => "blue"
+    p GrandChild.eyes     # => "blue"
+
+You can also have more than one getter or setter function
+
+    Parent.all! do
+      has_hair :begin => false, :getters => [:has_hair?, :hair?]
+    end
+    Child.has_hair = true
+
+    p Parent.has_hair?   # => false
+    p Parent.hair?       # => false
+
+    p Child.has_hair?   # => true
+    p Child.hair?       # => true
+    
+While not recommended, you can also apply custom getter/setter name in the array style syntax. 
+
+    Parent.cascade [:has_hair, false, true, [:has_hair?, :hair?]]
+   
+this initializes the ```has_hair``` property on ```Parent``` to false and sets the getter functions to ```:has_hair?``` and ```:hair?```. Recall that the third argument in the block explicitly sets whether class instances are inherit the property. 
+
+If you wanted to apply a custom setter, it would be the fifth argument:
+
+    Parent.cascade [:has_hair, false, true, :hair?, :hair!]
+
+Compare how much worse that looks compared to the block syntax:
+
+    Parent.cascade do
+      hair_color :default => false, :instances => true, :getter => :hair?, :setter => :hair!
+    end

data/lib/cascading_classes/cascading_classes.rb

@@ -2,18 +2,22 @@ require 'cascading_classes/dsl'
 
 module CascadingClasses
 
-  def self.cascade_intern(klass, property)
+  def self.cascade_intern(klass, property, getter, setter)
     Module.new do
 
-      define_method property do
-        val = instance_variable_get "@#{property}"
-        return val unless (val.nil? and self != klass)
-        (self.class == Class) ? superclass.send(property) :
-          self.class.send(property)
+      if getter
+        define_method getter do
+          val = instance_variable_get "@#{property}"
+          return val unless (val.nil? and self != klass)
+          (self.class == Class) ? superclass.send(getter) :
+            self.class.send(getter)
+        end
       end
 
-      define_method "#{property}=" do |v|
-        instance_variable_set "@#{property}", v
+      if setter
+        define_method setter do |v|
+          instance_variable_set "@#{property}", v
+        end
       end
 
     end
@@ -24,23 +28,30 @@ module CascadingClasses
     res = {}  
     properties.each do |prop|
       name, default, inst_too = prop, nil, apply_to_instances
+      getters, setters = [], []
       if Array === prop 
         case prop.size
         when 0 then next
         when 1 then name = prop[0]
         when 2 then name, default = prop[0..1]
-        else name, default, inst_too = prop[0..2]
+        else
+          name, default, inst_too = prop[0..2]
+          getters = [*prop[3]] if prop.size >= 4
+          setters = [*prop[4]] if prop.size >= 5            
         end
       end
+      getters = [name.to_sym] if getters.empty?
+      setters = ["#{name}=".to_sym] if setters.empty?
       inst_too = !!inst_too
-      res[name.to_sym] = [default, inst_too]
+      res[name.to_sym] = [default, inst_too, getters, setters]
     end
 
     if block_given?
       a = CascadingClasses::DSL.new(apply_to_instances, &block)
-      names, defaults, inst =
-        a.instance_eval{ [@names, @defaults, @instances_too] }
-      names.each{|name| res[name] = [defaults[name], inst[name]] }
+      names, defaults, inst, getters, setters =
+        a.instance_eval{ [@names, @defaults, @instances_too, @getters, @setters] }
+      names.each{|name|
+        res[name] = [defaults[name], inst[name], getters[name], setters[name]] }
     end
 
     res

data/lib/cascading_classes/dsl.rb

@@ -62,13 +62,33 @@ module CascadingClasses
       else
         @apply_to_instances                    
       end
+
+      @getters[name] = if args.include? :getter
+        [*args[:getter]]
+      elsif args.include? :getters
+        [*args[:getters]]
+      elsif args.include? :get
+        [*args[:get]]
+      else
+        [name.to_sym]
+      end
+
+      @setters[name] = if args.include? :setter
+        [*args[:setter]]
+      elsif args.include? :setters
+        [*args[:setters]]
+      elsif args.include? :set
+        [*args[:set]]
+      else
+        ["#{name}=".to_sym]
+      end
     end
 
     def initialize(apply_to_instances, &block)
       @apply_to_instances = apply_to_instances
       @names = []
-      @defaults = {} 
-      @instances_too = {}  # values are true/false
+      @defaults, @instances_too = {}, {}
+      @getters, @setters = {}, {}
 
       return unless block_given?
       if block.arity == 0

data/lib/cascading_classes.rb

@@ -33,7 +33,8 @@ module CascadingClasses
   # todo: fill in rest
   # todo: allow one of [:cascade, :all!] to be overwritten
   def self.illegal_names
-    [:cascade, :all!, :instance_eval, :instance_exec, :class_eval]
+    [:cascade, :all!, :set_property, :instance_eval, :instance_exec,
+     :class_eval]
   end
 
   def self.apply(klass, instances_too)
@@ -43,11 +44,15 @@ module CascadingClasses
         illegal_names = CascadingClasses.illegal_names
 
         props = CascadingClasses.parse_options(klass, instances_too, *props, &block)
-        props.each{|prop, v| raise NameError, "Illegal property name: #{prop}" if
-          illegal_names.include? prop }
+        props.each{|prop, v| 
+          default, inst_too, getters, setters = v
+          getters.each{|getter|
+            raise NameError, "Illegal property getter: #{getter} for #{prop}" if
+              illegal_names.include? getter }
+        }
 
         props.each do |prop, v|
-          default, inst_too = v
+          default, inst_too, getters, setters = v
 
           klass.singleton_class.instance_eval do
             undef_method prop.to_sym rescue nil
@@ -56,14 +61,27 @@ module CascadingClasses
 
           klass.instance_eval{ instance_variable_set "@#{prop}", default }
 
-          mod = CascadingClasses.cascade_intern(klass, prop)
+          mod = CascadingClasses.cascade_intern(klass, prop, getters[0], setters[0])
           klass.extend mod
+          klass.singleton_class.instance_eval do
+            getters[1..-1].each{|getter| alias_method getter, getters[0]} unless
+              getters[0].nil?
+            setters[1..-1].each{|setter| alias_method setter, setters[0]} unless
+              setters[0].nil?
+          end
+
           if inst_too
             klass.instance_eval do
               undef_method prop.to_sym rescue nil
               undef_method "#{prop}=".to_sym rescue nil
             end
             klass.send(:include, mod)
+            klass.instance_eval do
+              getters[1..-1].each{|getter| alias_method getter, getters[0]} unless
+                getters[0].nil?
+              setters[1..-1].each{|setter| alias_method setter, setters[0]} unless
+                setters[0].nil?
+            end
           end
         end
       end

data/spec/alternative_syntax_spec.rb

@@ -20,6 +20,26 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     GrandChild = Class.new(Child)
   end
 
+  after do
+    Object.send :remove_const, :Parent
+    Object.send :remove_const, :Child
+    Object.send :remove_const, :GrandChild    
+  end
+
+  def standard
+    Parent.hair_color.must_equal "black"
+    Child.hair_color.must_equal "blond"
+    GrandChild.hair_color.must_equal "blond"  
+
+    Parent.eye_color.must_equal nil
+    Child.eye_color.must_equal "brown"
+    GrandChild.eye_color.must_equal "brown"
+
+    Parent.piercings.must_equal false
+    Child.piercings.must_equal false
+    GrandChild.piercings.must_equal false
+  end
+
   describe "when an alternative syntax is given (0)" do
     before do
       Parent.cascade [:hair_color, "black"], :eye_color, [:piercings, false]
@@ -29,17 +49,7 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     end
 
     it "should give the same result" do
-      Parent.hair_color.must_equal "black"
-      Child.hair_color.must_equal "blond"
-      GrandChild.hair_color.must_equal "blond" 
-
-      Parent.eye_color.must_equal nil
-      Child.eye_color.must_equal "brown"
-      GrandChild.eye_color.must_equal "brown"
-
-      Parent.piercings.must_equal false
-      Child.piercings.must_equal false
-      GrandChild.piercings.must_equal false
+      standard
     end
   end
 
@@ -52,17 +62,7 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     end
 
     it "should give the same result" do
-      Parent.hair_color.must_equal "black"
-      Child.hair_color.must_equal "blond"
-      GrandChild.hair_color.must_equal "blond"    
-
-      Parent.eye_color.must_equal nil
-      Child.eye_color.must_equal "brown"
-      GrandChild.eye_color.must_equal "brown"
-
-      Parent.piercings.must_equal false
-      Child.piercings.must_equal false
-      GrandChild.piercings.must_equal false
+      standard
     end
   end
 
@@ -78,17 +78,7 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     end
 
     it "should give the same result" do
-      Parent.hair_color.must_equal "black"
-      Child.hair_color.must_equal "blond"
-      GrandChild.hair_color.must_equal "blond"  
-
-      Parent.eye_color.must_equal nil
-      Child.eye_color.must_equal "brown"
-      GrandChild.eye_color.must_equal "brown"
-
-      Parent.piercings.must_equal false
-      Child.piercings.must_equal false
-      GrandChild.piercings.must_equal false
+      standard
     end
   end
 
@@ -104,17 +94,7 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     end
 
     it "should give the same result" do
-      Parent.hair_color.must_equal "black"
-      Child.hair_color.must_equal "blond"
-      GrandChild.hair_color.must_equal "blond"  
-
-      Parent.eye_color.must_equal nil
-      Child.eye_color.must_equal "brown"
-      GrandChild.eye_color.must_equal "brown"
-
-      Parent.piercings.must_equal false
-      Child.piercings.must_equal false
-      GrandChild.piercings.must_equal false
+      standard
     end
   end
 
@@ -130,17 +110,64 @@ describe "when a class extends CascadingClasses and an alternative syntax is use
     end
 
     it "should give the same result" do
-      Parent.hair_color.must_equal "black"
-      Child.hair_color.must_equal "blond"
-      GrandChild.hair_color.must_equal "blond"  
+      standard
+    end
+  end
+
+  # getters/setters
+  describe "when an alternative getter/setter syntax is given" do
+    before do
+      Parent.cascade do
+        eye_color :getter => :eyes, :setter => :eyes=
+        hair_color :initial => "black", :getters => :hair, :setters => :hair=
+        piercings :start => false,
+                  :getter => [:has_piercings?, :piercings?],
+                  :setter => [:has_piercings=, :piercings=]
+      end
+
+      Child.hair = "blond"
+      Child.eyes = "brown"
+    end
+
+    it "should give the same result" do
+      Parent.hair.must_equal "black"
+      Child.hair.must_equal "blond"
+      GrandChild.hair.must_equal "blond"
+
+      Parent.eyes.must_equal nil
+      Child.eyes.must_equal "brown"
+      GrandChild.eyes.must_equal "brown"
+
+      Parent.has_piercings?.must_equal false
+      Child.piercings?.must_equal false
+      GrandChild.has_piercings?.must_equal false
+    end
+  end
+
+  describe "when an alternative syntax is given (2)" do
+    before do
+      Parent.cascade [:eye_color, nil, false, :eyes, :eyes=]
+      Parent.cascade [:hair_color, "black", false, :hair, :hair=]
+      Parent.cascade [:piercings, false, false,
+                       [:has_piercings?, :piercings?],
+                       [:has_piercings=, :piercings=] ]
+
+      Child.hair = "blond"
+      Child.eyes = "brown"
+    end
+
+    it "should give the same result" do
+      Parent.hair.must_equal "black"
+      Child.hair.must_equal "blond"
+      GrandChild.hair.must_equal "blond"
 
-      Parent.eye_color.must_equal nil
-      Child.eye_color.must_equal "brown"
-      GrandChild.eye_color.must_equal "brown"
+      Parent.eyes.must_equal nil
+      Child.eyes.must_equal "brown"
+      GrandChild.eyes.must_equal "brown"
 
-      Parent.piercings.must_equal false
-      Child.piercings.must_equal false
-      GrandChild.piercings.must_equal false
+      Parent.has_piercings?.must_equal false
+      Child.piercings?.must_equal false
+      GrandChild.has_piercings?.must_equal false
     end
   end
 end

data/spec/extended_spec.rb

@@ -27,6 +27,12 @@ describe "when a class extends CascadingClasses" do
     GrandChild = Class.new(Child)
   end
 
+  after do
+    Object.send :remove_const, :Parent
+    Object.send :remove_const, :Child
+    Object.send :remove_const, :GrandChild
+  end
+
   describe "when a parent has a default" do
     before do
       Parent.cascade [:eyes, "brown"]      
@@ -164,4 +170,146 @@ describe "when a class extends CascadingClasses" do
       res.must_equal true
     end
   end
+
+  # getters/setters
+  describe "when a custom getter is given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "brown", :getter => :color
+      end
+    end
+
+    it "is the only reader method" do
+      Parent.color.must_equal "brown"
+
+      Parent.send(:respond_to?, :eye_color).must_equal false
+    end
+  end
+
+  # :getters aliased to :getter
+  describe "when multiple getters are given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "brown", :getters => [:color, :eyes]
+      end
+
+      it "those methods are the only readers" do
+        Parent.color.must_equal "brown"
+        Parent.eyes.must_equal "brown"
+
+        Parent.send(:respond_to?, :eye_color).must_equal false
+      end
+    end
+  end
+
+  describe "when a getter name is nil" do
+    before do
+      Parent.all! do
+        color :default => "red", :getter => nil
+      end
+    end
+
+    it "should not have a getter method" do
+      Parent.send(:respond_to?, :color).must_equal false
+    end
+  end
+
+  describe "when a getter name is false" do
+    before do
+      Parent.all!{
+        color :default => "red", :getter => false
+      }
+    end
+
+    it "should not have a getter method" do
+      Parent.send(:respond_to?, :color).must_equal false
+    end
+  end
+
+  describe "when a custom getter is given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "black", :getter => :color
+      end
+    end
+
+    it "should also be the getter for child classes" do
+      Child.color.must_equal "black"
+
+      Child.send(:respond_to?, :eye_color).must_equal false
+    end
+  end
+
+  describe "when a custom setter is given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "brown", :setter => :color=
+      end
+    end
+
+    it "is the only writer method" do
+      Parent.color = "blue"
+      Parent.eye_color.must_equal "blue"
+
+      Parent.send(:respond_to?, :eye_color=).must_equal false
+    end
+  end
+
+  # :setters aliased to :setters
+  describe "when multiple setters are given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "brown", :setters => [:color=, :set_color]
+      end
+
+      it "those methods are the only readers" do
+        Parent.color = "blue"
+        Parent.color.must_equal "blue"
+
+        Parent.set_color "black"
+        Parent.color.must_equal "black"
+
+        Parent.send(:respond_to?, :eye_color=).must_equal false
+      end
+    end
+  end
+
+  describe "when a setter name is nil" do
+    before do
+      Parent.all!{
+        color :default => "red", :setter => nil
+      }
+    end
+
+    it "should not have a setter method" do
+      Parent.send(:respond_to?, :color=).must_equal false
+    end
+  end
+
+  describe "when a setter name is false" do
+    before do
+      Parent.all! do
+        color :default => "red", :setter => false
+      end
+    end
+
+    it "should not have a setter method" do
+      Parent.send(:respond_to?, :color=).must_equal false
+    end
+  end
+
+  describe "when a custom setter is given" do
+    before do
+      Parent.cascade do
+        eye_color :default => "black", :setter => :color=
+      end
+    end
+
+    it "should also be the getter for child classes" do
+      Child.color = "blue"      
+      Child.eye_color.must_equal "blue"
+
+      Child.send(:respond_to?, :eye_color=).must_equal false
+    end
+  end
 end

data/spec/included_spec.rb

@@ -24,7 +24,13 @@ describe "when CascadingClasses is included by a class" do
     B = Class.new(A)
     C = Class.new(B)
     @a, @b, @c = A.new, B.new, C.new
-  end  
+  end
+
+  after do
+    Object.send :remove_const, :A
+    Object.send :remove_const, :B
+    Object.send :remove_const, :C
+  end
 
   describe "when CascadingClasses is included in a module" do
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cascading_classes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-08 00:00:00.000000000Z
+date: 2011-08-09 00:00:00.000000000Z
 dependencies: []
-description: Similar to active_support/core_ext/class/attribute.rb but better. Also,
-  doesn't monkey-patch Class
+description: ! 'Easily create properties whose values cascade down class trees.
+
+
+  Similar to active_support/core_ext/class/attribute.rb but better. Also, doesn''t
+  monkey-patch Class'
 email: jeremy.gables@gmail.com
 executables: []
 extensions: []
@@ -27,7 +30,6 @@ files:
 - spec/extended_spec.rb
 - spec/included_spec.rb
 - spec/alternative_syntax_spec.rb
-- spec/note.txt
 homepage: http://github.com/gables/cascading_classes
 licenses: []
 post_install_message: 
@@ -57,4 +59,3 @@ test_files:
 - spec/extended_spec.rb
 - spec/included_spec.rb
 - spec/alternative_syntax_spec.rb
-- spec/note.txt

data/spec/note.txt

@@ -1,2 +0,0 @@
-you should expect to see many "already initialized constant" warnings
-This happens because the same constants must get reloaded for every test