effective_work_experience 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d811981a7c43b70ce9db5f3dcae39fa76aa9ef843c40bc4346d35d21c7c9f52
-  data.tar.gz: 492455690ecfae1382073e48f214a1cc71fa0f45088f61238b3307b843aad243
+  metadata.gz: 198d09800c65312ee58cb577f5e2f5e50d605e19ebf3f2b62b0f5fd6a1e8bca2
+  data.tar.gz: b6bc82fcf12e3113f9b1744501936c669937c981d5aa19d944fe1773650eeb7c
 SHA512:
-  metadata.gz: 4f6892d5599fabb1fc93cbc2559b50251d983b5cd011efb411469feeb381d744086e668e5f38c638d946599044b99aede21a8a2c4b4ae33e35b35e632dec7aed
-  data.tar.gz: 8e96bd6e05cc33f5a56ba1c0e28d4531bbd51fc093f57f02fd3ec22c71b45d6a492d9a23d16a87263eb8b2d26759a9c3c2177d04c93856b520b7e14d704547f5
+  metadata.gz: 0d20b2d8754827e003f485430e5738c34247f206eb1e268fbd1aca269c3065c102efc7a7796d69245966f3bfe0c641238a64ac8f0883d93141369077bbcc8549
+  data.tar.gz: fdb4f374f3dd84b70a9ec3e7d7406b713d0383253a79f49b812d7ad6d4804bd70cf4283593cd721d61592a4f4710dcc6e1d15758c994e7359812a0a6c0921b39

data/README.md

@@ -65,33 +65,78 @@ and configure it:
 config.work_experience_summary_class_name = 'Bcsla::WorkExperienceSummary'
 ```
 
+## Categories
+
+Nothing works until there are categories and subcategories to record hours against — a new record
+has one row per subcategory, so with none it is an empty form. Every application defines its own,
+either from the admin screens or from its own seeds. See `db/seeds.rb` for an example set.
+
+`minimum_hours` is optional on both. The work experience report shows a target and a percent
+complete for each category and subcategory that has one, and just the hours to date for those that
+don't.
+
 ## User
 
-Add the following to your User model:
+An intern's mentor is another user, so this gem needs one column on your users table. The install
+migration does not add it. Write your own:
+
+```ruby
+class AddWorkExperienceMentorToUsers < ActiveRecord::Migration[8.0]
+  def change
+    add_column :users, :work_experience_mentor_id, :integer
+  end
+end
+```
+
+Then add the following to your User model:
 
 ```ruby
 effective_work_experience_user
 ```
 
-This requires a `work_experience_mentor_id` column on your users table, and adds:
+which adds the `belongs_to :work_experience_mentor` for that column, plus:
 
-- `work_experience_mentor` — the user who reviews my work experience summaries
 - `work_experience_mentees` — the interns I am a mentor for
 - `work_experience_outside_mentor` — my mentor when they don't have an account. A `has_one`.
 - `work_experience_records`, `work_experience_entries`, `work_experience_projects`, `work_experience_summaries`, `mentee_work_experience_summaries`
 - the `work_experience_hours`, `work_experience_hours_by_year` and `work_experience_total_hours_to_date` calculations
+- `work_experience_intern?`, `work_experience_mentor?` and `work_experience_outside_mentor?`, used by the views and permissions below
 
 An intern with an outside mentor has no `work_experience_mentor`, so their summaries are reviewed automatically on submit.
 
 The summary's `user`, `mentor` and `supervisor` are polymorphic. A summary assigns its mentor from the user's `work_experience_mentor`, and its supervisor from the user's `supervisor` when your User model defines one.
 
+### Who is an intern
+
+`work_experience_intern?` is true once a user has any records or summaries. To have someone see the
+intern dashboard before they've recorded anything, define `intern?` on your User model and it will
+be used too:
+
+```ruby
+def intern?
+  membership.present? && membership.category.intern?
+end
+```
+
+### Admin user form
+
 Render the mentor fields from your own admin user form:
 
 ```haml
