quby 4.0.3 → 5.0.0.pre1

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

@@ -1,298 +0,0 @@
-# frozen_string_literal: true
-require 'nokogumbo'
-require 'active_model'
-require 'quby/questionnaires/entities/questionnaire'
-
-module Quby
-  module Questionnaires
-    module Services
-      class DefinitionValidator < ActiveModel::Validator
-        MAX_KEY_LENGTH  = 19
-        KEY_PREFIX      = 'v_'
-
-        attr_reader :definition
-        attr_reader :questionnaire
-
-        def validate(definition)
-          questionnaire = DSL.build_from_definition(definition)
-          validate_fields(questionnaire)
-          validate_title(questionnaire)
-          validate_questions(questionnaire)
-          validate_scores(questionnaire)
-          validate_table_edgecases(questionnaire)
-          validate_flags(questionnaire)
-          validate_respondent_types(questionnaire)
-          validate_outcome_tables(questionnaire)
-          validate_markdown_fields(questionnaire) if questionnaire.validate_html
-          validate_raw_content_items(questionnaire) if questionnaire.validate_html
-        # 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" \
-                                                       "#{exception.message}",
-                                              backtrace: exception.backtrace[0..5].join("<br/>")})
-        end
-
-        def validate_fields(questionnaire)
-          questionnaire.fields.input_keys
-                              .find { |k| !k.is_a?(Symbol) }
-                             &.tap { |k| fail "Input key #{k} is not a symbol" }
-          questionnaire.fields.answer_keys
-                              .find { |k| !k.is_a?(Symbol) }
-                             &.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)
-          end
-
-          questionnaire.question_hash.each_value do |question|
-            validate_question(question)
-            subquestions_cant_have_default_invisible question
-            validate_subquestion_absence_in_select question
-            validate_placeholder_options_nil_values question
-            validate_values_unique question
-
-            validate_question_options(questionnaire, question)
-            validate_presence_of_titles question
-            validate_no_spaces_before_question_nr_in_title question
-          end
-        end
-
-        def validate_question(question)
-          unless question.valid?
-            fail "Question #{question.key} is invalid: #{question.errors.full_messages.join(', ')}"
-          end
-        end
-
-        def validate_scores(questionnaire)
-          questionnaire.scores.each do |score|
-            validate_score_key_length(score)
-            validate_score_label_present(score)
-          end
-        end
-
-        def validate_question_options(questionnaire, question)
-          question.options.each do |option|
-            msg_base = "Question #{option.question.key} option #{option.key}"
-            to_be_hidden_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: msg_base)
-            to_be_shown_questions_exist_and_not_subquestion?(questionnaire, option, msg_base: msg_base)
-          end
-        end
-
-        def validate_presence_of_titles(question)
-          return if question.allow_blank_titles
-          if !question.subquestion? && question.title.blank? && question.context_free_title.blank?
-            fail "Question #{question.key} must define either `:title` or `:context_free_title`."
-          end
-        end
-
-        def validate_table_edgecases(questionnaire)
-          questionnaire.panels.each do |panel|
-            tables = panel.items.select { |item| item.is_a?(Entities::Table) }
-            tables.each do |table|
-              questions = table.items.select { |item| item.is_a?(Entities::Question) }
-              questions.each { |question| validate_table_question(question) }
-            end
-          end
-        end
-
-        def validate_flags(questionnaire)
-          questionnaire.flags.each_value do |flag|
-            validate_flag_shows(questionnaire, flag)
-            validate_flag_hides(questionnaire, flag)
-            validate_flag_depends_on(questionnaire, flag)
-          end
-        end
-
-        def validate_flag_shows(questionnaire, flag)
-          unknown_questions = flag.shows_questions.select { |key| !questionnaire.key_in_use?(key) }
-          return if unknown_questions.blank?
-
-          fail ArgumentError, "Flag '#{key}' has unknown shows_questions keys #{unknown_questions}"
-        end
-
-        def validate_flag_hides(questionnaire, flag)
-          unknown_questions = flag.hides_questions.select { |key| !questionnaire.key_in_use?(key) }
-          return if unknown_questions.blank?
-
-          fail ArgumentError, "Flag '#{key}' has unknown hides_questions keys #{unknown_questions}"
-        end
-
-        def validate_flag_depends_on(questionnaire, flag)
-          return if flag.depends_on.blank? || questionnaire.flags.key?(flag.depends_on)
-
-          fail ArgumentError, "Flag #{flag.key} depends_on nonexistent flag '#{flag.depends_on}'"
-        end
-
-        def validate_respondent_types(questionnaire)
-          valid_respondent_types = Entities::Questionnaire::RESPONDENT_TYPES
-
-          invalid_types = questionnaire.respondent_types - valid_respondent_types
-
-          if invalid_types.present?
-            fail "Invalid respondent types: :#{invalid_types.join(', :')}\n"\
-                 "Choose one or more from: :#{valid_respondent_types.join(', :')}"
-          end
-        end
-
-        def validate_outcome_tables(questionnaire)
-          questionnaire.outcome_tables.each do |table|
-            next if table.valid?
-            fail "Outcome table #{table.errors.full_messages}"
-          end
-        end
-
-        def to_be_hidden_questions_exist_and_not_subquestion?(questionnaire, option, msg_base:)
-          return if option.hides_questions.blank?
-          msg_base += " hides_questions"
-          option.hides_questions.each do |key|
-            validate_question_key_exists?(questionnaire, key, msg_base: msg_base)
-            validate_not_subquestion(questionnaire, key, msg_base: msg_base)
-          end
-        end
-
-        def to_be_shown_questions_exist_and_not_subquestion?(questionnaire, option, msg_base:)
-          return if option.shows_questions.blank?
-          msg_base += " shows_questions"
-          option.shows_questions.each do |key|
-            validate_question_key_exists?(questionnaire, key, msg_base: msg_base)
-            validate_not_subquestion(questionnaire, key, msg_base: msg_base)
-          end
-        end
-
-        def subquestions_cant_have_default_invisible(question)
-          if question.subquestion? && question.default_invisible
-            fail "Question #{question.key} is a subquestion with default_invisible."
-          end
-        end
-
-        private
-
-        # Don't write question numbers as "  1. Title", but as "1\\. Title".
-        def validate_no_spaces_before_question_nr_in_title(question)
-          if question.title && question.title.match(/^\s{2,}\d+\\\./)
-            fail "Question with number does not need leading spaces."
-          end
-        end
-
-        def validate_question_key_exists?(questionnaire, key, msg_base:)
-          unless questionnaire.question_hash[key]
-            fail msg_base + " references nonexistent question #{key}"
-          end
-        end
-
-        def validate_not_subquestion(questionnaire, key, msg_base:)
-          if questionnaire.question_hash[key].subquestion?
-            fail msg_base + " references subquestion #{key}"
-          end
-        end
-
-        def validate_key_format(key)
-          if key.to_s.length > MAX_KEY_LENGTH
-            fail "Key '#{key}' should contain at most #{MAX_KEY_LENGTH} characters."
-          end
-          unless key.to_s.start_with?(KEY_PREFIX)
-            fail "Key '#{key}' should start with '#{KEY_PREFIX}'."
-          end
-        end
-
-        def validate_score_key_length(score)
-          if score.key.to_s.length > MAX_KEY_LENGTH
-            fail "Score key `#{score.key}` should contain at most #{MAX_KEY_LENGTH} characters."
-          end
-        end
-
-        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)
-          return unless question.type == :select
-          question.options.each do |option|
-            unless option.questions.empty?
-              fail "Question '#{question.key}' of type ':select' may not include other questions."
-            end
-          end
-        end
-
-        def validate_placeholder_options_nil_values(question)
-          question.options.each do |question_option|
-            if question_option.placeholder && question_option.value.present?
-              fail "#{question.key}:#{question_option.key}: Placeholder options should not have values defined."
-            end
-          end
-        end
-
-        def validate_values_unique(question)
-          return if question.type == :check_box || question.allow_duplicate_option_values
-
-          question.options.each_with_object([]) do |question_option, seen_values|
-            next if question_option.placeholder || question_option.inner_title
-
-            fail "#{question.key}:#{question_option.key}: Has no option value defined." if question_option.value.blank?
-            if seen_values.include?(question_option.value)
-              fail "#{question.key}:#{question_option.key}: " \
-                      "Another option with value #{question_option.value} is already defined."
-            end
-            seen_values << question_option.value
-          end
-        end
-
-        def validate_table_question(question)
-          question.subquestions.each do |subquestion|
-            if subquestion.presentation != :next_to_title
-              fail "Question #{question.key} is inside a table, but has a subquestion #{subquestion.key}, " \
-                    "which is not allowed."
-            end
-          end
-        end
-
-        def validate_markdown_fields(questionnaire)
-          questionnaire.panels.each do |panel|
-            panel.items.select { |item| item.is_a?(Entities::Text) }.each do |text_item|
-              validate_markdown(text_item.str, text_item.str)
-            end
-          end
-          questionnaire.questions.each do |question|
-            Entities::Question::MARKDOWN_ATTRIBUTES.each do |attr|
-              validate_markdown(question.send(attr), "#{question.key}.#{attr}")
-              question.options.each do |option|
-                Entities::QuestionOption::MARKDOWN_ATTRIBUTES.each do |option_attr|
-                  validate_markdown(option.send(option_attr), "#{question.key}:#{option.key}.#{option_attr}")
-                end
-              end
-            end
-          end
-        end
-
-        def validate_raw_content_items(questionnaire)
-          questionnaire.panels.each do |panel|
-            panel.items.each do |item|
-              next if item.raw_content.blank?
-
-              validate_html(item.raw_content)
-            end
-          end
-        end
-
-        def validate_markdown(markdown, key)
-          validate_html(MarkdownParser.new(markdown).to_html, key)
-        end
-
-        def validate_html(html, key = nil)
-          fragment = Nokogiri::HTML5.fragment(html, max_errors: 3)
-          return unless fragment.errors.present?
-
-          fail "#{key || html} contains invalid html: #{fragment.errors.map(&:to_s).join(', ')}."
-        end
-      end
-    end
-  end
-end

