constructor 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,7 @@
+== 1.0.2 / 2008-05-07
+
+  * An error is raised when constructor keys are passed in that already exist in the super class
+
 == 1.0.1 / 2007-12-21
 
 * You can now pass a block to your constructor call; it gets executed after all the ivars get assigned.  (This lets you write some initializer code if you need to.)

data/README.txt

@@ -1,17 +1,13 @@
-constructor
+== Constructor
 
-* http://rubyforge.org/projects/atomicobjectrb/
 * http://atomicobjectrb.rubyforge.org/constructor
+* http://rubyforge.org/projects/atomicobjectrb/
 
 == DESCRIPTION:
   
 Declarative means to define object properties by passing a hash 
 to the constructor, which will set the corresponding ivars.
 
-== FEATURES/PROBLEMS:
-  
-* Declarative constructor definition and ivar initialization 
-
 == SYNOPSIS:
 
   require 'constructor'

data/lib/constructor.rb

@@ -1,4 +1,4 @@
-CONSTRUCTOR_VERSION = '1.0.1' #:nodoc:#
+CONSTRUCTOR_VERSION = '1.0.2' #:nodoc:#
 
 class Class #:nodoc:#
   def constructor(*attrs, &block)
@@ -10,11 +10,14 @@ class Class #:nodoc:#
     # Look for embedded options in the listing:
     opts = attrs.find { |a| a.kind_of?(Hash) and attrs.delete(a) } 
     do_acc = opts.nil? ? false : opts[:accessors] == true
+    do_reader = opts.nil? ? false : opts[:readers] == true
     require_args = opts.nil? ? true : opts[:strict] != false
     super_args = opts.nil? ? nil : opts[:super]
 
     # Incorporate superclass's constructor keys, if our superclass
     if superclass.constructor_keys
+      similar_keys = superclass.constructor_keys & attrs
+      raise "Base class already has keys #{similar_keys.inspect}" unless similar_keys.empty?
       attrs = [attrs,superclass.constructor_keys].flatten
     end
     # Generate ivar assigner code lines
@@ -25,9 +28,16 @@ class Class #:nodoc:#
 
     # If accessors option is on, declare accessors for the attributes:
     if do_acc
-      self.class_eval "attr_accessor " + attrs.map {|x| ":#{x.to_s}"}.join(',')
+      add_accessors = "attr_accessor " + attrs.reject {|x| superclass.constructor_keys.include?(x.to_sym)}.map {|x| ":#{x.to_s}"}.join(',')
+      #add_accessors = "attr_accessor " + attrs.map {|x| ":#{x.to_s}"}.join(',')
+      self.class_eval add_accessors
     end
 
+    # If readers option is on, declare readers for the attributes:
+    if do_reader
+      self.class_eval "attr_reader " + attrs.reject {|x| superclass.constructor_keys.include?(x.to_sym)}.map {|x| ":#{x.to_s}"}.join(',')
+    end
+    
     # If user supplied super-constructor hints:
     super_call = ''
     if super_args

data/specs/constructor_spec.rb

@@ -46,6 +46,31 @@ describe "constructor's accessor option" do
   end
 end
 
+describe "constructor's reader option" do
+  it 'provides readers for constructor arguments when reader option is true' do
+    fuh = TestingAutoReaders.new( 
+      :foo => 'my foo',
+      :why => 'lucky'
+    )
+    fuh.foo.should eql('my foo')
+    fuh.why.should eql('lucky')
+    fuh.to_pretty_pretty.should eql('my foo lucky')
+
+    lambda {fuh.why = 'no way'}.should raise_error(NoMethodError)
+    lambda {fuh.foo = 'uh uh'}.should raise_error(NoMethodError)
+  end
+
+  it 'does not provide reader for constructor arguments when reader option is false' do
+    fuh = TestingBlockedReaders.new :foo => 'my foo', :why => 'my why'
+    lambda {fuh.foo}.should raise_error(NoMethodError)
+    lambda {fuh.bar}.should raise_error(NoMethodError)
+    fuh.to_pretty_pretty.should eql('my foo my why')
+
+    lambda {fuh.why = 'no way'}.should raise_error(NoMethodError)
+    lambda {fuh.foo = 'uh uh'}.should raise_error(NoMethodError)
+  end
+end
+
 describe 'using constructor with inheritance' do
   it 'allows for inheritance of constructor arguments using a non-constructor defined subclass' do
     fuh = SubclassOfTestingClass.new :foo => 'whu?'
