activefacts-metamodel 1.9.12 → 1.9.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41e1740c184bc1058a20c1b62b3b31e3f362c6ce
-  data.tar.gz: 97bb44048eb3405c00ee4ae1ae37d7fc20b46161
+  metadata.gz: 2b9d48b959018dfa2c058b3f7ff8c6f72de85be7
+  data.tar.gz: 261ec3a4ff051b8ca6792699856d5b01e04c4fed
 SHA512:
-  metadata.gz: e06b4410d9591a1c8c25c9fc34fb7cf8939ab306271e1c1371bd5930104de29dd6ab8d5470a60403eaa67729132cb515e9a7b09b143cb41a20d660d045b8466a
-  data.tar.gz: 5f0a7e7593622ff32edf0a8b14aa28a8a99ecdb850fb64a9e1027499c1acf1cef0ad6a24857799d0bc32f7f2609b64e60643bde8d9a61414b2014870a75857cf
+  metadata.gz: 5f72c7417352823a629b4bc78d1490b12f49569909be18197aa8466f09ec4aeebaa09884309c257f7a94aac3c26a70b463d9b0170f42e61ab1903468224c4b17
+  data.tar.gz: d19e84520214f2cadfb9787c7339119679ba8a0800e06a895d2b1d57dfb83bb65342ba2ab2b8f19cbaea05cfd9cb8d69491d90c33bc16578ce218b97d327fb9c

data/Gemfile

