activefacts-cql 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4d6aee1f5f23c23a3a63b39313d2604d07f03a9
-  data.tar.gz: d2a4a7a5426a48c35bed29330257550dd460956e
+  metadata.gz: dc4fec528ea30db43664caba24b4eae5b394d59b
+  data.tar.gz: 670db8c27a33bf2a3777127fd3d41babd0641718
 SHA512:
-  metadata.gz: 618d767c7325a2e4a22cfff3a4c245bcdc764458529c63623f32e1efd247b1b30bc1fceda682a18e5c206e0e8c9a5d45597be181fdd68c1c1c41d38fa0ec6b61
-  data.tar.gz: 58c3b053a6d7fabcd348ca9fd9c63705f98d873018879c5e7d307a2bc78d979bc4cceb36ae52fcd95e8b4656fbe334aa7d10ba5999df3b5265532727dcb970f9
+  metadata.gz: d57cf6ed6d728b03c4f4b644e4a1866e313d53fef2315674be23f1f0695b7294b3ef388196c7bf95aca581a54b4da29b0ce65a79fe9944b17d128c0441e092d6
+  data.tar.gz: 46e7553490bd3bcaf73c65b5006d7c1f13e38fbaf46e41f4d1a32ce6afaa0066c9e15e723ea2a48f22af887fb562c4fb6e26a8a954c66f57e6d67a9669a3ced1

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 lib/activefacts/cql/parser/[A-Z]*.rb
+lib/activefacts/cql/parser/Language/[A-Z]*.rb
 *.swp
 clj
 .DS_Store

data/Gemfile

