study_engine 0.0.2

data/app/controllers/study_engine/admin/notes_controller.rb

@@ -0,0 +1,17 @@
+module StudyEngine
+  class Admin::NotesController < Admin::ApplicationController
+    before_action :require_admin
+
+    def update
+      assessment.update_column :notes, params[:notes]
+      render text: assessment.notes?
+    end
+
+    private
+
+    def assessment
+      Assessment.find(params[:assessment_id])
+    end
+  end
+end
+

data/app/controllers/study_engine/application_controller.rb

@@ -0,0 +1,12 @@
+class StudyEngine::ApplicationController < ::ApplicationController
+  helper Helpers
+
+  protect_from_forgery with: :exception
+
+  def self.expose *methods
+    methods.each do |method|
+      attr_reader method
+      helper_method method
+    end
+  end
+end

data/app/controllers/study_engine/assessments_controller.rb

@@ -0,0 +1,94 @@
+require "study_engine/config"
+require "cat_engine/question"
+
+module StudyEngine
+  class AssessmentsController < ::StudyEngine::ApplicationController
+    expose :assessment, :welcome_content, :events, :enabled_application_methods
+
+    def index
+      @welcome_content = StudyEngine.welcome_content
+      @assessment = BeginAssessmentForm.new
+      assessment.coordinator = current_user
+    end
+
+    def create
+      @assessment = BeginAssessmentForm.new(params[:assessment])
+      assessment.coordinator = current_user
+      if assessment.save
+        if assessment.by_url?
+          flash.now.notice = "An assessment has been created."
+          ::StudyEngine::Mailer.assessment_url_notification(current_user.email, assessment).deliver_now
+          render :create
+        elsif assessment.by_mail?
+          flash.now.notice = "An assessment has been created."
+          render :create
+        else
+          redirect_to assessment
+        end
+      elsif assessment.restartable?
+        flash.now[:alert] = "Partial assessment data already exists for this ID number and event.  Would you like to resume or restart?"
+        render :restart
+      else
+        flash.now[:alert] = assessment.errors.full_messages.join(", ")
+        render :index
+      end
+    end
+
+    def show
+      if assessment.complete?
+        if assessment.completed_at.nil?
+          assessment.touch :completed_at
+          send_notification
+        end
+        render :complete
+      else
+        render :show
+      end
+    end
+
+    def edit
+      redirect_to assessment
+    end
+
+    def update
+      assessment.save_answer Answer.new(question: CatEngine::Question.new(params[:cat_engine_question]))
+      redirect_to assessment
+    end
+
+    def timeout
+      @assessment = BeginAssessmentForm.new_from_model(assessment)
+      flash.now[:alert] = "Assessment timed out due to inactivity.  Would you like to resume or restart?"
+      render :restart
+    end
+
+    def notification
+      send_notification
+      head :ok
+    end
+
+    private
+
+    def send_notification
+      if email = assessment.coordinator_email
+        ::StudyEngine::Mailer.assessment_recorded_notification(email, assessment).deliver_now
+      end
+    end
+
+    def assessment
+      @assessment ||= Assessment.find(params[:id])
+    end
+
+    def current_user_required?
+      return true unless %w[show update notification].include?(params[:action]) && assessment.by_url?
+    end
+
+    def events
+      StudyEngine.events
+    end
+
+    def enabled_application_methods
+      StudyEngine.enabled_application_methods
+    end
+  end
+end
+

data/app/helpers/study_engine/helpers.rb

@@ -0,0 +1,15 @@
+module StudyEngine
+  module Helpers
+    def progress_bar percent
+      render partial: "study_engine/progress_bar", locals: { percent: percent }
+    end
+
+    def sortable_link_url report, field
+      "?field=#{field}&direction=#{(report.field == field && report.direction == "ASC") ? "DESC" : "ASC"}"
+    end
+
+    def sortable_link_class report, field
+      "current-#{report.direction.downcase}" if report.field == field
+    end
+  end
+end

data/app/helpers/study_engine/mailer_helpers.rb

