effective_work_experience 0.0.1

data/config/locales/effective_work_experience.en.yml

@@ -0,0 +1,94 @@
+en:
+  effective_work_experience:
+    name: 'Work Experience'
+
+  activerecord:
+    models:
+      # These ones might be app level
+      app/work_experience_summary: 'Work Experience Summary'
+
+      # These ones should stay effective
+      effective/work_experience_category: 'Work Experience Category'
+      effective/work_experience_subcategory: 'Work Experience Subcategory'
+      effective/work_experience_record: 'Work Experience Record'
+      effective/work_experience_entry: 'Work Experience Entry'
+      effective/work_experience_project: 'Work Experience Project'
+      effective/work_experience_summary: 'Work Experience Summary'
+      effective/work_experience_outside_mentor: 'Outside Mentor'
+
+    attributes:
+      effective/work_experience_category:
+        title: 'Title'
+        minimum_hours: 'Minimum Hours'
+        position: 'Position'
+
+      effective/work_experience_subcategory:
+        title: 'Title'
+        minimum_hours: 'Minimum Hours'
+        position: 'Position'
+        work_experience_category: 'Category'
+        body: 'Description'
+
+      effective/work_experience_record:
+        month: 'Month'
+        total_hours: 'Hours'
+        backdated: 'Backdated'
+        submitted_at: 'Submitted'
+        reviewed_at: 'Reviewed'
+
+      effective/work_experience_entry:
+        work_experience_subcategory: 'Subcategory'
+        week_1: 'Week 1'
+        week_2: 'Week 2'
+        week_3: 'Week 3'
+        week_4: 'Week 4'
+        week_5: 'Week 5'
+
+      effective/work_experience_project:
+        name: 'Name'
+        description: 'Description'
+        start_on: 'Start Date'
+        end_on: 'End Date'
+
+      effective/work_experience_summary:
+        user: 'Intern'
+        mentor: 'Mentor'
+        supervisor: 'Supervisor'
+        start_on: 'Start Date'
+        end_on: 'End Date'
+        total_hours: 'Hours this period'
+        total_hours_to_date: 'Total hours to date'
+        recommendation: 'Recommendation'
+        comments: 'Reviewer Comments'
+        submitted_at: 'Submitted'
+        reviewed_at: 'Reviewed'
+        approve_work_experience_summary: 'Approve Work Experience Summary'
+
+      effective/work_experience_outside_mentor:
+        name: 'Name'
+        email: 'Email'
+        phone: 'Phone'
+        regulated_profession: 'Regulated Profession'
+        admin_notes: 'Admin Notes'
+
+  # The work experience report is an ActiveModel, not an ActiveRecord
+  activemodel:
+    models:
+      effective/work_experience_report: 'Work Experience Report'
+
+    attributes:
+      effective/work_experience_report:
+        user: 'Intern'
+
+  datatables:
+    effective_work_experience_summaries_datatable: 'Work Experience Summaries'
+    effective_work_experience_summaries_review_datatable: 'Work Experience Summaries to Review'
+    effective_work_experience_records_datatable: 'Work Experience Records'
+    effective_work_experience_projects_datatable: 'Work Experience Projects'
+    effective_work_experience_reports_review_datatable: 'Work Experience Reports'
+    admin/effective_work_experience_summaries_datatable: 'Work Experience Summaries'
+    admin/effective_work_experience_records_datatable: 'Work Experience Records'
+    admin/effective_work_experience_projects_datatable: 'Work Experience Projects'
+    admin/effective_work_experience_categories_datatable: 'Work Experience Categories'
+    admin/effective_work_experience_subcategories_datatable: 'Work Experience Subcategories'
+    admin/effective_work_experience_reports_datatable: 'Work Experience Reports'

