activefacts-api 0.8.12 → 0.9.1

data/lib/activefacts/api/standard_types.rb

@@ -8,6 +8,7 @@
 # and allow any Class to become an Entity.
 #
 require 'date'
+require 'activefacts/api/numeric'
 
 module ActiveFacts
   module API
@@ -20,12 +21,9 @@ module ActiveFacts
     end
   end
 end
-
-require 'activefacts/api/numeric'
-
 # Add the methods that convert our classes into ObjectType types:
 
-ValueClasses = [String, Date, DateTime, Time, Int, Real, AutoCounter]
+ValueClasses = [String, Date, DateTime, Time, Int, Real, AutoCounter, Decimal]
 ValueClasses.each{|c|
     c.send :extend, ActiveFacts::API::ValueClass
   }
@@ -62,19 +60,6 @@ class Class
   end
 end
 
-require 'bigdecimal'
-class Decimal < BigDecimal #:nodoc:
-  extend ActiveFacts::API::ValueClass
-  # The problem here is you can't pass a BigDecimal to BigDecimal.new. Fix it.
-  def self.new(v)
-    if v.is_a?(BigDecimal) || v.is_a?(Bignum)
-      super(v.to_s)
-    else
-      super
-    end
-  end
-end
-
 # These types are generated on conversion from NORMA's types:
 class Char < String #:nodoc:  # FixedLengthText
 end

data/lib/activefacts/api/vocabulary.rb

@@ -12,7 +12,7 @@ module ActiveFacts
     # Vocabulary is a mixin that adds methods to any Module which has any ObjectType classes (ValueType or EntityType).
     # A Vocabulary knows all the ObjectType classes including forward-referenced ones,
     # and can resolve the forward references when the class is finally defined.
-    # Construction of a Constellation requires a Vocabuary as argument.
+    # Construction of a Constellation requires a Vocabulary as argument.
     module Vocabulary
       # With a parameter, look up an object type by name.
       # Without, return the hash (keyed by the class' basename) of all object_types in this vocabulary

data/lib/activefacts/tracer.rb

@@ -25,7 +25,17 @@ module ActiveFacts
             @stderr.puts "---\nDebugging keys available: #{@available.keys.map{|s| s.to_s}.sort*", "}"
           }
         end
-        require 'ruby-debug' if @keys[:debug]
+        if @keys[:debug]
+          ['pry', 'debugger', 'ruby-debug'].each do |debugger|
+            begin
+              require debugger
+              puts "Loaded "+debugger
+              break
+            rescue LoadError
+            end
+          end
+          ::Debugger.start rescue nil
+        end
       end
     end
 
@@ -107,3 +117,5 @@ class Object
     (ActiveFacts.tracer ||= ActiveFacts::Tracer.new).trace(*args, &block)
   end
 end
+
+trace ''

data/spec/{constellation_spec.rb → constellation/constellation_spec.rb}

@@ -3,9 +3,6 @@
 # Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
 #
 
-require 'rspec'
-require 'activefacts/api'
-
 describe "A Constellation instance" do
   before :each do
     Object.send :remove_const, :Mod if Object.const_defined?("Mod")
@@ -16,30 +13,30 @@ describe "A Constellation instance" do
 
       # Create a value type and a subtype of that value type for each base type:
       @base_types.each do |base_type|
-        eval <<-END
-          class #{base_type.basename}Value < #{base_type.name}
+        Mod.module_eval <<-END
+          class #{base_type.basename}Val < #{base_type.name}
             value_type
           end
 
-          class #{base_type.basename}SubValue < #{base_type.name}Value
+          class #{base_type.basename}SubVal < #{base_type.name}Val
             # Note no new "value_type" is required here, it comes through inheritance
           end
         END
       end
 
-      class Name < StringValue
+      class Name < StringVal
         value_type
         #has_one :attr, Name
       end
 
       class LegalEntity
         identified_by :name
-        has_one :name, :mandatory => true
+        one_to_one :name, :mandatory => true
       end
 
       class SurrogateId
