canql 1.3.0

data/lib/canql.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'active_support/time'
+
+require 'canql/version'
+require 'canql/parser'

data/lib/canql/constants.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This stores additional constants of the Canql gem
+module Canql
+  ALL = 'all'
+  BEGINS = 'begins'
+  EQUALS = 'equals'
+  LIMITS = 'limits'
+  MESSAGE = 'msg'
+end

data/lib/canql/grammars.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'treetop'
+
+Treetop.load File.expand_path('grammars/age', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/dates', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/anomaly', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/batch_types', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/e_base_records', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/test_result', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/patient', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/registry', File.dirname(__FILE__))
+Treetop.load File.expand_path('grammars/main', File.dirname(__FILE__))

data/lib/canql/grammars/age.treetop

@@ -0,0 +1,23 @@
+module Canql
+  grammar Age
+    rule with_birth_date
+      born_keyword fuzzy_date <Nodes::Age::BirthDateNode>
+    end
+
+    rule with_death_date
+      that_who_keyword? died_keyword fuzzy_date <Nodes::Age::DeathDateNode>
+    end
+
+    rule that_who_keyword
+      space ('that' / 'who') word_break
+    end
+
+    rule born_keyword
+      space ('born' / 'delivered') word_break
+    end
+
+    rule died_keyword
+      space 'died' word_break
+    end
+  end
+end

data/lib/canql/grammars/anomaly.treetop

@@ -0,0 +1,19 @@
+module Canql
+  grammar Anomaly
+    rule anomalies
+      and_keyword? existance_modifier:anomalies_no_keyword? natal_period:anomalies_natal_period? anomalies_keyword <Nodes::Anomaly::Exists>
+    end
+
+    rule anomalies_no_keyword
+      space ('no' / 'some') word_break
+    end
+
+    rule anomalies_natal_period
+      (prenatal_keyword / postnatal_keyword)
+    end
+
+    rule anomalies_keyword
+      space 'anomalies' word_break
+    end
+  end
+end

data/lib/canql/grammars/batch_types.treetop

@@ -0,0 +1,11 @@
+module Canql
+  grammar BatchTypes
+    rule batch_type
+      paediatric <Nodes::BatchTypeNode>
+    end
+
+    rule paediatric
+      'paediatric' <Nodes::PaediatricNode>
+    end
+  end
+end

data/lib/canql/grammars/dates.treetop

@@ -0,0 +1,39 @@
+module Canql
+  grammar Dates
+    rule fuzzy_date
+      date:(between_dates / on_dates) word_break <Nodes::FuzzyDateNode>
+    end
+
+    rule on_dates
+      space ('on' / 'in') space date_fragment <Nodes::SpecificDateNode>
+    end
+
+    rule between_dates
+      space 'between' space start:date_fragment space 'and' space finish:date_fragment <Nodes::FragmentedDateRangeNode>
+    end
+
+    rule date_fragment
+     fragment:(daterange / year_quarter / chronic_date) word_break <Nodes::DateFragmentNode>
+    end
+
+    rule daterange
+      day_or_month? day_or_month? year <Nodes::DateRangeNode>
+    end
+
+    rule day_or_month
+      [0-9] 1..2 ('.' / '/')
+    end
+
+    rule year
+      [0-9] 4..4
+    end
+
+    rule year_quarter
+      'q' [1-4] space year <Nodes::YearQuarterNode>
+    end
+
+    rule chronic_date
+      (!(space ('and' / 'at' / 'with' / 'who')) .)+ <Nodes::ChronicDateNode>
+    end
+  end
+end

data/lib/canql/grammars/e_base_records.treetop

@@ -0,0 +1,82 @@
+module Canql
+  grammar EBaseRecords
+    rule action_or_ebr
+      and_keyword? action_and_ebr / actions / e_base_records
+    end
+
+    rule action_and_ebr
+      actions and_keyword e_base_records
+    end
+
+    rule e_base_records
+      unprocessed_keyword types:batch_types? records_keyword <Nodes::EBaseRecordsNode>
+    end
+
+    rule batch_types
+      space allowed_types word_break <Nodes::BatchTypesNode>
+    end
+
+    rule allowed_types
+      batch_type types:more_types* <Nodes::AllowedTypesNode>
+    end
+
+    rule more_types
+      ','? space? ('or' space)? batch_type <Nodes::MoreTypesNode>
+    end
+
+    rule with_keyword
+      space 'with' word_break
+    end
+
+    rule actions
+      action_type action_keyword action_provider? <Nodes::ActionsNode>
+    end
+
+    rule action_provider
+      space 'at' space provider:(action_provider_code / action_provider_name)
+    end
+
+    rule action_type
+      space accepted_action word_break
+    end
+
+    rule accepted_action
+     'wait' / 'proforma' / 'transfer' / 'notes' / 'child' /
+      'qa' / 'tag' / 'qc' / 'query' /
+      'moreinfo' / 'search' / 'check' / 'gpsearch'
+    end
+
+    rule action_keyword
+      space 'action' word_break
+    end
+
+    rule at_keyword
+      space 'at' word_break
+    end
+
+    rule action_provider_code
+      provider_type space code:(!' ' .)+ <Nodes::ActionProviderCodeNode>
+    end
+
+    rule action_provider_name
+      short_desc:(!(space provider_type) .)+ space provider_type <Nodes::ActionProviderNameNode>
+    end
+
+    # TODO: support cancer network?
+    rule provider_type
+      'hospital'
+    end
+
+    rule unprocessed_keyword
+      space 'unprocessed' word_break
+    end
+
+    rule records_keyword
+      space 'records' word_break
+    end
+
+    rule and_keyword
+      space 'and' word_break
+    end
+  end
+end

data/lib/canql/grammars/main.treetop

@@ -0,0 +1,86 @@
+grammar Canql
+  include Registry
+  include Patient
+  include Anomaly
+  include TestResult
+  include Dates
+  include EBaseRecords
+  include BatchTypes
+  include Age
+
+  # The root grammar
+  rule query
+    #quantity:record_count? pre:preconditions* cases_keyword post:additional_conditions*
+    quantity:record_count? pre:preconditions* cases_keyword post:additional_conditions* with_clause?
+  end
+
+  rule word_break
+    !(!(' '/',') .)
+  end
+
+  rule space
+    ' '+
+  end
+
+  rule comma
+    space? (',' / 'and') space?
+  end
+
+  rule number
+    [0-9]+
+  end
+
+  rule record_count
+    all_keyword
+    /
+    'first' space number <Nodes::RecordCountNode>
+  end
+
+  rule all_keyword
+     'all' word_break
+  end
+
+  rule cases_keyword
+     space subject:('cases' / 'babies') word_break
+  end
+
+  rule preconditions
+    registry / gender / outcome
+  end
+
+  rule additional_conditions
+    and_keyword? (expected / with_birth_date / with_death_date)
+  end
+
+  rule with_clause
+    with_keyword post:with_conditions+
+  end
+
+  rule with_keyword
+     space 'with' word_break
+  end
+
+  rule and_keyword
+     space 'and' word_break
+  end
+
+  rule existance_keyword
+     space ('missing' / ('field' 's'?) / 'populated') word_break
+  end
+
+  rule no_keyword
+     space 'no' word_break
+  end
+
+  rule prenatal_keyword
+    space 'prenatal' word_break
+  end
+
+  rule postnatal_keyword
+    space 'postnatal' word_break
+  end
+
+  rule with_conditions
+     anomalies / test_results / patient_field_existance / mother_conditions / action_or_ebr
+  end
+end

data/lib/canql/grammars/patient.treetop

@@ -0,0 +1,55 @@
+module Canql
+  grammar Patient
+    rule gender
+      space gender:('male' / 'female') word_break <Nodes::Patient::GenderNode>
+    end
+
+    rule outcome
+      space outcome:('stillborn' / 'liveborn' / 'miscarried' / 'terminated' / 'registrable' / 'non-registrable' ) word_break <Nodes::Patient::OutcomeNode>
+    end
+
+    rule expected_keyword
+      space ('expected' / 'due') word_break
+    end
+
+    rule expected
+      expected_keyword fuzzy_date <Nodes::Patient::ExpectedDateRangeNode>
+    end
+
+    rule patient_field_existance
+      and_keyword? field_existance_modifier:existance_keyword patient_field_list:patient_field_list  <Nodes::Patient::FieldExists>
+    end
+
+    rule patient_fields_keyword
+      space 'field' 's'? word_break
+    end
+
+    rule patient_field_list
+      space patient_field_names (comma patient_field_names)*
+    end
+
+    rule patient_field_names
+      patient_field_name:('date of birth' / 'dob' / 'nhs number' / 'postcode' / 'birth weight' / 'place of delivery' / 'sex' / 'outcome')
+    end
+
+    rule mother_conditions
+      and_keyword? space subject:'mother' word_break mother_additional_conditions mother_with_clause?
+    end
+
+    rule mother_additional_conditions
+      mother_age_conditions*
+    end
+
+    rule mother_age_conditions
+      and_keyword? (with_birth_date / with_death_date)
+    end
+
+    rule mother_with_clause
+      with_keyword? post:mother_with_conditions+
+    end
+
+    rule mother_with_conditions
+      patient_field_existance
+    end
+  end
+end

data/lib/canql/grammars/registry.treetop

@@ -0,0 +1,124 @@
+module Canql
+  grammar Registry
+    rule registry
+      space registry:(registry_code / registry_abbr) <Nodes::RegistryNode>
+    end
+
+    rule registry_code
+      [0-9] 2..2 <Nodes::RegistryCodeNode>
+    end
+
+    rule registry_abbr
+      (england / east_mids / thames / east / yorkshire / north_east / north_west /
+        west_mids / south_west / wessex / london / limbo)
+    end
+
+    rule thames
+      ('thames valley' / 'thames')
+      {
+        def to_registrycode
+          '68'
+        end
+      }
+    end
+
+    rule east_mids
+      ('east mids' / 'east midlands and south yorkshire' / 'east midlands')
+      {
+        def to_registrycode
+          '72'
+        end
+      }
+    end
+
+    rule yorkshire
+      'yorkshire'
+      {
+        def to_registrycode
+          '93'
+        end
+      }
+    end
+
+    rule north_east
+      'north east'
+      {
+        def to_registrycode
+          '73'
+        end
+      }
+    end
+
+    rule north_west
+      'north west'
+      {
+        def to_registrycode
+          '94'
+        end
+      }
+    end
+
+    rule west_mids
+      ('west mids' / 'west midlands')
+      {
+        def to_registrycode
+          '99'
+        end
+      }
+    end
+
+    rule south_west
+      'south west'
+      {
+        def to_registrycode
+          '84'
+        end
+      }
+    end
+
+    rule wessex
+      'wessex'
+      {
+        def to_registrycode
+          '70'
+        end
+      }
+    end
+
+    rule london
+      ('london and south east' / 'london')
+      {
+        def to_registrycode
+          '95'
+        end
+      }
+    end
+
+    rule east
+      ('east of england' / 'east')
+      {
+        def to_registrycode
+          '96'
+        end
+      }
+    end
+
+    rule limbo
+      'limbo'
+      {
+        def to_registrycode
+          '01'
+        end
+      }
+    end
+
+    rule england
+      'england'
+      {
+        def to_registrycode
+          '00'
+        end
+      }
+    end
+  end
+end