@@ -0,0 +1,11 @@
+module StudyEngine
+  module MailerHelpers
+    def domains_and_group_summary assessment
+      finished = assessment.results.select(&:finished?).count
+      total = assessment.results.count
+      domains = [finished, total].join("/")
+      [domains, assessment.group_index_name].join(" ").strip
+    end
+  end
+end
+

data/app/mailers/study_engine/mailer.rb

@@ -0,0 +1,25 @@
+require "study_engine/config"
+
+module StudyEngine
+  class Mailer < ActionMailer::Base
+    helper MailerHelpers
+
+    default content_type: "text/html"
+
+    def assessment_url_notification email, assessment
+      @assessment = assessment
+      subject = "URL for #{assessment.study_id} #{assessment.event}"
+      mail to: email,
+        subject: subject,
+        content_type: "text/plain"
+    end
+
+    def assessment_recorded_notification email, assessment
+      @study_name = StudyEngine.study_name
+      @assessment = assessment
+      subject = "#{assessment.study_id} #{assessment.event} recorded"
+      mail to: email, subject: subject, content_type: "text/plain", cc: StudyEngine.notification_email
+    end
+  end
+end
+

data/app/models/study_engine/answer.rb

@@ -0,0 +1,36 @@
+require "cat_engine/response"
+require "cat_engine/question"
+
+module StudyEngine
+  class Answer < ActiveRecord::Base
+    belongs_to :result
+
+    def question
+      CatEngine::Question.new(id: question_id, promis_id: question_promis_id, context: question_context, title: question_title, responses: [])
+    end
+
+    def question= value
+      self.response = value.selected_response
+      value.each_pair do |key, value|
+        if key == :response_before
+          self.response_before = value
+        else
+          send :"question_#{key}=", value
+        end
+      end
+    end
+
+    def response
+      CatEngine::Response.new(id: response_id, promis_id: response_promis_id, before: response_before, title: response_title)
+    end
+
+    def response= value
+      value.each_pair do |key, value|
+        send :"response_#{key}=", value
+      end
+    end
+
+    attr_accessor :question_responses
+  end
+end
+

data/app/models/study_engine/assessment.rb

@@ -0,0 +1,118 @@
+require "study_engine/config"
+require "study_engine/study_id"
+
+module StudyEngine
+  class Assessment < ActiveRecord::Base
+    cattr_accessor(:timeout_interval) { 10.minutes }
+
+    default_scope -> { includes(:persisted_results) }
+
+    def timestamp_attributes_for_create
+      super + [:assessment_updated_at]
+    end
+
+    def self.by_event event
+      where(event: event)
+    end
+
+    def self.by_study_id study_id
+      return none unless study_id
+      where(study_id: study_id)
+    end
+
+    def self.by_site site
+      where("study_id RLIKE '...-#{site}-....'")
+    end
+
+    has_many :persisted_results, class_name: "Result", dependent: :destroy
+
+    before_create :assign_group_index
+
+    belongs_to :coordinator, class_name: "User"
+
+    def coordinator_email
+      coordinator.try(:email)
+    end
+
+    def restarted_assessment
+      Assessment.by_study_id(study_id).where(event: event).where.not(id: id).last
+    end
+
+    def stream_id
+      StudyID.new("STR-#{study_id.site}-#{1000 + id}") unless new_record?
+    end
+
+    def notes?
+      notes.present?
+    end
+
+    serialize :study_id, StudyID
+
+    def results
+      @results ||= begin
+        bank_ids = StudyEngine.bank_finder.call(self)
+        return persisted_results if persisted_results.length == bank_ids.length
+        bank_ids.map do |bank_id|
+          persisted_results.find_or_initialize_by(bank_id: bank_id)
+        end
+      end
+    end
+
+    def current_result
+      results.find { |result| !result.finished? }
+    end
+
+    def percent_complete
+      (results.select(&:finished?).count / results.count.to_f * 100).round
+    end
+
+    delegate :current_question, to: :current_result
+
+    def save_answer answer
+      current_result.save_answer answer
+      save!
+      touch :assessment_updated_at
+    end
+
+    def complete?
+      current_result.nil?
+    end
+
+    def incomplete?
+      !complete?
+    end
+
+    def results_summary
+      "#{results.select(&:finished?).count}/#{results.count}"
+    end
+
+    def full_history
+      persisted_results.flat_map(&:answers).map(&:question_id)
+    end
+
+    def by_url?
+      method_applied == "By URL"
+    end
+
+    def by_mail?
+      method_applied == "By mail"
+    end
+
+    def group_index_name
+      return "" if group_index.nil?
+      event_groups[group_index]
+    end
+
+    private
+
+    def assign_group_index
+      return unless event_groups.any?
+      self.group_index = restarted_assessment.try(:group_index) || self.class.by_event(event).count % event_groups.length
+    end
+
+    def event_groups
+      StudyEngine.groups[event] || []
+    end
+  end
+end
+

