quby-compiler 0.3.3 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf1f976b37af794cf97fffb6ab66d420951f6d24ade6362851e0564ac504485f
-  data.tar.gz: bf363984e69fd45a2ccae488f2ea587d0482dd2cbf501a7b36fffc314368b6f3
+  metadata.gz: 9afe2a68ca9334f324a6d096918e625d432016b631794fdfe1db307acd25ebff
+  data.tar.gz: 87cce57c50f1509b48ef072d53dfa4f56a8880b3dc82c002dbd9c6b70a368c7b
 SHA512:
-  metadata.gz: d3b3470eea0acae3245483e780baa6fe9e9e321fc37ba6422ac5674aeaf5e7ad2a3c145aa6260359a12da34b5d818187e0d9f6de4b177886c5764631aecfd0e2
-  data.tar.gz: ad44885ecf958d9cabb332081dda45710c6baa8a96620b1998c7d86c56995051547f28d7b9b2f2776ab1df5335677d6dce904b56a1c56fd565583b16db7f9e7e
+  metadata.gz: 32acc8cd41565840352dc2c5b3137aca5f31422ee000424dd0b412d9ae9cadde00ff7d1eb5b92eb54b6b4ee493bd581413aee3c93fd01c2fd176fc57d7ec2e3b
+  data.tar.gz: 6f677f3ea56d37009e637298d58d1969761fa6793c412b42dc8068ca99bb47a185427d31beae7e29b60236ea724929e911ebafca78db2e0a2755babf9b1956bd

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/CHANGELOG.md

@@ -1,6 +1,23 @@
+# 0.3.7
+
+* Remove last_update
+
+# 0.3.6
+
+* `outcome_table` panel dsl method now exports the given outcome table definition to `roqua.json`
+  This can't be used in combination with the `outcome_table: ` attribute in score schemas.
+
+# 0.3.5
+
+* Allow score_schema's outcome_table to be set to nil to hide values from outcome tables
+
+# 0.3.4
+
+* Added preliminary support for sliders to the v2 output.
+
 # 0.3.3
 
-Replace `options={}` with `**options` in the builders to prevent prepare for ruby 3.0
+* Replace `options={}` with `**options` in the builders to prevent prepare for ruby 3.0
 
 # 0.3.2
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quby-compiler (0.3.3)
+    quby-compiler (0.3.7)
       actionview (>= 5.0)
       activemodel (>= 5.0)
       activesupport (>= 5.0)
@@ -15,86 +15,87 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (6.0.3.5)
-      activesupport (= 6.0.3.5)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    active_interaction (3.8.3)
-      activemodel (>= 4, < 7)
-    activemodel (6.0.3.5)
-      activesupport (= 6.0.3.5)
-    activerecord (6.0.3.5)
-      activemodel (= 6.0.3.5)
-      activesupport (= 6.0.3.5)
-    activesupport (6.0.3.5)
+    active_interaction (4.0.6)
+      activemodel (>= 5, < 7)
+      activesupport (>= 5, < 7)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    appsignal (2.10.12)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appsignal (3.0.15)
       rack
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    dry-configurable (0.12.0)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
     dry-struct (1.4.0)
       dry-core (~> 0.5, >= 0.5)
       dry-types (~> 1.5)
       ice_nine (~> 0.11)
