helena 1.3.0 → 2.1.0

data/README.md

@@ -1,15 +1,14 @@
-[![Build Status](https://img.shields.io/travis/gurix/helena/master.svg?style=flat)](https://travis-ci.org/gurix/helena)
-[![Code Climate](https://img.shields.io/codeclimate/github/gurix/helena.svg?style=flat)](https://codeclimate.com/github/gurix/helena)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0a74377cf11aeb621333/maintainability)](https://codeclimate.com/github/gurix/helena/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0a74377cf11aeb621333/test_coverage)](https://codeclimate.com/github/gurix/helena/test_coverage)
 [![Rubygems Version](https://img.shields.io/gem/v/helena.svg?style=flat)](https://rubygems.org/gems/helena)
 # Helena
-Helena is an online survey/test framework designed for agile survey/test development, longitudinal studies and instant feedback.
+Helena is an online survey/test framework designed for agile survey/test development, longitudinal studies and instant feedback. It was designed as modular part of the platform Laufbahndiagnostik (https://laufbahndiagnostik.ch/en).
 
 ![swiss made software](https://raw.githubusercontent.com/gurix/helena/master/app/assets/images/helena/swissmadesoftware.png "swiss made software")
 
-Demo: http://helena-demo.herokuapp.com (https://github.com/gurix/helena-demo)
 ## Requirements
 * Ruby (2.3.1 or higher)
-* Rails (4.2 or higher)
+* Rails (5.1 or higher)
 * Mongoid (4.0.0 or higher)
 * MongoDB (2.4.10 or higher)
 

data/Rakefile

@@ -1,4 +1,3 @@
-
 require 'rubygems'
 begin
   require 'bundler/setup'
@@ -17,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks

data/app/assets/javascripts/helena/application.js

@@ -1,4 +1,3 @@
 //= require jquery
 //= require jquery_ujs
 $(document).ready(function() { })
-//= require bootstrap

data/app/assets/stylesheets/helena/{application.css.sass → application.scss}

@@ -11,11 +11,3 @@
  *= require_self
  *= require_tree .
  */
-
-/* Needed because of http://stackoverflow.com/a/24958307/437892 */
-@import "bootstrap-sprockets"
-
-@import "bootstrap"
-
-.hide-text
-  visibility: hidden

data/app/controllers/helena/sessions_controller.rb

@@ -4,6 +4,7 @@ module Helena
     before_action :load_session, only: %i[edit update]
     before_action :update_answers, only: :update
     before_action :answer_errors, only: :update
+    before_action :flash_errors, only: :update
     after_action :update_last_question_group_id, only: :update
 
     def show
@@ -41,7 +42,7 @@ module Helena
       @session = Helena::Session.find_by token: params[:token]
       @survey = @session.survey
       @version = @survey.versions.find @session.version_id
-      render plain: 'Version not active', status: '404' unless @version && @version.active
+      render plain: 'Version not active', status: '404' unless @version&.active
       @question_group = question_group
     end
 
@@ -60,6 +61,7 @@ module Helena
 
     def session_params
       return unless params[:session]
+
       params.require(:session).permit(answers: @question_group.question_codes, question_types: @question_group.question_codes)
     end
 
@@ -92,6 +94,10 @@ module Helena
       @errors = errors
     end
 
+    def flash_errors
+      flash.now[:danger] = t('errors.messages.any_errors_flash') if @errors.any?
+    end
+
     def session_report
       Slim::Template.new { @version.session_report }.render(self).html_safe if @version.session_report
     end

data/app/helpers/helena/application_helper.rb

@@ -1,4 +1,22 @@
 module Helena
   module ApplicationHelper
+    def requeired_note
+      content_tag(:span, t('helena.shared.required_indicator'), aria: { hidden: true }) +
+        content_tag(:span, t('helena.shared.sr_required_indicator'), class: 'sr-only')
+    end
+
+    def question_label(question, options = {})
+      content_tag((options[:dummy] ? :span : :label), class: :label, for: "question_#{question.code}") do
+        raw(question.question_text) + (requeired_note if question.required?)
+      end
+    end
+
+    # Allows to set the header title within the text
+    # i.e `h1 = title 'This will be also shown in the title tag'`
+    # Do not forgot to set `content_for(:title)` within the title tag in the head.
+    def title(page_title)
+      content_for(:title, page_title)
+      page_title
+    end
   end
 end

data/app/models/helena/concerns/questions/validates_one_label.rb

@@ -13,6 +13,7 @@ module Helena
         def labels_preselection
           selected_labels = labels.select { |label| label.preselected == true }
           return if selected_labels.size <= 1
+
           selected_labels.each { |label| label.errors.add(:preselected, I18n.t(:taken, scope: 'activerecord.errors.messages')) }
           errors.add(:labels, I18n.t('helena.admin.radio_group.only_one_preselection_allowed')) # TODO: How to manage this translation?
         end

data/app/models/helena/question.rb

@@ -41,6 +41,7 @@ module Helena
 
     def uniqueness_of_code
       return unless question_group
+
       question_code_occurences = question_group.version.question_code_occurences
       errors.add :code, :taken if question_code_occurences[code] > 1
     end

data/app/models/helena/question_group.rb

@@ -15,5 +15,13 @@ module Helena
     def question_codes
       questions.map { |question| [question.code] + question.sub_questions.map(&:code) }.flatten
     end
+
+    def question_texts
+      questions.map { |question| [question.code, question.question_text] + subquestion_texts(question) }.flatten
+    end
+
+    def subquestion_texts(question)
+      question.sub_questions.map { |sub_question| [sub_question.code, sub_question.text] }
+    end
   end
 end

data/app/models/helena/questions/static_text.rb

@@ -2,6 +2,10 @@ module Helena
   module Questions
     class StaticText < Helena::Question
       field :default_value, type: String
+
+      def required?
+        false
+      end
     end
   end
 end

data/app/models/helena/session.rb

@@ -24,9 +24,8 @@ module Helena
     end
 
     def answers_as_yaml=(yaml)
-      parsed_answers = YAML.safe_load yaml
+      parsed_answers = YAML.load yaml # rubocop:disable Security/YAMLLoad
       update_answers parsed_answers
-      remove_unparsed_answers parsed_answers
     end
 
     def reset_tokens
@@ -46,14 +45,6 @@ module Helena
       Hash[*answers.map { |answer| [answer[:code], answer[:value]] }.flatten]
     end
 
-    def self.answer_codes
-      answer_codes = []
-      all.each do |session|
-        answer_codes += session.answers.map(&:code) - answer_codes
-      end
-      answer_codes
-    end
-
     private
 
     def generate_token(size)
@@ -65,19 +56,10 @@ module Helena
     end
 
     def update_answers(parsed_answers)
+      answers.delete_all
       parsed_answers.each do |code, value|
-        answer = answers.where(code: code).first
-        if answer
-          next if answer.value == value
-          answer.delete
-        end
         answers << Helena::Answer.build_generic(code, value, '')
       end
     end
-
-    def remove_unparsed_answers(parsed_answers)
-      unparsed_answers = answers.map(&:code) - parsed_answers.keys
-      answers.in(code: unparsed_answers).destroy
-    end
   end
 end

data/app/models/helena/sub_question.rb

@@ -25,6 +25,7 @@ module Helena
 
     def uniqueness_of_code
       return unless question
+
       question_code_occurences = question.question_group.version.question_code_occurences
 
       return true if question_code_occurences[code] <= 1

data/app/models/helena/version.rb

@@ -28,6 +28,10 @@ module Helena
       question_groups.map(&:question_codes).flatten
     end
 
+    def question_texts
+      question_groups.map(&:question_texts).flatten
+    end
+
     def question_code_occurences
       question_codes.each_with_object(Hash.new(0)) { |word, counts| counts[word] += 1 }
     end

data/app/views/helena/questions/_bipolar_radio_matrix.html.slim

@@ -0,0 +1,36 @@
+- label_width = "#{60 / question.labels.count}%"
+.radio_matrix class="#{'helena-error' if errors.present?}"
+  = question_label(question, dummy: true)
+
+  table
+    thead
+      tr
+        td
+        - question.labels.each do |label|
+          th width="#{label_width}"
+            = label.text
+        td
+
+    tbody
+      - question.sub_questions.each do |sub_question|
+        tr class="#{'error' if errors[sub_question.code]}" id="question_#{sub_question.code}"
+          td
+            = sub_question.parts.first
+            - if errors[sub_question.code]
+              .error= errors[sub_question.code]
+          - question.labels.each_with_index do |label, index|
+            - checked = answers[sub_question.code].to_s == label.value.to_s if answers[sub_question.code].present?
+            - checked ||= (label.preselected? ? true : false)
+            th width="#{label_width}"
+              label
+                = form.simple_fields_for :answers do |answer_form|
+                  = answer_form.radio_button sub_question.code, label.value, checked: checked
+                span.label-text
+                  - if index < (question.labels.size / 2)
+                    = "#{label.text} #{sub_question.parts.first}"
+                  - elsif index > (question.labels.size / 2)
+                    = "#{label.text} #{sub_question.parts.last}"
+                  - else
+                    = label.text
+          td
+            = sub_question.parts.last if sub_question.splitted?

data/app/views/helena/questions/{_checkbox_group.html.haml → _checkbox_group.html.slim}

@@ -1,17 +1,15 @@
-.checkbox_group.form-group{ class: "#{'has-error' if errors[question.code]}" }
-  %label
-    != question.question_text
-    = ' *' if question.required
+fieldset.checkbox_group class="#{'helena-error' if errors[question.code]}"
+  legend= question_label(question, dummy: true)
+
   = form.simple_fields_for :answers do |answer_form|
     - question.sub_questions.each do |sub_question|
       .checkbox
-        %label
+        label
           - checked = (answers[sub_question.code].to_s == sub_question.value.to_s) if sub_question.value
           - checked ||= sub_question.preselected
           = answer_form.input_field sub_question.code, as:      :boolean,
                                                        value:   sub_question.value,
-                                                       checked: checked,
-                                                       class:   'form-control'
+                                                       checked: checked
           = sub_question.text
   - if errors[question.code]
-    .help-block.text-danger= errors[question.code]
+    .error= errors[question.code]

data/app/views/helena/questions/_long_text.html.slim

@@ -0,0 +1,9 @@
+.long_text class="#{'helena-error' if errors[question.code]}"
+  = question_label(question)
+  = form.simple_fields_for :answers do |answer_form|
+    - params = { value: answers[question.code], id: "question_#{question.code}" }
+    - params = params.merge(aria: { describedby: "#{question.code}_error" }, invalid: true) if errors[question.code]
+    - params = params.merge(required: true) if question.required
+    = answer_form.text_area(question.code, params)
+  - if errors[question.code]
+    .error id="#{question.code}_error" = errors[question.code]

data/app/views/helena/questions/{_radio_group.html.haml → _radio_group.html.slim}

@@ -1,13 +1,12 @@
-.radio_group.form-group{ class: "#{'has-error' if errors[question.code]}" }
-  %label
-    != question.question_text
-    = ' *' if question.required
+fieldset.radio_group id="question_#{question.code}" class="#{'helena-error' if errors[question.code]}"
+  legend = question_label(question, dummy: true)
+
   - question.labels.each do |label|
     .radio
-      %label
+      label
         - checked = (answers[question.code].to_s == label.value.to_s) || label.preselected
         = form.simple_fields_for :answers do |answer_form|
           = answer_form.radio_button question.code, label.value, checked: checked
         = label.text
   - if errors[question.code]
-    .help-block.text-danger= errors[question.code]
+    .error= errors[question.code]

data/app/views/helena/questions/_radio_matrix.html.slim

@@ -0,0 +1,27 @@
+- label_width = "#{80 / question.labels.count}%"
+
+.radio_matrix class="#{'helena-error' if errors.present?}"
+  = question_label(question, dummy: true)
+
+  table.table
+    thead
+      tr
+        th
+        - question.labels.each do |label|
+          th width="#{label_width}"
+            == label.text
+    tbody
+      - question.sub_questions.each do |sub_question|
+        tr class="#{'error' if errors[sub_question.code]}" id="question_#{sub_question.code}"
+          td
+            = sub_question.parts.first
+            - if errors[sub_question.code]
+              .error= errors[sub_question.code]
+          - question.labels.each do |label|
+            - checked = answers[sub_question.code].to_s == label.value.to_s if answers[sub_question.code].present?
+            - checked ||= (label.preselected? ? true : false)
+            th width="#{label_width}"
+              label
+                = form.simple_fields_for :answers do |answer_form|
+                  = answer_form.radio_button sub_question.code, label.value, checked: checked
+                .label-text= label.text

data/app/views/helena/questions/_short_text.html.slim

@@ -0,0 +1,9 @@
+.short_text class="#{'helena-error' if errors[question.code]}"
+  = question_label(question)
+  = form.simple_fields_for :answers do |answer_form|
+    - params = { value: answers[question.code], id: "question_#{question.code}" }
+    - params = params.merge(aria: { describedby: "#{question.code}_error" }, invalid: true) if errors[question.code]
+    - params = params.merge(required: true) if question.required
+    = answer_form.text_field(question.code, params)
+    - if errors[question.code]
+      .error id="#{question.code}_error" = errors[question.code]

data/app/views/helena/questions/_static_text.html.slim

@@ -1,6 +1,4 @@
-.short_text.form-group
+.static_text
   - if question.question_text.present?
-    label
-      = question.question_text.html_safe
-    
+    = question_label(question, dummy: true)
   = question.default_value.html_safe

data/app/views/helena/sessions/_error_messages.html.slim

@@ -0,0 +1,8 @@
+#question_group_errors
+  p = t('errors.messages.any_errors')
+  .details
+    ul
+      - @errors.each do |key,value|
+        - text = Hash[*@session.version.question_texts][key]
+        li
+          a href="#question_#{key}" «#{text.sub('|', ' vs. ')}» #{value}.

data/app/views/helena/sessions/edit.html.slim

@@ -1,18 +1,22 @@
 = render 'progressbar' if @version.settings && @version.settings[:display_progressbar] == "1"
 #survey_content
-  h1.survey_title
-    = @version.survey_detail.title
+  h1.survey_title = title @version.survey_detail.title
   fieldset id="#{dom_id @question_group}"
-    legend= @question_group.title
+    legend
+      - if @question_group.title
+        = @question_group.title
+      - else
+        .sr-only= t('.question_group_legend', page: (@question_group.previous_items.size + 1).to_i)
     = simple_form_for(@session, url: helena.session_path(@session.token), as: :session) do |f|
+      = render 'error_messages'if @errors.any?
       - @questions.each do |question|
         = render "#{question.class.to_s.underscore}", form: f, question: question, answers: @answers, errors: @errors
 
       = hidden_field_tag :question_group, @question_group.id
 
       - if @question_group.previous_items.any? && @question_group.allow_to_go_back?
-        = link_to t('.back'), edit_session_path(@session.token, question_group: @question_group.previous_item), class: 'btn btn-default'
+        = link_to t('.back'), edit_session_path(@session.token, question_group: @question_group.previous_item), class: 'back_button'
 
-      = f.submit class: 'btn btn-success pull-right', value: @question_group.last? ? t('.save') : t('.next')
-
-    = t('shared.required') if @questions.map{ |question| question.try :required }.any?
+      = f.submit class: 'next_button', value: @question_group.last? ? t('.save') : t('.next')
+    - if @questions.map{ |question| question.try :required }.any?
+      span aria-hidden="true" = t('helena.shared.required')

data/app/views/helena/sessions/end_message.html.slim

@@ -1,5 +1,5 @@
 h1.survey_title
   = @version.survey_detail.title
 
-.well
+.end-message
   = t '.message'

data/config/locales/en.yml

@@ -1,19 +1,20 @@
 en:
-  shared:
-    delete_question: Are you sure?
-    delete: Delete
-    save: Save
-    edit: Edit
-    add: Add
-    show: Show
-    required: '* indicates required fields'
-    code_hint: The code should consist only of lowercase letters, numbers and underscores. Don't begin with a digit or an underscore and don't end with an underscore.
-    move_up: Move up
-    move_down: Move down
-    untitled: Untitled
+  helena:
+    shared:
+      required_indicator: "*"
+      sr_required_indicator: "(Mandatory)"
+      required: '* indicates required fields'
 
+  layouts:
+      application:
+        brand_name: Helena
   actions:
     deleted: "'%{resource}' successfully deleted"
     updated: "'%{resource}' successfully updated"
     created: "'%{resource}' successfully created"
     error: Ooopss... something is wrong, please check your input
+
+  errors:
+    messages:
+      any_errors: Problems have arisen in answering the questions. Please check your input.
+      any_errors_flash: One or more questions have not been answered correctly. You cannot continue until the correct answers have been given.