conject 0.0.4 → 0.0.5

data/TODO

@@ -1,9 +1,20 @@
-Sketch out some more use cases
+Features:
+  customer construction lambda via configure_objects
+
+  Class singletons:
+    use_class_in_context
+    class_depends_on
+
+  context.configure( :use_class_singletons => true)
+
+  ObjectContext#no_cache? <- reimplement for recursive upward search of object configs
+
+  contexts can accept configurations targeted at named subcontext
+
+  Support classes namespaced to modules
+
 
 Move / copy test data (loadable classes) into spec/acceptance/testdata
 Make helpers for accessing that folder
 Make helper to set load path for a specific test
 
-Move basic object creation spec to regression
-
-

data/TODO.txt

@@ -0,0 +1,4 @@
+
+Wed Mar 14 00:44:52 EDT 2012
+
+* Cleanup meta programming in .construct_with it's NASTY

data/lib/conject/object_context.rb

@@ -5,6 +5,7 @@ module Conject
 
     def initialize
       @cache = { :this_object_context => self }
+      @object_configs = Hash.new do |h,k| h[k] = {} end
     end
 
     # Inject a named object into this context
@@ -20,32 +21,31 @@ module Conject
     #   If the object exists nowhere in this or a super context: construct, cache and return a new instance of the requested object using the object factory.
     def get(name)
       name = name.to_sym
-      object = @cache[name]
       return @cache[name] if @cache.keys.include?(name)
       
       if parent_context and parent_context.has?(name)
         return parent_context.get(name)
       else
         object = object_factory.construct_new(name,self)
-        @cache[name] = object
+        @cache[name] = object unless no_cache?(name)
         return object
       end
     end
 
     alias_method :[], :get
 
-    # Indicates if this context, or any parent context, contains the requested object in its cache.
-    def has?(name)
-      return true if directly_has?(name)
+    def walk_up_contexts(&block)
+      yield self
+      parent_context.walk_up_contexts(&block) unless parent_context.nil?
+    end
 
-      # Ask parent (if i have a parent) if I don't have the object:
-      if !parent_context.nil?
-        return parent_context.has?(name)
-      else
-        # I don't have it, and neither do my ancestors.
-        return false
+    def has?(name)
+      walk_up_contexts do |context|
+        return true if context.directly_has?(name)
       end
+      return false
     end
+
     
     # Indicates if this context has the requested object in its own personal cache.
     # (Does not consult any parent contexts.)
@@ -53,9 +53,36 @@ module Conject
       @cache.keys.include?(name.to_sym)
     end
 
+    # Create and yield a new ObjectContext with this ObjectContext as its parent
     def in_subcontext
       yield Conject.create_object_context(self) if block_given?
     end
 
+
+    #
+    # Allow configuration options to be set for named objects.
+    #
+    def configure_objects(conf={})
+      conf.each do |key,opts|
+        get_object_config(key).merge!(opts)
+      end
+    end
+
+    #
+    # Get the object configuration options for the given name
+    #
+    def get_object_config(name)
+      @object_configs[name.to_sym]
+    end
+
+    private 
+
+    #
+    # Returns true if an object has been specifically declared as non-cacheable.
+    #
+    def no_cache?(name)
+      get_object_config(name)[:cache] == false
+    end
+
   end
 end

data/lib/conject/object_factory.rb

@@ -4,13 +4,31 @@ module Conject
     construct_with :class_finder, :dependency_resolver
 
     def construct_new(name, object_context)
+      lambda_constructor = object_context.get_object_config(name)[:construct]
+      if lambda_constructor
+        case lambda_constructor.arity
+        when 0
+          return lambda_constructor[]
+        when 1
+          return lambda_constructor[object_context]
+        when 2
+          return lambda_constructor[name, object_context]
+        else
+          raise "Constructor lambda takes 0, 1 or 2 params; this lambda takes #{lambda_constructor.arity}"
+        end
+      else
+        return type_1_constructor(name, object_context)
+      end
+    end
 
-      #
-      # This implementation is what I'm loosely calling "type 1" or "regular" object creation:
-      #  - Assume we're looking for a class to create an instance with
-      #  - it may or may not have a declared list of named objects it needs to be constructed with
-      #
+    private
 
+    #
+    # This implementation is what I'm loosely calling "type 1" or "regular" object creation:
+    #  - Assume we're looking for a class to create an instance with
+    #  - it may or may not have a declared list of named objects it needs to be constructed with
+    #
+    def type_1_constructor(name, object_context)
       klass = class_finder.find_class(name)
 
       if klass.has_object_definition?

data/lib/conject/version.rb

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