-        identified_by :auto_counter_value
-        has_one :auto_counter_value
+        identified_by :auto_counter_val
+        one_to_one :auto_counter_val
       end
 
       class Company < LegalEntity
@@ -60,18 +57,18 @@ describe "A Constellation instance" do
 
   describe "Vocabulary" do
     it "should create the constellation" do
-      Mod.constellation.should be_is_a ActiveFacts::API::Constellation
+      Mod.constellation.should be_an_instance_of ActiveFacts::API::Constellation
     end
 
     it "should create the constellation by direct populate" do
       Mod.populate do
         Name "foo"
-      end.should be_is_a ActiveFacts::API::Constellation
+      end.should be_an_instance_of ActiveFacts::API::Constellation
     end
 
     it "should verbalise" do
       s = Mod.verbalise
-      s.should be_is_a String
+      s.should be_an_instance_of String
     end
   end
 
@@ -107,8 +104,8 @@ describe "A Constellation instance" do
     lambda {
         name = @constellation.Name("foo")
         foo = @constellation.LegalEntity("foo")
-        acme = @constellation.Company("Acme, Inc", :auto_counter_value => :new)
-        fred_fly = @constellation.Person("fred", "fly", :auto_counter_value => :new)
+        acme = @constellation.Company("Acme, Inc", :auto_counter_val => :new)
+        fred_fly = @constellation.Person("fred", "fly", :auto_counter_val => :new)
     }.should_not raise_error
     name.class.should == Mod::Name
     name.constellation.should == @constellation
@@ -132,13 +129,13 @@ describe "A Constellation instance" do
   it "should re-use instances constructed the same way" do
     name1 = @constellation.Name("foo")
     foo1 = @constellation.LegalEntity("foo")
-    acme1 = @constellation.Company("Acme, Inc", :auto_counter_value => :new)
-    fred_fly1 = @constellation.Person("fred", "fly", :auto_counter_value => :new)
+    acme1 = @constellation.Company("Acme, Inc", :auto_counter_val => :new)
+    fred_fly1 = @constellation.Person("fred", "fly", :auto_counter_val => :new)
 
     name2 = @constellation.Name("foo")
     foo2 = @constellation.LegalEntity("foo")
-    acme2 = @constellation.Company("Acme, Inc", :auto_counter_value => :new)
-    fred_fly2 = @constellation.Person("fred", "fly", :auto_counter_value => :new)
+    acme2 = @constellation.Company("Acme, Inc") # , :auto_counter_val => :new)
+    fred_fly2 = @constellation.Person("fred", "fly") # , :auto_counter_val => :new)
 
     name1.object_id.should == name2.object_id
     foo1.object_id.should == foo2.object_id
@@ -146,13 +143,23 @@ describe "A Constellation instance" do
     fred_fly1.object_id.should == fred_fly2.object_id
   end
 
+  it "should reject re-assertion with additional assignments" do
+    name1 = @constellation.Name("foo")
+    foo1 = @constellation.LegalEntity("foo")
+    acme1 = @constellation.Company("Acme, Inc", :auto_counter_val => :new)
+
+    name2 = @constellation.Name("foo")
+    foo2 = @constellation.LegalEntity("foo")
+    lambda { @constellation.Company("Acme, Inc", :auto_counter_val => :new) }.should raise_error
+  end
+
   it "should support methods to assert instances via the class for that type" do
     name = foo = acme = fred_fly = nil
     lambda {
         name = @constellation.Name.assert("foo")
         foo = @constellation.LegalEntity.assert("foo")
-        acme = @constellation.Company.assert("Acme, Inc", :auto_counter_value => :new)
-        fred_fly = @constellation.Person.assert("fred", "fly", :auto_counter_value => :new)
+        acme = @constellation.Company.assert("Acme, Inc", :auto_counter_val => :new)
+        fred_fly = @constellation.Person.assert("fred", "fly", :auto_counter_val => :new)
     }.should_not raise_error
     name.class.should == Mod::Name
     name.constellation.should == @constellation
@@ -177,8 +184,8 @@ describe "A Constellation instance" do
     @constellation.populate do
       Name("bar")
       LegalEntity("foo")