@@ -116,6 +141,22 @@ describe 'using constructor with inheritance' do
     tsc.c.should eql('what a')
     tsc.d.should eql('day for')
   end
+  
+  it "raises an error if subclass tries to build a constructor with the keys as its parents" do
+    class1 = constructor_class(Object, :star, :wars)
+    class2 = constructor_class(class1, :space, :balls)
+    lambda { constructor_class(class2, :star, :space, :chewy) }.should raise_error("Base class already has keys [:space, :star]")
+  end
+  
+  it 'does not create accessors for superclass constructor arguments' do
+    tas = TestingAccessorSubclass.new(:far => 'thing')
+    tas.respond_to?(:cuteness).should be_false
+  end
+  
+  it 'does not create a reader for superclass constructor arguments' do
+    t1 = TestingReaderSubclass.new(:foo => 'thing')
+    t1.respond_to?(:foo).should be_false
+  end
 end
 
 describe 'stict mode usage' do
@@ -208,6 +249,12 @@ describe 'block yielding' do
   end
 end
 
+def constructor_class(base, *keys)
+  Class.new(base) do
+    constructor *keys
+  end
+end
+
 class TestingClass
   attr_accessor :foo, :bar, :why, :qux
   constructor :foo, :bar, :why, :qux, :strict => false
@@ -279,6 +326,21 @@ class TestingAutoAccessors
   end
 end
 
+class TestingAutoReaders
+  constructor :foo, :why, :readers => true, :strict => false
+  def to_pretty_pretty
+    "#{@foo} #{@why}"
+  end
+end
+
+class TestingReaderSuperclass
+  constructor :foo
+end
+
+class TestingReaderSubclass < TestingReaderSuperclass
+  constructor :bar,  :readers => true, :strict => false
+end  
+
 class TestingSuperConstructorBase
   attr_reader :a, :b
   def initialize(a,b)
@@ -303,6 +365,10 @@ class TestingSuperConstructor2 < TestingSuperConstructorBase2
   constructor :some, :accessors => true, :super => [], :strict => false
 end
 
+class TestingAccessorSubclass < Baby
+  constructor :foo, :accessors => true, :strict => false
+end
+
 class TestingBlockedAccessors
   constructor :foo, :bar, :accessors => false
   def to_pretty_pretty
@@ -310,12 +376,20 @@ class TestingBlockedAccessors
   end
 end
 
+class TestingBlockedReaders
+  constructor :foo, :why, :readers => false
+  def to_pretty_pretty
+    "#{@foo} #{@why}"
+  end
+end
+
 class Papa
   constructor :car, :saw
 end
 
 class Sonny < Papa
-  constructor :computer, :accessors => true
+  attr_accessor :car, :saw, :computer
+  constructor :computer
 end
 
 class Llamma

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: constructor
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Atomic Object
@@ -9,19 +9,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-08 00:00:00 -04:00
+date: 2009-11-01 01:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 2.3.3
     version: 
-description: "== DESCRIPTION:  Declarative means to define object properties by passing a hash  to the constructor, which will set the corresponding ivars."
+description: |-
+  == DESCRIPTION:
+    
+  Declarative means to define object properties by passing a hash 
+  to the constructor, which will set the corresponding ivars.
 email: dev@atomicobject.com
 executables: []
 
@@ -39,7 +44,9 @@ files:
 - lib/constructor.rb
 - specs/constructor_spec.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/atomicobjectrb/
+homepage: http://atomicobjectrb.rubyforge.org/constructor
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -61,9 +68,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: atomicobjectrb
-rubygems_version: 1.1.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Declarative, named constructor arguments.
 test_files: []