data/scratch/class_singletons.rb

@@ -0,0 +1,61 @@
+#
+# Classes-as-objects can be a convenient way to build
+# systems of objects that need to collaborate, but which 
+# have no other need for repeated instantiation, or implementation
+# substitutions within the roles.  (Ie, objects are what they are, and the
+# system objects are more or less free of mutable state.)
+#
+# Ruby's classes, when declared "normally", are named objects available globally.
+# So class S3, while a Class that could be used to generate instances, is also
+# and _object_, a singleton named S3, and any other object can refer to this
+# singleton by name.  Implement your functionality as class methods and you're ready to go.
+#
+# Drawbacks: 
+#
+#   You have to be right about not needing subcontexts or impl. 
+#   substitution; without this assumption, you're left with nothing.
+#
+#   Code NOT written this way might have difficulty using Classes-as-objects code
+#   
+#   Classes-as-objects code cannot utilize systems that aren't written in the same way
+#
+#  A classes-as-objects system, if during development is discovered to break these assumptions,
+#  they must be re-written.
+#
+# Observations:
+#  Classes-as-objects is a special case of contextual objects: all system objects are 
+#  singletons, no implementation substitution is ever required, dependency injection
+#  is not required, and no construction-time behavior needs to be implemented.
+#  (No constructors.  This isn't 100% off the table; there's always in-body configuration, eg,
+#  via metacoding.)  All objects are at the top-most (global, or root) context in the application,
+#  and no subcontexts are ever needed.
+#
+#  We could provide tooling to imply context for classes, and give them more abstract 
+#  access to their constituents, in a way that can be modified orthogonally to their 
+#  code.  (Whereas you can't change what it means for S3 to refer to NameFormatter, you _could_
+#  change the way name_formatter is provided to the S3 class).
+#
+#  NEEDS:
+#    - Let a class singleton declare itself to participate in a Context (root context by default)
+#    - withing class singleton, reference collaborator objects contextually
+#    - ObjectContext configuration: assume all objects are serviced by class singletons
+#    - ObjcetContext configuration: object-by-object config to indicate class singletons
+
+
+class S3
+  use_class_in_context 
+  class_depends_on :name_formatter
+
+  class << self
+    
+    def store_file(name, data)
+      formatted_name = name_formatter.format(name)
+    end
+  end
+end
+
+context.configure :use_class_singletons => true
+
+context.configure_object :s3 => { :use_class_singleton => true }
+# same as: context[:s3] = S3 ??
+

data/scratch/namespace_support.rb

@@ -0,0 +1,3 @@
+class Something
+  construct_with :engine__starter_motor, :engine__throttle
+end

data/scratch/special_construct.rb

@@ -0,0 +1,6 @@
+
+Conject.default_object_context.configure_object :s3 => { :construct  => lambda do |c| 
+  S3.new(
+    :items => c[:treasure_chest].items
+  )
+end }

data/spec/acceptance/regression/custom_constructor_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe "configuring objects to be built with a lambda" do
+  subject { new_object_context }
+
+  before do
+    append_test_load_path "basic_composition"
+    require 'fence'
+    require 'wood'
+    require 'nails'
+  end
+
+  let :wood_substitute do
+    Class.new do
+      attr_reader :name, :object_context
+
+      def initialize(name,object_context)
+        @name = name
+        @object_context = object_context
+      end
+
+      def to_s
+        "MDF"
+      end
+    end
+  end
+
+  after do
+    restore_load_path
+  end
+
+
+  it "constructs and caches instances by running the given lamdba" do
+    wood_constructs = 0
+
+    subject.configure_objects(
+      :wood => { 
+        :construct => lambda do |name,object_context|
+          wood_constructs += 1
+          wood_substitute.new name,object_context
+        end
+      }
+    )
+
+    fence = subject.get(:fence)
+    fence.wood.should be
+    fence.wood.to_s.should == "MDF"
+    fence.wood.name.should == :wood
+    fence.wood.object_context.should == subject
+    wood_constructs.should == 1
+
+    subject.get(:wood).should == fence.wood
+    wood_constructs.should == 1
+  end
+
+end

data/spec/acceptance/regression/default_object_context_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe "Conject" do
+  before do
+    append_test_load_path "basic_composition"
+    require 'fence'
+    require 'wood'
+    require 'nails'
+  end
+
+  describe ".default_object_context" do
+    it "provides an object context" do
+      context = Conject.default_object_context
+      context[:fence].should be
+    end
+
+
+    it "provides the SAME object context on repeated use" do
+      context1 = Conject.default_object_context
+      context2 = Conject.default_object_context
+
+      context1.should be
+      context1.should == context2
+      context1[:fence].should == context2[:fence]
+    end
+    
+  end
+
+  after do
+    restore_load_path
+    # Sneak in and reset default object context instance inside Conject:
+    Conject.instance_variable_set(:@default_object_context, nil)
+  end
+
+end
+

