activefacts-api 0.9.9 → 1.0.0

data/lib/activefacts/api/role.rb

@@ -22,14 +22,15 @@ module ActiveFacts
       attr_reader   :value_constraint # Counterpart Instances playing this role must meet this constraint
       attr_reader   :is_identifying   # Is this an identifying role for object_type?
 
-      def initialize(fact_type, object_type, name, mandatory, unique)
+      def initialize(fact_type, object_type, role_name, mandatory, unique)
 	@fact_type = fact_type
 	@fact_type.all_role << self
         @object_type = object_type
-        @name = name
+        @name = role_name
         @mandatory = mandatory
         @unique = unique
         @is_identifying = @object_type.is_entity_type && @object_type.identifying_role_names.include?(@name)
+	object_type.add_role(self)
         associate_role(@object_type)
       end
 
@@ -87,7 +88,6 @@ module ActiveFacts
     end
 
     # Every ObjectType has a Role collection
-    # REVISIT: You can enumerate the object_type's own roles, or inherited roles as well.
     class RoleCollection < Hash #:nodoc:
       def verbalise
         keys.sort_by(&:to_s).inspect

data/lib/activefacts/api/role_values.rb

@@ -8,11 +8,15 @@ module ActiveFacts
   module API
 
     class RoleValues  #:nodoc:
+      attr_accessor :object_type
       attr_accessor :sort
+      attr_accessor :index_roles
 
-      def initialize sort = false
-	@sort = !!(sort || ENV[@@af_sort_name ||= "ACTIVEFACTS_SORT"])
+      def initialize object_type, index_roles = nil, sort = nil
+	@object_type = object_type
+	@sort = sort == nil ? API::sorted : !!sort
         @a = @sort ? RBTree.new : []
+	@index_roles = index_roles
       end
 
       def +(a)
@@ -23,6 +27,17 @@ module ActiveFacts
 	end
       end
 
+      def [](*a)
+	if @sort
+	  # REVISIT: Consider whether to return an array when a partial key is provided.
+	  key = form_key(Array(a))
+	  @a[key]
+	else
+	  # Slow: Search the array for an element having the matching key:
+	  @a.detect{|e| index_values(e) == a}
+	end
+      end
+
       def to_a
 	@sort ? @a.values : @a
       end
@@ -36,12 +51,24 @@ module ActiveFacts
       end
 
       def form_key a
-	KeyArray.new(Array(a))
+	a = Array(a)
+	if @index_roles && @index_roles.size != a.size
+	  raise "Incorrectly-sized key #{a.inspect}. Index roles are #{@index_roles.map(&:name).inspect}"
+	end
+	KeyArray.new(a)
+      end
+
+      def index_values object
+	if @index_roles
+	  @index_roles.map{|r| object.send(r.name).identifying_role_values}
+	else
+	  object.identifying_role_values
+	end
       end
 
       def add_instance(value, key)
 	if @sort
-	  @a[form_key(key)] = value
+	  @a[form_key(index_values(value))] = value
 	else
 	  @a << value
 	end
@@ -51,17 +78,8 @@ module ActiveFacts
 	if @sort
 	  deleted = @a.delete(form_key(key))
 	else
-	  deleted = @a.delete(value)
+	  deleted = @a.delete(value)  # Slow: it has to search the array
 	end
-
-	# Test code:
-	unless deleted
-	  p @a
-	  p value
-	  debugger
-	  true
-	end
-
       end
 
       def verbalise

data/lib/activefacts/api/value.rb

@@ -37,7 +37,6 @@ module ActiveFacts
         include Instance::ClassMethods
 
         def value_type *args, &block #:nodoc:
-          # REVISIT: args could be a hash, with keys :length, :scale, :unit, :allow
           options = (args[-1].is_a?(Hash) ? args.pop : {})
           options.each do |key, value|
 	    raise UnrecognisedOptionsException.new('ValueType', basename, key) unless respond_to?(key)
@@ -67,9 +66,7 @@ module ActiveFacts
 
         # verbalise this ValueType
         def verbalise
-          # REVISIT: Add length and scale here, if set
-          # REVISIT: Set vocabulary name of superclass if not same as this
-          "#{basename} = #{superclass.basename}();"
+          "#{basename} < #{superclass.basename}();"
         end
 
         def identifying_role_values(constellation, args)   #:nodoc:
@@ -129,6 +126,7 @@ module ActiveFacts
         def inherited(other)  #:nodoc:
           # Copy the type parameters here, etc?
           other.send :realise_supertypes, self
+	  TypeInheritanceFactType.new(self, other)
           vocabulary.__add_object_type(other)
           super
         end