-    dry-types (1.5.0)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
     erubi (1.10.0)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    loofah (2.9.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
     naught (1.1.0)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogumbo (2.0.3)
+    nokogumbo (2.0.5)
       nokogiri (~> 1.8, >= 1.8.4)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     rake (12.3.3)
-    redcarpet (3.5.0)
-    roqua-support (0.3.5)
-      active_interaction (~> 3.0)
-      activesupport (>= 5.1, < 6.1)
-      appsignal (>= 2.9, < 2.11)
+    redcarpet (3.5.1)
+    roqua-support (0.4.1)
+      active_interaction (>= 3.0, < 5.0)
+      activesupport (>= 5.2, < 6.2)
+      appsignal (>= 2.9, < 3.1)
       naught (~> 1.0)
       with_advisory_lock (~> 3.2)
     rspec (3.9.0)
@@ -110,12 +111,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     with_advisory_lock (3.2.0)
       activerecord (>= 3.2)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -127,4 +127,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

data/exe/quby-compile

@@ -8,7 +8,6 @@ require "quby/compiler"
 
 output_path = "output"
 lookup_tables_path = "lookup_tables"
-seeds_path = "seeds"
 
 OptionParser.new do |opts|
   opts.banner = "Usage: quby-compile FILE_OR_DIRS [options]"
@@ -19,10 +18,6 @@ OptionParser.new do |opts|
   opts.on("--lookup-tables=INPUT") do |value|
     lookup_tables_path = value
   end
-
-  opts.on("--seeds=INPUT") do |value|
-    seeds_path = value
-  end
 end.parse!
 
 paths = ARGV.flat_map do |file_or_dir|
@@ -38,15 +33,11 @@ lookup_tables = Quby::Compiler::Entities::LookupTables.new(lookup_tables_path)
 paths.each do |path|
   puts "Compiling #{path}"
 
-  key = File.basename(path, File.extname(path))
+  key = File.basename(File.dirname(path))
   sourcecode = File.read(path)
-  last_update = File.mtime(path)
-  seed_path = File.join(seeds_path, "#{key}.yml")
-  seeds = File.exist?(seed_path) ? YAML.load(File.read(seed_path)) : nil
-  compiled = Quby::Compiler.compile(key, sourcecode, path: path, seeds: seeds, lookup_tables: lookup_tables, last_update: last_update)
+  compiled = Quby::Compiler.compile(key, sourcecode, path: path, lookup_tables: lookup_tables)
 
   FileUtils.mkdir_p(File.join(output_path, key))
-
   compiled[:outputs].each do |type, output|
     next unless output
     File.open(File.join(output_path, key, output.filename), 'w') do |file|

data/lib/quby/compiler/dsl.rb

@@ -9,15 +9,15 @@ module Quby
   module Compiler
     module DSL
       def self.build_from_definition(definition)
-        Entities::Questionnaire.new(definition.key, last_update: definition.timestamp).tap do |questionnaire|
+        Entities::Questionnaire.new(definition.key).tap do |questionnaire|
           builder = QuestionnaireBuilder.new(questionnaire, lookup_tables: definition.lookup_tables)
           builder.instance_eval(definition.sourcecode, definition.path) if definition.sourcecode
           questionnaire.callback_after_dsl_enhance_on_questions
         end
       end
 
-      def self.build(key, sourcecode = nil, path: nil, timestamp: nil, lookup_tables: {}, &block)
-        Entities::Questionnaire.new(key, last_update: timestamp).tap do |questionnaire|
+      def self.build(key, sourcecode = nil, path: nil, lookup_tables: {}, &block)
+        Entities::Questionnaire.new(key).tap do |questionnaire|
           builder = QuestionnaireBuilder.new(questionnaire, lookup_tables: lookup_tables)
           builder.instance_eval(sourcecode, path || key) if sourcecode
           builder.instance_eval(&block) if block

data/lib/quby/compiler/entities/outcome_table.rb

@@ -15,6 +15,7 @@ module Quby
         validates :score_keys, :subscore_keys, :questionnaire, :key, presence: true
         validates :name, presence: true, if: proc { |table| table.default_collapsed }
         validate :references_existing_score_keys
+        validate :no_outcome_tables_defined_in_score_schemas
 
         def references_existing_score_keys
           (score_keys - questionnaire.score_schemas.values.map(&:key)).each do |missing_key|
@@ -25,6 +26,17 @@ module Quby
             errors.add :subscore_keys, "#{missing_key.inspect} not found in subscore schemas"
           end
         end
+
+        def no_outcome_tables_defined_in_score_schemas
+          if questionnaire.score_schemas.values.any? do |schema|
+            schema.subscore_schemas.any? do |subscore|
+              subscore.outcome_table != :main
+            end
+          end
+            errors.add :score_schemas,
+              "Outcome table associations defined in score schemas should not be combined with explicit outcome tables"
+          end
+        end
       end
     end
   end

data/lib/quby/compiler/entities/questionnaire.rb

@@ -29,10 +29,9 @@ module Quby
 
         RESPONDENT_TYPES = %i( profess patient parent second_parent teacher caregiver )
 
-        def initialize(key, last_update: Time.now)
+        def initialize(key)
           @key = key
           @sbg_domains = []
-          @last_update = Time.at(last_update.to_i)
           @score_calculations = {}.with_indifferent_access
           @charts = Charting::Charts.new
           @fields = Fields.new(self)
@@ -92,7 +91,6 @@ module Quby
 
         attr_accessor :last_author
         attr_accessor :allow_hotkeys # allow hotkeys for :all views, just :bulk views (default), or :none for never
-        attr_accessor :last_update
 
         attr_accessor :charts
 

data/lib/quby/compiler/entities/questions/float_question.rb

@@ -5,6 +5,15 @@ module Quby
     module Entities
       module Questions
         class FloatQuestion < Question
+          def as_json(options = {})
+            super.merge(
+              minimum: minimum,
+              maximum: maximum,
+              step: 0.01, # fixed in v1.
+              # defaultPosition: default_position # Needs discussion, can be number or string "hidden"
+            )
+          end
+
           def size
             @size || 30
           end

data/lib/quby/compiler/entities/questions/integer_question.rb

@@ -5,6 +5,15 @@ module Quby
     module Entities
       module Questions
         class IntegerQuestion < Question
+          def as_json(options = {})
+            super.merge(
+              minimum: minimum,
+              maximum: maximum,
+              step: 1, # fixed in v1.
+              # defaultPosition: default_position # Needs discussion, can be number or string "hidden"
+            )
+          end
+
           def size
             @size || 30
           end

data/lib/quby/compiler/entities/subscore_schema.rb

@@ -16,7 +16,8 @@ module Quby
         attribute :calculation_key?, Types::Symbol
         # [Optional argument] The name of the outcome table where this subscore should be shown. Used for cases where scores
         # differ in subscores too much to be shown as one table. By default, all scores end up in the `:main` table.
-        attribute :outcome_table, Types::Symbol.default(:main).meta(omittable: true)
+        # When outcome_table is explicitly nil, the value should not be shown in outcome tables
+        attribute :outcome_table, Types::Symbol.optional.default(:main)
       end
     end
   end

data/lib/quby/compiler/instance.rb

@@ -7,12 +7,12 @@ module Quby
         @lookup_tables = lookup_tables
       end
 
-      def compile(key:, sourcecode:, seeds:, path: nil, last_update: nil, &block)
+      def compile(key:, sourcecode:, path: nil, &block)
         if block # defined in block for tests
           questionnaire = DSL.build(key, path: path, &block)
         else # sourcecode given as string
-          tempfile = Tempfile.new(key)
-          questionnaire = Entities::Questionnaire.new(key, last_update: last_update)
+          tempfile = Tempfile.new([key, '.rb'])
+          questionnaire = Entities::Questionnaire.new(key)
           Thread.current["quby-questionnaire-loading"] = Quby::Compiler::DSL::QuestionnaireBuilder.new(questionnaire, lookup_tables: lookup_tables)
 
           tempfile.puts "Thread.current['quby-questionnaire-loading'].instance_eval do"
@@ -41,7 +41,7 @@ module Quby
             seeds: Output.new(
               key: :seeds,
               filename: "seeds.yml",
-              content: YAML.dump(Outputs::SeedSerializer.new(questionnaire, seeds).generate),
+              content: YAML.dump(Outputs::SeedSerializer.new(questionnaire).generate),
             ),
             quby_frontend_v1: Output.new(
               key: :quby_frontend_v1,

data/lib/quby/compiler/outputs/quby_frontend_v1_serializer.rb

@@ -322,7 +322,6 @@ module Quby
             licensor: questionnaire.licensor,
             language: questionnaire.language,
             renderer_version: questionnaire.renderer_version,
-            last_update: questionnaire.last_update,
             last_author: questionnaire.last_author,
             extra_css: questionnaire.extra_css,
             allow_switch_to_bulk: questionnaire.allow_switch_to_bulk,

data/lib/quby/compiler/outputs/roqua_serializer.rb

@@ -84,19 +84,56 @@ module Quby
         #   <subscore_key:Symbol>: <subscore.label:String> # headers for each subscore key for all tables.
 
         def outcome_tables_schema
+          if questionnaire.outcome_tables.present?
+            outcome_tables_from_definition
+          else
+            outcome_tables_from_score_schemas
+          end
+        end
+
+        def outcome_tables_from_definition
+          # hash of tables, with the score keys (rows) and subscore keys (columns) used for each
+          tables = {}
+          # hash of `subscore_key: subscore_label` pairs used in tables
+          headers = {}
+
+          questionnaire.outcome_tables.each do |table|
+            tables[table.key] = {name: table.name,
+                                 default_collapsed: table.default_collapsed,
+                                 score_keys: table.score_keys,
+                                 subscore_keys: table.subscore_keys}.compact
+
+            table.subscore_keys.each do |subscore_key|
+              table.score_keys.find do |score_key|
+                subschema = questionnaire.score_schemas[score_key].subscore_schemas.find do |subschema|
+                  subschema.key == subscore_key
+                end
+                headers[subscore_key] = subschema&.label
+              end
+            end
+          end
+
+          {
+            headers: headers,
+            tables: tables,
+          }
+        end
+
+        def outcome_tables_from_score_schemas
           # hash of tables, with the score keys (rows) and subscore keys (columns) used for each
           tables = Hash.new{ |hash, key| hash[key] = {score_keys: Set.new, subscore_keys: Set.new } }
           # hash of `subscore_key: subscore_label` pairs used in tables
           headers = {}
-          
+
           questionnaire.score_schemas.values.each do |schema|
             schema.subscore_schemas.each do |subschema|
+              next if subschema.outcome_table.blank?
               tables[subschema.outcome_table][:subscore_keys] << subschema.key
               tables[subschema.outcome_table][:score_keys] << schema.key
               headers[subschema.key] = subschema.label
             end
           end
-          
+
           {
             headers: headers,
             tables: tables,

data/lib/quby/compiler/outputs/seed_serializer.rb

@@ -7,23 +7,19 @@ module Quby
         attr_reader :questionnaire
         attr_reader :seeds
 
-        def initialize(questionnaire, seeds)
+        def initialize(questionnaire)
           @questionnaire = questionnaire
           @seeds = seeds || []
         end
 
         def generate
-          roqua_keys = seeds.present? ? seeds.map { |seed| seed["key"] } : questionnaire.roqua_keys
-
-          roqua_keys.map do |roqua_key|
-            seed = seeds.find { |seed| seed["key"] == roqua_key } || {}
-
+          questionnaire.roqua_keys.map do |roqua_key|
             new_seed = Services::QubyProxy.new(
               questionnaire,
               quby_key: questionnaire.key,
               roqua_key: roqua_key,
               skip_score_keys_consistency_check: true
-            ).generate(seed)
+            ).generate
 
             Services::SeedDiff.new.apply_patch(new_seed, questionnaire.seeds_patch[roqua_key])
           end

data/lib/quby/compiler/services/definition_validator.rb

@@ -15,8 +15,8 @@ module Quby
 
         def validate(definition)
           questionnaire = DSL.build_from_definition(definition)
+          validate_metadata(questionnaire)
           validate_fields(questionnaire)
-          validate_title(questionnaire)
           validate_questions(questionnaire)
           validate_scores(questionnaire)
           validate_table_edgecases(questionnaire)
@@ -25,7 +25,6 @@ module Quby
           validate_outcome_tables(questionnaire)
           validate_markdown_fields(questionnaire) if questionnaire.validate_html
           validate_raw_content_items(questionnaire) if questionnaire.validate_html
-          validate_scores(questionnaire)
         # Some compilation errors are Exceptions (pure syntax errors) and some StandardErrors (NameErrors)
         rescue Exception => exception # rubocop:disable Lint/RescueException
           definition.errors.add(:sourcecode, {message: "Questionnaire error: #{definition.key}\n" \
@@ -33,6 +32,20 @@ module Quby
                                               backtrace: exception.backtrace[0..20]})
         end
 
+        def validate_metadata(questionnaire)
+          if questionnaire.title.blank?
+            fail "Questionnaire title is missing."
+          end
+
+          if questionnaire.short_description && questionnaire.short_description.size > 255
+            fail "Questionnaire short_description is too long."
+          end
+
+          if questionnaire.description && questionnaire.description.size > 255
+            fail "Questionnaire description is too long."
+          end
+        end
+
         def validate_fields(questionnaire)
           questionnaire.fields.input_keys
                               .find { |k| !k.is_a?(Symbol) }
@@ -42,12 +55,6 @@ module Quby
                              &.tap { |k| fail "Answer key #{k} is not a symbol" }
         end
 
-        def validate_title(questionnaire)
-          if questionnaire.title.blank?
-            fail "Questionnaire title is missing."
-          end
-        end
-
         def validate_questions(questionnaire)
           questionnaire.answer_keys.each do |key|
             validate_key_format(key)
@@ -81,6 +88,13 @@ module Quby
             fail "Score #{score.key} does not have a score schema" unless score_schema
             fail "Score label langer dan 100 tekens (geeft problemen oru accare)\n #{score_schema.label}" if score_schema.label&.length > 100
           end
+
+          export_keys = questionnaire.score_schemas.flat_map { |_key, score_schema|
+            score_schema.subscore_schemas.map(&:export_key)
+          }
+
+          duplicate_export_keys = export_keys.tally.select { |key, count| count > 1 }.keys
+          fail "Score export keys not unique, duplicates: #{duplicate_export_keys}" if duplicate_export_keys.present?
         end
 
         def validate_question_options(questionnaire, question)
@@ -241,8 +255,6 @@ scores_schema tables to the resulting seed."
 
         def validate_score_label_present(score)
           fail "Score #{score.key} label must be passed in as an option." unless score.label.present?
-
-
         end
 
         def validate_subquestion_absence_in_select(question)

data/lib/quby/compiler/services/quby_proxy.rb

@@ -22,7 +22,8 @@ module Quby
           @options = options
         end
 
-        def generate(seed)
+        def generate
+          seed = {}
           question_titles = generate_question_titles
           d_qtypes = {}
           vars = []

data/lib/quby/compiler/version.rb

@@ -1,5 +1,5 @@
 module Quby
   module Compiler
-    VERSION = "0.3.3"
+    VERSION = "0.3.7"
   end
 end

data/lib/quby/compiler.rb

@@ -29,13 +29,11 @@ require 'quby/compiler/outputs'
 
 module Quby
   module Compiler
-    def self.compile(key, sourcecode, path: nil, seeds:, lookup_tables:, last_update: nil, &block)
+    def self.compile(key, sourcecode, path: nil, lookup_tables:, &block)
       Quby::Compiler::Instance.new(lookup_tables: lookup_tables).compile(
         key: key,
         sourcecode: sourcecode,
         path: path,
-        seeds: seeds,
-        last_update: last_update,
         &block
       )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quby-compiler
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.7
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -271,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Quby::Compiler compiles a DSL for questionnaires to JSON