data/app/models/study_engine/begin_assessment_form.rb

@@ -0,0 +1,110 @@
+require "study_engine/form"
+require "study_engine/assessment"
+require "study_engine/config"
+
+module StudyEngine
+  class BeginAssessmentForm < Form
+    wraps "study_engine/assessment"
+
+    attributes :study_id, :event, :method_applied, :coordinator
+
+    attr_accessor :restart
+
+    delegate :study, :site, :id, to: :study_id, prefix: true
+    delegate :study=, :site=, :id=, to: :study_id, prefix: true
+
+    validate :presence_of_event
+    validate :format_of_study_id
+    validate :uniqueness_of_study_id_and_event, unless: :restart
+    validate :presence_of_previous_events
+
+    def study_id_study
+      study_options.one? ? study_options.first : study_id.study
+    end
+
+    def study_id_site
+      site_options.one? ? site_options.first : study_id.site
+    end
+
+    def study_id_id
+      id_options.one? ? id_options.first : study_id.id
+    end
+
+    def study_id
+      @study_id ||= StudyID.new
+    end
+
+    def method_applied
+      @method_applied || "In-person"
+    end
+
+    def existing_assessment
+      if study_id and new_record?
+        @existing_assessment ||= Assessment.by_study_id(study_id).where(event: event).last
+      end
+    end
+
+    def restartable?
+      existing_assessment.try(:incomplete?)
+    end
+
+    def study_options
+      StudyID::Bank.studies_grouped_by_site.fetch(coordinator.try(:site_id)) { StudyID::Bank.studies }
+    end
+
+    def site_options
+      coordinator.try(:site_id).present? ? [coordinator.site_id] : StudyID::Bank.sites
+    end
+
+    def id_options
+      ids_grouped_by_study_and_site[study_id_study.to_s + study_id_site.to_s]
+    end
+
+    def ids_grouped_by_study_and_site
+      StudyID::Bank.ids_grouped_by_study_and_site
+    end
+
+    delegate :by_url?, :by_mail?, :group_index_name, :created_at, :assessment_updated_at, to: :@model
+
+    private
+
+    def format_of_study_id
+      if study_id.present?
+        unless study_id.valid?
+          errors.add :base, "METRC study ID must be in the following format: XXX-XXX-####"
+        end
+      else
+        errors.add :base, "METRC study ID can not be blank.  Enter ID in the following format: XXX-XXX-####"
+      end
+    end
+
+    def presence_of_event
+      if event.blank?
+        events = StudyEngine.events.dup
+        events.map!(&:titleize)
+        events.last.prepend("or ")
+        events = events.join(", ")
+        errors.add :base, "Study event can not be blank.  Choose #{events} assessment."
+      end
+    end
+
+    def uniqueness_of_study_id_and_event
+      if existing_assessment
+        errors.add :base, "Assessment data has already been collected for this ID number and event.  Please check these fields to confirm you are beginning an assessment for the correct ID and event."
+      end
+    end
+
+    def presence_of_previous_events
+      index = StudyEngine.events.index(event)
+      return if index.nil? || index.zero?
+      previous_events = StudyEngine.events[0...index]
+
+      previous_events.each do |previous_event|
+        if Assessment.by_study_id(study_id).by_event(previous_event).none?
+          errors.add :base, "#{previous_event.capitalize} assessment must already exist to administer #{event} assessment"
+        end
+      end
+    end
+  end
+end
+