conject 0.0.3 → 0.0.4

data/.gitignore

@@ -4,3 +4,4 @@ tags
 *.swo
 pkg
 /README.html
+Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    conject (0.0.2)
+    conject (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/doc/inheritance_woes.txt

@@ -0,0 +1,57 @@
+
+class Mammal
+  construct_with :fur
+end
+
+class Cat < Mammal
+end
+
+
+Things Cat will inherit from Mammal:
+
+  .new
+  .actual_new
+
+  .object_definition
+
+  .object_context_prep (indirectly)
+    
+  #initialize(component_map) (will be overridden)
+  #actual_initialize (will get stomped)
+
+Calling Cat.new 
+
+
+Rationale: Why does Conject re-implement .new for classes that use construct_with ?
+
+To get in front of normal object construction.  I wanted to get instances built up
+before the normal, user-defined #initialize gets called.
+
+
+
+
+
+
+
+4 initialize cases for subclasses
+  subclass has defined its own #initialize and calls super
+  subclass has defined its own #initialize and DOES NOT CALL super
+    X
+  superclass defined its own #initialize and it has been wrapped by Conject to accept component map
+  superclass defined its own #initialize, but it HAS NOT BEEN WRAPPED YET
+  superclass DOES NOT DEFINE its own #initialize, and it has been wrapped by Conject
+  superclass DOES NOT DEFINE its own #initialize, but it HAS NOT BEEN WRAPPED YET
+
+These circumstances affect when/if set_comonents gets called in the superclass 
+
+
+class A
+  construct_with :b
+end
+
+class Aa < A
+  construct_with :b, :c
+end
+
+- if A gets instantiated first, A#actual_initialize is created and A#initialize is rewritten
+- Instantiating Aa invokes actual_initialize with the component_map which invokes Conjected A#initialize ... which invokes :actual_initialize which has been re-aliased by the subclass and NO LONGER REFERS TO THE ORIGINAL CONSTRUCTOR

data/lib/conject/class_ext_construct_with.rb

@@ -4,93 +4,136 @@ class Class
   def construct_with(*syms)
     klass = self
 
+    #
+    # Create the .object_definition accessor for this class.
+    #
+    # The ObjectDefinition stores information # on the dependencies required to
+    # build new instances.
+    # 
     object_def = Conject::ObjectDefinition.new(:owner => klass, :component_names => syms)
     klass.meta_def :object_definition do
-      object_def
+      @object_definition
+    end
+
+    # TODO: actually, just use meta_eval here to set the ivar and move on.
+    klass.meta_def :set_object_definition do |od| #XXX
+      @object_definition = od
     end
+    klass.set_object_definition(object_def) # XXX
+    klass.meta_eval do private :set_object_definition end # XXX
 
 
+    #
+    # Define internal accessor methods for instances of klass
+    #
+
+    # The internal hash of dependencies, keyed by name:
     klass.class_def_private :components do 
       @_components ||= {}
     end
+    # Have the components been set for this instance yet?
+    klass.class_def_private :components_set? do 
+      !@_components.nil?
+    end
 
+    # Define an internal reader method per dependency:
     syms.each do |object_name|
       class_def_private object_name do
         components[object_name]
       end
     end
 
+    # Define the internal setter method that installs dependencies
+    # in an instance of klass.
+    # #set_components respects the rules set forth in the ObjectDefinition
+    # for this class, and will raise a detailed exception if the rules
+    # are violated.
     klass.class_def_private :set_components do |component_map|
-      required = object_def.component_names
+      return if components_set? # do not repeat.  In inheritance town, a superclass must currently rely on all
+                                # of its deps to be declared and set by subclass functionality.
+
+      obj_def = self.class.object_definition
+      required = obj_def.component_names
       provided = component_map.keys
       if required.to_set != provided.to_set
+        # Explain the diff between what was required and what was actually provided:
         raise Conject::CompositionError.new(
-          :object_definition => object_def,
+          :object_definition => obj_def,
           :required => required, 
           :provided => provided)
       end
 
+      # set all the components
       components.clear.merge! component_map
-
     end
 
-    # Tidbits of state that our dynamically-defined functions herein
-    # will close over.
-    object_context_prep = {
-      :initialize_has_been_wrapped => false,  # keep track of when a class's :initialize method has been wrapped
-    }
-    
-    # Alias :new such that we can wrap and invoke it later
-    klass.meta_eval do 
-      alias_method :actual_new, :new
+    # .object_context_prep is used internally by klass to maintain some state regarding
+    # its internal restructuring.
+    klass.meta_def :object_context_prep do 
+      @object_context_prep ||= {
+        :initialize_has_been_wrapped => false
+      }
     end
+    klass.meta_eval do private :object_context_prep end
+    
+    unless klass.methods.include?(:actual_new) # only do this once per family tree (subclasses will inherit the Conjected .new)
+      # Alias :new such that we can wrap and invoke it later
+      klass.meta_eval do 
+        alias_method :actual_new, :new
+      end
 
-    # Override default :new behavior for this class.
-    #
-    # The .new method is rewritten to accept a single argument:
-    #   component_map: a Hash containing all required objects to construct a new instance.
-    #                  Keys are expected to be symbols.
-    # 
-    # If user defines their own #initialize method, all components sent into .new
-    # will be installed BEFORE the user-defined #initialize, and it may accept arguments thusly:
-    # * zero args.  Nothing will be passed to #initialize
-    # * single arg. The component_map will be passed.
-    # * var args (eg, def initialize(*args)).  args[0] will be the component map.  NO OTHER ARGS WILL BE PASSED. See Footnote a)
-    #
-    klass.meta_def :new do |component_map|
-
-      # We only want to do the following one time, but we've waited until now
-      # in order to make sure our metaprogramming didn't get ahead of the user's
-      # own definition of initialize:
-      unless object_context_prep[:initialize_has_been_wrapped]
-        # Define a new wrapper'd version of initialize that accepts and uses a component map
-        alias_method :actual_initialize, :initialize
-        class_def :initialize do |component_map|
-          # Apply the given components
-          set_components component_map
-
-          # Invoke the normal initialize method.
-          # User-defined initialize method may accept 0 args, or it may accept a single arg
-          # which will be the component map.
-          arg_count = method(:actual_initialize).arity
-          case arg_count
-          when 0
-            actual_initialize
-          when 1, -1  # See Footnote a) at the bottom of this file
-
-            actual_initialize component_map
-
-          else
-            # We're not equipped to handle this
-            raise "User-defined initialize method defined with #{arg_count} parameters; must either be 0, other wise 1 or -1 (varargs) to receive the component map."
+      # Override default :new behavior for this class.
+      #
+      # The .new method is rewritten to accept a single argument:
+      #   component_map: a Hash containing all required objects to construct a new instance.
+      #                  Keys are expected to be symbols.
+      # 
+      # If user defines their own #initialize method, all components sent into .new
+      # will be installed BEFORE the user-defined #initialize, and it may accept arguments thusly:
+      # * zero args.  Nothing will be passed to #initialize
+      # * single arg. The component_map will be passed.
+      # * var args (eg, def initialize(*args)).  args[0] will be the component map.  NO OTHER ARGS WILL BE PASSED. See Footnote a)
+      #
+      klass.meta_def :new do |component_map|
+
+        # We only want to do the following one time, but we've waited until now
+        # in order to make sure our metaprogramming didn't get ahead of the user's
+        # own definition of initialize:
+        unless object_context_prep[:initialize_has_been_wrapped]
+          # Define a new wrapper'd version of initialize that accepts and uses a component map
+          init_alias = "original_#{self.name}_initialize".to_sym
+          alias_method init_alias, :initialize
+          class_def :initialize do |component_map|
+            if self.class.has_object_definition?
+              # Apply the given components
+              set_components component_map
+            else
+              raise "#{self.class} has an ancestor that uses construct_with, but has not declared any component dependencies.  Will not be able to instantiate!"
+            end
+
+            # Invoke the normal initialize method.
+            # User-defined initialize method may accept 0 args, or it may accept a single arg
+            # which will be the component map.
+            arg_count = method(init_alias).arity
+            case arg_count
+            when 0
+              self.send init_alias
+
+            when 1, -1  # See Footnote a) at the bottom of this file
+              self.send init_alias, component_map
+
+            else
+              # We're not equipped to handle this
+              raise "User-defined initialize method defined with #{arg_count} parameters; must either be 0, other wise 1 or -1 (varargs) to receive the component map."
+            end
           end
+          # Make a note that the initialize wrapper has been applied
+          object_context_prep[:initialize_has_been_wrapped] = true
         end
-        # Make a note that the initialize wrapper has been applied
-        object_context_prep[:initialize_has_been_wrapped] = true
-      end
 
-      # Instantiate an instance
-      actual_new component_map 
+        # Instantiate an instance
+        actual_new component_map 
+      end
     end
   end
 

data/lib/conject/version.rb

@@ -1,3 +1,3 @@
 module Conject
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/acceptance/regression/basic_composition_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe "basic object composition" do
-  subject { Conject.default_object_context }
+  subject { Conject.create_object_context(nil) }
 
   before do
     append_test_load_path "basic_composition"

data/spec/acceptance/regression/basic_object_creation_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 
 describe "simple object creation" do
-  subject { Conject.default_object_context }
+  subject { Conject.create_object_context(nil) }
 
   before do
     append_test_load_path "simple_stuff"

data/spec/acceptance/regression/inherited_dependencies_spec.rb

@@ -0,0 +1,253 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe "basic inheritance" do
+  subject { new_object_context }
+
+  before do
+    append_test_load_path "inheritance"
+    require 'vehicle'
+    require 'wheel'
+    require 'body'
+    require 'car'
+    require 'malibu'
+    require 'emblem'
+  end
+
+  context "simple subclasses of a class that uses construct_with" do
+    it "gets built with its superclass's dependencies" do
+      # Check the base type object:
+      vehicle = subject[:vehicle]
+      vehicle.should be
+      vehicle.hit_body.should == "body!"
+      vehicle.hit_wheel.should == "wheel!"
+      
+      # grab the subtype object:
+      car = subject[:car]
+      car.should be
+      car.hit_body.should == "body!"
+      car.hit_wheel.should == "wheel!"
+    end
+  end
+
+  context "class three levels deep in inheritance, adding a dep" do
+    it "works" do
+      malibu = subject[:malibu]
+      malibu.hit_body.should == "body!"
+      malibu.hit_wheel.should == "wheel!"
+      malibu.hit_emblem.should == "chevy!"
+    end
+  end
+
+  context "[initializers]" do
+    context "superclass has 0-arg #initialize" do
+      class Mammal
+        construct_with :fur
+        attr_reader :temp
+        def initialize
+          @temp = 98.6
+        end
+      end
+
+      class Fur; end
+      class Tree; end
+
+      it "invokes super #initialize" do
+        m = subject[:mammal]
+        m.temp.should == 98.6
+      end
+
+      context "subclass has default #initialize" do
+        class Cat < Mammal
+          construct_with :fur
+        end
+
+        it "invokes superclass #initialize" do
+          subject[:cat].temp.should == 98.6
+        end
+      end
+
+      context "subclass has 1-arg #initialize that invokes #super" do
+        class Ape < Mammal
+          construct_with :fur,:tree
+          attr_accessor :got_map
+          def initialize(map)
+            @got_map = map
+            super
+          end
+        end
+
+        let(:chauncy) { subject[:ape] }
+
+        it "invokes subclass custom #initialize with component map" do
+          fur = subject[:fur]
+          tree = subject[:tree]
+          chauncy.got_map.should == { fur: fur, tree: tree }
+        end
+
+        it "invokes superclass #initialize" do
+          chauncy.temp.should == 98.6
+        end
+      end
+
+      context "subclass has 0-arg #initialize that invokes #super" do
+        class Dog < Mammal
+          construct_with :fur
+          attr_accessor :legs
+          def initialize
+            @legs = 4
+            super :whoa_there # superclass has a Conjected #initialize which requires the component map arg, though it's not used.  Ugh.
+          end
+        end
+        
+        let(:indy) { subject[:dog] }
+
+        it "invokes subclass #initialize" do
+          indy.legs.should == 4
+        end
+
+        it "invokes superclass #initialize" do
+          indy.temp.should == 98.6
+        end
+      end
+
+      context "subclass has a no-arg #initialize that does NOT invoke #super" do
+        class Shrew < Mammal
+          construct_with :fur
+          def initialize
+          end
+        end
+
+        it "does not invoke superclass #initiailize" do
+          subject[:shrew].temp.should be_nil
+        end
+      end
+
+      context "subclass has a 1-arg #initialize that does NOT invoke #super" do
+        class Shrew < Mammal
+          construct_with :fur
+          def initialize(map)
+          end
+        end
+
+        it "does not invoke superclass #initiailize" do
+          subject[:shrew].temp.should be_nil
+        end
+      end
+    end
+
+
+
+
+
+
+    context "superclass has 1-arg #initialize" do
+      class Reptile
+        construct_with :scales
+        attr_reader :super_map
+        def initialize(map)
+          @super_map = map
+        end
+      end
+
+      class Scales; end
+      class Rock; end
+      class Shell; end
+
+      it "invokes super #initialize with component map" do
+        subject[:reptile].super_map.should == { scales: subject[:scales] }
+      end
+
+      context "subclass has default #initialize" do
+        class Snake < Reptile
+          construct_with :scales
+        end
+
+        it "invokes superclass #initialize" do
+          subject[:reptile].super_map.should == { scales: subject[:scales] }
+        end
+      end
+
+      context "subclass has 1-arg #initialize that invokes #super" do
+        class Lizard < Reptile
+          construct_with :scales,:rock
+          attr_accessor :got_map
+          def initialize(map)
+            @got_map = map
+            super
+          end
+        end
+
+        let(:harry) { subject[:lizard] }
+
+        it "invokes subclass custom #initialize with component map" do
+          scales = subject[:scales]
+          rock = subject[:rock]
+          harry.got_map.should == { scales: scales, rock: rock }
+        end
+
+        it "invokes superclass #initialize with component_map" do
+          scales = subject[:scales]
+          rock = subject[:rock]
+          harry.super_map.should == { scales: scales, rock: rock }
+        end
+      end
+
+      #
+      # This case--where a subclass has a user-defined #initialize, which does
+      # not accept an argument (will not be passed the component map at construct time)
+      # invokes super with some bs argument because we CANNOT SUPPLY super with its
+      # needs.  User SHOULD accept the component_map as an argument to #initialize
+      # and let the map float to super class.
+      # 
+      context "subclass has 0-arg #initialize that invokes #super" do
+        class Turtle < Reptile
+          construct_with :scales, :shell
+          attr_accessor :tail
+          def initialize
+            @tail = true
+            super :theres_ur_problem # stoopid
+          end
+        end
+        
+        let(:franklin) { subject[:turtle] }
+
+        it "invokes subclass #initialize" do
+          franklin.tail.should == true
+        end
+
+        it "invokes superclass #initialize with... fuh..." do
+          franklin.super_map.should == :theres_ur_problem
+        end
+      end
+
+      context "subclass has a no-arg #initialize that does NOT invoke #super" do
+        class Aligator < Reptile
+          construct_with :scales
+          def initialize
+          end
+        end
+
+        it "does not invoke superclass #initiailize" do
+          subject[:aligator].super_map.should be_nil
+        end
+      end
+
+      context "subclass has a 1-arg #initialize that does NOT invoke #super" do
+        class Croc < Reptile
+          construct_with :scales
+          attr_reader :my_map
+          def initialize(map)
+            @my_map = map
+          end
+        end
+
+        it "does not invoke superclass #initiailize" do
+          subject[:croc].super_map.should be_nil
+          subject[:croc].my_map.should == { scales: subject[:scales] }
+        end
+
+      end
+    end
+
+  end
+end

data/spec/acceptance/regression/inject_object_context_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe "object referencing its own context" do
-  subject { Conject.default_object_context }
+  subject { Conject.create_object_context(nil) }
 
   before do
     append_test_load_path "basic_composition"

data/spec/acceptance/regression/nested_contexts_spec.rb

@@ -2,9 +2,9 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe "nested contexts" do
-  subject { Conject.default_object_context }
+  subject { Conject.create_object_context(nil) }
 
-  let(:root_context) { Conject.default_object_context }
+  let(:root_context) { subject }
 
   before do
     append_test_load_path "basic_composition"

data/spec/spec_helper.rb

@@ -20,5 +20,6 @@ end
 
 RSpec.configure do |config|
   config.include LoadPathHelpers
+  config.include ConjectHelpers
 end
 

data/spec/support/conject_helpers.rb

@@ -0,0 +1,5 @@
+module ConjectHelpers
+  def new_object_context
+    Conject.create_object_context(nil)
+  end
+end

data/spec/test_data/basic_composition/special_guest.rb

@@ -0,0 +1,4 @@
+class SpecialGuest < Guest
+  def initialize
+  end
+end

data/spec/test_data/basic_composition/very_special_guest.rb

@@ -0,0 +1,4 @@
+class VerySpecialGuest < SpecialGuest
+  def initialize
+  end
+end

data/spec/test_data/inheritance/body.rb

@@ -0,0 +1,5 @@
+class Body
+  def hit
+    "body!"
+  end
+end

data/spec/test_data/inheritance/car.rb

@@ -0,0 +1,3 @@
+class Car < Vehicle
+  construct_with :body, :wheel
+end

data/spec/test_data/inheritance/emblem.rb

@@ -0,0 +1,5 @@
+class Emblem
+  def hit
+    "chevy!"
+  end
+end

data/spec/test_data/inheritance/malibu.rb

@@ -0,0 +1,7 @@
+class Malibu < Car
+  construct_with :body, :wheel, :emblem
+
+  def hit_emblem
+    emblem.hit
+  end
+end

data/spec/test_data/inheritance/vehicle.rb

@@ -0,0 +1,11 @@
+class Vehicle
+  construct_with :body, :wheel
+
+  def hit_body
+    body.hit
+  end
+
+  def hit_wheel
+    wheel.hit
+  end
+end

data/spec/test_data/inheritance/wheel.rb

@@ -0,0 +1,5 @@
+class Wheel
+  def hit
+    "wheel!"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conject
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152364960 !ruby/object:Gem::Requirement
+  requirement: &2152782340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152364960
+  version_requirements: *2152782340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152364540 !ruby/object:Gem::Requirement
+  requirement: &2152781820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152364540
+  version_requirements: *2152781820
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152364060 !ruby/object:Gem::Requirement
+  requirement: &2152781320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152364060
+  version_requirements: *2152781320
 description: Enable Guice-like dependency injection and contextual object interactions.
 email:
 - david.crosby@atomicobject.com
@@ -60,6 +60,7 @@ files:
 - Rakefile
 - TODO
 - conject.gemspec
+- doc/inheritance_woes.txt
 - lib/conject.rb
 - lib/conject/borrowed_active_support_inflector.rb
 - lib/conject/class_ext_construct_with.rb
@@ -77,6 +78,7 @@ files:
 - spec/acceptance/regression/README
 - spec/acceptance/regression/basic_composition_spec.rb
 - spec/acceptance/regression/basic_object_creation_spec.rb
+- spec/acceptance/regression/inherited_dependencies_spec.rb
 - spec/acceptance/regression/inject_object_context_spec.rb
 - spec/acceptance/regression/nested_contexts_spec.rb
 - spec/conject/borrowed_active_support_inflector_spec.rb
@@ -91,6 +93,7 @@ files:
 - spec/conject/utilities_spec.rb
 - spec/spec_helper.rb
 - spec/support/SPEC_HELPERS_GO_HERE
+- spec/support/conject_helpers.rb
 - spec/support/load_path_helpers.rb
 - spec/test_data/basic_composition/fence.rb
 - spec/test_data/basic_composition/front_desk.rb
@@ -99,8 +102,16 @@ files:
 - spec/test_data/basic_composition/lobby.rb
 - spec/test_data/basic_composition/master_of_puppets.rb
 - spec/test_data/basic_composition/nails.rb
+- spec/test_data/basic_composition/special_guest.rb
 - spec/test_data/basic_composition/tv.rb
+- spec/test_data/basic_composition/very_special_guest.rb
 - spec/test_data/basic_composition/wood.rb
+- spec/test_data/inheritance/body.rb
+- spec/test_data/inheritance/car.rb
+- spec/test_data/inheritance/emblem.rb
+- spec/test_data/inheritance/malibu.rb
+- spec/test_data/inheritance/vehicle.rb
+- spec/test_data/inheritance/wheel.rb
 - spec/test_data/simple_stuff/some_random_class.rb
 - spike/arity_funny_business_in_different_ruby_versions.rb
 - spike/depends_on_spike.rb
@@ -133,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Enable Guice-like dependency injection and contextual object interactions.
@@ -142,6 +153,7 @@ test_files:
 - spec/acceptance/regression/README
 - spec/acceptance/regression/basic_composition_spec.rb
 - spec/acceptance/regression/basic_object_creation_spec.rb
+- spec/acceptance/regression/inherited_dependencies_spec.rb
 - spec/acceptance/regression/inject_object_context_spec.rb
 - spec/acceptance/regression/nested_contexts_spec.rb
 - spec/conject/borrowed_active_support_inflector_spec.rb
@@ -156,6 +168,7 @@ test_files:
 - spec/conject/utilities_spec.rb
 - spec/spec_helper.rb
 - spec/support/SPEC_HELPERS_GO_HERE
+- spec/support/conject_helpers.rb
 - spec/support/load_path_helpers.rb
 - spec/test_data/basic_composition/fence.rb
 - spec/test_data/basic_composition/front_desk.rb
@@ -164,6 +177,14 @@ test_files:
 - spec/test_data/basic_composition/lobby.rb
 - spec/test_data/basic_composition/master_of_puppets.rb
 - spec/test_data/basic_composition/nails.rb
+- spec/test_data/basic_composition/special_guest.rb
 - spec/test_data/basic_composition/tv.rb
+- spec/test_data/basic_composition/very_special_guest.rb
 - spec/test_data/basic_composition/wood.rb
+- spec/test_data/inheritance/body.rb
+- spec/test_data/inheritance/car.rb
+- spec/test_data/inheritance/emblem.rb
+- spec/test_data/inheritance/malibu.rb
+- spec/test_data/inheritance/vehicle.rb
+- spec/test_data/inheritance/wheel.rb
 - spec/test_data/simple_stuff/some_random_class.rb