data/lib/activefacts/api/vocabulary.rb

@@ -58,7 +58,7 @@ module ActiveFacts
           @object_type.keys.sort.map do |object_type|
 	    c = @object_type[object_type]
 	    __bind(c.basename)
-	    c.verbalise + "\n\t\t// Roles played: " + c.roles.verbalise
+	    c.verbalise + "\n\t\t// Roles played: " + c.all_role.verbalise
 	  end.
 	  join("\n\t")
       end

data/spec/constellation/constellation_spec.rb

@@ -465,7 +465,7 @@ describe "A Constellation instance" do
         end
       end
       c = @constellation.ListedCompany("foo", :auto_counter_val => 23)
-    }.should_not raise_error(NameError)
+    }.should_not raise_error
   end
 
   it "should be able to attach a new supertype on an entity type to make it a (sub-)subtype" do

data/spec/constellation/instance_index_spec.rb

@@ -21,11 +21,12 @@ describe ActiveFacts::API::InstanceIndex do
       end
 
       class EntityB < EntityA
-        identified_by :value_b
-        one_to_one :value_b
+        identified_by :value_c
+        one_to_one :value_c, :class => ValueB
       end
 
       class EntityD < EntityA
+        has_one :value_d, :class => ValueB
       end
 
       class EntityC < EntityB
@@ -35,8 +36,8 @@ describe ActiveFacts::API::InstanceIndex do
 
     @constellation = ActiveFacts::API::Constellation.new(Mod)
     @a = @constellation.EntityA(:value_a => 1, :value_b => 'a')
-    @b = @constellation.EntityB(:value_a => 12, :value_b => 'ab')
-    @c = @constellation.EntityC(:value_a => 123, :value_b => 'abc')
+    @b = @constellation.EntityB(:value_a => 12, :value_b => 'ab', :value_c => 'abc')
+    @c = @constellation.EntityC(:value_a => 123, :value_b => 'abc1', :value_c => 'abc2', :value_d => 'abcd')
   end
 
   it "should index an instance under its own class" do
@@ -55,12 +56,12 @@ describe ActiveFacts::API::InstanceIndex do
     end
 
     it "should recursively try to use identifying role values within an array" do
-      value_b = @constellation.ValueB('abc')
+      value_b = @constellation.ValueB('abc2')
       @constellation.EntityC[[value_b]].should == @c
     end
 
     it "should use the value as-is if it doesn't have identifying role values" do
-      @constellation.EntityC[%w{abc}].should == @c
+      @constellation.EntityC[%w{abc2}].should == @c
     end
   end
 
@@ -79,7 +80,7 @@ describe ActiveFacts::API::InstanceIndex do
         b_index = @constellation.EntityB
         b_index.size.should == 2
         b_index.send(api) do |k, v, *a|
-          [['ab'], ['abc']].should include(k)
+          [['ab'], ['abc'], ['abc2']].should include(k)
           [@b, @c].should include v
           a.size.should == 0
           false

data/spec/constellation/instance_spec.rb

@@ -3,12 +3,6 @@
 # Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
 #
 
-#require 'ruby-debug'; Debugger.start
-#trap "INT" do
-#  puts caller*"\n\t"
-#  debugger
-#end
-
 describe "An instance of every type of ObjectType" do
   before :all do
     Object.send :remove_const, :Mod if Object.const_defined?("Mod")
@@ -302,7 +296,7 @@ describe "An instance of every type of ObjectType" do
         # All identifying roles should be in the verbalisation.
         # Strictly this should be the role name, but we don't set names here.
         entity_type.identifying_role_names.each do |ir|