@@ -2,9 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
-if ENV['PWD'] =~ %r{\A#{ENV['HOME']}/work}
-  $stderr.puts "Using work area gems for #{File.basename(File.dirname(__FILE__))} from activefacts-cql"
-  gem 'activefacts-api', path: '/Users/cjh/work/activefacts/api'
-  gem 'activefacts-metamodel', path: '/Users/cjh/work/activefacts/metamodel'
-  # gem 'activefacts-metamodel', git: 'git://github.com/cjheath/activefacts-metamodel.git'
+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-cql"
+  gem 'activefacts-api', path: dir+'/api'
+  gem 'activefacts-metamodel', path: dir+'/metamodel'
 end

data/activefacts-cql.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.extensions << 'lib/activefacts/cql/Rakefile'
 
-  spec.add_development_dependency "bundler", ">= 1.10", "~> 1.10.6"
+  spec.add_development_dependency "bundler", ">= 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
 
-  spec.add_runtime_dependency "activefacts-metamodel", ">= 1.8.3", "~> 1"
-  spec.add_runtime_dependency %q<treetop>, [">= 1.4.14", "~> 1.4"]
+  spec.add_runtime_dependency "activefacts-metamodel", "~> 1", ">= 1.9.5"
+  spec.add_runtime_dependency "treetop", [">= 1.4.14", "~> 1.4"]
 end
 

data/lib/activefacts/cql/compiler.rb

@@ -13,6 +13,7 @@ require 'activefacts/cql/compiler/expression'
 require 'activefacts/cql/compiler/fact'
 require 'activefacts/cql/compiler/constraint'
 require 'activefacts/cql/compiler/query'
+require 'activefacts/cql/compiler/informal'
 
 module ActiveFacts
   module CQL
@@ -28,6 +29,7 @@ module ActiveFacts
         @filename = a.shift || "stdio"
         super *a
         @constellation = ActiveFacts::API::Constellation.new(ActiveFacts::Metamodel)
+        @constellation.loggers << proc{|*k| trace :apilog, k.inspect} if trace(:apilog)
         @language = nil
         trace :file, "Parsing '#{@filename}'"
       end
@@ -58,11 +60,11 @@ module ActiveFacts
 
       # Mark any new Concepts as belonging to this topic
       def topic_flood
-	@constellation.Concept.each do |key, concept|
-	  next if concept.topic
-	  trace :topic, "Colouring #{concept.describe} with #{@topic.topic_name}"
-	  concept.topic = @topic
-	end
+        @constellation.Concept.each do |key, concept|
+          next if concept.topic
+          trace :topic, "Colouring #{concept.describe} with #{@topic.topic_name}"
+          concept.topic = @topic
+        end
       end
 
       def compile input
@@ -74,7 +76,7 @@ module ActiveFacts
         # parse_all returns an array of the block's non-nil return values.
         ok = parse_all(@string, :definition) do |node|
           trace :parse, "Parsed '#{node.text_value.gsub(/\s+/,' ').strip}'" do
-	    trace :lex, (proc { node.inspect })
+            trace :lex, (proc { node.inspect })
             begin
               ast = node.ast
               next unless ast
@@ -84,14 +86,14 @@ module ActiveFacts
               ast.vocabulary = @vocabulary
               value = compile_definition ast
               trace :definition, "Compiled to #{value.is_a?(Array) ? value.map{|v| v.verbalise}*', ' : value.verbalise}" if value
-	      if value.is_a?(ActiveFacts::Metamodel::Topic)
-		topic_flood if @topic
-		@topic = value
-	      elsif ast.is_a?(Compiler::Vocabulary)
-		topic_flood if @topic
-		@vocabulary = value
-		@topic = @constellation.Topic(@vocabulary.name)
-	      end
+              if value.is_a?(ActiveFacts::Metamodel::Topic)
+                topic_flood if @topic
+                @topic = value
+              elsif ast.is_a?(Compiler::Vocabulary)
+                topic_flood if @topic
+                @vocabulary = value
+                @topic = @constellation.Topic(@vocabulary.name)
+              end
             rescue => e
               # Augment the exception message, but preserve the backtrace
               start_line = @string.line_of(node.interval.first)
@@ -102,7 +104,7 @@ module ActiveFacts
               raise ne
             end
           end
-	  topic_flood if @topic
+          topic_flood if @topic
         end
         raise failure_reason unless ok
         vocabulary
@@ -115,16 +117,16 @@ module ActiveFacts
         saved_input_length = @input_length
         saved_topic = @topic
         old_filename = @filename
-        @filename = File.dirname(old_filename)+'/'+file+'.cql'
+        @filename = import_filename(old_filename, file)
 
         # REVISIT: Save and use another @vocabulary for this file?
         File.open(@filename) do |f|
-	  topic_flood if @topic
-	  @topic = @constellation.Topic(File.basename(@filename, '.cql'))
-	  trace :import, "Importing #{@filename} as #{@topic.topic_name}" do
-	    ok = parse_all(f.read, nil, &@block)
-	  end
-	  @topic = saved_topic
+          topic_flood if @topic
+          @topic = @constellation.Topic(File.basename(@filename, '.cql'))
+          trace :import, "Importing #{@filename} as #{@topic.topic_name}" do
+            ok = parse_all(f.read, nil, &@block)
+          end
+          @topic = saved_topic
         end
 
       rescue => e
@@ -140,6 +142,11 @@ module ActiveFacts
         nil
       end
 
+      # import_filename may be redefined in subclass
+      def import_filename(old_filename, file)
+        File.dirname(old_filename)+'/'+file+'.cql'
+      end
+
       def compile_definition ast
         ast.compile
       end

data/lib/activefacts/cql/compiler/clause.rb

@@ -52,34 +52,34 @@ module ActiveFacts
             # else 'definitely '
             end
           }#{
