diff --git a/app/controllers/answers_controller.rb b/app/controllers/answers_controller.rb index a977620..d52b8c1 100644 --- a/app/controllers/answers_controller.rb +++ b/app/controllers/answers_controller.rb @@ -6,6 +6,7 @@ respond_to :html # POST /answers/create_or_update + # SEE MODULE def create_or_update p_params = permitted_params() diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb index 2719f34..4fddf02 100644 --- a/app/controllers/application_controller.rb +++ b/app/controllers/application_controller.rb @@ -111,6 +111,7 @@ } end + # SEE MODULE def success_message(obj, action = "saved") _("Successfully %{action} the %{object}.") % { object: obj_name_for_display(obj), @@ -125,6 +126,7 @@ end end + # SEE MODULE def obj_name_for_display(obj) display_name = { ExportedPlan: _("plan"), diff --git a/app/controllers/notes_controller.rb b/app/controllers/notes_controller.rb index 6c04b3e..70caee6 100644 --- a/app/controllers/notes_controller.rb +++ b/app/controllers/notes_controller.rb @@ -8,6 +8,7 @@ after_action :verify_authorized respond_to :html + # SEE MODULE def create @note = Note.new @note.user_id = note_params[:user_id] @@ -72,6 +73,7 @@ end end + # SEE MODULE def update @note = Note.find(params[:id]) authorize @note @@ -109,6 +111,7 @@ end end + # SEE MODULE def archive @note = Note.find(params[:id]) authorize @note diff --git a/app/controllers/org_admin/plans_controller.rb b/app/controllers/org_admin/plans_controller.rb index 2ba57ef..9cfcda5 100644 --- a/app/controllers/org_admin/plans_controller.rb +++ b/app/controllers/org_admin/plans_controller.rb @@ -4,7 +4,8 @@ prepend Dmpopidor::Controllers::OrgAdmin::Plans - # # GET org_admin/plans + # GET org_admin/plans + # SEE MODULE def index # Test auth directly and throw Pundit error sincePundit # is unaware of namespacing @@ -45,7 +46,8 @@ end end - # # GET /org_admin/download_plans + # GET /org_admin/download_plans + # SEE MODULE def download_plans # Test auth directly and throw Pundit error sincePundit # is unaware of namespacing diff --git a/app/controllers/orgs_controller.rb b/app/controllers/orgs_controller.rb index c036f80..c6d1657 100644 --- a/app/controllers/orgs_controller.rb +++ b/app/controllers/orgs_controller.rb @@ -20,6 +20,7 @@ ## # PUT /organisations/1 + # SEE MODULE def admin_update attrs = org_params @org = Org.find(params[:id]) diff --git a/app/controllers/paginable/plans_controller.rb b/app/controllers/paginable/plans_controller.rb index be28f4b..65f5fca 100644 --- a/app/controllers/paginable/plans_controller.rb +++ b/app/controllers/paginable/plans_controller.rb @@ -38,6 +38,7 @@ end # GET /paginable/plans/org_admin/:page + # SEE MODULE def org_admin unless current_user.present? && current_user.can_org_admin? raise Pundit::NotAuthorizedError diff --git a/app/controllers/paginable/templates_controller.rb b/app/controllers/paginable/templates_controller.rb index 2c91afd..9e3361f 100644 --- a/app/controllers/paginable/templates_controller.rb +++ b/app/controllers/paginable/templates_controller.rb @@ -90,6 +90,7 @@ # GET /paginable/templates/publicly_visible/:page (AJAX) # ----------------------------------------------------- + # SEE MODULE def publicly_visible templates = Template.live(Template.families(Org.funder.pluck(:id)).pluck(:family_id)) .publicly_visible.pluck(:id) << diff --git a/app/controllers/paginable/users_controller.rb b/app/controllers/paginable/users_controller.rb index fbcf46b..546b209 100644 --- a/app/controllers/paginable/users_controller.rb +++ b/app/controllers/paginable/users_controller.rb @@ -6,6 +6,7 @@ include Paginable # /paginable/users/index/:page + # SEE MODULE def index authorize User if current_user.can_super_admin? diff --git a/app/controllers/plan_exports_controller.rb b/app/controllers/plan_exports_controller.rb index 2ba8484..d26779f 100644 --- a/app/controllers/plan_exports_controller.rb +++ b/app/controllers/plan_exports_controller.rb @@ -5,6 +5,7 @@ prepend Dmpopidor::Controllers::PlanExports after_action :verify_authorized + # SEE MODULE def show @plan = Plan.includes(:answers).find(params[:plan_id]) @@ -73,6 +74,7 @@ locals: { export_format: "docx" }) end + # SEE MODULE def show_pdf render pdf: file_name, margin: @formatting[:margin], diff --git a/app/controllers/plans_controller.rb b/app/controllers/plans_controller.rb index fbce478..e2f962b 100644 --- a/app/controllers/plans_controller.rb +++ b/app/controllers/plans_controller.rb @@ -9,6 +9,7 @@ after_action :verify_authorized, except: [:overview] + # SEE MODULE def index authorize Plan @plans = Plan.active(current_user).page(1) @@ -46,6 +47,7 @@ end # POST /plans + # SEE MODULE def create @plan = Plan.new authorize @plan @@ -213,6 +215,7 @@ # # PUT /plans/1 # PUT /plans/1.json + # SEE MODULE def update @plan = Plan.find(params[:id]) authorize @plan @@ -304,6 +307,7 @@ end end + # SEE MODULE def download @plan = Plan.find(params[:id]) authorize @plan @@ -327,6 +331,7 @@ end # # POST /plans/:id/visibility + # SEE MODULE def visibility plan = Plan.find(params[:id]) if plan.present? @@ -361,6 +366,7 @@ end end + # SEE MODULE def set_test plan = Plan.find(params[:id]) authorize plan diff --git a/app/controllers/public_pages_controller.rb b/app/controllers/public_pages_controller.rb index 30b03b3..632230c 100644 --- a/app/controllers/public_pages_controller.rb +++ b/app/controllers/public_pages_controller.rb @@ -8,6 +8,7 @@ # GET template_index # ----------------------------------------------------- + # SEE MODULE def template_index templates = Template.live(Template.families(Org.funder.pluck(:id)).pluck(:family_id)) .publicly_visible.pluck(:id) << diff --git a/app/controllers/registrations_controller.rb b/app/controllers/registrations_controller.rb index 4908cd3..f835b42 100644 --- a/app/controllers/registrations_controller.rb +++ b/app/controllers/registrations_controller.rb @@ -4,6 +4,7 @@ prepend Dmpopidor::Controllers::Registrations + # SEE MODULE def edit @user = current_user @prefs = @user.get_preferences(:email) diff --git a/app/controllers/roles_controller.rb b/app/controllers/roles_controller.rb index eba01df..9f69d00 100644 --- a/app/controllers/roles_controller.rb +++ b/app/controllers/roles_controller.rb @@ -67,6 +67,7 @@ end + # SEE MODULE def update @role = Role.find(params[:id]) authorize @role diff --git a/app/controllers/template_options_controller.rb b/app/controllers/template_options_controller.rb index 61223c2..f81470d 100644 --- a/app/controllers/template_options_controller.rb +++ b/app/controllers/template_options_controller.rb @@ -7,6 +7,7 @@ # GET /template_options (AJAX) # Collect all of the templates available for the org+funder combination + # SEE MODULE def index org_id = (plan_params[:org_id] == "-1" ? "" : plan_params[:org_id]) funder_id = (plan_params[:funder_id] == "-1" ? "" : plan_params[:funder_id]) diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb index 85c3be8..628736f 100644 --- a/app/controllers/users_controller.rb +++ b/app/controllers/users_controller.rb @@ -13,6 +13,7 @@ ## # GET - List of all users for an organisation # Displays number of roles[was project_group], name, email, and last sign in + # SEE MODULE def admin_index authorize User diff --git a/app/helpers/exports_helper.rb b/app/helpers/exports_helper.rb index a12f3d1..b5c7b50 100644 --- a/app/helpers/exports_helper.rb +++ b/app/helpers/exports_helper.rb @@ -35,6 +35,7 @@ get_margin_value_for_side(:right) end + # SEE MODULE def plan_attribution(attribution) attribution = Array(attribution) prefix = attribution.many? ? _("Creators:") : _("Creator:") diff --git a/app/helpers/plans_helper.rb b/app/helpers/plans_helper.rb index c9517f5..36c77b5 100644 --- a/app/helpers/plans_helper.rb +++ b/app/helpers/plans_helper.rb @@ -16,6 +16,7 @@ end # display the visibility of the plan + # SEE MODULE def display_visibility(val) case val when 'organisationally_visible' @@ -29,6 +30,7 @@ end end + # SEE MODULE def visibility_tooltip(val) case val when 'organisationally_visible' diff --git a/app/mailers/user_mailer.rb b/app/mailers/user_mailer.rb index 30b8529..f926652 100644 --- a/app/mailers/user_mailer.rb +++ b/app/mailers/user_mailer.rb @@ -113,6 +113,7 @@ # commenter - User who wrote the comment # plan - Plan for which the comment is associated to # answer - Answer commented on + # SEE MODULE def new_comment(commenter, plan, answer) if commenter.is_a?(User) && plan.is_a?(Plan) owner = plan.owner diff --git a/app/models/phase.rb b/app/models/phase.rb index 4f6e5a9..9a86bdb 100644 --- a/app/models/phase.rb +++ b/app/models/phase.rb @@ -116,6 +116,7 @@ n end + # SEE MODULE def visibility_allowed?(plan) value = Rational(num_answered_questions(plan), plan.num_questions) * 100 value >= Rails.application.config.default_plan_percentage_answered.to_f diff --git a/app/models/plan.rb b/app/models/plan.rb index 8cc19b9..dd9bbc1 100644 --- a/app/models/plan.rb +++ b/app/models/plan.rb @@ -282,6 +282,7 @@ # # Returns Answer # Returns nil + # SEE MODULE def answer(qid, create_if_missing = true) answer = answers.where(question_id: qid).order("created_at DESC").first question = Question.find(qid) @@ -435,6 +436,7 @@ # # Returns User # Returns nil + # SEE MODULE def owner usr_id = Role.where(plan_id: id, active: true) .administrator @@ -571,6 +573,7 @@ # Deactivates the plan (sets all roles to inactive and visibility to :private) # # Returns Boolean + # SEE MODULE def deactivate! # If no other :creator, :administrator or :editor is attached # to the plan, then also deactivate all other active roles