effective_cpd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96dbf47b702128c10b5b8f1ee07f9fb4798efdd77220b506b75124737e55e8ec
+  data.tar.gz: a5e0a5a658c43ffef382a8becb65b7a84b61a24a01f701dbb7daaecf63aa391f
+SHA512:
+  metadata.gz: 3ee41586315d02240cbdaa075b91aec80122db0c6820db8f5c79595af3e45a617fcabbe5284d67ef149209bd998870dd9684bf3d3bce0c88ddfec836e7e82e6b
+  data.tar.gz: ab8a10bd1aed88b3971d596a22bae191a6e9d77c20ba1f7343bc8888d9930feb57ab8d57cc2cb3aded11b938d5c83e8689ed2c54f85bd28cdd76291921c7fc7e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Code and Effect Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# Effective CPD
+
+Continuing professional development.
+
+An admin creates a set of categories, activites and rules.  User enters number of hours or work done to have a scored statement. Audits.
+
+Works with action_text for content bodies, and active_storage for file uploads.
+
+## Getting Started
+
+This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
+
+Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
+
+Please download and install the [Twitter Bootstrap4](http://getbootstrap.com)
+
+Add to your Gemfile:
+
+```ruby
+gem 'haml-rails' # or try using gem 'hamlit-rails'
+gem 'effective_cpd'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_cpd:install
+```
+
+The generator will install an initializer which describes all configuration options and creates a database migration.
+
+If you want to tweak the table names, manually adjust both the configuration file and the migration now.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+Render the "available statements for current_user" datatable on your user dashboard:
+
+```haml
+%h2 Continuing Professional Development
+
+%p Please submit a CPD statement for the following available #{cpd_cycles_label}:
+= render_datatable(EffectiveCpdDatatable.new, simple: true)
+
+- datatable = EffectiveCpdStatementsDatatable.new(self)
+- if datatable.present?
+  .mt-4
+    %p You completed these statements:
+    = render_datatable(datatable, simple: true)
+
+```
+
+Add a link to the admin menu:
+
+```haml
+- if can? :admin, :effective_cpd
+  = link_to 'CPD Categories', effective_cpd.admin_cpd_categories_path
+  = link_to 'CPD Cycles', effective_cpd.admin_cpd_cycles_path
+  = link_to 'CPD Statements', effective_cpd.admin_cpd_statements_path
+```
+
+## Authorization
+
+All authorization checks are handled via the effective_resources gem found in the `config/initializers/effective_resources.rb` file.
+
+## Permissions
+
+The permissions you actually want to define are as follows (using CanCan):
+
+```ruby
+# Regular signed up user. Guest users not supported.
+if user.persisted?
+  can :new, Effective::CpdStatement
+  can [:index, :show, :update], Effective::CpdStatement, user_id: user.id
+  can [:index, :show], Effective::CpdCycle
+  can([:create, :update, :destroy], Effective::CpdStatementActivity) { |sa| sa.cpd_statement.user_id == user.id }
+end
+
+if user.admin?
+  can :admin, :effective_cpd
+  can :manage, Effective::CpdActivity
+  can :manage, Effective::CpdCategory
+  can :manage, Effective::CpdCycle
+  can :manage, Effective::CpdRule
+  can :manage, Effective::CpdStatement
+end
+```
+
+## License
+
+MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+## Testing
+
+Run tests by:
+
+```ruby
+rails test
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/effective_cpd_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/app/assets/javascripts/effective_cpd.js

@@ -0,0 +1,2 @@
+//= require effective_cpd/activities
+//= require effective_cpd/activities_new

data/app/assets/javascripts/effective_cpd/activities.js

@@ -0,0 +1,49 @@
+const initialize_effective_cpd_activities = function() {
+  const $obj = $('.cpd-statement-activities:not(.initialized)')
+
+  if($obj.length > 0) {
+    $(document).on('mousedown touchstart', function(event) { collapse_effective_cpd_activities() })
+
+    // When we click outside the New Activity or Edit Activity
+    $(document).on('mousedown touchstart', '.activities-new', function(event) { event.stopPropagation() });
+    $(document).on('mousedown touchstart', '.statement-activity', function(event) { event.stopPropagation() });
+
+    $obj.addClass('initialized')
+  }
+};
+
+// Collapse the New Activity and all Edit Activity forms
+const collapse_effective_cpd_activities = function() {
+  const $activities = $('#cpd-statement-activities')
+  $activities.children('.activities-new').hide()
+  $activities.children('.activities-index').show()
+
+  const $statementActivities = $('.cpd-statement-activities')
+  $statementActivities.find('.statement-activity-content').show()
+  $statementActivities.find('.statement-activity-form').hide()
+};
+
+// When we click the New Activity button, use the whole screen
+$(document).on('click', '[data-cpd-new-activity]', function(event) {
+  event.preventDefault()
+  event.stopPropagation()
+
+  const $statement = $('#cpd-statement-activities')
+  $statement.children('.activities-index').hide()
+  $statement.children('.activities-new').show()
+});
+
+// When we click the Edit Activity
+$(document).on('click', '[data-cpd-edit-activity]', function(event) {
+  event.preventDefault()
+
+  collapse_effective_cpd_activities()
+
+  const $activity = $(event.currentTarget).closest('.statement-activity')
+  $activity.children('.statement-activity-content').hide()
+  $activity.children('.statement-activity-form').show()
+});
+
+// Initializers
+$(document).ready(function() { initialize_effective_cpd_activities() });
+$(document).on('turbolinks:load', function() { initialize_effective_cpd_activities() });

data/app/assets/javascripts/effective_cpd/activities_new.js

@@ -0,0 +1,21 @@
+// In the New Activity Form
+$(document).on('click', '[data-cpd-show-activity]', function(event) {
+  event.preventDefault()
+
+  let $obj = $(event.currentTarget)
+  let $form = $obj.siblings('.statement-activity-form')
+  let $tabContent = $obj.closest('.tab-content').children('.statement-activity-content')
+
+  $tabContent.html($form.html())
+  $tabContent.siblings('.active').removeClass('active')
+  $tabContent.addClass('active')
+});
+
+$(document).on('click', '[data-cpd-back-activity]', function(event) {
+  event.preventDefault()
+
+  let $activities = $(event.currentTarget).closest('.activities-new')
+  let anchor = $activities.find('.nav[role=tablist]').find('a.nav-link.active').first().attr('href')
+
+  $(anchor).siblings('.active').removeClass('active').end().addClass('active')
+});

data/app/assets/stylesheets/effective_cpd.scss

@@ -0,0 +1 @@
+@import 'effective_cpd/activities';

data/app/assets/stylesheets/effective_cpd/_activities.scss

@@ -0,0 +1,19 @@
+.cpd-statement-activities {
+  .statement-activity-category {
+    .progress { height: 3px; }
+  }
+
+  .statement-activity-content {
+    a { color: inherit; }
+  }
+
+  .carry-forward {
+    text-align: right;
+    padding-right: 2rem;
+  }
+
+  .score {
+    text-align: right;
+  }
+
+}

data/app/controllers/admin/cpd_activities_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdActivitiesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_activity).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_categories_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdCategoriesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_category).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_cycles_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdCyclesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_cycle).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_rules_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdRulesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_rule).permit!
+    end
+
+  end
+end

data/app/controllers/admin/cpd_statements_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdStatementsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    # def permitted_params
+    #   params.require(:effective_cpd_statement).permit!
+    # end
+
+  end
+end

data/app/controllers/effective/cpd_cycles_controller.rb

@@ -0,0 +1,19 @@
+module Effective
+  class CpdCyclesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    def show
+      cycle = Effective::CpdCycle.find(params[:id])
+      EffectiveResources.authorize!(self, :show, cycle)
+
+      statement = Effective::CpdStatement.where(cpd_cycle: cycle, user: current_user).first
+
+      if statement.present?
+        redirect_to effective_cpd.cpd_cycle_cpd_statement_build_path(cycle, statement, statement.next_step)
+      else
+        redirect_to effective_cpd.cpd_cycle_cpd_statement_build_path(cycle, :new, :start)
+      end
+    end
+
+  end
+end

data/app/controllers/effective/cpd_statement_activities_controller.rb

@@ -0,0 +1,27 @@
+module Effective
+  class CpdStatementActivitiesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::CrudController
+
+    resource_scope -> { CpdStatement.find(params[:cpd_statement_id]).cpd_statement_activities }
+
+    # Score all statements when we change any activity
+    after_save do
+      CpdScorer.new(user: resource.cpd_statement.user, from: resource.cpd_statement).score!
+    end
+
+    # Redirect the remote form back to the activities page
+    on :save, redirect: -> {
+      statement = resource.cpd_statement
+      effective_cpd.cpd_cycle_cpd_statement_build_path(statement.cpd_cycle, statement, :activities)
+    }
+
+    def permitted_params
+      params.require(:effective_cpd_statement_activity).permit(
+        :id, :cpd_category_id, :cpd_activity_id, :amount, :amount2, :description, files: []
+      )
+    end
+
+  end
+end

data/app/controllers/effective/cpd_statements_controller.rb

@@ -0,0 +1,71 @@
+module Effective
+  class CpdStatementsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope do
+      cycle = Effective::CpdCycle.find(params[:cpd_cycle_id])
+      Effective::CpdStatement.deep.where(cpd_cycle: cycle, user: current_user)
+    end
+
+    after_save(if: -> { step == :start }) do
+      CpdScorer.new(user: resource.user).score!
+    end
+
+    # Enforce one statement per user per cycle. Redirect them to an existing statement for this cycle.
+    before_action(only: [:new, :show]) do
+      cycle = Effective::CpdCycle.find(params[:cpd_cycle_id])
+      existing = Effective::CpdStatement.where(cpd_cycle: cycle, user: current_user).where.not(id: resource).first
+
+      if existing&.completed?
+        flash[:danger] = "You have already completed a statement for this #{cpd_cycle_label}."
+        redirect_to(root_path)
+      elsif existing.present?
+        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(existing.next_step)} step."
+        redirect_to effective_cpd.cpd_cycle_cpd_statement_build_path(existing.cpd_cycle, existing, existing.next_step)
+      end
+    end
+
+    # Enforce cycle availability
+    before_action(only: [:show, :update]) do
+      cycle = resource.cpd_cycle
+
+      unless cycle.available?
+        flash[:danger] = begin
+          if cycle.ended?
+            "This #{cpd_cycle_label} has ended"
+          elsif !cycle.started?
+            "This #{cpd_cycle_label} has not yet started"
+          else
+            "This #{cpd_cycle_label} is unavailable"
+          end
+        end
+
+        redirect_to(root_path)
+      end
+    end
+
+    def permitted_params
+      case step
+      when :start
+        params.require(:effective_cpd_statement).permit(:current_step)
+      when :activities
+        params.require(:effective_cpd_statement).permit(:current_step)
+      when :agreements
+        params.require(:effective_cpd_statement).permit(
+          :current_step, :confirm_read, :confirm_factual, files: []
+        )
+      when :submit
+        params.require(:effective_cpd_statement).permit(
+          :current_step, :confirm_readonly
+        )
+      when :complete
+        raise('unexpected post to complete')
+      else
+        raise('unexpected step')
+      end
+    end
+
+  end
+end