activefacts 0.8.8 → 0.8.9

data/bin/cql

@@ -26,10 +26,72 @@ class InteractiveCQL < ActiveFacts::CQL::Compiler
     self.root = :definition
   end
 
+  def list_instances name
+    if name.empty?
+      @vocabulary.constellation.Instance.values
+    else
+      if !@vocabulary.constellation.Concept[[[@vocabulary.name], name]]
+	puts "Object type '#{name}' does not exist in vocabulary '#{@vocabulary.name}'"
+	[]
+      else
+	@vocabulary.constellation.Instance.values.select{|i| i.concept.supertypes_transitive.detect{|k| k.name == name}}
+      end
+    end.select do |instance|
+      instance.concept.vocabulary == @vocabulary
+    end.map do |instance|
+      instance.verbalise
+    end.sort.each do |verbalisation|
+      puts verbalisation
+    end
+  end
+
+  def toggle_trace words
+    words.each { |word|
+      puts "#{word} #{debug_toggle(word) ? "en" : "dis"}abled"
+    }
+  end
+
+  def list_object_types
+    concepts_by_vocabulary = {}
+    @constellation.Concept.keys.
+      each do |v,t|
+	(concepts_by_vocabulary[v[0]] ||= []) << t
+      end
+    concepts_by_vocabulary.keys.sort.each do |v|
+      puts "#{v}:\n\t" + concepts_by_vocabulary[v].sort*"\n\t"
+    end
+  end
+
+  def list_connotations word
+    concept = @constellation.Concept[[@vocabulary.identifying_role_values, word]]
+    unless concept
+      puts "Object type '#{word}' is unknown in #{@vocabulary.name}"
+      return
+    end
+    puts "Fact types in which '#{word}' plays a part:"
+    if concept.is_a?(ActiveFacts::Metamodel::ValueType)
+      puts "\t#{concept.name} is written as #{concept.supertype.name};" if concept.supertype
+      concept.all_value_type_as_supertype.each do |st|
+	puts "#{st.name} is written as #{concept.name};"
+      end
+    end
+    concept.all_role.map{|role| role.fact_type}.uniq.each do |fact_type|
+      puts "\t#{fact_type.default_reading}"
+    end
+  end
+
   def metacommand(line)
     # meta-commands start with /
     words = line.split
     case cmd = words.shift
+    when /(\w*)\?/
+      list_instances $1
+    when "/trace"
+      if words.empty?
+	puts debug_keys*", "
+      else
+	toggle_trace words
+      end
     when "/tree"
       @show_tree = !@show_tree
       puts "Will #{@show_tree ? "" : "not "}show the parse tree"
@@ -37,39 +99,13 @@ class InteractiveCQL < ActiveFacts::CQL::Compiler
       self.root = words[0] && words[0].to_sym || :definition
       puts "Looking for a #{self.root}"
     when "/list"
-      concepts_by_vocabulary = {}
-      @constellation.Concept.keys.
-	each do |v,t|
-	  (concepts_by_vocabulary[v[0]] ||= []) << t
-	end
-      concepts_by_vocabulary.keys.sort.each do |v|
-	puts "#{v}:\n\t" + concepts_by_vocabulary[v].sort*"\n\t"
-      end
+      list_object_types
     when "/about"
-      concept = @constellation.Concept[[@vocabulary.identifying_role_values, words[0]]]
-      unless concept
-	puts "Concept #{words[0]} is unknown in #{@vocabulary.name}"
-	return
-      end
-      if concept.is_a?(ActiveFacts::Metamodel::ValueType)
-	puts "\t#{concept.name} is written as #{concept.supertype.name};" if concept.supertype
-	concept.all_value_type_as_supertype.each do |st|
-	  puts "#{st.name} is written as #{concept.name};"
-	end
-      end
-      concept.all_role.map{|role| role.fact_type}.uniq.each do |fact_type|
-	puts "\t#{fact_type.default_reading}"
+      words.each do |word|
+	list_connotations word
       end
     when "/load"