-	    (
-	      phrases.map do |phrase|
-		case phrase
-		when String
-		  '"' + phrase.to_s + '"'
-		when Reference
-		  phrase.to_s +
-		    if phrase.nested_clauses
-		      ' (in which ' +
-			phrase.nested_clauses.map do |c|
-			  ((j = c.conjunction) ? j+' ' : '') +
-			    c.to_s
-			end*' ' +
-		      ')'
-		    else
-		      ''
-		    end
-		when Operation
-		  phrase.inspect
-		when Literal
-		  phrase.inspect
-		#when FunctionCallChain		# REVISIT: Add something here when I re-add functions
-		#  phrase.inspect
-		else
-		  raise "Unexpected phrase type in clause: #{phrase.class}"
-		end
-	      end * ' '
-	    ).gsub(/" "/, ' ')
+            (
+              phrases.map do |phrase|
+                case phrase
+                when String
+                  '"' + phrase.to_s + '"'
+                when Reference
+                  phrase.to_s +
+                    if phrase.nested_clauses
+                      ' (in which ' +
+                        phrase.nested_clauses.map do |c|
+                          ((j = c.conjunction) ? j+' ' : '') +
+                            c.to_s
+                        end*' ' +
+                      ')'
+                    else
+                      ''
+                    end
+                when Operation
+                  phrase.inspect
+                when Literal
+                  phrase.inspect
+                #when FunctionCallChain         # REVISIT: Add something here when I re-add functions
+                #  phrase.inspect
+                else
+                  raise "Unexpected phrase type in clause: #{phrase.class}"
+                end
+              end * ' '
+            ).gsub(/" "/, ' ')
           }#{
             @context_note && ' ' + @context_note.inspect
           }"
@@ -121,8 +121,8 @@ module ActiveFacts
           end
         end
 
-	# This method is used in matching unary fact types in entity identification
-	# It disregards literals, which are not allowed in this context.
+        # This method is used in matching unary fact types in entity identification
+        # It disregards literals, which are not allowed in this context.
         def phrases_match(phrases)
           @phrases.zip(phrases).each do |mine, theirs|
             return false if mine.is_a?(Reference) != theirs.is_a?(Reference)
@@ -145,20 +145,20 @@ module ActiveFacts
           raise "Cannot match a clause that contains no object types" if refs.size == 0
           raise "Internal error, clause already matched, should not match again" if @fact_type
 
-	  if is_naked_object_type
-	    ref = refs[0]	# "There can be only one"
-	    return true unless ref.nested_clauses
-	    ref.nested_clauses.each do |nested|
-	      ft = nested.match_existing_fact_type(context)
-	      raise "Unrecognised fact type #{nested.display} nested under #{inspect}" unless ft
-	      if (ft.entity_type == ref.player)
-		ref.objectification_of = ft
-		nested.objectified_as = ref
-	      end
-	    end
-	    raise "#{ref.inspect} contains objectification steps that do not objectify it" unless ref.objectification_of
-	    return true
-	  end
+          if is_naked_object_type
+            ref = refs[0]       # "There can be only one"
+            return true unless ref.nested_clauses
+            ref.nested_clauses.each do |nested|
+              ft = nested.match_existing_fact_type(context)
+              raise "Unrecognised fact type #{nested.display} nested under #{inspect}" unless ft
+              if (ft.entity_type == ref.player)
+                ref.objectification_of = ft
+                nested.objectified_as = ref
+              end
+            end
+            raise "#{ref.inspect} contains objectification steps that do not objectify it" unless ref.objectification_of
+            return true
+          end
 
           # If we fail to match, try a left contraction (or save this for a subsequent left contraction):
           left_contract_this_onto = context.left_contractable_clause
@@ -267,9 +267,9 @@ module ActiveFacts
                     next if role.fact_type.is_a?(ActiveFacts::Metamodel::LinkFactType)
                     next if role.fact_type.all_role.size != players.size      # Wrong number of players
 
-		    compatible_readings = role.fact_type.compatible_readings(player_related_types)
-		    next unless compatible_readings.size > 0
-		    trace :matching_fails, "These readings are compatible: #{compatible_readings.map(&:expand).inspect}"
+                    compatible_readings = role.fact_type.compatible_readings(player_related_types)
+                    next unless compatible_readings.size > 0
+                    trace :matching_fails, "These readings are compatible: #{compatible_readings.map(&:expand).inspect}"
                     true
                   end.
                     map{ |role| role.fact_type}
