effective_cpd 0.0.1

data/app/views/effective/cpd_statements/agreements.html.haml

@@ -0,0 +1,14 @@
+= render('layout') do
+  %h1= resource.cpd_cycle
+
+  - if resource.cpd_cycle.all_steps_content.present?
+    .mb-2= resource.cpd_cycle.all_steps_content
+
+  - if resource.cpd_cycle.agreements_content.present?
+    .mb-2= resource.cpd_cycle.agreements_content
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = render('agreements', f: f, form: f)
+    = f.hidden_field :current_step
+
+    = f.submit 'Save and Continue', center: true

data/app/views/effective/cpd_statements/complete.html.haml

@@ -0,0 +1,13 @@
+= render('layout') do
+  %h1= resource.cpd_cycle
+
+  - if resource.cpd_cycle.all_steps_content.present?
+    .mb-2= resource.cpd_cycle.all_steps_content
+
+  - if resource.cpd_cycle.complete_content.present?
+    .mb-2= resource.cpd_cycle.complete_content
+
+  = render(resource)
+
+  %hr
+  .text-center= link_to 'Home', root_url, class: 'btn btn-primary'

data/app/views/effective/cpd_statements/start.html.haml

@@ -0,0 +1,13 @@
+= render('layout') do
+  %h1= resource.cpd_cycle
+
+  - if resource.cpd_cycle.all_steps_content.present?
+    .mb-2= resource.cpd_cycle.all_steps_content
+
+  - if resource.cpd_cycle.start_content.present?
+    .mb-2= resource.cpd_cycle.start_content
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.hidden_field :current_step
+
+    = f.submit 'Start', center: true

data/app/views/effective/cpd_statements/submit.html.haml

@@ -0,0 +1,20 @@
+= render('layout') do
+  %h1= resource.cpd_cycle
+
+  - if resource.cpd_cycle.all_steps_content.present?
+    .mb-2= resource.cpd_cycle.all_steps_content
+
+  - if resource.cpd_cycle.submit_content.present?
+    .mb-2= resource.cpd_cycle.submit_content
+
+  = render(resource)
+
+  %p= link_to 'Change Activities', wizard_path(:activities)
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.hidden_field :current_step
+
+    = f.check_box :confirm_readonly,
+      label: 'Yes, I understand that I will not be able to modify this statement after submission'
+
+    = f.submit 'Save and Continue', center: true

data/app/views/layouts/effective_cpd_mailer_layout.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html{style: 'background: #fff;'}
+  %head
+    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
+
+  %body{style: 'background: #fff;'}
+    = yield

data/config/effective_cpd.rb

@@ -0,0 +1,29 @@
+EffectiveCpd.setup do |config|
+  config.cpd_cycles_table_name = :cpd_cycles
+  config.cpd_categories_table_name = :cpd_categories
+  config.cpd_activities_table_name = :cpd_activities
+  config.cpd_rules_table_name = :cpd_rules
+  config.cpd_statement_activities_table_name = :cpd_statement_activities
+  config.cpd_statements_table_name = :cpd_statements
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  config.layout = {
+    cpd: 'application',
+    admin: 'admin'
+  }
+
+  config.cycle_label = 'year'       # 'cycle', 'season'
+  config.credit_label = 'credit'    # 'credit', 'PDH', 'PDU', 'CCC'
+
+  # Notifications Mailer Settings
+  #
+  # Schedule rake effective_cpd:notify to run every 10 minutes
+  # to send out email poll notifications
+  #
+  config.mailer = {
+    layout: 'effective_cpd_mailer_layout',
+    default_from: 'no-reply@example.com'
+  }
+
+end

data/config/routes.rb

@@ -0,0 +1,28 @@
+Rails.application.routes.draw do
+  mount EffectiveCpd::Engine => '/', as: 'effective_cpd'
+end
+
+EffectiveCpd::Engine.routes.draw do
+  scope module: 'effective' do
+    resources :cpd_cycles, path: "cpd_#{EffectiveCpd.cycle_label.pluralize.parameterize.underscore}", only: [:show] do
+      resources :cpd_statements, path: :statements, only: [:new, :show] do
+        resources :build, controller: :cpd_statements, only: [:show, :update]
+      end
+    end
+
+    resources :cpd_statements, only: [] do
+      resources :cpd_statement_activities, except: [:index, :show]
+    end
+
+  end
+
+  namespace :admin do
+    resources :cpd_categories, except: [:show]
+    resources :cpd_activities, except: [:show]
+    resources :cpd_cycles, except: [:show]
+    resources :cpd_rules, only: [:index]
+
+    resources :cpd_statements, only: [:index, :edit, :update]
+  end
+
+end