-      begin
-	vocabularies = @constellation.Vocabulary.keys
-	@results = []
-	compile_file words*' '
-	new_vocabularies = @constellation.Vocabulary.keys-vocabularies
-	puts "Loaded new vocabularies: #{new_vocabularies*', '}" unless new_vocabularies.empty?
-      rescue Errno::ENOENT => e
-	$stderr.puts e.message
-      end
+      load_file(words*' ')
     else
       if cmd == "/help" or cmd == "/"
 	help words
@@ -80,6 +116,21 @@ class InteractiveCQL < ActiveFacts::CQL::Compiler
     end
   end
 
+  def load_file filename
+    begin
+      vocabularies = @constellation.Vocabulary.keys
+      @results = []
+      compile_file filename
+      new_vocabularies = @constellation.Vocabulary.keys-vocabularies
+      puts "Loaded new vocabularies: #{new_vocabularies*', '}" unless new_vocabularies.empty?
+    rescue Errno::ENOENT => e
+      $stderr.puts e.message
+    rescue => e
+      puts e.message
+      puts "\t#{e.backtrace*"\n\t"}" if debug :exception
+    end
+  end
+
   def process(statement)
     begin
       @results = []
@@ -110,6 +161,7 @@ Meta-commands are:
   /load file.cql\tLoad a CQL file
   /root rule\t\tParse just a fragment of a CQL statement, matching syntax rule only
   /tree\t\t\tDisplay the abstract syntax tree from each statement parsed
+  /trace key\t\tToggle debug tracing key, or list available keys
 }
     else
       words.each do |word|
@@ -324,10 +376,17 @@ end
 
 compiler = InteractiveCQL.new
 statement = nil
+ARGV.each do |arg|
+  compiler.load_file(arg)
+end
 puts "Enter / for help on special commands"
+
 while line = Readline::readline(statement ? "CQL+ " : "CQL? ", [])
   statement = statement ? statement + "\n"+line : line
-  if line =~ %r{\A/}
+  if statement =~ /\s*(.*?)\s*\?\s*$/
+    compiler.list_instances $1
+    statement = nil
+  elsif line =~ %r{\A/}
     compiler.metacommand(line)
     statement = nil
   elsif compiler.root != :definition or

data/download.html

@@ -63,7 +63,8 @@
   PATH C:\Ruby187\bin;%PATH%
   </pre>
   <p>
-  Or right-click "My Computer" -%gt; Properties -%gt; Advanced  -%gt; Environment Variables -%gt; System Variables
+  Or right-click "My Computer" -&gt; Properties -&gt; Advanced  -&gt; Environment Variables -&gt; System Variables
+  <br>
   Scroll down to find the entry for Path and double-click it. Click in the Variable value: text widget and move the cursor to the start of the value before typing <b>C:\Ruby187;</b> before the first entry. Hit Ok three times and start a new command prompt.
   </p>
   <p>

data/examples/CQL/Diplomacy.cql

@@ -13,8 +13,8 @@ LanguageName is written as String;
 Country is identified by its Name;
 
 Diplomat is identified by its Name;
-Diplomat represents one Country;
-Diplomat serves in one Country;
+Diplomat represents one Country (as Represented Country);
+Diplomat serves in one Country (as Served Country);
 
 Language is identified by its Name;
 
@@ -29,8 +29,8 @@ Fluency is where
 	Language is spoken by Diplomat;
 
 Representation is where