@@ -437,13 +437,13 @@ module ActiveFacts
               if la = role_ref.leading_adjective and !la.empty?
                 # The leading adjectives must match, one way or another
                 la = la.split(/\s+/)
-		if (la[0, intervening_words.size] == intervening_words)		# Exact match
-		  iw = intervening_words
-		else
-		  # We may have hyphenated adjectives. Break them up to check:
-		  iw = intervening_words.map{|w| w.split(/-/)}.flatten
-		  return nil unless la[0,iw.size] == iw
-		end
+                if (la[0, intervening_words.size] == intervening_words)         # Exact match
+                  iw = intervening_words
+                else
+                  # We may have hyphenated adjectives. Break them up to check:
+                  iw = intervening_words.map{|w| w.split(/-/)}.flatten
+                  return nil unless la[0,iw.size] == iw
+                end
 
                 # Any intervening_words matched, see what remains
                 la.slice!(0, iw.size)
@@ -933,7 +933,9 @@ module ActiveFacts
         def identify_player context
           @player || begin
             @player = context.object_type @term
-            raise "ObjectType #{@term} unrecognised" unless @player
+            unless @player
+              raise "ObjectType #{@term} unrecognised"
+            end
             context.player_by_role_name[@role_name] = player if @role_name
             @player
           end
@@ -953,8 +955,8 @@ module ActiveFacts
             t = @trailing_adjective
             key = [!l || l.empty? ? nil : l, @term, !t || t.empty? ? nil : t]
           end
-	  key += [:literal, literal.literal] if @literal
-	  key
+          key += [:literal, literal.literal] if @literal
+          key
         end
 
         def bind context
@@ -972,27 +974,27 @@ module ActiveFacts
               role_name = @term
             end
           end
-	  k = key
-	  @binding = context.bindings[k]
-	  if !@binding
-	    if !literal
-	      # Find a binding that has a literal, and bind to it if it's the only one
-	      candidates = context.bindings.map do |binding_key, binding|
-		  binding_key[0...k.size] == k &&
-		    binding_key[-2] == :literal ? binding : nil
-		end.compact
-	      raise "Uncertain binding reference for #{to_s}, could be any of #{candidates.inspect}" if candidates.size > 1
-	      @binding = candidates[0]
-	    else
-	      # New binding has a literal, look for one without:
-	      @binding = context.bindings[k[0...-2]]
-	    end
-	  end
-
-	  if !@binding
-	    @binding = Binding.new(@player, role_name)
-	    context.bindings[k] = @binding
-	  end
+          k = key
+          @binding = context.bindings[k]
+          if !@binding
+            if !literal
+              # Find a binding that has a literal, and bind to it if it's the only one
+              candidates = context.bindings.map do |binding_key, binding|
+                  binding_key[0...k.size] == k &&
+                    binding_key[-2] == :literal ? binding : nil
+                end.compact
+              raise "Uncertain binding reference for #{to_s}, could be any of #{candidates.inspect}" if candidates.size > 1
+              @binding = candidates[0]
+            else
+              # New binding has a literal, look for one without:
+              @binding = context.bindings[k[0...-2]]
+            end
+          end
+
+          if !@binding
+            @binding = Binding.new(@player, role_name)
+            context.bindings[k] = @binding
+          end
           @binding.add_ref self
           @binding
         end
@@ -1079,11 +1081,11 @@ module ActiveFacts
                   :max_frequency => @quantifier.max,
                   :min_frequency => @quantifier.min
                 )