data/spec/acceptance/regression/inherited_dependencies_spec.rb

@@ -136,10 +136,6 @@ describe "basic inheritance" do
     end
 
 
-
-
-
-
     context "superclass has 1-arg #initialize" do
       class Reptile
         construct_with :scales
@@ -250,4 +246,23 @@ describe "basic inheritance" do
     end
 
   end
+
+  context "subclass not declaring deps, though its superclass DOES have deps" do
+    let(:parent) do
+      Class.new do 
+        construct_with :home, :money
+      end
+    end
+
+    let(:child) do
+      Class.new(parent) do
+      end
+    end
+
+    it "raises an error at init time" do
+      lambda do
+        child.new nil
+      end.should raise_error(/ancestor.*construct_with.*dependencies.*instantiate/)
+    end
+  end
 end

data/spec/acceptance/regression/non_singleton_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+
+describe "configuring objects to be non-cacheable" do
+  subject { new_object_context }
+
+  before do
+    append_test_load_path "basic_composition"
+    require 'fence'
+    require 'wood'
+    require 'nails'
+  end
+
+  after do
+    restore_load_path
+  end
+
+  it "causes an object to be rebuilt with every request" do
+    subject.configure_objects(
+      :fence => { :cache => false }, 
+      :nails => { :cache => false },
+    )
+
+    f1 = subject.get(:fence)
+    f2 = subject.get(:fence)
+
+    # Show new fences built:
+    f1.should be
+    f2.should be
+    f1.should_not == f2
+
+    # nails should also be unique:
+    f1.nails.should_not == f2.nails
+
+    # context should not retain references to fence or nails:
+    subject.has?(:fence).should == false
+    subject.has?(:nails).should == false
+
+    # wood should remain cached as usual, and shared
+    f1.wood.should == f2.wood
+    subject.has?(:wood).should == true
+    subject.get(:wood).should == f1.wood
+    subject.get(:wood).should == f2.wood
+  end
+
+end
+
+#
+# other syntax ideas:
+#
+    # subject.no_cache(:fence)
+
+    # subject.do_not_cache(:fence)
+
+    # subject.configure(:fence, :cache => false)
+
+    # subject.configure(:fence, :singleton => false)
+
+    # subject.configure do |config|
+    #   config.object :fence, :cache => false
+    # end
+
+    # subject.configure.object :fence, :cache => false

data/spec/conject/object_context_spec.rb

@@ -119,10 +119,12 @@ describe Conject::ObjectContext do
 
       describe "when there is a parent context" do
         it "delegates the question to the parent context" do
-          parent_context.should_receive(:has?).with(:a_clue).and_return("the parent answer")
-          subject.has?(:a_clue).should == "the parent answer"
+          parent_context.should_receive(:walk_up_contexts).and_yield(parent_context)
+          parent_context.should_receive(:directly_has?).with(:a_clue).and_return(true)
+          subject.has?(:a_clue).should == true
         end
       end
+
     end
   end
 
@@ -183,4 +185,30 @@ describe Conject::ObjectContext do
       subsubcontext_executed.should be_true
     end
   end
+
+  describe "#configure_objects" do
+    describe ":cache => false" do
+      before do
+        parent_context.stub(:has?).and_return(false)
+        parent_context.should_not_receive(:get)
+        @first_burger = "first burger"
+        @second_burger = "second burger"
+
+        subject.configure_objects :cheezburger => { :cache => false }
+      end
+
+      it "causes the Context not to cache a constructed object, but to build new each time" do
+        object_factory.should_receive(:construct_new).with(:cheezburger, subject).and_return(@first_burger)
+        object_factory.should_receive(:construct_new).with(:cheezburger, subject).and_return(@second_burger)
+
+        subject[:cheezburger].should == @first_burger
+        subject[:cheezburger].should == @second_burger
+      end
+    end
+
+    # describe "for already-cached objects" do
+    #   it "raises an error"
+    # end
+
+  end
 end

data/spec/conject/object_factory_spec.rb

@@ -22,46 +22,96 @@ describe Conject::ObjectFactory do
   let :my_objects_components do mock(:my_objects_components) end
 
   describe "#construct_new" do
