activefacts-api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDI2NTVhZWJlYmU5NDhlNmFlZTg5ZjBkNzY2YTMxMDI2MjJiYWRlZA==
+    ZjdhYmJiODJmYjRmM2IwYjE5MDUyOWEzYTk2ZTlhZTNiOTlkYTZjMg==
   data.tar.gz: !binary |-
-    NzJjODlmMmNjZjgxMmIxNzFkZmJkZjNmMGYyZDNkOGZkMTIxNGRhYg==
+    MGE3OGQ5OWY4MThhMzUyYzE3NmU3NDJkMWMwZWJhNWQyMjE1OTVkZQ==
 SHA512:
   metadata.gz: !binary |-
-    MGU5M2Y2ZWM1YjgwN2ZjMWM2MjBlOGVhYzAyOGRhNjBjZWY2YTM5ZmNjZWQz
-    ZTJlYTY2YTQ2YzE3YjA2ZDA2NWVmZmM4YmRiMmEwZDRiNmU2NDBlYzQ3ODc2
-    YjhjOTNmMTA1MDhiZWFiOGRkMjc3YzE1NjIxMGUzOTEzMTYxYTE=
+    M2FiZDNkMzA5YTcxOTQyOGNmODBhZDI4YjgwNTBmOTM1NmViMDhiMjcxNDhk
+    Mjg0Njg4NGM3OWQ0YjIzN2IyOWU0MzAwYzMzMmU1N2IxMDg1YjU2ZTdmMDNk
+    N2ViMjQyMmYwYmM1YzhlZjNlZGUxZTI5OTNmNjAzNzhhYmY3MGU=
   data.tar.gz: !binary |-