-	      if @quantifier.pragmas
-		@quantifier.pragmas.each do |p|
-		  constellation.ConceptAnnotation(:concept => constraint.concept, :mapping_annotation => p)
-		end
-	      end
+              if @quantifier.pragmas
+                @quantifier.pragmas.each do |p|
+                  constellation.ConceptAnnotation(:concept => constraint.concept, :mapping_annotation => p)
+                end
+              end
               trace :constraint, "Made new embedded PC GUID=#{constraint.concept.guid} min=#{@quantifier.min.inspect} max=#{@quantifier.max.inspect} over #{(e = fact_type.entity_type) ? e.name : role_sequence.describe} in #{fact_type.describe}"
               @quantifier.enforcement.compile(constellation, constraint) if @quantifier.enforcement
               @embedded_presence_constraint = constraint
@@ -1110,7 +1112,7 @@ module ActiveFacts
           @max = max
           @enforcement = enforcement
           @context_note = context_note
-	  @pragmas = pragmas
+          @pragmas = pragmas
         end
 
         def is_unique

data/lib/activefacts/cql/compiler/constraint.rb

@@ -14,10 +14,10 @@ module ActiveFacts
       end
 
       class ContextNote
-        attr_reader :context_kind, :discussion, :who, :agreed_date, :agreed_agents
+        attr_reader :context_kind, :description, :who, :agreed_date, :agreed_agents
 
-        def initialize context_kind, discussion, who, agreed
-          @context_kind, @discussion, @who, @agreed = context_kind, discussion, who, agreed
+        def initialize context_kind, description, who, agreed
+          @context_kind, @description, @who, @agreed = context_kind, description, who, agreed
           @agreed_date, @agreed_agents = *agreed
         end
 
@@ -26,7 +26,7 @@ module ActiveFacts
             constellation.ContextNote(
               :new,
               :context_note_kind => @context_kind,
-              :discussion => @discussion
+              :description => @description
             )
           context_note.relevant_concept = target.concept
           if @agreed_date || @agreed_agents
@@ -49,14 +49,14 @@ module ActiveFacts
         def initialize context_note, enforcement, clauses_lists = []
           if context_note.is_a?(Treetop::Runtime::SyntaxNode) && !context_note.empty?
             context_note = context_note.empty? ? nil : context_note.ast
-	  else
-	    context_note = nil	# Perhaps a context note got attached to one of the clauses. Steal it.
-	    clauses_lists.detect do |clauses_list|
-	      if c = clauses_list.last.context_note
-		context_note = c
-		clauses_list.last.context_note = nil
-	      end
-	    end
+          else
+            context_note = nil  # Perhaps a context note got attached to one of the clauses. Steal it.
+            clauses_lists.detect do |clauses_list|
+              if c = clauses_list.last.context_note
+                context_note = c
+                clauses_list.last.context_note = nil
+              end
+            end
           end
           @context_note = context_note
           @enforcement = enforcement
@@ -233,13 +233,13 @@ module ActiveFacts
               :is_preferred_identifier => false,
               :is_mandatory => @quantifier.min && @quantifier.min > 0
             )
-	  if @quantifier.pragmas
-	    @quantifier.pragmas.each do |p|
-	      @constellation.ConceptAnnotation(:concept => @constraint.concept, :mapping_annotation => p)
-	    end
-	  end
+          if @quantifier.pragmas
+            @quantifier.pragmas.each do |p|
+              @constellation.ConceptAnnotation(:concept => @constraint.concept, :mapping_annotation => p)
+            end
+          end
           @enforcement.compile(@constellation, @constraint) if @enforcement
-	  trace :constraint, "Made new PC GUID=#{@constraint.concept.guid} min=#{@quantifier.min.inspect} max=#{@quantifier.max.inspect} over #{role_sequence.describe}"
+          trace :constraint, "Made new PC GUID=#{@constraint.concept.guid} min=#{@quantifier.min.inspect} max=#{@quantifier.max.inspect} over #{role_sequence.describe}"
           super
         end
 