data/config/routes.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount EffectiveWorkExperience::Engine => '/', as: 'effective_work_experience'
+end
+
+EffectiveWorkExperience::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+    resources :work_experience_records
+    resources :work_experience_projects
+    resources :work_experience_reports, only: [:show]
+
+    resources :work_experience_summaries, only: [:new, :create, :show, :destroy] do
+      resources :build, controller: :work_experience_summaries, only: [:show, :update]
+    end
+  end
+
+  namespace :admin do
+    resources :work_experience_categories, only: [:index, :show, :edit, :update]
+    resources :work_experience_subcategories, except: [:show]
+    resources :work_experience_projects
+    resources :work_experience_records
+    resources :work_experience_reports, only: [:index, :show]
+    resources :work_experience_summaries, only: [:index, :show, :edit, :update, :destroy]
+  end
+
+end

data/db/migrate/101_create_effective_work_experience.rb

@@ -0,0 +1,120 @@
+class CreateEffectiveWorkExperience < ActiveRecord::Migration[6.0]
+  def change
+    create_table :work_experience_categories do |t|
+      t.string :title
+      t.integer :minimum_hours
+      t.integer :position
+
+      t.timestamps
+    end
+
+    create_table :work_experience_subcategories do |t|
+      t.integer :work_experience_category_id
+
+      t.string :title
+      t.integer :minimum_hours
+      t.integer :position
+
+      t.timestamps
+    end
+
+    create_table :work_experience_outside_mentors do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.string :name
+      t.string :email
+      t.string :phone
+      t.string :regulated_profession
+      t.text :admin_notes
+
+      t.timestamps
+    end
+
+    create_table :work_experience_records do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.date :month
+      t.decimal :total_hours, precision: 10, scale: 2
+
+      # There can only be one backdated work experience record
+      t.boolean :backdated, default: false
+
+      t.string :status
+      t.text :status_steps
+
+      t.datetime :submitted_at
+      t.datetime :reviewed_at
+
+      t.timestamps
+    end
+
+    create_table :work_experience_entries do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.integer :work_experience_record_id
+      t.integer :work_experience_subcategory_id
+
+      t.decimal :week_1, precision: 10, scale: 2
+      t.decimal :week_2, precision: 10, scale: 2
+      t.decimal :week_3, precision: 10, scale: 2
+      t.decimal :week_4, precision: 10, scale: 2
+      t.decimal :week_5, precision: 10, scale: 2
+
+      t.timestamps
+    end
+
+    create_table :work_experience_projects do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.string :name
+      t.text :description
+
+      t.date :start_on
+      t.date :end_on
+
+      t.timestamps
+    end
+
+    create_table :work_experience_summaries do |t|
+      t.integer :user_id
+      t.string :user_type
+
+      t.integer :mentor_id
+      t.string :mentor_type
+
+      t.integer :supervisor_id
+      t.string :supervisor_type
+
+      t.string :status
+      t.text :status_steps
+
+      t.text :wizard_steps
+
+      t.date :start_on
+      t.date :end_on
+
+      t.decimal :total_hours, precision: 10, scale: 2
+
+      t.string :recommendation
+      t.text :comments
+
+      t.datetime :submitted_at
+      t.datetime :reviewed_at
+
+      t.string :token
+
+      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]
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,40 @@
+puts "Running effective_work_experience seeds"
+
+# An example set of work experience categories and subcategories.
+# Each application will define their own, from the admin screens or their own seeds.
+
+categories = [
+  { title: 'Design Development', minimum_hours: 500, position: 1 },
+  { title: 'Contract Documents', minimum_hours: 1275, position: 2 },
+  { title: 'Office Practice', minimum_hours: 155, position: 3 },
+  { title: 'Other', minimum_hours: nil, position: 4 }
+]
+
+categories.each do |attributes|
+  work_experience_category = Effective::WorkExperienceCategory.where(title: attributes[:title]).first_or_initialize
+  work_experience_category.update!(attributes)
+end
+
+subcategories = [
+  { category: 'Design Development', position: 1, minimum_hours: 200, title: 'Conceptual Designs' },
+  { category: 'Design Development', position: 2, minimum_hours: 300, title: 'Other Design Development' },
+  { category: 'Contract Documents', position: 3, minimum_hours: 150, title: 'Grading and Drainage Plans' },
+  { category: 'Contract Documents', position: 4, minimum_hours: 1125, title: 'Other Contract Documents' },
+  { category: 'Office Practice', position: 5, minimum_hours: 155, title: 'Meetings' },
+  { category: 'Other', position: 6, minimum_hours: nil, title: 'Other' }
+]
+
+subcategories.each do |attributes|
+  work_experience_category = Effective::WorkExperienceCategory.where(title: attributes[:category]).first!
+
+  work_experience_subcategory = Effective::WorkExperienceSubcategory.where(position: attributes[:position]).first_or_initialize
+
+  work_experience_subcategory.update!(
+    work_experience_category: work_experience_category,
+    position: attributes[:position],
+    minimum_hours: attributes[:minimum_hours],
+    title: attributes[:title]
+  )
+end
+
+puts "Created #{Effective::WorkExperienceCategory.count} work experience categories and #{Effective::WorkExperienceSubcategory.count} subcategories"

