activefacts-metamodel 1.9.8 → 1.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7afe6a26853ed01f535f4d7f5790f79ec9be7f5
-  data.tar.gz: 746e2147513f5095bd03e1d16eaa3639ec7b7983
+  metadata.gz: 3e03674ba747b46f6f9ad28824b36f56f6a45fc5
+  data.tar.gz: 0f8eeb054a8cc86237ab65ef2a67ec1b0280dc11
 SHA512:
-  metadata.gz: f4d217b455a600eb0899906962bad4f8fff3c0da763526bfd6251df02873fb6582ccdac618d43dc7fb882d8326c9a92dc1f8d29fa70f95ce5d867e6515f01690
-  data.tar.gz: 71068e4a2c568f2f82c671412d37e11bf6eb9c0c35c58c26ec97508e64dc1065869197aae468ffd866f1273ec343bad98045af63f988ca9a4944cc31f4d43511
+  metadata.gz: 7958a809a59505eeb640cd02f612dc1d1a1ebb299b7eaff248a028fbc19eb5ce401caf1dd86d4c2e1b8e334e30a0452e9b9de88561d72c66f1b494742d41ea34
+  data.tar.gz: b3c17494c56c49883b19a19f20f00aa060cbb8eacee2d24a4590c724a7a7b677621bec3edb55e7f621f49850598e5c18090a21599842c6b9271ad0174739f9fb

data/.gitignore

@@ -13,3 +13,4 @@ bin
 *.rej
 *.orig
 *.diff
+Metamodel.old.cql

data/Rakefile

@@ -29,8 +29,8 @@ task :cql do
   # This means that SOME PATCHES WILL FAIL
   system "afgen --cql orm/Metamodel.orm > Metamodel.cql"
   system "patch < orm/Metamodel.cql.diffs"
-  system "afgen --cql cql/Metamodel.cql 2>/dev/null >Metamodel.cql.cql"
-  system "diff -b -C 1 Metamodel.cql Metamodel.cql.cql | tee Metamodel.cql.diffs"
+  system "afgen --cql cql/Metamodel.cql 2>/dev/null >Metamodel.old.cql"
+  system "diff -b -C 1  Metamodel.old.cql Metamodel.cql | tee Metamodel.cql.diffs"
 end
 
 desc "Generate new Ruby from the CQL file"

data/cql/Metamodel.cql