data/spec/quby/questionnaires/dsl/calls_custom_methods_spec.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Quby::Questionnaires::DSL
-  describe CallsCustomMethods do
-
-    class TestCustomMethod
-      prepend CallsCustomMethods
-
-      attr_reader :test
-      def initialize(*args)
-        @test = 'attribute'
-      end
-    end
-
-    let(:custom_methods) { {custom: -> { 'custom_method' }} }
-    let(:test_object) { TestCustomMethod.new(custom_methods: custom_methods) }
-
-    describe 'prepending' do
-      it 'does not skip the actual initializer' do
-        expect(test_object.test).to eq('attribute')
-      end
-    end
-
-    describe '#method_missing' do
-      it 'allows the class to receive messages defined in custom_methods' do
-        expect(test_object.custom).to eq('custom_method')
-      end
-    end
-
-    describe '#respond_to_missing?' do
-      it 'also considers custom methods' do
-        expect(test_object.send(:respond_to_missing?, :custom)).to eq(true)
-      end
-    end
-  end
-end

data/spec/quby/questionnaires/dsl/charting/bar_chart_builder_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Quby::Questionnaires::DSL
-  describe BarChartBuilder do
-    it_behaves_like ChartBuilder
-
-    let(:questionnaire) { double(key: 'questionnaire_key') }
-
-    it 'makes a bar chart' do
-      expect(dsl { }).to be_an_instance_of(::Quby::Questionnaires::Entities::Charting::BarChart)
-    end
-
-    def dsl(key = :test, options = {}, &block)
-      builder = BarChartBuilder.new(questionnaire, key, options)
-      builder.build(&block)
-    end
-
-    it 'sets y-axis range' do
-      expect(dsl { range 0..40 }.y_range).to eq (0..40)
-    end
-
-    it 'sets y-axis tick interval' do
-      expect(dsl { tick_interval 1 }.tick_interval).to eq 1
-    end
-
-    it 'sets plotlines' do
-      plotlines =
-        dsl do
-          plotline 40, :orange
-          plotline 60, :red
-        end.plotlines
-
-      expect(plotlines).to eq [
-        {value: 40, color: :orange, width: 1, zIndex: 3},
-        {value: 60, color: :red, width: 1, zIndex: 3}
-      ]
-    end
-  end
-end

