class Plan < ActiveRecord::Base
##
# Associations
belongs_to :template
has_many :phases, through: :template
has_many :sections, through: :phases
has_many :questions, through: :sections
has_many :answers
has_many :notes, through: :answers
has_many :users, through: :roles
##
# Possibly needed for active_admin
# -relies on protected_attributes gem as syntax depricated in rails 4.2
attr_accessible :locked, :project_id, :version_id, :version, :plan_sections,
:exported_plans, :project, :title, :template, :grant_number,
:identifier, :principal_investigator, :principal_investigator_identifier,
:description, :data_contact, :funder_name, :visibility,
:as => [:default, :admin]
# public is a Ruby keyword so using publicly
enum visibility: [:organisationally_visible, :publicly_visible, :is_test, :privately_visible]
##
# Constants
A4_PAGE_HEIGHT = 297 #(in mm)
A4_PAGE_WIDTH = 210 #(in mm)
ROUNDING = 5 #round estimate up to nearest 5%
FONT_HEIGHT_CONVERSION_FACTOR = 0.35278 #convert font point size to mm
FONT_WIDTH_HEIGHT_RATIO = 0.4 #Assume glyph width averages 2/5 the height
##
# Settings for the template
has_settings :export, class_name: 'Settings::Template' do |s|
s.key :export, defaults: Settings::Template::DEFAULT_SETTINGS
end
alias_method :super_settings, :settings
# EVALUATE CLASS AND INSTANCE METHODS BELOW
#
# What do they do? do they do it efficiently, and do we need them?
# Special note, these are both the methods in the old plan, and in the old project
##
# Proxy through to the template settings (or defaults if this plan doesn't have
# an associated template) if there are no settings stored for this plan.
# `key` is required by rails-settings, so it's required here, too.
#
# @param key [Key] a key required by rails
# @return [Settings] settings for this plan's template
def settings(key)
self_settings = self.super_settings(key)
return self_settings if self_settings.value?
self.dmptemplate.settings(key)
end
##
# returns the template for this plan, or generates an empty template and returns that
#
# @return [Dmptemplate] the template associated with this plan
def dmptemplate
self.project.try(:dmptemplate) || Dmptemplate.new
end
##
# returns the title for this project as defined by the settings
#
# @return [String] the title for this project
def title
logger.debug "Title in settings: #{self.settings(:export).title}"
if self.settings(:export).title == ""
if !self.version.nil? && !self.version.phase.nil? && !self.version.phase.title? then
return self.version.phase.title
else
return I18n.t('tool_title2')
end
else
return self.settings(:export).title
end
end
##
# returns the most recent answer to the given question id
# optionally can create an answer if none exists
#
# @param qid [Integer] the id for the question to find the answer for
# @param create_if_missing [Boolean] if true, will genereate a default answer to the question
# @return [Answer,nil] the most recent answer to the question, or a new question with default value, or nil
def answer(qid, create_if_missing = true)
answer = answers.where(:question_id => qid).order("created_at DESC").first
question = Question.find(qid)
if answer.nil? && create_if_missing then
answer = Answer.new
answer.plan_id = id
answer.question_id = qid
answer.text = question.default_value
default_options = Array.new
question.options.each do |option|
if option.is_default
default_options << option
end
end
answer.options = default_options
end
return answer
end
##
# returns all of the sections for this version of the plan, and for the project's organisation
#
# @return [Array<Section>,nil] either a list of sections, or nil if none were found
def sections
unless project.organisation.nil? then
sections = version.global_sections + project.organisation.all_sections(version_id)
else
sections = version.global_sections
end
return sections.uniq.sort_by &:number
end
##
# returns the guidances associated with the project's organisation, for a specified question
#
# @param question [Question] the question to find guidance for
# @return [Array<Guidance>] the list of guidances which pretain to the specified question
def guidance_for_question(question)
guidances = {}
# If project org isn't nil, get guidance by theme from any "non-subset" groups belonging to project org
unless project.organisation.nil? then
project.organisation.guidance_groups.each do |group|
if !group.optional_subset && (group.dmptemplates.pluck(:id).include?(project.dmptemplate_id) || group.dmptemplates.count == 0) then
group.guidances.each do |guidance|
guidance.themes.where("id IN (?)", question.theme_ids).each do |theme|
guidances = self.add_guidance_to_array(guidances, group, theme, guidance)
end
end
end
end
end
# Get guidance by theme from any guidance groups selected on creation
project.guidance_groups.each do |group|
if group.dmptemplates.pluck(:id).include?(project.dmptemplate_id) || group.dmptemplates.count == 0 then
group.guidances.each do |guidance|
guidance.themes.where("id IN (?)", question.theme_ids).each do |theme|
guidances = self.add_guidance_to_array(guidances, group, theme, guidance)
end
end
end
end
# Get guidance by question where guidance group was selected on creation or if group is organisation default
question.guidances.each do |guidance|
guidance.guidance_groups.each do |group|
if (group.organisation == project.organisation && !group.optional_subset) || project.guidance_groups.include?(group) then
guidances = self.add_guidance_to_array(guidances, group, nil, guidance)
end
end
end
return guidances
end
##
# adds the given guidance to a hash indexed by a passed guidance group and theme
#
# @param guidance_array [{GuidanceGroup => {Theme => Array<Gudiance>}}] the passed hash of arrays of guidances. Indexed by GuidanceGroup and Theme.
# @param guidance_group [GuidanceGroup] the guidance_group index of the hash
# @param theme [Theme] the theme object for the GuidanceGroup
# @param guidance [Guidance] the guidance object to be appended to the correct section of the array
# @return [{GuidanceGroup => {Theme => Array<Guidance>}}] the updated object which was passed in
def add_guidance_to_array(guidance_array, guidance_group, theme, guidance)
if guidance_array[guidance_group].nil? then
guidance_array[guidance_group] = {}
end
if theme.nil? then
if guidance_array[guidance_group]["no_theme"].nil? then
guidance_array[guidance_group]["no_theme"] = []
end
if !guidance_array[guidance_group]["no_theme"].include?(guidance) then
guidance_array[guidance_group]["no_theme"].push(guidance)
end
else
if guidance_array[guidance_group][theme].nil? then
guidance_array[guidance_group][theme] = []
end
if !guidance_array[guidance_group][theme].include?(guidance) then
guidance_array[guidance_group][theme].push(guidance)
end
end
return guidance_array
end
##
# determines if the plan is editable by the specified user
# NOTE: This should be renamed to editable_by?
#
# @param user_id [Integer] the id for a user
# @return [Boolean] true if user can edit the plan
def editable_by(user_id)
return project.editable_by(user_id)
end
##
# determines if the plan is readable by the specified user
# NOTE: This shoudl be renamed to readable_by?
#
# @param user_id [Integer] the id for a user
# @return [Boolean] true if the user can read the plan
def readable_by(user_id)
if project.nil?
return false
else
return project.readable_by(user_id)
end
end
##
# determines if the plan is administerable by the specified user
# NOTE: This should be renamed to administerable_by?
#
# @param user_id [Integer] the id for the user
# @return [Boolean] true if the user can administer the plan
def administerable_by(user_id)
return project.readable_by(user_id)
end
##
# defines and returns the status of the plan
# status consists of a hash of the num_questions, num_answers, sections, questions, and spaced used.
# For each section, it contains theid's of each of the questions
# for each question, it contains the answer_id, answer_created_by, answer_text, answer_options_id, aand answered_by
#
# @return [Status]
def status
status = {
"num_questions" => 0,
"num_answers" => 0,
"sections" => {},
"questions" => {},
"space_used" => 0 # percentage of available space in pdf used
}
space_used = height_of_text(self.project.title, 2, 2)
sections.each do |s|
space_used += height_of_text(s.title, 1, 1)
section_questions = 0
section_answers = 0
status["sections"][s.id] = {}
status["sections"][s.id]["questions"] = Array.new
s.questions.each do |q|
status["num_questions"] += 1
section_questions += 1
status["sections"][s.id]["questions"] << q.id
status["questions"][q.id] = {}
answer = answer(q.id, false)
space_used += height_of_text(q.text) unless q.text == s.title
space_used += height_of_text(answer.try(:text) || I18n.t('helpers.plan.export.pdf.question_not_answered'))
if ! answer.nil? then
status["questions"][q.id] = {
"answer_id" => answer.id,
"answer_created_at" => answer.created_at.to_i,
"answer_text" => answer.text,
"answer_option_ids" => answer.option_ids,
"answered_by" => answer.user.name
}
q_format = q.question_format
status["num_answers"] += 1 if (q_format.title == I18n.t("helpers.checkbox") || q_format.title == I18n.t("helpers.multi_select_box") ||
q_format.title == I18n.t("helpers.radio_buttons") || q_format.title == I18n.t("helpers.dropdown")) || answer.text.present?
section_answers += 1
#TODO: include selected options in space estimate
else
status["questions"][q.id] = {
"answer_id" => nil,
"answer_created_at" => nil,
"answer_text" => nil,
"answer_option_ids" => nil,
"answered_by" => nil
}
end
status["sections"][s.id]["num_questions"] = section_questions
status["sections"][s.id]["num_answers"] = section_answers
end
end
status['space_used'] = estimate_space_used(space_used)
return status
end
##
# defines and returns the details for the plan
# details consists of a hash of: project_title, phase_title, and for each section,
# section: title, question text for each question, answer type and answer value
#
# @return [Details]
def details
details = {
"project_title" => project.title,
"phase_title" => version.phase.title,
"sections" => {}
}
sections.sort_by(&:"number").each do |s|
details["sections"][s.number] = {}
details["sections"][s.number]["title"] = s.title
details["sections"][s.number]["questions"] = {}
s.questions.order("number").each do |q|
details["sections"][s.number]["questions"][q.number] = {}
details["sections"][s.number]["questions"][q.number]["question_text"] = q.text
answer = answer(q.id, false)
if ! answer.nil? then
q_format = q.question_format
if (q_format.title == t("helpers.checkbox") || q_format.title == t("helpers.multi_select_box") ||
q_format.title == t("helpers.radio_buttons") || q_format.title == t("helpers.dropdown")) then
details["sections"][s.number]["questions"][q.number]["selections"] = {}
answer.options.each do |o|
details["sections"][s.number]["questions"][q.number]["selections"][o.number] = o.text
end
end
details["sections"][s.number]["questions"][q.number]["answer_text"] = answer.text
end
end
end
return details
end
##
# determines wether or not a specified section of a plan is locked to a specified user and returns a status hash
#
# @param section_id [Integer] the setion to determine if locked
# @param user_id [Integer] the user to determine if locked for
# @return [Hash{String => Hash{String => Boolean, nil, String, Integer}}]
def locked(section_id, user_id)
plan_section = plan_sections.where("section_id = ? AND user_id != ? AND release_time > ?", section_id, user_id, Time.now).last
if plan_section.nil? then
status = {
"locked" => false,
"locked_by" => nil,
"timestamp" => nil,
"id" => nil
}
else
status = {
"locked" => true,
"locked_by" => plan_section.user.name,
"timestamp" => plan_section.updated_at,
"id" => plan_section.id
}
end
end
##
# for each section, lock the section with the given user_id
#
# @param user_id [Integer] the id for the user who can use the sections
def lock_all_sections(user_id)
sections.each do |s|
lock_section(s.id, user_id, 1800)
end
end
##
# for each section, unlock the section
#
# @param user_id [Integer] the id for the user to unlock the sections for
def unlock_all_sections(user_id)
plan_sections.where(:user_id => user_id).order("created_at DESC").each do |lock|
lock.delete
end
end
##
# for each section, unlock the section
# Not sure how this is different from unlock_all_sections
#
# @param user_id [Integer]
def delete_recent_locks(user_id)
plan_sections.where(:user_id => user_id).each do |lock|
lock.delete
end
end
##
# Locks the specified section to only be used by the specified user, for the number of secconds specified
#
# @param section_id [Integer] the id of the section to be locked
# @param user_id [Integer] the id of the user who can use the section
# @param release_time [Integer] the number of secconds the section will be locked for, defaults to 60
# @return [Boolean] wether or not the section was locked
def lock_section(section_id, user_id, release_time = 60)
status = locked(section_id, user_id)
if ! status["locked"] then
plan_section = PlanSection.new
plan_section.plan_id = id
plan_section.section_id = section_id
plan_section.release_time = Time.now + release_time.seconds
plan_section.user_id = user_id
plan_section.save
elsif status["current_user"] then
plan_section = PlanSection.find(status["id"])
plan_section.release_time = Time.now + release_time.seconds
plan_section.save
else
return false
end
end
##
# unlocks the specified section for the specified user
#
# @param section_id [Integer] the id for the section to be unlocked
# @param user_id [Integer] the id for the user for whom the section was previously locked
# @return [Boolean] wether or not the lock was removed
def unlock_section(section_id, user_id)
plan_sections.where(:section_id => section_id, :user_id => user_id).order("created_at DESC").each do |lock|
lock.delete
end
end
##
# returns the time of either the latest answer to any question, or the latest update to the model
#
# @return [DateTime] the time at which the plan was last changed
def latest_update
if answers.any? then
last_answered = answers.order("updated_at DESC").first.updated_at
if last_answered > updated_at then
return last_answered
else
return updated_at
end
else
return updated_at
end
end
##
# returns an array of hashes. Each hash contains the question's id, the answer_id,
# the answer_text, the answer_timestamp, and the answer_options
#
# @param section_id [Integer] the section to find answers of
# @return [Array<Hash{String => nil,String,Integer,DateTime}]
def section_answers(section_id)
section = Section.find(section_id)
section_questions = Array.new
counter = 0
section.questions.each do |q|
section_questions[counter] = {}
section_questions[counter]["id"] = q.id
#section_questions[counter]["multiple_choice"] = q.multiple_choice
q_answer = answer(q.id, false)
if q_answer.nil? then
section_questions[counter]["answer_id"] = nil
if q.suggested_answers.find_by_organisation_id(project.organisation_id).nil? then
section_questions[counter]["answer_text"] = ""
else
section_questions[counter]["answer_text"] = q.default_value
end
section_questions[counter]["answer_timestamp"] = nil
section_questions[counter]["answer_options"] = Array.new
else
section_questions[counter]["answer_id"] = q_answer.id
section_questions[counter]["answer_text"] = q_answer.text
section_questions[counter]["answer_timestamp"] = q_answer.created_at
section_questions[counter]["answer_options"] = q_answer.options.pluck(:id)
end
counter = counter + 1
end
return section_questions
end
private
##
# Based on the height of the text gathered so far and the available vertical
# space of the pdf, estimate a percentage of how much space has been used.
# This is highly dependent on the layout in the pdf. A more accurate approach
# would be to render the pdf and check how much space had been used, but that
# could be very slow.
# NOTE: This is only an estimate, rounded up to the nearest 5%; it is intended
# for guidance when editing plan data, not to be 100% accurate.
#
# @param used_height [Integer] an estimate of the height used so far
# @return [Integer] the estimate of space used of an A4 portrain
def estimate_space_used(used_height)
@formatting ||= self.settings(:export).formatting
return 0 unless @formatting[:font_size] > 0
margin_height = @formatting[:margin][:top].to_i + @formatting[:margin][:bottom].to_i
page_height = A4_PAGE_HEIGHT - margin_height # 297mm for A4 portrait
available_height = page_height * self.dmptemplate.settings(:export).max_pages
percentage = (used_height / available_height) * 100
(percentage / ROUNDING).ceil * ROUNDING # round up to nearest five
end
##
# Take a guess at the vertical height (in mm) of the given text based on the
# font-size and left/right margins stored in the plan's settings.
# This assumes a fixed-width for each glyph, which is obviously
# incorrect for the font-face choices available; the idea is that
# they'll hopefully average out to that in the long-run.
# Allows for hinting different font sizes (offset from base via font_size_inc)
# and vertical margins (i.e. for heading text)
#
# @param text [String] the text to estimate size of
# @param font_size_inc [Integer] the size of the font of the text, defaults to 0
# @param vertical_margin [Integer] the top margin above the text, defaults to 0
def height_of_text(text, font_size_inc = 0, vertical_margin = 0)
@formatting ||= self.settings(:export).formatting
@margin_width ||= @formatting[:margin][:left].to_i + @formatting[:margin][:right].to_i
@base_font_size ||= @formatting[:font_size]
return 0 unless @base_font_size > 0
font_height = FONT_HEIGHT_CONVERSION_FACTOR * (@base_font_size + font_size_inc)
font_width = font_height * FONT_WIDTH_HEIGHT_RATIO # Assume glyph width averages at 2/5s the height
leading = font_height / 2
chars_in_line = (A4_PAGE_WIDTH - @margin_width) / font_width # 210mm for A4 portrait
num_lines = (text.length / chars_in_line).ceil
(num_lines * font_height) + vertical_margin + leading
end
# BEGIN METHODS FROM PROJECT
#
##
# sets a new funder for the project
# defaults to the first dmptemplate if the current template is nill and the funder has more than one dmptemplate
#
# @param new_funder_id [Integer] the id for a new funder
# @return [Organisation] the new funder
def funder_id=(new_funder_id)
if new_funder_id != "" then
new_funder = Org.find(new_funder_id);
if new_funder.dmptemplates.count >= 1 && self.dmptemplate.nil? then
self.dmptemplate = new_funder.dmptemplates.first
end
end
end
##
# returns the funder id for the project
#
# @return [Integer, nil] the id for the funder
def funder_id
if self.dmptemplate.nil? then
return nil
end
template_org = self.dmptemplate.organisation
if template_org.organisation_type.name == constant("organisation_types.funder").downcase
return template_org.id
else
return nil
end
end
##
# returns the funder organisation for the project or nil if none is specified
#
# @return [Organisation, nil] the funder for project, or nil if none exists
def funder
if self.dmptemplate.nil? then
return nil
end
template_org = self.dmptemplate.organisation
if template_org.organisation_type.name == constant("organisation_types.funder").downcase
return template_org
else
return nil
end
end
##
# returns the name of the funder for the project
#
# @return [String] the name fo the funder for the project
def funder_name
if self.funder.nil?
return read_attribute(:funder_name)
else
return self.funder.name
end
end
##
# defines a new funder_name for the project.
#
# @param new_funder_name [String] the string name of the new funder
# @return [Integer, nil] the org_id of the new funder
def funder_name=(new_funder_name)
write_attribute(:funder_name, new_funder_name)
org_table = Org.arel_table
existing_org = Org.where(org_table[:name].matches(new_funder_name))
if existing_org.nil?
existing_org = Org.where(org_table[:abbreviation].matches(new_funder_name))
end
unless existing_org.empty?
self.funder_id=existing_org.id
end
end
##
# sets a new institution_id if there is no current organisation
#
# @param new_institution_id [Integer] the id for the new institution
# @return [Integer, Bool] false if an organisation exists, or the id of the set org if a new organisation is set
def institution_id=(new_institution_id)
if organisation.nil? then
self.organisation_id = new_institution_id
end
end
##
# returns the organisation which is root over the owning organisation
#
# @return [Integer, nil] the organisation_id or nil
def institution_id
if organisation.nil?
return nil
else
return organisation.root.id
end
end
##
# defines a new organisation_id for the project
# but is confusingly labled unit_id
#
# @param new_unit_id [Integer]
# @return [Integer, Boolean] the new organisation ID or false if no unit_id was passed
def unit_id=(new_unit_id)
unless new_unit_id.nil? ||new_unit_id == ""
self.organisation_id = new_unit_id
end
end
##
# returns the organisation_id or nil
# again seems redundant
#
# @return [nil, Integer] nil if no organisation, or the id if there is an organisation specified
def unit_id
if organisation.nil? || organisation.parent_id.nil?
return nil
else
return organisation_id
end
end
##
# assigns the passed user_id to the creater_role for the project
# gives the user rights to read, edit, administrate, and defines them as creator
#
# @param user_id [Integer] the user to be given priveleges' id
def assign_creator(user_id)
add_user(user_id, true, true, true)
end
##
# assigns the passed user_id as an editor for the project
# gives the user rights to read and edit
#
# @param user_id [Integer] the user to be given priveleges' id
def assign_editor(user_id)
add_user(user_id, true)
end
##
# assigns the passed user_id as a reader for the project
# gives the user rights to read
#
# @param user_id [Integer] the user to be given priveleges' id
def assign_reader(user_id)
add_user(user_id)
end
##
# assigns the passed user_id as an administrator for the project
# gives the user rights to read, adit, and administrate the project
#
# @param user_id [Integer] the user to be given priveleges' id
def assign_administrator(user_id)
add_user(user_id, true, true)
end
##
# whether or not the current plan is administrable by the user
#
# @param user_id [Integer] the user to check if has privleges
# @return [Boolean] true if user can administer project, false otherwise
def administerable_by(user_id)
user = project_groups.find_by_user_id(user_id)
if (! user.nil?) && user.project_administrator then
return true
else
return false
end
end
##
# whether or not the current plan is editable by the user
#
# @param user_id [Integer] the user to check if has privleges
# @return [Boolean] true if user can edit project, false otherwise
def editable_by(user_id)
user = project_groups.find_by_user_id(user_id)
if (! user.nil?) && user.project_editor then
return true
else
return false
end
end
##
# whether or not the current plan is readable by the user
# should be renamed to readable_by?
#
# @param user_id [Integer] the user to check if has privleges
# @return [Boolean] true if user can read project, false otherwise
def readable_by(user_id)
user = project_groups.find_by_user_id(user_id)
if (! user.nil?) then
return true
else
return false
end
end
##
# returns the projects which the user can atleast read
#
# @param user_id [Integer] the user to lookup projects for
# @return [Array<Project>] list of all projects the user can atleast read
def self.projects_for_user(user_id)
projects = Array.new
groups = ProjectGroup.where("user_id = ?", user_id)
unless groups.nil? then
groups.each do |group|
unless group.project.nil? then
projects << group.project
end
end
end
return projects
end
##
# whether or not the specified user_id created this project
# should be renamed to created_by?
#
# @param user_id [Integer] the user to check the priveleges of
# @return [Boolean] true if the user created the project
def created_by(user_id)
user = project_groups.find_by_user_id(user_id)
if (! user.nil?) && user.project_creator then
return true
else
return false
end
end
##
# the datetime for the latest update of this project, or any plan it owns
#
# @return [DateTime] the time of latest update
def latest_update
latest_update = updated_at
plans.each do |plan|
if plan.latest_update > latest_update then
latest_update = plan.latest_update
end
end
return latest_update
end
# Getters to match 'My plans' columns
##
# the title of the project
#
# @return [String] the title of the project
def name
self.title
end
##
# the owner of the project
#
# @return [User] the creater of the project
def owner
self.project_groups.find_by_project_creator(true).try(:user)
end
##
# the time the project was last updated, formatted as a date
#
# @return [Date] last update as a date
def last_edited
self.latest_update.to_date
end
##
# whether or not the plan is shared with anybody
#
# @return [Boolean] true if the project has been shared
def shared?
self.project_groups.count > 1
end
alias_method :shared, :shared?
##
# the organisation who owns the project
#
# @return [Dmptemplate,Organisation,String] the template, it's owner, or it's owner's abreviation
def template_owner
self.dmptemplate.try(:organisation).try(:abbreviation)
end
private
##
# adds a user to the project
# if no flags are specified, the user is given read privleges
#
# @param user_id [Integer] the user to be given privleges
# @param is_editor [Boolean] whether or not the user can edit the project
# @param is_administrator [Boolean] whether or not the user can administrate the project
# @param is_creator [Boolean] wheter or not the user created the project
# @return [Array<ProjectGroup>]
def add_user(user_id, is_editor = false, is_administrator = false, is_creator = false)
group = ProjectGroup.new
group.user_id = user_id
group.project_creator = is_creator
group.project_editor = is_editor
group.project_administrator = is_administrator
project_groups << group
end
##
# creates a plan for each phase in the dmptemplate associated with this project
# unless the phase is unpublished, it creates a new plan, and a new version of the plan and adds them to the project's plans
#
# @return [Array<Plan>]
def create_plans
dmptemplate.phases.each do |phase|
latest_published_version = phase.latest_published_version
unless latest_published_version.nil?
new_plan = Plan.new
new_plan.version = latest_published_version
plans << new_plan
end
end
end
end
Brian Riley