-    OWFkY2JiMTQwZTBkYjlhNGFhNGNiOWIxMWZmODEzZjcyYmNhZjNkZWM0N2U4
-    M2ZhMGNlYTBjNTAxNzdiZDAwNzc5ZDY1ZWNhYTY3MTNlNDBhMGQwZjFiNGZh
-    MTc2NGMxN2VmYmZjYTEzOWYxODdmMjM4NDkyNzRkMmI4MDUzN2Q=
+    YTRiY2IyMTgzMmQwYTU5ODhjZTcwNDE4MDUzMjVhYjllNTAxOTc1ZjFhNzFm
+    NjhhNmRiMGEzZGUwYjgxNTI4OWZhODQ4MGRiYmQ5NTMzNDUxOGY4NDY4ODVj
+    ZGE4NWM3NzY0Njc1MDc0NmMzYmM3NDNkOTdjNzVmOTMxNDI4ODU=

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/activefacts-api.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: activefacts-api 1.0.0 ruby lib
+# stub: activefacts-api 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "activefacts-api"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Clifford Heath"]
-  s.date = "2014-02-18"
+  s.date = "2014-08-12"
   s.description = "\nThe ActiveFacts API is a Ruby DSL for managing constellations of elementary facts.\nEach fact is either existential (a value or an entity), characteristic (boolean) or\nbinary relational (A rel B). Relational facts are consistently co-referenced, so you\ncan traverse them efficiently in any direction. Each constellation maintains constraints\nover the fact population.\n"
   s.email = "clifford.heath@gmail.com"
   s.extra_rdoc_files = [

data/lib/activefacts/api/constellation.rb

@@ -145,7 +145,9 @@ module ActiveFacts
 	    last_irvs = instance.identifying_role_values(klass)
 	    last_irns = n
 	  end
-          instances[klass].delete(last_irvs)
+          deleted = instances[klass].delete(last_irvs)
+	  # The RBTree class sometimes returns a different object than what was deleted! Check non-nil:
+	  raise "Internal error: deindex #{instance.class} as #{klass} failed" if deleted == nil
         end
       end
 
@@ -188,10 +190,15 @@ module ActiveFacts
             klass = vocabulary.const_get(object_type)
 
             single_roles, multiple_roles = klass.all_role.
-		partition{|n, r| r.unique }.
-		map{ |rs| rs.map{|n, r| n}.sort_by(&:to_s) }
-
-            single_roles -= klass.identifying_role_names if (klass.is_entity_type)
+		partition do |n, r|
+		  r.unique &&		    # Show only single-valued roles
+		    !r.is_identifying &&    # Unless identifying
+		    (r.unary? || !r.counterpart.is_identifying)	# Or identifies a counterpart
+		end.
+		map do |rs|
+		  rs.map{|n, r| n}.
+		    sort_by(&:to_s)
+		end
 
             instances = send(object_type.to_sym)
             next nil unless instances.size > 0
@@ -222,6 +229,87 @@ module ActiveFacts
           end.compact*"\n"
       end
 
+      def clone
+	remaining_object_types = vocabulary.object_type.clone
+	constellation = self.class.new(vocabulary, @options)
+	correlates = {}
+	other_attribute_assignments = []
+	until remaining_object_types.empty?
+	  count = 0
+	  # Choose an object type we can clone now:
+	  name, object_type = *remaining_object_types.detect do |name, o|
+	    (count = @instances[o].size) == 0 or	# There are no instances of this object type; clone is ok
+	      !o.is_entity_type or			# It's a value type
+	      (
+		!o.subtypes_transitive.detect do |subtype|# All its subtypes have been cloned
+		    remaining_object_types.has_key?(subtype.basename)
+		end and
+		!o.identifying_roles.detect do |role|	# The players of its identifying roles have all been dumped
+		  next unless role.counterpart		    # Unary role, no player
+		  counterpart = role.counterpart.object_type  # counterpart object
+
+		  # The identifying type and its subtypes have been dumped
+		  ([counterpart]+counterpart.subtypes_transitive).detect do |subtype|
+		    remaining_object_types.has_key?(subtype.basename)
+		  end
+		end
+	      )
+	  end
+#	  puts "Cloning #{count} instances of #{name}" if count > 0
+	  remaining_object_types.delete(name)
+
+	  key_role_names =
+	    if object_type.is_entity_type
+	      ([object_type]+object_type.supertypes_transitive).map { |t| t.identifying_role_names }.flatten.uniq
+	    else
+	      nil
+	    end
+	  other_roles = object_type.all_role_transitive.map do |role_name, role|
+	      next if !role.unique or
+		role.fact_type.class == ActiveFacts::API::TypeInheritanceFactType or
+		role.fact_type.all_role[0] != role or  # Only the first role in a one-to-one pair
+		key_role_names.include?(role_name)
+	      role
+	    end.compact - Array(key_role_names)
+
+	  @instances[object_type].each do |key, object|
+	    next if object.class != object_type
+
+	    # Clone this object
+
+	    # Get the identifying values:
+	    key = object
+	    if (key_role_names)
+	      key = key_role_names.inject({}) do |h, krn|
+		  h[krn] = object.send(krn)
+		  h
+		end
+	    end
+#	    puts "\tcloning #{object.class} #{key.inspect}"
+#	    puts "\t\talso copy #{other_roles.map(&:name)*', '}"
+
+	    new_object = constellation.assert(object_type, key)
+	    correlates[object] = new_object
+
+	    other_roles.each do |role|
+	      value = object.send(role.getter)
+	      next unless value
+	      other_attribute_assignments << proc do
+		new_object.send(role.setter, correlates[value])
+	      end
+	    end
+	  end
+	end
+
+	# Now, assign all non-identifying facts
+#	puts "Assigning #{other_attribute_assignments.size} additional roles"
+	other_attribute_assignments.each do |assignment|
+	  assignment.call
+	end
+
+	constellation
+      end
+
     end
 
     def self.sorted

data/lib/activefacts/api/entity.rb

@@ -204,6 +204,30 @@ module ActiveFacts
 	end
       end
 
+      # If this instance's role is updated to the new value, does that cause a collision?
+      # We need to check each superclass that has a different identification pattern
+      def check_identification_change_legality(role, value)
+        return unless @constellation && role.is_identifying
+	return if @constellation.send(:instance_variable_get, :@suspend_duplicate_key_check)
+
+	klasses = [self.class] + self.class.supertypes_transitive
+	last_identity = nil
+	last_irns = nil
+	counterpart_class = role.counterpart ? role.counterpart.object_type : value.class
+        duplicate = klasses.detect do |klass|
+          next false unless klass.identifying_roles.include?(role)
+	  irns = klass.identifying_role_names
+	  if last_irns != irns
+	    last_identity = identifying_role_values(klass)
+	    role_position = irns.index(role.name)
+	    last_identity[role_position] = value.identifying_role_values(counterpart_class)
+	  end
+	  @constellation.instances[klass][last_identity]
+        end
+
+	raise DuplicateIdentifyingValueException.new(self.class, role.name, value) if duplicate
+      end
+
       # All classes that become Entity types receive the methods of this class as class methods:
       module ClassMethods
         include Instance::ClassMethods

data/lib/activefacts/api/instance.rb

@@ -30,30 +30,6 @@ module ActiveFacts
         super || self.class.supertypes_transitive.include?(klass)
       end
 
-      # If this instance's role is updated to the new value, does that cause a collision?
-      # We need to check each superclass that has a different identification pattern
-      def check_identification_change_legality(role, value)
-        return unless @constellation && role.is_identifying
-	return if @constellation.send(:instance_variable_get, :@suspend_duplicate_key_check)
-
-	klasses = [self.class] + self.class.supertypes_transitive
-	last_identity = nil
-	last_irns = nil
-	counterpart_class = role.counterpart ? role.counterpart.object_type : value.class
-        duplicate = klasses.detect do |klass|
-          next false unless klass.identifying_roles.include?(role)
-	  irns = klass.identifying_role_names
-	  if last_irns != irns
-	    last_identity = identifying_role_values(klass)
-	    role_position = irns.index(role.name)
-	    last_identity[role_position] = value.identifying_role_values(counterpart_class)
-	  end
-	  @constellation.instances[klass][last_identity]
-        end
-
-	raise DuplicateIdentifyingValueException.new(self.class, role.name, value) if duplicate
-      end
-
       # List entities which have an identifying role played by this object.
       def related_entities(indirectly = true, instances = [])
 	# Check all roles of this instance
@@ -78,6 +54,7 @@ module ActiveFacts
       def retract
         # Delete from the constellation first, while we remember our identifying role values
         @constellation.deindex_instance(self) if @constellation
+	instance_variable_set(@@constellation_variable_name ||= "@constellation", nil)
 
         # Now, for all roles (from this class and all supertypes), assign nil to all functional roles
         # The counterpart roles get cleared automatically.
@@ -93,6 +70,26 @@ module ActiveFacts
 	  irvrvs[role_values] = role_values.index_values(self)
 	end
 
+	# Nullify the counterpart role of objects we identify first, before damaging our identifying_role_values:
+	klasses.each do |klass|
+          klass.all_role.each do |role_name, role|
+	    next if role.unary?
+	    next if !(counterpart = role.counterpart).is_identifying
+	    next if role.fact_type.is_a?(TypeInheritanceFactType)
+
+	    counterpart_instances = send(role.getter)
+	    counterpart_instances.to_a.each do |counterpart_instance|
+	      # Allow nullifying non-mandatory roles, as long as they're not identifying.
+	      if counterpart.mandatory
+		counterpart_instance.retract
+	      else
+		counterpart_instance.send(counterpart.setter, nil, false)
+	      end
+	    end
+	  end
+	end
+
+	# Now deal with other roles:
 	klasses.each do |klass|
           klass.all_role.each do |role_name, role|
             next if role.unary?
@@ -104,31 +101,28 @@ module ActiveFacts
 	      next if role.fact_type.is_a?(TypeInheritanceFactType)
 	      i = send(role.getter)
 	      next unless i
-	      if counterpart.is_identifying && counterpart.mandatory
-		# We play a mandatory identifying role in i; so retract that (it'll clear our instance variable)
-		i.retract
+
+	      if (counterpart.unique)
+		# REVISIT: This will incorrectly fail to propagate a key change for a non-mandatory role
+		i.send(counterpart.setter, nil, false)
 	      else
-		if (counterpart.unique)
-		  # REVISIT: This will incorrectly fail to propagate a key change for a non-mandatory role
-		  i.send(counterpart.setter, nil, false)
-		else
-		  rv = i.send(role.counterpart.getter)
-		  rv.delete_instance(self, irvrvs[rv])
+		rv = i.send(role.counterpart.getter)
+		rv.delete_instance(self, irvrvs[rv])
+
+		if (rv.empty? && !i.class.is_entity_type)
+		  i.retract if i.plays_no_role
 		end
+
 	      end
 	      instance_variable_set(role.variable, nil)
             else
               # puts "Not removing role #{role_name} from counterpart RoleValues #{counterpart.name}"
               # Duplicate the array using to_a, as the RoleValues here will be modified as we traverse it:
 	      next if role.fact_type.is_a?(TypeInheritanceFactType)
-	      counterpart_instances = send(role.name)
+	      counterpart_instances = send(role.getter)
 	      counterpart_instances.to_a.each do |counterpart_instance|
-		# These actions deconstruct the RoleValues as we go:
-                if counterpart.is_identifying && counterpart.mandatory
-                  counterpart_instance.retract
-                else
-                  counterpart_instance.send(counterpart.setter, nil, false)
-                end
+		# This action deconstructs our RoleValues as we go:
+		counterpart_instance.send(counterpart.setter, nil, false)
               end
 	      instance_variable_set(role.variable, nil)
             end

data/lib/activefacts/api/object_type.rb

@@ -172,6 +172,10 @@ module ActiveFacts
         @subtypes ||= []
       end
 
+      def subtypes_transitive
+	(subtypes+subtypes.map(&:subtypes_transitive)).flatten.uniq
+      end
+
       # Every new role added or inherited comes through here:
       def realise_role(role) #:nodoc:
         if (role.unary?)
@@ -328,7 +332,12 @@ module ActiveFacts
 	  instance_variable_set(role_var, value)
 
 	  # Remove "self" from the old counterpart:
-	  old_role_values.delete_instance(self, old_key) if old_key
+	  if old_key
+	    old_role_values.delete_instance(self, old_key)
+	    if (old_role_values.empty? && !old.class.is_entity_type)
+	      old.retract if old.plays_no_role
+	    end
+	  end
 
 	  @constellation.when_admitted do
 	    # Add "self" into the counterpart

data/lib/activefacts/api/value.rb

@@ -32,6 +32,20 @@ module ActiveFacts
 	respond_to?(:__getobj__) ? __getobj__ : self
       end
 
+      def plays_no_role
+	# REVISIT: Some Value Types are independent, and so must always be regarded as playing a role
+	self.class.all_role.all? do |n, role|
+	  case
+	  when role.fact_type.is_a?(ActiveFacts::API::TypeInheritanceFactType)
+	    true  # No need to consider subtyping/supertyping roles here
+	  when role.unique
+	    send(role.getter) == nil
+	  else
+	    send(role.getter).empty?
+	  end
+	end
+      end
+
       # All ValueType classes include the methods defined here
       module ClassMethods
         include Instance::ClassMethods

data/spec/metadata_spec.rb

@@ -17,7 +17,7 @@ describe "In a vocabulary" do
     :add_role, :all_role, :subtypes, :supertypes, :vocabulary,
     :all_role_transitive,
     # To make private:
-    :check_identifying_role_has_valid_cardinality, :realise_role, :supertypes_transitive,
+    :check_identifying_role_has_valid_cardinality, :realise_role, :supertypes_transitive, :subtypes_transitive,
   ]
 
   ValueType_methods = [
@@ -28,7 +28,7 @@ describe "In a vocabulary" do
   Instance_methods = [
     :constellation, :retract, :is_a?,
     # To remove or move to EntityType
-    :related_entities, :check_identification_change_legality,
+    :related_entities,
     :instance_index
   ]
   Value_methods = Instance_methods + [
@@ -52,7 +52,7 @@ describe "In a vocabulary" do
   Entity_methods = Instance_methods + [
     :verbalise, :identifying_role_values,
     # To remove hide or rewrite:
-    :identity_by, :identity_as_hash
+    :identity_by, :identity_as_hash, :check_identification_change_legality,
   ]
 
   Cases =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activefacts-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Clifford Heath
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree-pure