effective_work_experience 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a876f18790cdca6bc9e13228ec0be8b643e4167e1e348cfaf00f09c9376f79f
-  data.tar.gz: c08a8257f216cb33f27760b729526b76d854a6d4f7d71ec32c21af581f78c358
+  metadata.gz: 5b1b17b8acb26be41f882c4aba1bd5546986dc12bed911b4ee7fba690d1dee4b
+  data.tar.gz: a40e92b082bc6217ee0c3fc11452b7c3aa36afa35b95571b3a140eccbedd1bbf
 SHA512:
-  metadata.gz: 7c4aa51ef471a77a677dfb382e4a4c190336903557b827d3b9839c93f075ad2c856b8d281692f0efbe8d6291d5c99fd797d77cf840dd8e71048ebb0104fbd597
-  data.tar.gz: '0788634767708d121ce06edadf1cfefd9c5150b4cfed0ae5e0e354143a3f4446b0891a0115ccf3b45c98911c426223ca0cda33af45d782c60b738e85f1128723'
+  metadata.gz: 4741e55d2afddd0d6e7478ee8adcd5fdcf8f3307e669fb4a84ff522efbd5657b583f22ccc295953dc41076c82b44619738b647df6a38e10b5b9bec6029fdd691
+  data.tar.gz: b283fcdc327b1353f89bc43ae92012271dd21a9307cf6a7c11801fccfc54a71df5bce0eee3a00c04c0747a55f61d6e5f6acbc6c575d5dac746696c02475c41f5

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_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_records/_fields.html.haml

@@ -23,7 +23,7 @@
 
   - f.object.work_experience_subcategories.group_by(&:work_experience_category).each do |work_experience_category, work_experience_subcategories|
     %tbody
-      - category_hours = work_experience_subcategories.sum { |work_experience_subcategory| user.work_experience_total_hours_to_date(work_experience_subcategory: work_experience_subcategory, month: ceiling_month) }
+      - category_hours = work_experience_subcategories.sum { |work_experience_subcategory| user&.work_experience_total_hours_to_date(work_experience_subcategory: work_experience_subcategory, month: ceiling_month) || 0.0 }
       %tr{style: "background: #f6f8fa"}
         %th{colspan: 6}= work_experience_category
         %th.text-right= (category_hours > 0.0 ? work_experience_hours_to_s(category_hours) : '-')
@@ -45,7 +45,7 @@
             %td= ef.number_text_field :week_4, label: false
             %td= ef.number_text_field :week_5, label: false
             %td.text-right
-              - hours = user.work_experience_total_hours_to_date(work_experience_subcategory: work_experience_subcategory, month: ceiling_month)
+              - hours = user&.work_experience_total_hours_to_date(work_experience_subcategory: work_experience_subcategory, month: ceiling_month) || 0.0
               = (hours > 0.0 ? work_experience_hours_to_s(hours) : '-')
             %td.text-right
               - if work_experience_subcategory.minimum_hours.present?

data/config/locales/effective_work_experience.en.yml

@@ -27,7 +27,7 @@ en:
         minimum_hours: 'Minimum Hours'
         position: 'Position'
         work_experience_category: 'Category'
-        body: 'Description'
+        body: 'Body'
 
       effective/work_experience_record:
         month: 'Month'

data/db/migrate/101_create_effective_work_experience.rb

@@ -1,6 +1,6 @@
 class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
   def change
-    create_table :work_experience_categories do |t|
+    create_table :work_experience_categories, if_not_exists: true do |t|
       t.string :title
       t.integer :minimum_hours
       t.integer :position
@@ -8,7 +8,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_subcategories do |t|
+    create_table :work_experience_subcategories, if_not_exists: true do |t|
       t.integer :work_experience_category_id
 
       t.string :title
@@ -18,7 +18,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_outside_mentors do |t|
+    create_table :work_experience_outside_mentors, if_not_exists: true do |t|
       t.integer :user_id
       t.string :user_type
 
@@ -31,7 +31,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_records do |t|
+    create_table :work_experience_records, if_not_exists: true do |t|
       t.integer :user_id
       t.string :user_type
 
@@ -50,7 +50,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_entries do |t|
+    create_table :work_experience_entries, if_not_exists: true do |t|
       t.integer :user_id
       t.string :user_type
 
@@ -66,7 +66,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_projects do |t|
+    create_table :work_experience_projects, if_not_exists: true do |t|
       t.integer :user_id
       t.string :user_type
 
@@ -79,7 +79,7 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :work_experience_summaries do |t|
+    create_table :work_experience_summaries, if_not_exists: true do |t|
       t.integer :user_id
       t.string :user_type
 
@@ -110,11 +110,11 @@ class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    add_index :work_experience_outside_mentors, [:user_id, :user_type], unique: true
-    add_index :work_experience_records, [:user_id, :user_type]
-    add_index :work_experience_entries, [:work_experience_record_id]
-    add_index :work_experience_projects, [:user_id, :user_type]
-    add_index :work_experience_summaries, [:user_id, :user_type]
-    add_index :work_experience_summaries, [:mentor_id, :mentor_type]
+    add_index :work_experience_outside_mentors, [:user_id, :user_type], unique: true, if_not_exists: true
+    add_index :work_experience_records, [:user_id, :user_type], if_not_exists: true
+    add_index :work_experience_entries, [:work_experience_record_id], if_not_exists: true
+    add_index :work_experience_projects, [:user_id, :user_type], if_not_exists: true
+    add_index :work_experience_summaries, [:user_id, :user_type], if_not_exists: true
+    add_index :work_experience_summaries, [:mentor_id, :mentor_type], if_not_exists: true
   end
 end

data/lib/effective_work_experience/version.rb

@@ -1,3 +1,3 @@
 module EffectiveWorkExperience
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_work_experience
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Code and Effect