@@ -11,7 +11,7 @@ Assimilation is written as String restricted to {'absorbed', 'partitioned', 'sep
 Context Note Kind is written as String restricted to {'as_opposed_to', 'because', 'so_that', 'to_avoid'};
 Date is written as Date;
 Denominator is written as Unsigned Integer(32);
-Discussion is written as String;
+Description is written as String;
 Display Role Names Setting is written as String restricted to {'false', 'true'};
 Enforcement Code is written as String(16);
 Ephemera URL is written as String;
@@ -57,6 +57,7 @@ Coefficient is identified by Numerator and Denominator and Coefficient is precis
 Concept is identified by Guid where
 	Concept has one Guid,
 	Guid is of at most one Concept;
+Concept has at most one informal-Description;
 
 Concept Annotation is where
 	Concept has mapping-Annotation,
@@ -71,8 +72,8 @@ Context Note is identified by Concept where
 	Context Note is an instance of one Concept;
 Context Note has one Context Note Kind,
 	Context Note Kind is of Context Note;
-Context Note has one Discussion,
-	Discussion is for Context Note;
+Context Note has one Description,
+	Description is for Context Note;
 Context Note applies to at most one relevant-Concept,
 	Concept has Context Note;
 
@@ -158,12 +159,6 @@ Instance plays Role Value,
 
 Set Constraint is a kind of Constraint;
 
-Shape is identified by Guid where
-	Shape has one Guid,
-	Guid is of at most one Shape;
-Shape is at at most one Location;
-Shape is expanded;
-
 Step is identified by Guid where
 	Step has one Guid,
 	Guid is of at most one Step;
@@ -246,9 +241,6 @@ Bound is identified by Value and Bound is inclusive where
 	Value is of at least one Bound,
 	Bound is inclusive;
 
-Constraint Shape is a kind of Shape;
-Constraint Shape is for one Constraint;
-
 Context According To is where
 	Context Note is according to Agent,
 	Agent claims Context Note;
@@ -262,29 +254,10 @@ Derivation is where
 	Unit (as Derived Unit) is derived from base-Unit (as Base Unit) [acyclic, intransitive];
 Derivation has at most one Exponent;
 
-Diagram is identified by Vocabulary and Name where
-	Diagram is for one Vocabulary,
-	Vocabulary contains Diagram,
-	Diagram is called one Name,
-	Name is of Diagram;
-
-Fact Type Shape is a kind of Shape;
-Fact Type Shape has at most one Display Role Names Setting;
-Fact Type Shape is for one Fact Type,
-	Fact Type has Fact Type Shape;
-Fact Type Shape has at most one Rotation Setting;
-
 Mirror Role is a kind of Role;
 Mirror Role is for at most one Role (as Base Role),
 	Base Role implies at most one Mirror Role;
 
-Model Note Shape is a kind of Shape;
-Model Note Shape is for one Context Note;
-
-ORM Diagram is a kind of Diagram;
-Shape is in one ORM Diagram,
-	ORM Diagram includes Shape;
-
 Object Type is identified by Vocabulary and Name where
 	Object Type belongs to one Vocabulary,
 	Object Type is called one Name;
@@ -293,19 +266,9 @@ Object Type is an instance of one Concept;
 Object Type uses at most one Pronoun;
 Object Type plays Role,
 	Role is played by one Object Type;
-Object Type is independent;
 Variable is for one Object Type,
 	Object Type is referenced in Variable;
 
-Object Type Shape is a kind of Shape;
-Object Type Shape is for one Object Type,
-	Object Type has Object Type Shape;
-Object Type Shape has expanded reference mode;
-
-Objectified Fact Type Name Shape is a kind of Shape;
-Objectified Fact Type Name Shape is for one Fact Type Shape,
-	Fact Type Shape has at most one Objectified Fact Type Name Shape;
-
 Play is where
 	Variable is restricted by Role of Step,
 	Step contains Role restricting one Variable;
@@ -324,23 +287,6 @@ Population includes Instance,
 Population includes Role Value,
 	Role Value belongs to one Population;
 
-Reading Shape is a kind of Shape;
-Fact Type Shape has at most one Reading Shape,
-	Reading Shape is for one Fact Type Shape;
-Reading Shape is for one Reading,
-	Reading has Reading Shape;
-
-Ring Constraint Shape is a kind of Constraint Shape;
-Ring Constraint Shape is attached to one Fact Type Shape;
-
-Role Display is where
-	Fact Type Shape displays Role in Ordinal position,
-	Fact Type Shape displays in Ordinal position one Role;
-
-Role Name Shape is a kind of Shape;
-Role Name Shape is for one Role Display,
-	Role Display has at most one Role Name Shape;
-
 Role Ref is where
 	Role Sequence in Ordinal position includes one Role,
 	Role is in Role Sequence in one Ordinal place,
@@ -364,12 +310,6 @@ Set Equality Constraint is a kind of Set Comparison Constraint;
 Set Exclusion Constraint is a kind of Set Comparison Constraint;
 Set Exclusion Constraint is mandatory;
 
-Value Constraint Shape is a kind of Constraint Shape;
-Role Display has at most one Value Constraint Shape,
-	Value Constraint Shape is for at most one Role Display;
-Value Constraint Shape is for at most one Object Type Shape,
-	Object Type Shape has Value Constraint Shape;
-
 Value Range is identified by minimum-Bound and maximum-Bound where
 	Value Range has at most one minimum-Bound,
 	Value Range has at most one maximum-Bound;
@@ -378,6 +318,7 @@ Allowed Range is where
 	Value Constraint allows Value Range;
 
 Domain Object Type is a kind of Object Type;
+Domain Object Type is independent;
 
 Entity Type is a kind of Domain Object Type;
 Entity Type objectifies at most one Fact Type,
@@ -429,9 +370,12 @@ Component (as Member) belongs to at most one Component (as Parent) [acyclic, str
 	Parent contains Member;
 Component projects at most one Name;
 Component has at most one Ordinal rank;
+Component has absolute name;
 
 Indicator is a kind of Component;
 Indicator indicates one Role played;
+Indicator uses at most one false-Value;
+Indicator uses at most one true-Value;
 
 Discriminator is a kind of Component;
 Discriminated Role is where
@@ -440,6 +384,7 @@ Discriminated Role is where
 
 Mapping is a kind of Component;
 Mapping represents one Object Type;
+Mapping uses at most one native- type Name;
 
 Composite is identified by Mapping where
 	Mapping projects at most one Composite,
@@ -514,8 +459,8 @@ Composite has at most one primary-Index,
 	Index is primary for at most one Composite;
 Index is primary for Composite
 	only if Index is unique;
-identified Composite has primary Access Path
-	only if Composite is reached through Access Path;
+Composite has primary Index
+	only if Composite is reached through Access Path that is an Index;
 
 Index Field is where
 	Access Path for Ordinal field uses one Component,
@@ -550,6 +495,88 @@ Absorption is nested under index Role in Ordinal position
 	if and only if
 	that Absorption uses some Nesting Mode;
 
+/*
+ * Diagrams
+ */
+Diagram is identified by Vocabulary and Name where
+	Diagram is for one Vocabulary,
+	Vocabulary contains Diagram,
+	Diagram is called one Name,
+	Name is of Diagram;
+ORM Diagram is a kind of Diagram;
+
+Shape is identified by Guid where
+	Shape has one Guid,
+	Guid is of at most one Shape;
+Shape is in one ORM Diagram,
+	ORM Diagram includes Shape;
+Shape is at at most one Location;
+
+each combination ORM Diagram, Location occurs at most one time in
+	Shape is in ORM Diagram,
+	Shape is at Location;
+
+Fact Type Shape is a kind of Shape;
+Fact Type Shape has at most one Display Role Names Setting;
+Fact Type Shape is for one Fact Type,
+	Fact Type has Fact Type Shape;
+Fact Type Shape has at most one Rotation Setting;
+
+Object Type Shape is a kind of Shape;
+Object Type Shape is for one Object Type,
+	Object Type has Object Type Shape;
+Object Type Shape is expanded;
+
+Objectified Fact Type Name Shape is a kind of Shape;
+Objectified Fact Type Name Shape is for one Fact Type Shape,
+	Fact Type Shape has at most one Objectified Fact Type Name Shape;
+
+Constraint Shape is a kind of Shape;
+Constraint Shape is for one Constraint;
+
+Model Note Shape is a kind of Shape;
+Model Note Shape is for one Context Note;
+
+Reading Shape is a kind of Shape;
+Fact Type Shape has at most one Reading Shape,
+	Reading Shape is for one Fact Type Shape;
+Reading Shape is for one Reading,
+	Reading has Reading Shape;
+
+Ring Constraint Shape is a kind of Constraint Shape;
+Ring Constraint Shape is attached to one Fact Type Shape;
+
+Role Display is where
+	Fact Type Shape displays Role in Ordinal position,
+	Fact Type Shape displays in Ordinal position one Role;
+
+Role Name Shape is a kind of Shape;
+Role Name Shape is for one Role Display,
+	Role Display has at most one Role Name Shape;
+
+Value Constraint Shape is a kind of Constraint Shape;
+Role Display has at most one Value Constraint Shape,
+	Value Constraint Shape is for at most one Role Display;
+Value Constraint Shape is for at most one Object Type Shape,
+	Object Type Shape has Value Constraint Shape;
+
+Component Shape is a kind of Shape;
+Component Shape is for at most one Component;
+parent- Component Shape contains Component Shape,
+	Component Shape is contained in at most one parent- Component Shape;
+
+either Constraint Shape is a Ring Constraint Shape or Constraint Shape is a Value Constraint Shape but not both;
+for each Shape exactly one of these holds:
+	Shape is an Object Type Shape,
+	Shape is a Fact Type Shape,
+	Shape is a Constraint Shape,
+	Shape is an Objectified Fact Type Name Shape,
+	Shape is a Reading Shape,
+	Shape is a Role Name Shape,
+	Shape is a Model Note Shape,
+	Shape is a Component Shape;
+either Value Constraint Shape is for Object Type Shape or Value Constraint Shape is for Role Display but not both;
+
 /*
  * Constraints:
  */
@@ -569,7 +596,6 @@ for each Concept exactly one of these holds:
 	Fact is an instance of Concept,
 	Population is an instance of Concept,
 	Query is an instance of Concept;
-either Constraint Shape is a Ring Constraint Shape or Constraint Shape is a Value Constraint Shape but not both;
 for each Constraint exactly one of these holds:
 	Constraint is a Set Constraint,
 	Constraint is a Presence Constraint,
@@ -589,17 +615,8 @@ for each Role Sequence exactly one of these holds:
 	Role Sequence is Ordinal in Set Comparison Constraint;
 either Set Comparison Constraint is a Set Exclusion Constraint or Set Comparison Constraint is a Set Equality Constraint but not both;
 either Set Constraint is a Set Comparison Constraint or Set Constraint is a Subset Constraint but not both;
-for each Shape exactly one of these holds:
-	Shape is an Object Type Shape,
-	Shape is a Fact Type Shape,
-	Shape is a Constraint Shape,
-	Shape is an Objectified Fact Type Name Shape,
-	Shape is a Reading Shape,
-	Shape is a Role Name Shape,
-	Shape is a Model Note Shape;
 either Unit uses coefficient from Ephemera URL or Unit has Coefficient but not both;
 either Unit is fundamental or Unit is derived from base-Unit but not both;
-either Value Constraint Shape is for Object Type Shape or Value Constraint Shape is for Role Display but not both;
 either Value Constraint allows Value Range or Value Constraint requires matching Regular Expression but not both;
 either Value Constraint constrains Value Type or Value Constraint applies to Role but not both;
 for each Mapping at most one of these holds:
@@ -647,9 +664,6 @@ each combination Discriminator, Value occurs one time in
 each combination Entity Type(1), Type Inheritance occurs at most one time in
 	Entity Type(1) is subtype of super Entity Type(2),
 	Type Inheritance provides identification;
-each combination ORM Diagram, Location occurs at most one time in
-	Shape is in ORM Diagram,
-	Shape is at Location;
 each Presence Constraint occurs at least one time in
 	Presence Constraint has min Frequency(2),
 	Presence Constraint has max Frequency(1),

data/lib/activefacts/metamodel/datatypes.rb

@@ -0,0 +1,273 @@
+#
+#       ActiveFacts Vocabulary Metamodel.
+#       Data type support for the Metamodel
+#
+# Copyright (c) 2016 Clifford Heath. Read the LICENSE file.
+#
+
+module ActiveFacts
+  module Metamodel
+    class DataType
+      TypeNames = %w{
+        Boolean
+        Integer Real Decimal Money
+        Char String Text
+        Date Time DateTime Timestamp
+        Binary
+      }.freeze
+
+      TypeNames.each_with_index do |name, i|
+        DataType.const_set("TYPE_"+name, i)
+      end
+
+      # Alternate names are case-insensitive, and underscore can be literal, or correspond to a space or to nothing
+      AlternateNames = {
+        TYPE_Boolean =>
+          %w{ bit },
+        TYPE_Integer =>
+          %w{ auto_counter int tiny_int small_int big_int unsigned unsigned_int unsigned_integer signed_int signed_integer},
+        TYPE_Real =>
+          %w{ float double },
+        TYPE_Decimal =>
+          %w{ },
+        TYPE_Money =>
+          %w{ currency },
+        TYPE_Char =>
+          %w{ character nchar national_character fixed_length_text },
+        TYPE_String =>
+          %w{ varchar nvarchar national_character_varying variable_length_text },
+        TYPE_Text =>
+          %w{ large_length_text },
+        TYPE_Date =>
+          %w{ },
+        TYPE_Time =>
+          %w{ },
+        TYPE_DateTime =>
+          %w{ date_time },
+        TYPE_Timestamp =>
+          %w{ time_stamp auto_time_stamp },
+        TYPE_Binary =>
+          %w{ guid picture_raw_data variable_length_raw_data },
+      }
+      TypeParameters = {
+        TYPE_Integer => [:length],            # Length is the number of bits
+        TYPE_Real => [:length],               # Length is the number of bits in the mantissa
+        TYPE_Decimal => [:precision, :scale], # Precision is the number of significant digits
+        TYPE_Money => [:precision, :scale],   # Precision is the number of significant digits. Scale is the digits of fractional cents.
+        TYPE_Char => [:length, :charset],     # Charset is e.g. ascii, latin1, iso8859-1, unicode
+        TYPE_String => [:length, :charset],
+        TYPE_Text => [:charset],
+        TYPE_Binary => [:length, :charset],
+      }
+
+      # A DataType Context class should refine this class.
+      # The default context might work for you.
+      class Context
+        def integer_ranges
+        end
+
+        def default_length data_type, type_name
+        end
+
+        def choose_integer_type min, max
+          integer_ranges.detect{|type_name, vmin, vmax, bits| min >= vmin && max <= vmax}
+        end
+
+        def boolean_type
+        end
+
+        def surrogate_type
+        end
+
+        def valid_from_type
+        end
+      end
+
+      class DefaultContext < Context
+        def integer_ranges
+          # A set suitable for Standard SQL:
+          [
+            ['SMALLINT', -2**15, 2**15-1, 16],  # The SQL standard says -10^5..10^5 (less than 16 bits)
+            ['INTEGER', -2**31, 2**31-1, 32],   # The standard says -10^10..10^10 (more than 32 bits!)
+            ['BIGINT', -2**63, 2**63-1, 64],    # The standard says -10^19..10^19 (less than 64 bits)
+          ]
+        end
+
+        def default_length data_type, type_name
+          case data_type
+          when TYPE_Real
+            53        # IEEE Double precision floating point
+          when TYPE_Integer
+            case type_name
+            when /([a-z ]|\b)Tiny([a-z ]|\b)/i
+              8
+            when /([a-z ]|\b)Small([a-z ]|\b)/i,
+              /([a-z ]|\b)Short([a-z ]|\b)/i
+              16
+            when /([a-z ]|\b)Big([a-z ]|\b)/i
+              64
+            else
+              32
+            end
+          else
+            nil
+          end
+        end
+
+        def boolean_type
+          'CHAR'
+        end
+
+        def surrogate_type
+          'BIGINT'
+        end
+
+        def valid_from_type
+          'TIMESTAMP'
+        end
+      end
+
+      def self.normalise type_name
+        data_type, = type_mapping.detect{|t, names| names.detect{|n| n === type_name}}
+        data_type
+      end
+
+      def self.normalise_int_length type_name, length = nil, value_constraint = nil, context = DefaultContext.new
+        int_length = length || context.default_length(TYPE_Integer, type_name)
+        if int_length
+          if value_constraint
+            # Pick out the largest maximum and smallest minimum from the ValueConstraint:
+            ranges = value_constraint.all_allowed_range_sorted.flat_map{|ar| ar.value_range}
+            min = ranges.map(&:minimum_bound).compact.map{|minb| minb.is_inclusive ? minb.value : minb.value-1}.map{|v| v.literal.to_i}.sort[0]
+            max = ranges.map(&:maximum_bound).compact.map{|maxb| maxb.is_inclusive ? maxb.value : maxb.value+1}.map{|v| v.literal.to_i}.sort[-1]
+          end
+
+          unsigned = type_name =~ /^unsigned/i
+          int_min = unsigned ? 0 : -2**(int_length-1)+1
+          min = int_min if !min || length && int_min < min
+          # SQL does not have unsigned types.
+          # Don't force the next largest type just because the app calls for unsigned:
+          int_max = unsigned ? 2**(int_length-1) - 1 : 2**(int_length-1)-1
+          max = int_max if !max || length && int_max < max
+        end
+        best = context.choose_integer_type(min, max)
+        unless best || length
+          # Use the largest available integer size
+          best = context.integer_ranges.last
+        end
+
+        # Use a context-defined integer size if one suits, otherwise the requested size:
+        best && [best[0], best[3]] || [ 'int', length ]
+      end
+
+    private
+      def self.type_mapping
+        if DataType.const_defined?("TypeMapping")
+          return TypeMapping
+        end
+        DataType.const_set("TypeMapping",
+          AlternateNames.inject({}) do |h, (t, a)|
+            h[t] = [TypeNames[t]]
+            a.each do |n|
+              h[t] << /^#{n.gsub(/_/, '[ _]?')}$/i
+            end
+            h
+          end
+        )
+        TypeMapping
+      end
+
+    end
+
+    class Component
+      def in_primary_index
+        root.primary_index.all_index_field.detect{|ixf| ixf.component == self}
+      end
+
+      def in_foreign_key
+        all_foreign_key_field.detect{|fkf| fkf.foreign_key.source_composite == root}
+      end
+
+      def data_type context = DataType::DefaultContext.new
+        case self
+        when Indicator
+          context.boolean_type
+
+        when SurrogateKey
+          [ context.surrogate_type,
+            if in_primary_index and !in_foreign_key
+              {auto_assign: true}
+            else
+              {}
+            end.
+            merge!({mandatory: path_mandatory})
+          ]
+
+        when ValidFrom
+          context.valid_from_type
+
+        when ValueField, Absorption
+          vt = self.object_type
+          while vt.is_a?(EntityType)
+            rr = vt.preferred_identifier.role_sequence.all_role_ref.single
+            raise "Can't produce a column for composite #{inspect}" unless rr
+            value_constraint = narrow_value_constraint(value_constraint, rr.role.role_value_constraint)
+            vt = rr.role.object_type
+          end
+          raise "A column can only be produced from a ValueType not a #{vt.class.basename}" unless vt.is_a?(ValueType)
+
+          if is_a?(Absorption)
+            value_constraint = narrow_value_constraint(value_constraint, child_role.role_value_constraint)
+          end
+
+          stype = vt
+          begin
+            vt = stype
+            # REVISIT: Check for length and scale shortening
+            length ||= vt.length
+            scale ||= vt.scale
+            unless parent.parent and parent.foreign_key
+              # No need to enforce value constraints that are already enforced by a foreign key
+              value_constraint = narrow_value_constraint(value_constraint, vt.value_constraint)
+            end
+          end while stype = vt.supertype
+
+          [ vt.name,
+            (length ? {length: length} : {}).
+            merge!(scale ? {scale: scale} : {}).
+            merge!({ auto_assign: (in_primary_index and !in_foreign_key and vt.is_auto_assigned) }).
+            merge!({mandatory: path_mandatory}).
+            merge!(value_constraint ? {value_constraint: value_constraint} : {})
+          ]
+
+        when Injection
+          object_type.name
+        else
+          raise "Can't make a column from #{component}"
+        end
+      end
+
+      def narrow_value_constraint(value_constraint, nested_value_constraint)
+        # REVISIT: Need to calculate the constrant narrowing
+        return nested_value_constraint || value_constraint
+      end
+    end
+  end
+end
+
+if $0 == __FILE__
+  D = ActiveFacts::Metamodel::DataType
+  D.normalise('Auto Timestamp')
+
+  class ModContext < D::DefaultContext
+    def integer_ranges
+      [
+        ['BIT', 0, 1, 1], 
+        ['TINYINT', -2**7, 2**7-1, 8],
+      ] +
+      super 
+    end
+  end
+  puts "Normalising a tiny"
+  p D.normalise_int_length('tiny', nil, nil, ModContext.new)
+end