-      Person("Fred", "Nerk", :auto_counter_value => :new)
-      Company("Acme, Inc", :auto_counter_value => :new)
+      Person("Fred", "Nerk", :auto_counter_val => :new)
+      Company("Acme, Inc", :auto_counter_val => :new)
     end
     @constellation.Name.size.should == 5
     @constellation.SurrogateId.size.should == 2
@@ -188,29 +195,29 @@ describe "A Constellation instance" do
     @constellation.populate do
       Name("bar")
       LegalEntity("foo")
-      c = Company("Acme, Inc", :auto_counter_value => :new)
-      p = Person("Fred", "Nerk", :auto_counter_value => :new, :employer => c)
+      c = Company("Acme, Inc", :auto_counter_val => :new)
+      p = Person("Fred", "Nerk", :auto_counter_val => :new, :employer => c)
       p.birth_name = "Nerk"
     end
     s = @constellation.verbalise
     names = s.split(/\n/).grep(/\tEvery /).map{|l| l.sub(/.*Every (.*):$/, '\1')}
-    expected = ["AutoCounterValue", "Company", "LegalEntity", "Name", "Person", "StringValue", "SurrogateId"]
+    expected = ["AutoCounterVal", "Company", "LegalEntity", "Name", "Person", "StringVal", "SurrogateId"]
     names.sort.should == expected
   end
 
   it "should support string capitalisation functions" do
-    names = ["Company", "LegalEntity", "Name", "Person", "StringValue", "SurrogateId"]
+    names = ["Company", "LegalEntity", "Name", "Person", "StringVal", "SurrogateId"]
     camelwords = names.map{|n| n.camelwords }
-    camelwords.should == [["Company"], ["Legal", "Entity"], ["Name"], ["Person"], ["String", "Value"], ["Surrogate", "Id"]]
+    camelwords.should == [["Company"], ["Legal", "Entity"], ["Name"], ["Person"], ["String", "Val"], ["Surrogate", "Id"]]
 
     snakes = names.map{|n| n.snakecase }
-    snakes.should == ["company", "legal_entity", "name", "person", "string_value", "surrogate_id"]
+    snakes.should == ["company", "legal_entity", "name", "person", "string_val", "surrogate_id"]
 
     camelupper = snakes.map{|n| n.camelcase }
-    camelupper.should == ["Company", "LegalEntity", "Name", "Person", "StringValue", "SurrogateId"]
+    camelupper.should == ["Company", "LegalEntity", "Name", "Person", "StringVal", "SurrogateId"]
 
     camellower = snakes.map{|n| n.camelcase(:lower) }
-    camellower.should == ["company", "legalEntity", "name", "person", "stringValue", "surrogateId"]
+    camellower.should == ["company", "legalEntity", "name", "person", "stringVal", "surrogateId"]
   end
 
   it "should allow inspection of instance indices" do
@@ -222,9 +229,9 @@ describe "A Constellation instance" do
     baz = @constellation.Name("baz")
     @constellation.Name.keys.sort.should == ["baz"]
 
-    @constellation.StringValue.keys.sort.should == ["baz"]
-    @constellation.StringValue.include?(baz).should == baz
-    @constellation.StringValue.include?("baz").should == baz
+    @constellation.StringVal.keys.sort.should == ["baz"]
+    @constellation.StringVal.include?(baz).should == baz
+    @constellation.StringVal.include?("baz").should == baz
   end
 
   describe "instance indices" do
@@ -245,24 +252,24 @@ describe "A Constellation instance" do
     name = "Acme, Inc"
     fred = "Fred"
     fly = "Fly"
-    acme = @constellation.Company name, :auto_counter_value => :new
-    fred_fly = @constellation.Person fred, fly, :auto_counter_value => :new
+    acme = @constellation.Company name, :auto_counter_val => :new
+    fred_fly = @constellation.Person fred, fly, :auto_counter_val => :new
 
     # REVISIT: This should be illegal:
-    #fred_fly.auto_counter_value = :new
+    #fred_fly.auto_counter_val = :new
 
     @constellation.Person.keys.sort.should == [[fred, fly]]
     @constellation.Company.keys.sort.should == [[name]]
 