data/db/migrate/01_create_effective_cpd.rb.erb

@@ -0,0 +1,98 @@
+class CreateEffectiveCpd < ActiveRecord::Migration[6.0]
+  def change
+    create_table <%= @cpd_cycles_table_name %> do |t|
+      t.string :title
+
+      t.datetime :start_at
+      t.datetime :end_at
+
+      t.integer :required_score
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_categories_table_name %> do |t|
+      t.string :title
+      t.integer :position
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_activities_table_name %> do |t|
+      t.references :cpd_category
+
+      t.string :title
+      t.integer :position
+
+      t.string :amount_label
+      t.string :amount2_label
+
+      t.boolean :requires_upload_file, default: false
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_rules_table_name %> do |t|
+      t.references :cpd_cycle
+      t.integer :ruleable_id
+      t.string :ruleable_type
+
+      t.text :credit_description
+      t.string :formula
+
+      t.integer :max_credits_per_cycle
+      t.integer :max_cycles_can_carry_forward
+      t.boolean :unavailable, default: false
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_statement_activities_table_name %> do |t|
+      t.references :cpd_statement
+      t.references :cpd_activity
+      t.references :cpd_category
+      t.references :original
+
+      t.integer :amount
+      t.integer :amount2
+
+      t.text :description
+
+      t.integer :carry_over
+      t.integer :score
+      t.integer :carry_forward
+
+      t.text :reduced_messages
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_statements_table_name %> do |t|
+      t.references :cpd_cycle
+
+      t.integer :user_id
+      t.string :user_type
+
+      t.string :token
+
+      t.integer :score
+
+      t.boolean :confirm_read
+      t.boolean :confirm_factual
+      t.boolean :confirm_readonly
+
+      t.datetime :completed_at
+
+      t.text :wizard_steps
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,472 @@
+puts "Running effective_cpd seeds"
+
+now = Time.zone.now
+
+if Rails.env.test?
+  Effective::CpdCycle.delete_all
+  Effective::CpdCategory.delete_all
+  Effective::CpdActivity.delete_all
+  Effective::CpdRule.delete_all
+
+  ActionText::RichText.where(record_type: ['Effective::CpdCycle', 'Effective::CpdCycle', 'Effective::CpdActivity']).delete_all
+end
+
+# Build the first CpdCycle
+cycle = Effective::CpdCycle.create!(
+  title: "#{now.year} Continuing Professional Development",
+  start_at: now.beginning_of_year,
+  end_at: now.end_of_year,
+  required_score: 100,
+  all_steps_content: "<div>All Steps Content</div>",
+  start_content: "<div>Start Content</div>",
+  activities_content: "<div>Activities Content</div>",
+  submit_content: "<div>Submit Content</div>",
+  complete_content: "<div>Complete Content</div>"
+)
+
+# Professional Practice
+category = Effective::CpdCategory.create!(
+  title: 'Professional Practice',
+  body: "A registrant who is actively practicing applied biology (performing technical work) or influencing (having some effect on how the professional is practiced) the practice of applied biology. <em>Note: Points claimed in this category cannot also be claimed under the Management category</em>",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
+  max_credits_per_cycle: 20
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Practicing applied biology',
+  amount_label: 'points',
+)
+
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Influencing the practice of applied biology',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+# Management
+category = Effective::CpdCategory.create!(
+  title: 'Management',
+  body: "The management, evaluation, direction/supervision of professionals; and the management, evaluation and direction/management of projects or activities being carried out by professionals <em>Note: Points claimed in this category cannot also be claimed under the Professional Practice category.</em>",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
+  max_credits_per_cycle: 20
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Assessment and evaluation of professionals who are conducting applied biology',
+  body: "e.g. determining who is best for the particular work.",
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Overseeing projects or activities',
+  body: "e.g. reviewing professional documents being carried out by professionals.",
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 2,
+  title: 'Establishing financial (cost assessments) and time limits for projects, and scope of projects',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 3,
+  title: 'Other',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: nil
+)
+
+# Formal Learning
+category = Effective::CpdCategory.create!(
+  title: 'Formal Learning',
+  body: "Learning that has academic or technical credit, and may include assignments or examinations to evaluate learning that assists a registrant in practicing due diligence with regards to clients and their professional requirements; and to maintain, enhance or to develop practice competence in areas of practice.",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 35 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  max_credits_per_cycle: 35
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  title: 'From post-secondary education institutes, suppliers, employers, government or professional associations',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Online, in classroom settings, a combination, or other methods',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+# Informal Learning
+category = Effective::CpdCategory.create!(
+  title: 'Informal Learning',
+  body: "Learning that has academic or technical credit, and may include assignments or examinations to evaluate learning that assists a registrant in practicing due diligence with regards to clients and their professional requirements; and to maintain, enhance or to develop practice competence in areas of practice.",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  max_credits_per_cycle: 15
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Self-directed studies',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 2,
+  title: 'Attendance at conferences, seminars, workshops, technical presentations, clinics',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 3,
+  title: 'Formalized and structured on the job training',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 4,
+  title: 'Attendance at meetings of technical, professional or managerial associations or societies',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 5,
+  title: 'Structured discussion of technical or professional issues with peers',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+# Presentations
+category = Effective::CpdCategory.create!(
+  title: 'Presentations',
+  body: "<div>Lecture/talk/speech that is of a technical and/or professional nature that are outside the normal daily job function(s)</div>",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  max_credits_per_cycle: 15
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Conference, symposium, workshop, seminar meeting, course, training session, lunch presentations',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Post-secondary education institutes, employers, government, professional associations, public organizations',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 2,
+  title: 'Other',
+  amount_label: 'points',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_cycles_can_carry_forward: 2
+)
+
+# Contributions to Knowledge
+category = Effective::CpdCategory.create!(
+  title: 'Contributions to Knowledge',
+  body: "Activities which expand or develop new biological and/or technical/scientific knowledge in the biological profession are recognized that are outside the normal daily job function(s).",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 30 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  max_credits_per_cycle: 30
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Development of published standards, practices, codes',
+  amount_label: 'standard, practice, code',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '10 * amount',
+  credit_description: '1 publication equals 10 CPD points',
+  max_credits_per_cycle: 10,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Development of published policy(ies), reference(s), guidelines(s), guidance(s)',
+  amount_label: 'standard, practice, guideline',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '10 * amount',
+  credit_description: '1 publication equals 10 CPD points',
+  max_credits_per_cycle: 10,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 2,
+  title: 'Publication of papers in scientific peer-reviewed journals',
+  amount_label: 'hour',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 hour equals 1 CPD point',
+  max_credits_per_cycle: 15,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 3,
+  title: 'Publication of articles in non-peer-reviewed journals',
+  amount_label: 'article',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '5 * amount',
+  credit_description: '1 article equals 5 CPD point',
+  max_credits_per_cycle: 10,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 4,
+  title: 'Publication of a books, a book chapter',
+  amount_label: 'book or book chapter',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '10 * amount',
+  credit_description: '1 book or book chapter equals 10 CPD point',
+  max_credits_per_cycle: 10,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 5,
+  title: 'Peer-review of manuscripts for a scientific journal',
+  amount_label: 'hour',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 hour equals 1 CPD point',
+  max_credits_per_cycle: 10,
+  max_cycles_can_carry_forward: 2
+)
+
+# Service to the Community and the Profession
+category = Effective::CpdCategory.create!(
+  title: 'Service to the Community and the Profession',
+  body: "Activities that promote peer interaction, provide exposure to new ideas and technologies; enhance the profession and serve the public interest.",
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: category,
+  credit_description: 'Upto a maximum of 10 points per mentee or position per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  max_credits_per_cycle: nil
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 0,
+  title: 'Appointment as a mentor to an in-training registrant, a less experienced applied biology professional, student',
+  amount_label: 'mentee',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '10 * amount',
+  credit_description: '1 mentee equals 10 CPD point',
+  max_credits_per_cycle: nil,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 1,
+  title: 'Service as an appointed and/or elected biology professional on a public, government, non-government and non-profit organization Board, Council, Committee, Working group etc.',
+  amount_label: 'appointed position',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: '10 * amount',
+  credit_description: '1 appointed position equals 10 CPD point',
+  max_credits_per_cycle: nil,
+  max_cycles_can_carry_forward: 2
+)
+
+activity = Effective::CpdActivity.create!(
+  cpd_category: category,
+  position: 2,
+  title: 'Other',
+  amount_label: 'point',
+)
+Effective::CpdRule.create!(
+  cpd_cycle: cycle,
+  ruleable: activity,
+  formula: 'amount',
+  credit_description: '1 point equals 1 CPD point',
+  max_credits_per_cycle: nil,
+  max_cycles_can_carry_forward: 2
+)
+
+puts "All Done"