-            role = entity_type.roles(ir)
+            role = entity_type.all_role(ir)
             role.should_not be_nil
             counterpart_object_type = role.counterpart.object_type
             verbalisation.should =~ %r{\b#{counterpart_object_type.basename}\b}
@@ -336,7 +330,7 @@ describe "An instance of every type of ObjectType" do
         verbalisation = entity.verbalise
         verbalisation.should =~ %r{\b#{entity.class.basename}\b}
         entity.class.identifying_role_names.each do |ir|
-            role = entity.class.roles(ir)
+            role = entity.class.all_role(ir)
             role.should_not be_nil
             counterpart_object_type = role.counterpart.object_type
             verbalisation.should =~ %r{\b#{counterpart_object_type.basename}\b}

data/spec/fact_type/role_values_spec.rb

@@ -82,7 +82,7 @@ end
 describe "Roles of an Object Type" do
 
   it "should return a roles collection" do
-    roles = TestValueTypesModule::Octopus.roles
+    roles = TestValueTypesModule::Octopus.all_role
     roles.should_not be_nil
     roles.size.should == 2+VALUE_TYPES.size*5*2
 
@@ -215,7 +215,7 @@ describe "Object type role values" do
           octopus = @constellation.Octopus(0)
           octopus_role_name = :"octopus_as_one_#{object_type_name.snakecase}"
           object.send(:"#{octopus_role_name}=", octopus)
-          counterpart_name = object.class.roles[octopus_role_name].counterpart.name
+          counterpart_name = object.class.all_role[octopus_role_name].counterpart.name
 
           # Create a reference by assigning the object from a RoleProxy:
           proxy = octopus.send(counterpart_name)
@@ -239,7 +239,7 @@ describe "Object type role values" do
     before :each do
       @constellation = ActiveFacts::API::Constellation.new(TestValueTypesModule)
       @object = @constellation.Octopus(0)
-      @roles = @object.class.roles
+      @roles = @object.class.all_role
     end
 
     it "should return its constellation and vocabulary" do
@@ -249,7 +249,7 @@ describe "Object type role values" do
       @object.class.vocabulary.should == TestValueTypesModule
     end
 
-    TestValueTypesModule::Octopus.roles.each do |role_name, role|
+    TestValueTypesModule::Octopus.all_role.each do |role_name, role|
       next if role_name == :zero
 
       it "should respond to getting its #{role_name} role" do

data/spec/fact_type/roles_spec.rb

@@ -48,7 +48,7 @@ describe "Roles" do
         has_one :name
       end
     end
-    role = Mod::Existing1.roles(:name)
+    role = Mod::Existing1.all_role(:name)
     role.should_not be_nil
     role.inspect.class.should == String
     role.counterpart.object_type.should == Mod::Name
@@ -138,10 +138,10 @@ describe "Roles" do
       end
     end
     # REVISIT: need to make more tests for the class's role accessor methods:
-    Mod::Name.roles(:all_existing1).should == Mod::Name.all_existing1_role
+    Mod::Name.all_role(:all_existing1).should == Mod::Name.all_existing1_role
 
-    Mod::Name.roles(:all_existing1).should_not be_nil
-    Mod::LegalEntity.roles(:all_contract_as_first).should_not be_nil
+    Mod::Name.all_role(:all_existing1).should_not be_nil
+    Mod::LegalEntity.all_role(:all_contract_as_first).should_not be_nil
   end
 
   it "should associate a role name with a matching object_type after it's created" do
@@ -151,8 +151,8 @@ describe "Roles" do
         has_one :given_name
       end
     end
-    # print "Mod::Existing2.roles = "; p Mod::Existing2.roles
-    r = Mod::Existing2.roles(:given_name)
+    # print "Mod::Existing2.all_role = "; p Mod::Existing2.all_role
+    r = Mod::Existing2.all_role(:given_name)
     r.should_not be_nil
     r.counterpart.should be_nil
     module Mod
@@ -161,7 +161,7 @@ describe "Roles" do
       end
     end
     # puts "Should resolve now:"
-    r = Mod::Existing2.roles(:given_name)
+    r = Mod::Existing2.all_role(:given_name)
     r.should_not be_nil
     r.counterpart.object_type.should == Mod::GivenName
   end
@@ -173,10 +173,10 @@ describe "Roles" do
         one_to_one :patriarch, :class => Person
       end
     end
-    r = Mod::FamilyName.roles(:patriarch)
+    r = Mod::FamilyName.all_role(:patriarch)
     r.should_not be_nil
     r.counterpart.object_type.should == Mod::Person
-    r.counterpart.object_type.roles(:family_name_as_patriarch).counterpart.object_type.should == Mod::FamilyName
+    r.counterpart.object_type.all_role(:family_name_as_patriarch).counterpart.object_type.should == Mod::FamilyName
   end
 
   it "should instantiate the matching object_type on assignment" do
@@ -241,4 +241,43 @@ describe "Roles" do
     identifier.employee.name.should == "PuppetMaster"
   end
 
+  it "should create TypeInheritance fact type and roles" do
+    module Mod
+      class GivenName < Name
+      end
+      class Document
+	identified_by :name
+	one_to_one :name
+      end
+      class Contract
+	supertypes Document
+      end
+    end
+    [Mod::GivenName, Mod::Person, Mod::Contract].each do |subtype|
+      subtype.supertypes.each do |supertype|
+	# Get the role names:
+	supertype_role_name = supertype.name.gsub(/.*::/,'').to_sym
+	subtype_role_name = subtype.name.gsub(/.*::/,'').to_sym
+
+	# Check that the roles are indexed:
+	subtype.all_role.should include(supertype_role_name)
+	supertype.all_role.should include(subtype_role_name)
+
+	# Get the role objects:
+	supertype_role = subtype.all_role[supertype_role_name]
+	subtype_role = supertype.all_role[subtype_role_name]
+
+	# Check uniqueness and mandatory:
+	supertype_role.unique.should be_true
+	subtype_role.unique.should be_true
+	supertype_role.mandatory.should be_true
+	subtype_role.mandatory.should be_false
+
+	# Check they belong to the same TypeInheritanceFactType:
+	subtype_role.fact_type.class.should be(ActiveFacts::API::TypeInheritanceFactType)
+	subtype_role.fact_type.should == supertype_role.fact_type
+      end
+    end
+  end
+
 end

data/spec/identification_scheme/identification_spec.rb

@@ -5,7 +5,7 @@
 
 describe "An Entity Type" do
   before :all do
-    module Mod
+    module ModIS
       class Name < String
         value_type
       end
@@ -16,12 +16,12 @@ describe "An Entity Type" do
     end
   end
   before :each do
-    @c = ActiveFacts::API::Constellation.new(Mod)
+    @c = ActiveFacts::API::Constellation.new(ModIS)
   end
 
   describe "whose instances are identified by a single value role" do
     before :all do
-      module Mod
+      module ModIS
         class Business
           identified_by :name
           one_to_one :name
@@ -31,7 +31,7 @@ describe "An Entity Type" do
 
     it "should fail if the role isn't one-to-one" do
       proc do
-        module Mod
+        module ModIS
           class Cat
             identified_by :name
             has_one :name
@@ -48,11 +48,11 @@ describe "An Entity Type" do
       end
 
       it "should return a new instance if not previously present" do
-        @bus.should be_a(Mod::Business)
+        @bus.should be_a(ModIS::Business)
       end
 
       it "should assert the identifying value" do
-        @acme.should be_a(Mod::Name)
+        @acme.should be_a(ModIS::Name)
       end
 
       it "should be found in the constellation using the value" do
@@ -97,7 +97,7 @@ describe "An Entity Type" do
         end
 
         it "should assert the new identifier" do
-          @c.Name['Bloggs'].should be_a(Mod::Name)
+          @c.Name['Bloggs'].should be_a(ModIS::Name)
         end
 
         it "should allow the change" do
@@ -168,7 +168,7 @@ describe "An Entity Type" do
 
         describe "and the identifying value plays other roles" do
           before :all do
-            module Mod
+            module ModIS
               class Dog
                 identified_by :name
                 one_to_one :name
@@ -191,7 +191,7 @@ describe "An Entity Type" do
 
   describe "identified by two values" do
     before :all do
-      module Mod
+      module ModIS
         class Building
           identified_by :name
           one_to_one :name
@@ -222,12 +222,12 @@ describe "An Entity Type" do
     end
 
     before :each do
-      @c = ActiveFacts::API::Constellation.new(Mod)
+      @c = ActiveFacts::API::Constellation.new(ModIS)
     end
 
     it "should fail if any role is one-to-one" do
       proc do
-        module Mod
+        module ModIS
           class Floor
             identified_by :building, :number
             has_one :building
@@ -249,11 +249,11 @@ describe "An Entity Type" do
       end
 
       it "should return a new instance if not previously present" do
-        @r.should be_a(Mod::Room)
+        @r.should be_a(ModIS::Room)
       end
 
       it "should assert the identifying values" do
-        @rn.should be_a(Mod::Number)
+        @rn.should be_a(ModIS::Number)
         @c.Number[@rn.identifying_role_values].should == @rn    # Yes
         @c.Number[101].should == @rn    # No
         @c.Number[101].should be_eql 101    # No
@@ -318,6 +318,9 @@ describe "An Entity Type" do
         end
 
         it "should be found under the new identifier even on deep associations" do
+#          p @c.OwnerRoom.keys[0]
+#	  p @new_number
+#	  p [@o.identifying_role_values, @r.identifying_role_values]
           @c.OwnerRoom[[@o.identifying_role_values, @r.identifying_role_values]].should == @or
           @c.OwnerRoom[[[1_001, ['Mackay']], [['Mackay'], 103]]].should == @or
           @c.OwnerRoom[[[1_001, ['Mackay']], [['Mackay'], 101]]].should be_nil
@@ -378,7 +381,7 @@ describe "An Entity Type" do
 
   describe "which has a supertype that has separate identification" do
     before :each do
-      module Mod
+      module ModIS
         class Animal
           identified_by :number
           one_to_one :neumber