data/spec/quby/questionnaires/dsl/charting/chart_builder_spec.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-module Quby::Questionnaires::DSL
-  describe ChartBuilder do
-
-    let(:plottable_key) { :some_key }
-    let(:plottable) { Quby::Questionnaires::Entities::ScoreCalculation.new plottable_key, {} }
-    let(:questionnaire) do
-      double(key: 'questionnaire_key').tap do |questionnaire|
-        allow(questionnaire).to receive(:find_plottable).with(plottable_key).and_return plottable
-      end
-    end
-    let(:chart_plottables) { [] }
-    let(:chart_class) { Quby::Questionnaires::Entities::Charting::Chart }
-    before { ChartBuilder.set_chart_class(chart_class) }
-    let(:chart_builder) { ChartBuilder.new questionnaire, 'chart_key' }
-
-    def dsl(key = :test, options = {}, &block)
-      builder = ChartBuilder.new(questionnaire, key, options)
-      builder.build(&block)
-    end
-
-    describe '#plot' do
-      it 'fetches a plottable by key from the questionnaire' do
-        expect(questionnaire).to receive(:find_plottable).with(plottable_key)
-        chart_builder.plot plottable_key
-      end
-
-      it 'creates a plottable with the options merged into the plottable options' do
-        allow(plottable).to receive(:options).and_return({some: 'options', other: 'options'})
-        expect(Quby::Questionnaires::Entities::Charting::Plottable).to receive(:new)
-          .with(plottable.key,
-                some: 'different_options',
-                other: 'options',
-                questionnaire_key: 'questionnaire_key')
-        chart_builder.plot plottable_key, some: 'different_options'
-      end
-
-      it 'sets the label from a question title when no label is present' do
-        plottable = Quby::Questionnaires::Entities::Question.new plottable_key, title: 'some_title'
-        expect(questionnaire).to receive(:find_plottable).with(plottable_key).and_return plottable
-        expect(Quby::Questionnaires::Entities::Charting::Plottable).to receive(:new)
-          .with(plottable_key, questionnaire_key: 'questionnaire_key', label: 'some_title')
-        chart_builder.plot plottable_key
-      end
-
-      it 'does not set the label when it is given in the options' do
-        plottable = Quby::Questionnaires::Entities::Question.new plottable_key, title: 'some_title'
-        expect(questionnaire).to receive(:find_plottable).with(plottable_key).and_return plottable
-        expect(Quby::Questionnaires::Entities::Charting::Plottable).to receive(:new)
-          .with(plottable_key, questionnaire_key: 'questionnaire_key', label: 'some_label')
-        chart_builder.plot plottable_key, label: 'some_label'
-      end
-    end
-
-    describe '#y_categories' do
-      it 'assigns y_categories' do
-        categories = %w(Bad Great Best)
-        chart_builder.y_categories categories
-        expect(chart_builder.build { }.y_categories).to eq(categories)
-      end
-    end
-
-    describe '#plotband' do
-      it 'can set plotbands' do
-        plotbands =
-          dsl do
-            plotband 2, 5, :yellow
-            plotband 5, 8, :red
-          end.plotbands
-  
-        expect(plotbands).to eq [
-          {from: 2, to: 5, color: :yellow},
-          {from: 5, to: 8, color: :red}
-        ]
-      end
-    end
-
-    describe '#y_range_categories' do
-      it 'sets RangeCategories.new(*parameters).as_range_hash to the chart y_range_categories' do
-        expect(RangeCategories).to receive(:new).with(0, 'Zeer laag', 30).and_return(double(as_range_hash: 'foo'))
-        chart_builder.y_range_categories 0, 'Zeer laag', 30
-        expect(chart_builder.build { }.y_range_categories).to eq('foo')
-      end
-
-      it 'converts the parameters to a range hash' do
-        expected_categories = {(0.0...30.0) => "Zeer laag", (30.0...40.0) => "Laag", (40.0...60.0) => "Gemiddeld",
-                               (60.0...70.0) => "Hoog", (70.0..100.0) => "Zeer hoog"}
-        chart_builder.y_range_categories 0, 'Zeer laag',
-                                         30, 'Laag',
-                                         40, 'Gemiddeld',
-                                         60, 'Hoog',
-                                         70, 'Zeer hoog', 100
-        expect(chart_builder.build { }.y_range_categories).to eq(expected_categories)
-      end
-    end
-
-    describe '#range' do
-      it 'assigns y_range' do
-        chart_builder.range 0..5
-        expect(chart_builder.build { }.y_range).to eq(0..5)
-      end
-    end
-    describe '#validate' do
-      describe 'when there is no range defined but y_categories are present' do
-        it 'uses the 0..y_categories.count-1 as a range' do
-          chart_builder.y_categories %w(Bad Great Best)
-          expect(chart_builder.build { }.y_range).to eq(0..2)
-        end
-      end
-      describe 'when range and y_categories are present' do
-        it 'raises if the range does not correspond to the y_categories length' do
-          chart_builder.range 0..3
-          chart_builder.y_categories %w(Bad Great Best)
-          expect { chart_builder.build { } }.to raise_error(ArgumentError)
-        end
-        it 'does not raise if the range matches the y_categories' do
-          chart_builder.range 0..2
-          chart_builder.y_categories %w(Bad Great Best)
-          expect { chart_builder.build { } }.not_to raise_error
-        end
-      end
-    end
-  end
-end