@@ -5,9 +5,9 @@ gemspec
 this_file = File.absolute_path(__FILE__)
 if this_file =~ %r{\A#{ENV['HOME']}}i
   dir = File.dirname(File.dirname(this_file))
-  $stderr.puts "Using work area gems in #{dir} from activefacts-metamodel"
-  gem 'activefacts-cql', path: dir+'/cql'
-  gem 'activefacts-compositions', path: dir+'/compositions'
+  $stderr.puts "Using work area gems in #{dir}"
   gem 'activefacts-api', path: dir+'/api'
+  gem 'activefacts-cql', path: dir+'/cql'
   gem 'activefacts-orm', path: dir+'/orm'
+  gem 'activefacts-compositions', path: dir+'/compositions'
 end

data/Rakefile

@@ -24,19 +24,27 @@ task :bump do
 end
 
 desc "Generate new CQL from the ORM file (to verify version similarity)"
-task :cql do
+task :validation do
   # Note: Import from ORM is broken on the implicit derivations in constraints, and the result is unstable.
   # This means that SOME PATCHES WILL FAIL
-  system "afgen --cql orm/Metamodel.orm > Metamodel.cql"
+  system "bundle exec afgen --cql orm/Metamodel.orm > Metamodel.orm.cql"
   system "patch < orm/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"
+  system "bundle exec afgen --cql cql/Metamodel.cql 2>Metamodel.cql.errors >Metamodel.cql.cql"
+  system "diff -b -C 1  Metamodel.cql.cql Metamodel.orm.cql | tee Metamodel.cql.diffs"
+end
+
+# This patch exists because there are some features of the CQL that we
+# can't represent in the ORM, and some features in the ORM that we don't
+# want to represent in the CQL.
+desc "When you're satisfied that the CQL-generated ORM is close enough, make a new patch"
+task :remake_orm_patch do
+  system "diff -C1 Metamodel.orm.cql.orig  Metamodel.orm.cql > orm/Metamodel.cql.diffs"
 end
 
 desc "Generate new Ruby from the CQL file"
 task :ruby do
   system %q{
-    schema_compositor --binary --ruby=scope=ActiveFacts cql/Metamodel.cql > metamodel.rb &&
+    bundle exec schema_compositor --binary --ruby=scope=ActiveFacts cql/Metamodel.cql > metamodel.rb &&
     diff -ub lib/activefacts/metamodel/metamodel.rb metamodel.rb
   }
 end

data/activefacts-metamodel.gemspec

@@ -25,7 +25,9 @@ This gem provides the core representations for the Fact Modeling tools of Active
   spec.add_development_dependency "rspec", "~> 3.3"
 
   spec.add_development_dependency "activefacts-compositions", ">= 1.9.6"  # Needed for schema_compositor to emit Ruby from CQL
-  spec.add_development_dependency "activefacts", "~> 1", ">= 1.8"	  # Needed to emit CQL from ORM (and check it from CQL)
+  spec.add_development_dependency "activefacts-orm", ">= 1.9.0"  # Needed to load the ORM file during validation
+  spec.add_development_dependency "activefacts-cql", "~> 1", ">= 1.9"
+  spec.add_development_dependency "activefacts", "~> 1", ">= 1.8"
 
   spec.add_runtime_dependency "activefacts-api", "~> 1", ">= 1.9.5"
 end

data/cql/Metamodel.cql

@@ -34,6 +34,8 @@ Scale is written as Unsigned Integer(32);
 Subscript is written as Unsigned Integer(16);
 Text is written as String(256);
 Transaction Phase is written as String restricted to {'assert', 'commit'};
+Version Number is written as String(32);
+Version Pattern is written as String(64);
 X is written as Signed Integer(32);
 Y is written as Signed Integer(32);
 
@@ -161,9 +163,10 @@ Instance plays Role Value,
 
 Set Constraint is a kind of Constraint;
 
-Step is identified by Guid where
-	Step has one Guid,
-	Guid is of at most one Step;
+Step is identified by Query and Ordinal where
+    Query includes at least one Step,
+    Step is in one Query,
+    Step has one Ordinal position;
 Step falls under at most one Alternative Set,
 	Alternative Set covers at least one Step;
 Step specifies one Fact Type,
@@ -181,6 +184,12 @@ Topic is identified by topic-Name where
 Concept belongs to at most one Topic,
 	Topic contains Concept;
 
+Import is where
+    Topic imports precursor- Topic;
+Import has at most one role-Name (as Import Role);
+Import has at most one file-Name;
+Import has at most one Version Pattern;
+
 Unit is identified by Concept where
 	Unit is an instance of one Concept;
 Ephemera URL provides Unit coefficient,
@@ -223,6 +232,8 @@ Variable has at most one role-Name,
 
 Vocabulary is identified by Name where
 	Vocabulary is called one Name;
+Vocabulary is transform;
+Vocabulary has at most one Version Number;
 Vocabulary contains Constraint,
 	Constraint belongs to at most one Vocabulary;
 Vocabulary includes Unit,
@@ -358,12 +369,15 @@ Value Type Parameter Restriction is where
 	Value Type Parameter applies to Value Type;
 Value Type Parameter Restriction has one Value;
 
-/* Compositions */
+/*
+ * Compositions
+ */
 Composition is identified by Guid where
 	Composition has one Guid,
 	Guid is of at most one Composition;
 Composition is called one Name,
 	Name is of at most one Composition;
+Composition is by one compositor- Name;
 
 Component is identified by Guid where
 	Component has one Guid,
@@ -394,6 +408,9 @@ Composite is identified by Mapping where
 Composition contains Composite,
 	Composite belongs to one Composition;
 
+each Composite Group is identified by Name;
+Composite belongs to at most one Composite Group;
+
 Temporal Mapping is a kind of Mapping;
 Temporal Mapping records time using one Value Type;
 
@@ -404,10 +421,9 @@ forward-Absorption is matched by at most one reverse-Absorption,
 	reverse-Absorption is reverse of at most one forward-Absorption;
 Absorption flattens;
 
-/*
 some Absorption traverses from some parent- Role(1) and that Role(1) is played by some Object Type
 	only if that Absorption is a kind of Component(2) that contains some Component(3) that is a Mapping that represents that Object Type;
-*/
+
 some Absorption traverses to some child- Role(1) and that Role(1) is played by some Object Type
 	only if that Absorption is a kind of Mapping that represents that Object Type;
 
@@ -431,7 +447,7 @@ Leaf Constraint is where
 Local Constraint is where
 	Composite contains local-Constraint,
 	local-Constraint connects leaves of Composite;
- 
+
 Spanning Constraint is where
 	Composite has spanning-Constraint,
 	Constraint spans Composite;
@@ -461,6 +477,7 @@ 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;
+
 Composite has primary Index
 	only if Composite is reached through Access Path that is an Index;
 
@@ -497,6 +514,61 @@ Absorption is nested under index Role in Ordinal position
 	if and only if
 	that Absorption uses some Nesting Mode;
 
+/*
+ * Transformations
+ */
+each Expression Type is written as String restricted to {'Literal', 'Role', 'Unary', 'Binary', 'Ternary'};
+each Literal String is written as String;
+each Operator is written as String restricted to {
+    'and', 'or', 'not',
+    '=', '!=', 'count', 'max', 'min', 'total', 'avg', '<', '<=', '=>', '>',
+    '?', '+', '-', '*', '/', '0-', '1/'
+};
+
+each Expression is identified by Guid where
+	Expression has one Guid,
+	Guid is of at most one Expression;
+
+Expression has one Expression Type;
+Expression has at most one Literal String;
+Expression has at most one Operator;
+Expression has at most one first- operand Expression;
+Expression has at most one second- operand Expression;
+Expression has at most one third- operand Expression;
+
+Expression Object Ref is where
+    Expression in Ordinal position maps to one Object Type,
+    Object Type is in Expression in one Ordinal position;
+
+Expression Object Ref has at most one leading- Adjective;
+Expression Object Ref has at most one trailing- Adjective;
+
+each Transform Matching is identified by Guid where
+	Transform Matching has one Guid,
+	Guid is of at most one Transform Matching;
+
+Transform Target Ref is where
+    Transform Matching in Ordinal position maps to one Object Type,
+    Object Type is in Transform Matching in one Ordinal position;
+
+Transform Target Ref has at most one leading- Adjective;
+Transform Target Ref has at most one trailing- Adjective;
+
+each Simple Matching is a kind of Transform Matching;
+Simple Matching maps from at most one Expression;
+
+each Compound Matching is a kind of Transform Matching;
+Compound Matching maps from at most one source- Object Type;
+Compound Matching maps from at most one source- Query;
+
+Compound Matching consists of Transform Matching,
+    Transform Matching is part of at most one Compound Matching;
+
+each Transform Rule is independent identified by Concept where
+    Transform Rule is an instance of one Concept;
+Transform Rule implements at most one Compound Matching,
+    Compound Matching is implemented by at most one Transform Rule;
+
 /*
  * Diagrams
  */
@@ -582,7 +654,9 @@ either Value Constraint Shape is for Object Type Shape or Value Constraint Shape
 /*
  * Constraints:
  */
+
 either Component(1) belongs to Component(2) or Component(1) is a Mapping that projects some Composite but not both;
+
 for each Component exactly one of these holds:
 	Component is a Mapping,
 	Component is an Indicator,

data/lib/activefacts/metamodel/extensions.rb

@@ -81,6 +81,7 @@ module ActiveFacts
         when context_note; "ContextNote#{context_note.verbalise}"
         when unit; "Unit #{unit.describe}"
         when population; "Population: #{population.name}"
+        when transform_rule; "Transform Rule: #{transform_rule.describe}"
         else
           raise "ROGUE CONCEPT OF NO TYPE"
         end
@@ -98,6 +99,7 @@ module ActiveFacts
         when context_note; context_note
         when unit; unit
         when population; population
+        when transform_rule; transform_rule
         else
           raise "ROGUE CONCEPT OF NO TYPE"
         end
@@ -858,8 +860,7 @@ module ActiveFacts
             l_adj = "#{role_ref.leading_adjective}".sub(/(\b-\b|.\b|.\Z)/, '\1-').sub(/\b--\b/,'-- ').sub(/- /,'-  ')
             l_adj = nil if l_adj == ""
             # Double the space to compensate for space removed below
-            # REVISIT: hyphenated trailing adjectives are not correctly represented here
-            t_adj = "#{role_ref.trailing_adjective}".sub(/(\b.|\A.)/, '-\1').sub(/ -/,'  -')
+            t_adj = "#{role_ref.trailing_adjective}".sub(/\w+$/,' -\0').sub(/--\w*$/, ' \0')
             t_adj = nil if t_adj == ""
 
             expanded.gsub!(/\{#{i}\}/) do
@@ -1236,10 +1237,6 @@ module ActiveFacts
         end
       end
 
-      def all_step
-        all_variable.map{|var| var.all_step.to_a}.flatten.uniq
-      end
-
       # Check all parts of this query for validity
       def validate
         show
@@ -2140,8 +2137,47 @@ module ActiveFacts
       end
 
       def comment
-        return 'surrogate key' unless parent
-        ((c = parent.comment) != '' ? c : parent.name + ' surrogate key')
+        if parent && (c = parent.comment) != ''
+          return c
+        end
+        if fkf = all_foreign_key_field.single
+          return fkf.foreign_key.composite.mapping.name + ' surrogate key'
+        end
+        (parent ? parent.name + ' ' : '') + 'surrogate key'
+      end
+    end
+
+    #
+    # Transform Rules
+    #
+
+    class TransformRule
+      def describe
+        compound_matching.describe
+      end
+    end
+
+    class CompoundMatching
+      def describe
+        targ = all_transform_target_ref.map do |tr|
+          (tr.leading_adjective ? tr.leading_adjective + ' ' : '') +
+            tr.object_type.name + (tr.trailing_adjective ? ' ' + tr.trailing_adjective : '')
+        end * ' . '
+        src = (sot = source_object_type) ? sot.name : 'Query'
+
+        "#{targ} <== #{src} {" + all_transform_matching.map{|tm| tm.describe}.sort * ', ' + '}'
+      end
+    end
+
+    class SimpleMatching
+      def describe
+        targ = all_transform_target_ref.map do |tr|
+          (tr.leading_adjective ? tr.leading_adjective + ' ' : '') +
+            tr.object_type.name + (tr.trailing_adjective ? ' ' + tr.trailing_adjective : '')
+        end * ' . '
+        src = expression ? ((et = expression.expression_type) ? et : 'Expr') : ''
+
+        "#{targ} <-- #{src}"
       end
     end
 

data/lib/activefacts/metamodel/metamodel.rb

@@ -23,17 +23,23 @@ module ActiveFacts
       has_one         :name                               # Access Path is called Name, see Name#all_access_path
     end
 
-    class Guid < ::Guid
-      value_type
-    end
-
     class Name < String
       value_type      length: 64
     end
 
+    class CompositeGroup
+      identified_by   :name
+      one_to_one      :name, mandatory: true              # Composite Group has Name, see Name#composite_group
+    end
+
+    class Guid < ::Guid
+      value_type
+    end
+
     class Composition
       identified_by   :guid
       one_to_one      :guid, mandatory: true              # Composition has Guid, see Guid#composition
+      has_one         :compositor_name, mandatory: true, class: Name  # Composition is by compositor-Name, see Name#all_composition_as_compositor_name
       one_to_one      :name, mandatory: true              # Composition is called Name, see Name#composition
     end
 
@@ -71,6 +77,7 @@ module ActiveFacts
       identified_by   :mapping
       one_to_one      :mapping, mandatory: true           # Composite consists of Mapping, see Mapping#composite
       has_one         :composition, mandatory: true       # Composite belongs to Composition, see Composition#all_composite
+      has_one         :composite_group                    # Composite belongs to Composite Group, see CompositeGroup#all_composite
       one_to_one      :natural_index, class: Index        # Composite has natural-Index, see Index#composite_as_natural_index
       one_to_one      :primary_index, class: Index        # Composite has primary-Index, see Index#composite_as_primary_index
     end
@@ -83,9 +90,15 @@ module ActiveFacts
       value_type      length: 20
     end
 
+    class VersionNumber < String
+      value_type      length: 32
+    end
+
     class Vocabulary
       identified_by   :name
       one_to_one      :name, mandatory: true              # Vocabulary is called Name, see Name#vocabulary
+      maybe           :is_transform                       # Is Transform
+      has_one         :version_number                     # Vocabulary has Version Number, see VersionNumber#all_vocabulary
     end
 
     class ObjectType
@@ -140,9 +153,15 @@ module ActiveFacts
       has_one         :topic                              # Concept belongs to Topic, see Topic#all_concept
     end
 
+    class Query
+      identified_by   :concept
+      one_to_one      :concept, mandatory: true           # Query is an instance of Concept, see Concept#query
+    end
+
     class FactType
       identified_by   :concept
       one_to_one      :concept, mandatory: true           # Fact Type is an instance of Concept, see Concept#fact_type
+      one_to_one      :query, counterpart: :derived_fact_type  # derived-Fact Type is projected from Query, see Query#derived_fact_type
     end
 
     class LinkFactType < FactType
@@ -220,12 +239,6 @@ module ActiveFacts
       one_to_one      :value_type                         # Value Constraint constrains Value Type, see ValueType#value_constraint
     end
 
-    class Query
-      identified_by   :concept
-      one_to_one      :concept, mandatory: true           # Query is an instance of Concept, see Concept#query
-      has_one         :derived_fact_type, class: FactType  # Query projects Derived Fact Type, see FactType#all_query_as_derived_fact_type
-    end
-
     class AlternativeSet
       identified_by   :guid
       one_to_one      :guid, mandatory: true              # Alternative Set has Guid, see Guid#alternative_set
@@ -233,8 +246,9 @@ module ActiveFacts
     end
 
     class Step
-      identified_by   :guid
-      one_to_one      :guid, mandatory: true              # Step has Guid, see Guid#step
+      identified_by   :query, :ordinal
+      has_one         :query, mandatory: true             # Step is in Query, see Query#all_step
+      has_one         :ordinal, mandatory: true           # Step has Ordinal position, see Ordinal#all_step
       maybe           :is_disallowed                      # Is Disallowed
       maybe           :is_optional                        # Is Optional
       has_one         :fact_type, mandatory: true         # Step specifies Fact Type, see FactType#all_step
@@ -378,6 +392,23 @@ module ActiveFacts
       has_one         :parent_component_shape, class: ComponentShape  # Component Shape is contained in parent-Component Shape, see ComponentShape#all_component_shape_as_parent_component_shape
     end
 
+    class TransformMatching
+      identified_by   :guid
+      one_to_one      :guid, mandatory: true              # Transform Matching has Guid, see Guid#transform_matching
+      has_one         :compound_matching                  # Transform Matching is part of Compound Matching, see CompoundMatching#all_transform_matching
+    end
+
+    class TransformRule
+      identified_by   :concept
+      one_to_one      :concept, mandatory: true           # Transform Rule is an instance of Concept, see Concept#transform_rule
+    end
+
+    class CompoundMatching < TransformMatching
+      has_one         :source_object_type, class: ObjectType  # Compound Matching maps from source-Object Type, see ObjectType#all_compound_matching_as_source_object_type
+      has_one         :source_query, class: Query         # Compound Matching maps from source-Query, see Query#all_compound_matching_as_source_query
+      one_to_one      :transform_rule                     # Compound Matching is implemented by Transform Rule, see TransformRule#compound_matching
+    end
+
     class ConceptAnnotation
       identified_by   :concept, :mapping_annotation
       has_one         :concept, mandatory: true           # Concept Annotation involves Concept, see Concept#all_concept_annotation
@@ -448,6 +479,38 @@ module ActiveFacts
       has_one         :implicitly_objectified_fact_type, class: FactType  # Entity Type implicitly objectifies implicitly- objectified Fact Type, see FactType#all_entity_type_as_implicitly_objectified_fact_type
     end
 
+    class ExpressionType < String
+      value_type
+    end
+
+    class LiteralString < String
+      value_type
+    end
+
+    class Operator < String
+      value_type
+    end
+
+    class Expression
+      identified_by   :guid
+      one_to_one      :guid, mandatory: true              # Expression has Guid, see Guid#expression
+      has_one         :expression_type, mandatory: true   # Expression has Expression Type, see ExpressionType#all_expression
+      has_one         :first_operand_expression, class: Expression  # Expression has first- operand Expression, see Expression#all_expression_as_first_operand_expression
+      has_one         :literal_string                     # Expression has Literal String, see LiteralString#all_expression
+      has_one         :operator                           # Expression has Operator, see Operator#all_expression
+      has_one         :second_operand_expression, class: Expression  # Expression has second- operand Expression, see Expression#all_expression_as_second_operand_expression
+      has_one         :third_operand_expression, class: Expression  # Expression has third- operand Expression, see Expression#all_expression_as_third_operand_expression
+    end
+
+    class ExpressionObjectRef
+      identified_by   :expression, :ordinal
+      has_one         :expression, mandatory: true        # Expression Object Ref involves Expression, see Expression#all_expression_object_ref
+      has_one         :ordinal, mandatory: true           # Expression Object Ref involves Ordinal, see Ordinal#all_expression_object_ref
+      has_one         :object_type, mandatory: true       # Expression Object Ref involves Object Type, see ObjectType#all_expression_object_ref
+      has_one         :leading_adjective, class: Adjective  # Expression Object Ref has leading-Adjective, see Adjective#all_expression_object_ref_as_leading_adjective
+      has_one         :trailing_adjective, class: Adjective  # Expression Object Ref has trailing-Adjective, see Adjective#all_expression_object_ref_as_trailing_adjective
+    end
+
     class Instance
       identified_by   :concept
       one_to_one      :concept, mandatory: true           # Instance is an instance of Concept, see Concept#instance
@@ -504,6 +567,19 @@ module ActiveFacts
       has_one         :value                              # Foreign Key Field is discriminated by Value, see Value#all_foreign_key_field
     end
 
+    class VersionPattern < String
+      value_type      length: 64
+    end
+
+    class Import
+      identified_by   :topic, :precursor_topic
+      has_one         :topic, mandatory: true             # Import involves Topic, see Topic#all_import
+      has_one         :precursor_topic, mandatory: true, class: Topic  # Import involves precursor-Topic, see Topic#all_import_as_precursor_topic
+      has_one         :file_name, class: Name             # Import has file-Name, see Name#all_import_as_file_name
+      has_one         :import_role, class: Name           # Import has Import Role, see Name#all_import_as_import_role
+      has_one         :version_pattern                    # Import has Version Pattern, see VersionPattern#all_import
+    end
+
     class IndexField
       identified_by   :access_path, :ordinal
       has_one         :access_path, mandatory: true       # Index Field involves Access Path, see AccessPath#all_index_field
@@ -650,6 +726,10 @@ module ActiveFacts
       maybe           :is_mandatory                       # Is Mandatory
     end
 
+    class SimpleMatching < TransformMatching
+      has_one         :expression                         # Simple Matching maps from Expression, see Expression#all_simple_matching
+    end
+
     class SpanningConstraint
       identified_by   :composite, :spanning_constraint
       has_one         :composite, mandatory: true         # Spanning Constraint involves Composite, see Composite#all_spanning_constraint
@@ -668,6 +748,15 @@ module ActiveFacts
       has_one         :value_type, mandatory: true        # Temporal Mapping records time using Value Type, see ValueType#all_temporal_mapping
     end
 
+    class TransformTargetRef
+      identified_by   :transform_matching, :ordinal
+      has_one         :transform_matching, mandatory: true  # Transform Target Ref involves Transform Matching, see TransformMatching#all_transform_target_ref
+      has_one         :ordinal, mandatory: true           # Transform Target Ref involves Ordinal, see Ordinal#all_transform_target_ref
+      has_one         :object_type, mandatory: true       # Transform Target Ref involves Object Type, see ObjectType#all_transform_target_ref
+      has_one         :leading_adjective, class: Adjective  # Transform Target Ref has leading-Adjective, see Adjective#all_transform_target_ref_as_leading_adjective
+      has_one         :trailing_adjective, class: Adjective  # Transform Target Ref has trailing-Adjective, see Adjective#all_transform_target_ref_as_trailing_adjective
+    end
+
     class TypeInheritance < FactType
       identified_by   :subtype, :supertype
       has_one         :subtype, mandatory: true, class: EntityType  # Type Inheritance involves Subtype, see EntityType#all_type_inheritance_as_subtype