-    @constellation.LegalEntity.keys.sort.should be_include([name])
-    @constellation.LegalEntity.keys.sort.should be_include([fred])
+    @constellation.LegalEntity.keys.sort.should include [name]
+    @constellation.LegalEntity.keys.sort.should include [fred]
 
-    @constellation.SurrogateId.values.should be_include(acme)
-    @constellation.SurrogateId.values.should be_include(fred_fly)
+    @constellation.SurrogateId.values.should include acme
+    @constellation.SurrogateId.values.should include fred_fly
   end
 
   it "should handle one-to-ones correctly" do
-    person = @constellation.Person "Fred", "Smith", :auto_counter_value => :new, :birth_name => "Nerk"
+    person = @constellation.Person "Fred", "Smith", :auto_counter_val => :new, :birth_name => "Nerk"
 
     nerk = @constellation.Name["Nerk"]
     nerk.should_not be_nil
@@ -273,7 +280,7 @@ describe "A Constellation instance" do
   end
 
   it "should allow retraction of instances" do
-    person = @constellation.Person "Fred", "Smith", :auto_counter_value => :new, :birth_name => "Nerk"
+    person = @constellation.Person "Fred", "Smith", :auto_counter_val => :new, :birth_name => "Nerk"
 
     @constellation.retract(@constellation.Name("Smith"))
     @constellation.Name["Smith"].should be_nil
@@ -282,9 +289,14 @@ describe "A Constellation instance" do
     person.family_name.should be_nil
     @constellation.retract(@constellation.Name("Fred"))
     @constellation.Name["Fred"].should be_nil
-    pending "Retraction of identifiers doesn't de/re-index" do
-      @constellation.Person.size.should == 0
-    end
+  end
+
+  it "should retract linked instances (cascading)" do
+    @constellation.Person "Fred", "Smith", :auto_counter_val => :new, :birth_name => "Nerk"
+    @constellation.Person "George", "Smith", :auto_counter_val => :new, :birth_name => "Patrick"
+    @constellation.Person.size.should == 2
+    @constellation.retract(@constellation.Name("Smith"))
+    @constellation.Person.size.should == 0
   end
 
   it "should fail to recognise references to unresolved forward referenced classes" do
@@ -338,7 +350,7 @@ describe "A Constellation instance" do
 
     lambda {
       module Mod
-        class IntValue
+        class IntVal
           has_one :thingummy, :class => Outside::Other
         end
       end
@@ -377,10 +389,70 @@ describe "A Constellation instance" do
         class ListedCompany < Company
         end
       end
-      c = @constellation.ListedCompany("foo", :auto_counter_value => 23)
+      c = @constellation.ListedCompany("foo", :auto_counter_val => 23)
     }.should_not raise_error(NameError)
   end
 