-	Ambassador is from Country(1) to Country(2),
-	Country(1) is represented in Country(2) by one Ambassador;
+	Ambassador is from Country (as Represented Country) to Country(2),
+	Represented Country(1) is represented in Country(2) by one Ambassador;
 
 /*
  * Constraints:
@@ -38,10 +38,10 @@ Representation is where
 for each Diplomat, Country at most one of these holds:
 	Diplomat serves in Country,
 	Diplomat represents Country;
-Ambassador is from Country(1) to Country(2)
-	only if Ambassador is a kind of Diplomat that represents Country(1);
-Ambassador is from Country(2) to Country(1)
-	only if Ambassador is a kind of Diplomat that serves in Country(1);
+Diplomat is an Ambassador that is from Country(1) to Country(2)
+	only if Diplomat represents Country(1);
+Diplomat is an Ambassador that is from Country(2) to Country(1)
+	only if Diplomat serves in Country(1);
 Diplomat serves in Country
 	only if Diplomat speaks Language that is spoken in Country;
 each Ambassador occurs at least one time in

data/examples/CQL/Insurance.cql

@@ -205,7 +205,7 @@ Vehicle was sold by at most one Dealer;
 Driver is a kind of Person;
 
 Driving is where
-	Vehicle Incident involves at most one Driver,
+	Vehicle Incident involves one Driver,
 	Driver drove covered vehicle in at least one Vehicle Incident;
 Driving followed at most one Intoxication;
 Driving resulted in at most one blood-Test Result;
@@ -215,7 +215,7 @@ Driving was without owners consent for at most one nonconsent-Reason;
 Driving was unlicenced for at most one unlicensed-Reason;
 
 Driving Charge is where
-	Driving resulted in at most one Charge;
+	Driving resulted in one Charge;
 Driving Charge is a warning;
 
 Finance Institution is a kind of Company;
@@ -236,7 +236,7 @@ License was granted in at most one Year restricted to {1990..2100};
 License is international;
 
 Lodgement is where
-	Claim was lodged by at most one Person;
+	Claim was lodged by one Person;
 Lodgement was made at at most one Date Time;
 
 Policy is identified by p_year and p_product and p_state and p_serial where

data/examples/CQL/Metamodel.cql

@@ -33,6 +33,7 @@ Role Sequence Id is written as Auto Counter;
 Rotation Setting is written as String restricted to {'left', 'right'};
 Scale is written as Unsigned Integer(32);
 Shape Id is written as Auto Counter;
+Subscript is written as Unsigned Integer(16);
 Text is written as String(256);
 Unit Id is written as Auto Counter;
 X is written as Signed Integer(32);
@@ -86,13 +87,8 @@ Join Node is identified by Join and Ordinal where
 	Join includes Join Node,
 	Join Node is in one Join,
 	Join Node has one Ordinal position;
-
-Join Step is identified by input-Join Node and output-Join Node where
-	Join Step has one input-Join Node,
-	Join Step has one output-Join Node;
-Join Step traverses one Fact Type;
-is anti Join Step;
-Join Step is outer;
+Join Node has at most one Subscript,
+	Subscript is of Join Node;
 
 Position is identified by X and Y where
 	Position is at one X,
@@ -127,7 +123,6 @@ Role has at most one role-Name,
 	role-Name is name of at least one Role;
 
 Role Sequence is identified by its Id;
-Join projects one Role Sequence;
 Presence Constraint covers one Role Sequence;
 Reading is in one Role Sequence,
 	Role Sequence is for Reading;
@@ -167,6 +162,7 @@ Value is identified by Literal and Value is a string and Unit where
 	Value is in at most one Unit,
 	Unit is of Value;
 Instance has at most one Value;
+Join Node has at most one Value;
 
 Value Constraint is a kind of Constraint;
 Role has at most one role-Value Constraint,
@@ -238,6 +234,19 @@ Fact Type Shape is for one Fact Type,
 	Fact Type has Fact Type Shape;
 Fact Type Shape has at most one Rotation Setting;
 
+Join Role is where
+	Join Node includes at least one Role,
+	Role connects to Join Node;
+
+Join Step is identified by input-Join Role and output-Join Role where
+	Join Step has one input-Join Role,
+	Join Step has one output-Join Role;
+Join Step traverses one Fact Type,
+	Fact Type directs Join Step;
+Join Step involves incidental-Join Role;
+is anti Join Step;
+Join Step is outer;
+
 Model Note Shape is a kind of Shape;
 Model Note Shape is for one Context Note;
 
@@ -273,29 +282,28 @@ Ring Constraint Shape is attached to one Fact Type;
 
 Role Display is where
 	Fact Type Shape displays Role in Ordinal position,
-	Fact Type Shape displays in Ordinal position at most one Role;
+	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 at most one Role,
-	Role is in Role Sequence in at most one Ordinal place,
+	Role Sequence in Ordinal position includes one Role,
+	Role is in Role Sequence in one Ordinal place,
 	Role Sequence includes Role in Ordinal place,
 	Role has Ordinal place in Role Sequence;
-Role Ref connects to at most one Join Node,
-	Join Node includes Role Ref;
+Join Role projects at most one Role Ref;
 Role Ref has at most one leading-Adjective;
 Role Ref has at most one trailing-Adjective;
 
 Set Comparison Constraint is a kind of Set Constraint;
 
 Set Comparison Roles is where
-	Set Comparison Constraint has in Ordinal position at most one Role Sequence,
+	Set Comparison Constraint has in Ordinal position one Role Sequence,
 	Role Sequence is Ordinal in Set Comparison Constraint,
 	in Ordinal position Set Comparison Constraint has Role Sequence,
-	Set Comparison Constraint has Role Sequence in at most one Ordinal position;
+	Set Comparison Constraint has Role Sequence in one Ordinal position;
 
 Set Equality Constraint is a kind of Set Comparison Constraint;
 
@@ -341,7 +349,7 @@ Parameter is where
 	Value Type has parameter called Name;
 
 Param Value is where
-	Value for Parameter applies to at most one Value Type;
+	Value for Parameter applies to one Value Type;
 
 /*
  * Constraints:
@@ -364,6 +372,9 @@ either Value Constraint constrains Value Type or Value Constraint applies to Rol
 for each Instance at most one of these holds:
 	Instance has Value,
 	Instance objectifies Fact;
+Join Node is for Concept that plays Role
+	if and only if
+	Join Node includes Role;
 Role Value is of Instance that is of Concept
 	if and only if
 	Role Value is of Role that is played by Concept;
@@ -381,10 +392,14 @@ each combination Diagram, Position occurs at most one time in
 each combination Entity Type, Type Inheritance occurs at most one time in
 	Entity Type is subtype of super Entity Type,
 	Type Inheritance provides identification;
+each Join Role occurs at most one time in
+	Join Step involves incidental Join Role;
 each Presence Constraint occurs at least one time in
 	Presence Constraint has min Frequency,
 	Presence Constraint has max Frequency,
 	Presence Constraint is mandatory;
+each Role Ref occurs at most one time in
+	Join Role projects Role Ref;
 each Role Sequence occurs at least one time in
 	Role Sequence in Ordinal position includes Role;
 each Set Comparison Constraint occurs at least 2 times in

data/examples/CQL/MetamodelNext.cql

@@ -32,6 +32,7 @@ Role Sequence Id is written as Auto Counter;
 Rotation Setting is written as String restricted to {'left', 'right'};
 Scale is written as Unsigned Integer(32);
 Shape Id is written as Auto Counter;
+Subscript is written as String;
 Text is written as String(256);
 Unit Id is written as Auto Counter;
 X is written as Signed Integer(32);
@@ -87,13 +88,8 @@ Join Node is identified by Join and Ordinal where
 	Join includes Join Node,
 	Join Node is in one Join,
 	Join Node has one Ordinal position;
-
-Join Step is identified by input-Join Node and output-Join Node where
-	Join Step has one input-Join Node,
-	Join Step has one output-Join Node;
-Join Step traverses one Fact Type;
-is anti Join Step;
-Join Step is outer;
+Join Node has at most one Subscript,
+	Subscript is of Join Node;
 
 Object Type is a kind of Concept [partitioned];
 Instance is of one Object Type;
@@ -129,13 +125,12 @@ Implicit Fact Type is implied by one Role,
 Object Type plays Role,
 	Role is played by one Object Type;
 Ring Constraint has at most one other-Role;
-Ring Constraint has other-Role,
+Ring Constraint has at most one other-Role,
 	other-Role is of Ring Constraint;
 Role is of Ring Constraint,
 	Ring Constraint has at most one Role;
 
 Role Sequence is identified by its Id;
-Join projects one Role Sequence;
 Presence Constraint covers one Role Sequence;
 Reading is in one Role Sequence,
 	Role Sequence is for Reading;
@@ -175,6 +170,7 @@ Value is identified by Literal and Value is a string and Unit where
 	Value is in at most one Unit,
 	Unit is of Value;
 Instance has at most one Value;
+Join Node has at most one Value;
 
 Value Constraint is a kind of Constraint;
 Role has at most one role-Value Constraint,
@@ -245,6 +241,18 @@ Fact Type Shape has at most one Rotation Setting;
 
 ImplicitBooleanValueType is a kind of Value Type;
 
+Join Role is where
+	Join Node includes Role,
+	Role connects to Join Node;
+
+Join Step is identified by input-Join Role and output-Join Role where
+	Join Step has one input-Join Role,
+	Join Step has one output-Join Role;
+Join Step traverses one Fact Type,
+	Fact Type directs Join Step;
+is anti Join Step;
+Join Step is outer;
+
 Model Note Shape is a kind of Shape;
 Model Note Shape is for one Context Note;
 
@@ -284,29 +292,28 @@ Ring Constraint Shape is attached to one Fact Type;
 
 Role Display is where
 	Fact Type Shape displays Role in Ordinal position,
-	Fact Type Shape displays in Ordinal position at most one Role;
+	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 at most one Role,
-	Role is in Role Sequence in at most one Ordinal place,
+	Role Sequence in Ordinal position includes one Role,
+	Role is in Role Sequence in one Ordinal place,
 	Role Sequence includes Role in Ordinal place,
 	Role has Ordinal place in Role Sequence;
-Join Node includes Role Ref,
-	Role Ref connects to at most one Join Node;
+Join Role projects at most one Role Ref;
 Role Ref has at most one leading-Adjective;
 Role Ref has at most one trailing-Adjective;
 
 Set Comparison Constraint is a kind of Set Constraint;
 
 Set Comparison Roles is where
-	Set Comparison Constraint has in Ordinal position at most one Role Sequence,
+	Set Comparison Constraint has in Ordinal position one Role Sequence,
 	Role Sequence is Ordinal in Set Comparison Constraint,
 	in Ordinal position Set Comparison Constraint has Role Sequence,
-	Set Comparison Constraint has Role Sequence in at most one Ordinal position;
+	Set Comparison Constraint has Role Sequence in one Ordinal position;
 
 Set Equality Constraint is a kind of Set Comparison Constraint;
 
@@ -343,13 +350,13 @@ Allowed Range is where
 	Value Constraint allows at least one Value Range;
 
 Param Value is where
-	Value for Parameter applies to at most one Value Type;
+	Value for Parameter applies to one Value Type;
 
 /*
  * Constraints:
  */
 for each Concept exactly one of these holds:
-	Concept is a Object Type,
+	Concept is an Object Type,
 	Concept is a Fact Type,
 	Concept is a Constraint,
 	Concept is a Role;
@@ -382,6 +389,9 @@ for each Term at most one of these holds:
 for each Term at most one of these holds:
 	Term is secondary for Object Type,
 	Term is name of Role Ref;
+Join Node is for Object Type that plays Role
+	if and only if
+	Join Node includes Role;
 Role Value is of Instance that is of Object Type
 	if and only if
 	Role Value is of Role that is played by Object Type;
@@ -403,6 +413,8 @@ each Presence Constraint occurs at least one time in
 	Presence Constraint has min Frequency,
 	Presence Constraint has max Frequency,
 	Presence Constraint is mandatory;
+each Role Ref occurs at most one time in
+	Join Role projects Role Ref;
 each Role Sequence occurs at least one time in
 	Role Sequence in Ordinal position includes Role;
 each Set Comparison Constraint occurs at least 2 times in