-= render('effective/work_experience/user_fields', f: f)
+= render('admin/work_experience/user_fields', f: f, hint: 'Who can be a mentor')
 ```
 
 This is the `work_experience_mentor` select plus an `f.has_many` builder for the one outside mentor.
+The `work_experience_mentor_id` and `work_experience_outside_mentors_attributes` params are permitted
+by effective_resources for free — there is nothing to add to your `effective_resource do` block.
+
+Render an intern's records, projects, summaries and report as a tab on the same form:
+
+```haml
+- if user.work_experience_intern?
+  = tab Effective::WorkExperienceRecord, label: 'Work Experience' do
+    = render('admin/work_experience/user_work_experience', user: user)
+```
 
 ## Dashboard
 

data/app/models/concerns/effective_work_experience_summary.rb

@@ -134,6 +134,24 @@ module EffectiveWorkExperienceSummary
       validates :approve_work_experience_summary, acceptance: true
       validates :recommendation, presence: true
     end
+
+    def can_visit_step?(current_step)
+      return false if current_user == user && intern_steps.exclude?(current_step)
+      return false if current_user == mentor && mentor_steps.exclude?(current_step)
+
+      # Once submitted, the intern cannot go back and submit again
+      if was_submitted?
+        return false if [:start, :records, :projects, :submit].include?(current_step)
+      end
+
+      # Once reviewed, the mentor can go back and review again
+      if was_reviewed?
+        return [:review, :reviewed].include?(current_step)
+      end
+
+      can_revisit_completed_steps(current_step)
+    end
+
   end
 
   def to_s
@@ -172,22 +190,6 @@ module EffectiveWorkExperienceSummary
     mentor.present? || user.try(:work_experience_outside_mentor?).present?
   end
 
-  def can_visit_step?(current_step)
-    return false if current_user == user && intern_steps.exclude?(current_step)
-    return false if current_user == mentor && mentor_steps.exclude?(current_step)
-
-    # Once submitted, the intern cannot go back and submit again
-    if was_submitted?
-      return false if [:start, :records, :projects, :submit].include?(current_step)
-    end
-
-    # Once reviewed, the mentor can go back and review again
-    if was_reviewed?
-      return [:review, :reviewed].include?(current_step)
-    end
-
-    can_revisit_completed_steps(current_step)
-  end
 
   def total_hours_to_date
     user.work_experience_total_hours_to_date(month: end_on)

data/app/models/concerns/effective_work_experience_user.rb

@@ -66,7 +66,7 @@ module EffectiveWorkExperienceUser
   end
 
   def work_experience_intern?
-    return true if try(:intern?)
+    return true if try(:intern?) || try(:pre_intern?)
     work_experience_records.present? || work_experience_summaries.present?
   end
 

data/app/views/effective/work_experience_projects/show.html.haml

@@ -0,0 +1,14 @@
+- resource = (@_effective_resource || Effective::Resource.new(controller_path))
+- @resource = instance_variable_get('@' + resource.name) if resource.name
+
+- if @resource
+  - content_for :resource_buttons do
+    .resource-buttons
+      = render_resource_buttons(@resource, show: false)
+
+  = render_resource_partial(@resource)
+
+.my-4
+
+.form-actions
+  = link_to 'Return to Dashboard', return_to_dashboard_path, class: 'btn btn-lg btn-primary btn-block'

data/app/views/effective/work_experience_records/show.html.haml

@@ -0,0 +1,14 @@
+- resource = (@_effective_resource || Effective::Resource.new(controller_path))
+- @resource = instance_variable_get('@' + resource.name) if resource.name
+
+- if @resource
+  - content_for :resource_buttons do
+    .resource-buttons
+      = render_resource_buttons(@resource, show: false)
+
+  = render_resource_partial(@resource)
+
+.my-4
+
+.form-actions
+  = link_to 'Return to Dashboard', return_to_dashboard_path, class: 'btn btn-lg btn-primary btn-block'

data/lib/effective_work_experience/version.rb

@@ -1,3 +1,3 @@
 module EffectiveWorkExperience
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_work_experience
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Code and Effect
@@ -262,9 +262,11 @@ files:
 - app/views/effective/work_experience_projects/_fields.html.haml
 - app/views/effective/work_experience_projects/_form.html.haml
 - app/views/effective/work_experience_projects/_work_experience_project.html.haml
+- app/views/effective/work_experience_projects/show.html.haml
 - app/views/effective/work_experience_records/_fields.html.haml
 - app/views/effective/work_experience_records/_form.html.haml
 - app/views/effective/work_experience_records/_work_experience_record.html.haml
+- app/views/effective/work_experience_records/show.html.haml
 - app/views/effective/work_experience_reports/_work_experience_report.html.haml
 - app/views/effective/work_experience_reports/show.html.haml
 - app/views/effective/work_experience_summaries/_content.html.haml