-    before do
-      class_finder.should_receive(:find_class).with(my_object_name).and_return my_object_class
-      Conject::Utilities.stub(:has_zero_arg_constructor?).and_return true
-    end
-
-    describe "when target class has an object definition (implying composition dependencies)" do
+    describe "for Type 1 object construction" do
       before do
-        my_object_class.should_receive(:has_object_definition?).and_return true
+        object_context.stub(:get_object_config).and_return({})
+
+        class_finder.should_receive(:find_class).with(my_object_name).and_return my_object_class
+        Conject::Utilities.stub(:has_zero_arg_constructor?).and_return true
       end
 
-      it "finds the object definition, pulls its deps, and instantiates a new instance" do
-        dependency_resolver.should_receive(:resolve_for_class).with(my_object_class, object_context).and_return my_objects_components
-        my_object_class.should_receive(:new).with(my_objects_components).and_return(my_object)
+      describe "when target class has an object definition (implying composition dependencies)" do
+        before do
+          my_object_class.should_receive(:has_object_definition?).and_return true
+        end
 
-        subject.construct_new(my_object_name, object_context).should == my_object
+        it "finds the object definition, pulls its deps, and instantiates a new instance" do
+          dependency_resolver.should_receive(:resolve_for_class).with(my_object_class, object_context).and_return my_objects_components
+          my_object_class.should_receive(:new).with(my_objects_components).and_return(my_object)
+
+          subject.construct_new(my_object_name, object_context).should == my_object
+        end
       end
-    end
 
-    describe "when target class has no object definition" do
-      before do
-        my_object_class.should_receive(:has_object_definition?).and_return false
+      describe "when target class has no object definition" do
+        before do
+          my_object_class.should_receive(:has_object_definition?).and_return false
+        end
+
+        it "creates a new instance of the class without any arguments" do
+          my_object_class.should_receive(:new).and_return(my_object)
+          subject.construct_new(my_object_name, object_context).should == my_object
+        end
       end
 
-      it "creates a new instance of the class without any arguments" do
-        my_object_class.should_receive(:new).and_return(my_object)
-        subject.construct_new(my_object_name, object_context).should == my_object
+      describe "when target class has no object def, but also a non-default constructor" do
+        before do
+          my_object_class.should_receive(:has_object_definition?).and_return false
+          Conject::Utilities.stub(:has_zero_arg_constructor?).and_return false
+        end
+
+        it "raises a CompositionError" do
+          lambda do
+            subject.construct_new(my_object_name, object_context)
+          end.should raise_error(ArgumentError)
+        end
       end
     end
 
-    describe "when target class has no object def, but also a non-default constructor" do
+    describe "for custom lambda construction" do
+      let(:object_config) do { :construct => lambda do "The Object" end } end
+      let(:object_config2) do { :construct => lambda do |object_context| { :the_oc => object_context } end } end
+      let(:object_config3) do { :construct => lambda do |name, object_context| { :the_name => name, :the_oc => object_context } end } end
+      let(:object_config4) do { :construct => lambda do raise("the roof") end } end
+      let(:object_config5) do { :construct => lambda do |a,b,c| "whatev" end } end
+
       before do
-        my_object_class.should_receive(:has_object_definition?).and_return false
-        Conject::Utilities.stub(:has_zero_arg_constructor?).and_return false
+        object_context.stub(:get_object_config).with(:the_object).and_return(object_config)
+        object_context.stub(:get_object_config).with(:the_other_object).and_return(object_config2)
+        object_context.stub(:get_object_config).with(:the_third_object).and_return(object_config3)
+        object_context.stub(:get_object_config).with(:the_fail_object).and_return(object_config4)
+        object_context.stub(:get_object_config).with(:the_two_many_params).and_return(object_config5)
       end
 
-      it "raises a CompositionError" do
-        lambda do
-          subject.construct_new(my_object_name, object_context)
-        end.should raise_error(ArgumentError)
+      it "invokes the configured lambda in order to build the object" do
+        subject.construct_new(:the_object, object_context).should == "The Object"
       end
+
+      it "supplies object_context for lambdas with arity of 1" do
+        obj = subject.construct_new(:the_other_object, object_context)
+        obj.should be
+        obj[:the_oc].should == object_context
+      end
+
+      it "supplies name, object_context for lambdas with arity of 2" do
+        obj = subject.construct_new(:the_third_object, object_context)
+        obj.should be
+        obj[:the_name].should == :the_third_object
+        obj[:the_oc].should == object_context
+      end
+
+      describe "when lambda has more than two args" do
+        it "raises an error" do
+          lambda do subject.construct_new(:the_fail_object, object_context) end.should raise_error(/the roof/)
+        end
+      end
+
+      describe "when lambda raises an error" do
+        it "raises an error" do
+          lambda do subject.construct_new(:the_two_many_params, object_context) end.should raise_error(/constructor lambda takes 0, 1 or 2 params/i)
+        end
+      end
+
     end
   end
 end