+  it "should be able to attach a new supertype on an entity type to make it a (sub-)subtype" do
+    module Mod
+      class Dad
+        identified_by :name
+      end
+      class Son < Dad
+        identified_by :name
+      end
+      # the grand son will be linked on the fly
+      class GrandSon
+        identified_by :name
+      end
+    end
+    Mod::GrandSon.supertypes(Mod::Son)
+    Mod::GrandSon.supertypes.should include Mod::Son
+    Mod::Son.supertypes.should include Mod::Dad
+  end
+
+  it "should keep information on where the identification came from" do
+    module Mod
+      class Dad
+        identified_by :name
+      end
+      class Son < Dad
+        identified_by :name
+      end
+      # Note the inheritance.
+      class GrandSon < Son
+        identified_by :name
+      end
+    end
+
+    Mod::Son.identification_inherited_from.should == Mod::Dad
+    Mod::Son.identification_inherited_from.should == Mod::Dad
+    Mod::GrandSon.identification_inherited_from.should == Mod::Son
+    Mod::GrandSon.overrides_identification_of.should == Mod::Dad
+  end
+
+  it "should disallow using a value type as a supertypes for an entity type" do
+    lambda {
+      module Mod
+        class CompanyName
+          identified_by :name
+          supertypes :name
+        end
+      end
+    }.should raise_error
+  end
+
+  it "should complain when role name and counter part mismatch" do
+    lambda {
+      module Mod
+        class CompanyName
+          identified_by :name
+          has_one :company, :class => :person
+        end
+      end
+    }.should raise_error(Exception, /indicates a different counterpart object_type/)
+  end
+
   it "should error on invalid :class values" do
     lambda {
       module Mod
@@ -402,29 +474,28 @@ describe "A Constellation instance" do
   end
 
   it "should allow assert using an object of the same type" do
-    c = @constellation.Company("foo", :auto_counter_value => 23)
+    c = @constellation.Company("foo", :auto_counter_val => 23)
     c2 = ActiveFacts::API::Constellation.new(Mod)
     lambda {
-      c2.Company(c, :auto_counter_value => :new)
+      c2.Company(c, :auto_counter_val => :new)
     }.should_not raise_error
     c2.Company.keys.should == [["foo"]]
   end
 
   it "should allow cross-constellation construction" do
-    c = @constellation.Company("foo", :auto_counter_value => 23)
+    c = @constellation.Company("foo", :auto_counter_val => 23)
     lambda {
       c2 = ActiveFacts::API::Constellation.new(Mod)
-      c2.Company(c.name, :auto_counter_value => :new)
+      c2.Company(c.name, :auto_counter_val => :new)
     }.should_not raise_error
   end
 
   it "should allow cross-constellation assignment" do
-    c = @constellation.Company("foo", :auto_counter_value => 23)
+    c = @constellation.Company("foo", :auto_counter_val => 23)
     lambda {
       c2 = ActiveFacts::API::Constellation.new(Mod)
-      p = c2.Person('Fred', 'Smith', :auto_counter_value => :new)
-      p.employer = [c, {:auto_counter_value => :new}]
+      p = c2.Person('Fred', 'Smith', :auto_counter_val => :new)
+      p.employer = [c, {:auto_counter_val => :new}]
     }.should_not raise_error
   end
-
 end

data/spec/constellation/instance_index_spec.rb

@@ -0,0 +1,90 @@
+#
+# ActiveFacts tests: Value instances in the Runtime API
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+
+describe ActiveFacts::API::InstanceIndex do
+  before :all do
+    module Mod
+      class ValueA < Int
+        value_type
+      end
+
+      class ValueB < String
+        value_type
+      end
+
+      class EntityA
+        identified_by :value_a
+        one_to_one :value_a
+        has_one :value_b
+      end
+
+      class EntityB < EntityA
+        identified_by :value_b
+        one_to_one :value_b
+      end
+
+      class EntityD < EntityA
+      end
+
+      class EntityC < EntityB
+        supertypes EntityD
+      end
+    end
+
+    @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')
+  end
+
+  it "should index an instance under its own class" do
+    @constellation.instances[Mod::EntityC].size.should == 1
+  end
+
+  it "should index instances of subtypes" do
+    @constellation.instances[Mod::EntityA].size.should == 3
+    @constellation.instances[Mod::EntityB].size.should == 2
+    @constellation.instances[Mod::EntityD].size.should == 1
+  end
+
+  describe "#flatten_key" do
+    it "should use identifying role values when using an entity type" do
+      @constellation.EntityA[@a].should == @a
+    end
+
+    it "should recursively try to use identifying role values within an array" do
+      value_b = @constellation.ValueB('abc')
+      @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
+    end
+  end
+
+  describe "should iterate over instances" do
+    [:each, :map, :detect].each do |api|
+      it "Should pass the key and object to #{api}" do
+        a_index = @constellation.EntityA
+        a_index.size.should == 3
+        a_index.send(api) do |k, v, *a|
+          [[1], [12], [123]].should include(k)
+          [@a, @b, @c].should include(v)
+          a.size.should == 0
+          false
+        end
+
+        b_index = @constellation.EntityB
+        b_index.size.should == 2
+        b_index.send(api) do |k, v, *a|
+          [['ab'], ['abc']].should include(k)
+          [@b, @c].should include v
+          a.size.should == 0
+          false
+        end
+      end
+    end
+  end
+end