data/lib/effective_work_experience/engine.rb

@@ -0,0 +1,19 @@
+module EffectiveWorkExperience
+  class Engine < ::Rails::Engine
+    engine_name 'effective_work_experience'
+
+    # Set up our default configuration options.
+    initializer 'effective_work_experience.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_work_experience.rb")
+    end
+
+    # Include the work experience concerns and allow any ActiveRecord object to call them
+    initializer 'effective_work_experience.active_record' do |app|
+      app.config.to_prepare do
+        ActiveRecord::Base.extend(EffectiveWorkExperienceSummary::Base)
+        ActiveRecord::Base.extend(EffectiveWorkExperienceUser::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_work_experience/version.rb

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

data/lib/effective_work_experience.rb

@@ -0,0 +1,34 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_work_experience/engine'
+require 'effective_work_experience/version'
+
+module EffectiveWorkExperience
+
+  def self.config_keys
+    [
+      :work_experience_categories_table_name, :work_experience_subcategories_table_name,
+      :work_experience_records_table_name, :work_experience_entries_table_name,
+      :work_experience_projects_table_name, :work_experience_summaries_table_name,
+      :work_experience_outside_mentors_table_name,
+
+      :work_experience_summary_class_name,
+
+      :layout, :recommendations, :summary_months,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject,
+      :use_effective_email_templates
+    ]
+  end
+
+  include EffectiveGem
+
+  # The only swappable class. Mark yours with effective_work_experience_summary
+  def self.WorkExperienceSummary
+    work_experience_summary_class_name&.constantize || Effective::WorkExperienceSummary
+  end
+
+  def self.mailer_class
+    mailer&.constantize || Effective::WorkExperienceMailer
+  end
+
+end

data/lib/generators/effective_work_experience/install_generator.rb

@@ -0,0 +1,24 @@
+module EffectiveWorkExperience
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveWorkExperience initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Migration.next_migration_number(current_migration_number(dirname) + 1)
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_work_experience.rb', 'config/initializers/effective_work_experience.rb'
+      end
+
+      def create_migration_file
+        migration_template ('../' * 3) + 'db/migrate/101_create_effective_work_experience.rb', 'db/migrate/create_effective_work_experience.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_work_experience_mailer_preview.rb

@@ -0,0 +1,4 @@
+# Visit http://localhost:3000/rails/mailers
+
+class EffectiveWorkExperienceMailerPreview < ActionMailer::Preview
+end

data/lib/tasks/effective_work_experience_tasks.rake

@@ -0,0 +1,8 @@
+namespace :effective_work_experience do
+
+  # bundle exec rake effective_work_experience:seed
+  task seed: :environment do
+    load "#{__dir__}/../../db/seeds.rb"
+  end
+
+end