data/spec/test_data/basic_composition/wood.rb

@@ -1,2 +1,5 @@
 class Wood
+  def to_s
+    "Real wood"
+  end
 end

data/spec/test_data/namespace/chart/model.rb

@@ -0,0 +1,4 @@
+module Chart
+  class Model
+  end
+end

data/spec/test_data/namespace/chart/presenter.rb

@@ -0,0 +1,7 @@
+module Chart
+  class Presenter
+    construct_with :chart__model, :chart__view
+
+    public :model, :view
+  end
+end

data/spec/test_data/namespace/chart/view.rb

@@ -0,0 +1,4 @@
+module Chart
+  class View
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conject
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152782340 !ruby/object:Gem::Requirement
+  requirement: &2152736840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152782340
+  version_requirements: *2152736840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152781820 !ruby/object:Gem::Requirement
+  requirement: &2152736400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152781820
+  version_requirements: *2152736400
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &2152781320 !ruby/object:Gem::Requirement
+  requirement: &2152735900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152781320
+  version_requirements: *2152735900
 description: Enable Guice-like dependency injection and contextual object interactions.
 email:
 - david.crosby@atomicobject.com
@@ -59,6 +59,7 @@ files:
 - README.md
 - Rakefile
 - TODO
+- TODO.txt
 - conject.gemspec
 - doc/inheritance_woes.txt
 - lib/conject.rb
@@ -74,13 +75,27 @@ files:
 - lib/conject/utilities.rb
 - lib/conject/version.rb
 - rake_tasks/rspec.rake
+- scratch/arity_funny_business_in_different_ruby_versions.rb
+- scratch/class_singletons.rb
+- scratch/depends_on_spike.rb
+- scratch/donkey_fail.rb
+- scratch/donkey_journey.rb
+- scratch/go.rb
+- scratch/metaid.rb
+- scratch/namespace_support.rb
+- scratch/object_definition.rb
+- scratch/sample.rb
+- scratch/special_construct.rb
 - spec/acceptance/dev/README
 - spec/acceptance/regression/README
 - spec/acceptance/regression/basic_composition_spec.rb
 - spec/acceptance/regression/basic_object_creation_spec.rb
+- spec/acceptance/regression/custom_constructor_spec.rb
+- spec/acceptance/regression/default_object_context_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/acceptance/regression/non_singleton_spec.rb
 - spec/conject/borrowed_active_support_inflector_spec.rb
 - spec/conject/class_ext_construct_with_spec.rb
 - spec/conject/class_finder_spec.rb
@@ -112,15 +127,10 @@ files:
 - spec/test_data/inheritance/malibu.rb
 - spec/test_data/inheritance/vehicle.rb
 - spec/test_data/inheritance/wheel.rb
+- spec/test_data/namespace/chart/model.rb
+- spec/test_data/namespace/chart/presenter.rb
+- spec/test_data/namespace/chart/view.rb
 - spec/test_data/simple_stuff/some_random_class.rb
-- spike/arity_funny_business_in_different_ruby_versions.rb
-- spike/depends_on_spike.rb
-- spike/donkey_fail.rb
-- spike/donkey_journey.rb
-- spike/go.rb
-- spike/metaid.rb
-- spike/object_definition.rb
-- spike/sample.rb
 - src/user_model.rb
 - src/user_presenter.rb
 - src/user_view.rb
@@ -153,9 +163,12 @@ test_files:
 - spec/acceptance/regression/README
 - spec/acceptance/regression/basic_composition_spec.rb
 - spec/acceptance/regression/basic_object_creation_spec.rb
+- spec/acceptance/regression/custom_constructor_spec.rb
+- spec/acceptance/regression/default_object_context_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/acceptance/regression/non_singleton_spec.rb
 - spec/conject/borrowed_active_support_inflector_spec.rb
 - spec/conject/class_ext_construct_with_spec.rb
 - spec/conject/class_finder_spec.rb
@@ -187,4 +200,7 @@ test_files:
 - spec/test_data/inheritance/malibu.rb
 - spec/test_data/inheritance/vehicle.rb
 - spec/test_data/inheritance/wheel.rb
+- spec/test_data/namespace/chart/model.rb
+- spec/test_data/namespace/chart/presenter.rb
+- spec/test_data/namespace/chart/view.rb
 - spec/test_data/simple_stuff/some_random_class.rb