@@ -285,9 +285,9 @@ module ActiveFacts
             # Does this clauses_list involve a query?
             if clauses_list.size > 1 or
               clauses_list.detect do |clause|
-		clause.refs.detect{|ref| ref.nested_clauses } or
-		clause.includes_literals
-	      end
+                clause.refs.detect{|ref| ref.nested_clauses } or
+                clause.includes_literals
+              end
 
               trace :query, "Building query for #{clauses_list.inspect}" do
                 trace :query, "Constrained bindings are #{@common_bindings.inspect}"
@@ -390,11 +390,11 @@ module ActiveFacts
             :vocabulary => @vocabulary,
             :is_mandatory => @quantifier.min == 1
           )
-	  if @quantifier.pragmas
-	    @quantifier.pragmas.each do |p|
-	      @constellation.ConceptAnnotation(:concept => @constraint.concept, :mapping_annotation => p)
-	    end
-	  end
+          if @quantifier.pragmas
+            @quantifier.pragmas.each do |p|
+              @constellation.ConceptAnnotation(:concept => @constraint.concept, :mapping_annotation => p)
+            end
+          end
           @enforcement.compile(@constellation, @constraint) if @enforcement
           role_sequences.each_with_index do |role_sequence, i|
             @constellation.SetComparisonRoles(@constraint, i, :role_sequence => role_sequence)
@@ -518,35 +518,35 @@ module ActiveFacts
           @regular_expression = ast[:regular_expression]
         end
 
-	def assert_value(val)
-	  if val.is_a?(String)
-	    @constellation.Value(eval(val), true, nil)
-	  elsif val
-	    @constellation.Value(val.to_s, false , nil)
-	  else
-	    nil
-	  end
-	end
+        def assert_value(val)
+          if val.is_a?(String)
+            @constellation.Value(eval(val), true, nil)
+          elsif val
+            @constellation.Value(val.to_s, false , nil)
+          else
+            nil
+          end
+        end
 
         def compile
           @constraint = @constellation.ValueConstraint(:new)
           raise "Units on value constraints are not yet processed (at line #{'REVISIT'})" if @units
               # @string.line_of(node.interval.first)
 
-	  if @value_ranges
-	    @value_ranges.each do |range|
-	      min, max = Array === range ? range : [range, range]
-	      v_range = @constellation.ValueRange(
-		min && @constellation.Bound(:value => assert_value(min), :is_inclusive => true),
-		max && @constellation.Bound(:value => assert_value(max), :is_inclusive => true))
-	      ar = @constellation.AllowedRange(@constraint, v_range)
-	    end
-	  else
-	    @constraint.regular_expression = @regular_expression
-	  end
-	  @enforcement.compile(@constellation, @constraint) if @enforcement
-	  super
-	end
+          if @value_ranges
+            @value_ranges.each do |range|
+              min, max = Array === range ? range : [range, range]
+              v_range = @constellation.ValueRange(
+                min && @constellation.Bound(:value => assert_value(min), :is_inclusive => true),
+                max && @constellation.Bound(:value => assert_value(max), :is_inclusive => true))
+              ar = @constellation.AllowedRange(@constraint, v_range)
+            end
+          else
+            @constraint.regular_expression = @regular_expression
+          end
+          @enforcement.compile(@constellation, @constraint) if @enforcement
+          super
+        end
 
         def vrto_s vr
           if Array === vr
@@ -568,10 +568,10 @@ module ActiveFacts
 
         def to_s
           "#{super} to " +
-	  (@value_ranges ?
-	    "(#{@value_ranges.map{|vr| vrto_s(vr) }.inspect })#{ @units ? " in #{@units.inspect}" : ''}" :
-	    @regular_expression
-	  )
+          (@value_ranges ?
+            "(#{@value_ranges.map{|vr| vrto_s(vr) }.inspect })#{ @units ? " in #{@units.inspect}" : ''}" :
+            @regular_expression
+          )
         end
       end