effective_mentorships 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d38ae69a59937ebf5e1c21dad2407001277481495e60af6a1d1870609c9c6fb
+  data.tar.gz: a8d9c6644d62270c9f2c28662d94e3e833ecbf57ee1daa99b5ac2668f3dbc234
+SHA512:
+  metadata.gz: f99ac651786e4cbcc30363b4170ace9ba1d44537fe174a8dd67d35ff004a4bb7d2b0e5556015952c0a20450c9d4871b706f659a1cce42074b726233a3d958a0a
+  data.tar.gz: 62124e0a9999292cc0d61e736d808c619f1e942a027edab3fc4c912dda2639fe605cb87bc8b82b87dca3ca8ead57b8b8c6a95c70f312713f752fd3cba3907be8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 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,88 @@
+# Effective Mentorships
+
+Mentorship program to match mentors and mentees.
+
+## 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'
+gem 'effective_mentorships'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_mentorships: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
+```
+
+Please add the following to your User model:
+
+```
+```
+
+Add a link to the admin menu:
+
+```haml
+- if can? :admin, :effective_mentorships
+  = nav_link_to Effective::MentorshipCycle, effective_mentorship.admin_mentorship_cycles_path
+```
+
+## Configuration
+
+As an admin, visit the Mentorship Cycles, and groups
+
+## 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 CanCanCan):
+
+```ruby
+```
+
+## 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_mentorships_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link_tree ../images

data/app/assets/javascripts/effective_mentorships.js

@@ -0,0 +1 @@
+//= require_tree ./effective_mentorship

data/app/controllers/admin/mentorship_cycles_controller.rb

@@ -0,0 +1,17 @@
+module Admin
+  class MentorshipCyclesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_mentorships) }
+
+    include Effective::CrudController
+
+    resource_scope -> { Effective::MentorshipCycle.deep.all }
+
+    private
+
+    def permitted_params
+      params.require(:effective_mentorship_cycle).permit!
+    end
+
+  end
+end

data/app/controllers/effective/mentorship_cycles_controller.rb

@@ -0,0 +1,9 @@
+module Effective
+  class MentorshipCyclesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::CrudController
+
+    resource_scope -> { Effective::MentorshipCycle.deep.all }
+  end
+end

data/app/datatables/admin/effective_mentorship_cycles_datatable.rb

@@ -0,0 +1,27 @@
+module Admin
+  class EffectiveMentorshipCyclesDatatable < Effective::Datatable
+    datatable do
+      order :start_at, :desc
+
+      col :id, visible: false
+      col :created_at, visible: false
+      col :updated_at, visible: false
+
+      col :title
+      col :start_at
+      col :end_at
+
+      col :registration_start_at
+      col :registration_end_at
+
+      col :max_pairings_mentor, label: "Max #{mentorships_mentors_label}"
+      col :max_pairings_mentee, label: "Max #{mentorships_mentees_label}"
+
+      actions_col
+    end
+
+    collection do
+      Effective::MentorshipCycle.all.deep
+    end
+  end
+end

data/app/helpers/effective_mentorships_helper.rb

@@ -0,0 +1,39 @@
+module EffectiveMentorshipsHelper
+
+  def mentorships_name_label
+    et('effective_mentorships.name')
+  end
+
+  def mentorships_mentee_label
+    et('effective_mentorships.mentee')
+  end
+
+  def mentorships_mentees_label
+    ets('effective_mentorships.mentee')
+  end
+
+  def mentorships_mentor_label
+    et('effective_mentorships.mentor')
+  end
+
+  def mentorships_mentors_label
+    ets('effective_mentorships.mentor')
+  end
+
+  def mentorship_cycle_label
+    et(Effective::MentorshipCycle)
+  end
+
+  def mentorship_cycles_label
+    ets(Effective::MentorshipCycle)
+  end
+
+  def mentorship_group_label
+    et(EffectiveMentorships.MentorshipGroup)
+  end
+
+  def mentorship_groups_label
+    ets(EffectiveMentorships.MentorshipGroup)
+  end
+
+end

data/app/mailers/effective/mentorships_mailer.rb

@@ -0,0 +1,18 @@
+module Effective
+  class MentorshipsMailer < EffectiveMentorships.parent_mailer_class
+
+    include EffectiveMailer
+    include EffectiveEmailTemplatesMailer
+
+    protected
+
+    def assigns_for(resource)
+      unless resource.kind_of?(EffectiveMentorships.MentorshipGroup)
+        raise('expected an EffectiveMentorships.MentorshipGroup')
+      end
+
+      {}
+    end
+
+  end
+end

data/app/models/concerns/effective_mentorships_group.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# EffectiveMentorshipsGroup
+#
+# Mark your group model with effective_mentorships_group to get all the includes
+
+module EffectiveMentorshipsGroup
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_mentorships_group
+      include ::EffectiveMentorshipsGroup
+    end
+  end
+
+  module ClassMethods
+    def effective_mentorships_group?; true; end
+  end
+
+  included do
+    log_changes if respond_to?(:log_changes)
+    acts_as_archived
+    acts_as_tokened
+
+    # rich_text_body
+    has_many_rich_texts
+
+    # Effective Scoped
+    belongs_to :mentorship_cycle, class_name: 'Effective::MentorshipCycle', counter_cache: true
+
+    # App Scoped
+    belongs_to :user
+
+    effective_resource do
+      archived      :boolean
+
+      token         :string
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:rich_texts) }
+    scope :sorted, -> { order(:id) }
+  end
+
+  # Instance Methods
+  def to_s
+    model_name.human
+  end
+
+end

data/app/models/concerns/effective_mentorships_registration.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# EffectiveMentorshipsRegistration
+#
+# Mark your group model with effective_mentorships_registration to get all the includes
+
+module EffectiveMentorshipsRegistration
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_mentorships_registration
+      include ::EffectiveMentorshipsRegistration
+    end
+  end
+
+  module ClassMethods
+    def effective_mentorships_registration?; true; end
+
+    def mentorship_roles
+      ['A Mentor', 'A Protege', 'Both']
+    end
+  end
+
+  included do
+    log_changes if respond_to?(:log_changes)
+    acts_as_tokened
+
+    # rich_text_body
+    has_many_rich_texts
+
+    # Effective Scoped
+    belongs_to :mentorship_cycle, class_name: 'Effective::MentorshipCycle', counter_cache: true
+
+    # App Scoped
+    belongs_to :user
+
+    effective_resource do
+      # Preferences
+      mentorship_role   :string
+
+      token             :string
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:rich_texts, :user, :mentorship_cycle) }
+    scope :sorted, -> { order(:id) }
+
+    # User
+    validates :user_id, uniqueness: { scope: [:mentorship_cycle_id] }
+    validates :mentorship_role, presence: true, inclusion: { in: mentorship_roles }
+  end
+
+  # Instance Methods
+  def to_s
+    mentorship_role.presence || model_name.human
+  end
+end

data/app/models/concerns/effective_mentorships_user.rb

@@ -0,0 +1,54 @@
+# EffectiveMentorshipsUser
+#
+# Mark your user model with effective_mentorship_user to get a few helpers
+# And user specific point required scores
+
+module EffectiveMentorshipsUser
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_mentorships_user
+      include ::EffectiveMentorshipsUser
+    end
+  end
+
+  module ClassMethods
+    def effective_mentorships_user?; true; end
+  end
+
+  included do
+    # App Scoped
+    has_many :mentorship_groups, -> { order(:mentorship_cycle_id) }, inverse_of: :user, dependent: :destroy
+    accepts_nested_attributes_for :mentorship_groups, allow_destroy: true
+
+    has_many :mentorship_registrations, -> { order(:mentorship_cycle_id) }, inverse_of: :user, dependent: :destroy
+    accepts_nested_attributes_for :mentorship_registrations, allow_destroy: true
+
+    scope :deep_effective_mentorships_user, -> { all }
+  end
+
+  # Find
+  def mentorship_group(mentorship_cycle:)
+    raise('expected an MentorshipCycle') unless mentorship_cycle.class.respond_to?(:effective_mentorships_mentorship_cycle?)
+    mentorship_groups.find { |mentorship_group| mentorship_group.mentorship_cycle_id == mentorship_cycle.id }
+  end
+
+  # Find or build
+  def build_mentorship_group(mentorship_cycle:)
+    raise('expected an MentorshipCycle') unless mentorship_cycle.class.respond_to?(:effective_mentorships_mentorship_cycle?)
+    mentorship_group(mentorship_cycle: mentorship_cycle) || mentorship_groups.build(mentorship_cycle: mentorship_cycle)
+  end
+
+  # Find
+  def mentorship_registration(mentorship_cycle:)
+    raise('expected an MentorshipCycle') unless mentorship_cycle.class.respond_to?(:effective_mentorships_mentorship_cycle?)
+    mentorship_registrations.find { |mentorship_registration| mentorship_registration.mentorship_cycle_id == mentorship_cycle.id }
+  end
+
+  # Find or build
+  def build_mentorship_registration(mentorship_cycle:)
+    raise('expected an MentorshipCycle') unless mentorship_cycle.class.respond_to?(:effective_mentorships_mentorship_cycle?)
+    mentorship_registration(mentorship_cycle: mentorship_cycle) || mentorship_registrations.build(mentorship_cycle: mentorship_cycle)
+  end
+
+end

data/app/models/effective/mentorship_cycle.rb

@@ -0,0 +1,104 @@
+module Effective
+  class MentorshipCycle < ActiveRecord::Base
+    has_many_rich_texts
+
+    has_many :mentorship_groups
+
+    if respond_to?(:log_changes)
+      log_changes(except: [:mentorship_groups])
+    end
+
+    effective_resource do
+      title                 :string       # 2021 Mentorship Program
+
+      # Availability starts and ends at
+      start_at              :datetime
+      end_at                :datetime
+
+      registration_start_at :datetime
+      registration_end_at   :datetime
+
+      max_pairings_mentor   :integer
+      max_pairings_mentee   :integer
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:rich_texts) }
+
+    scope :shallow, -> { select(:id, :title) }
+    scope :sorted, -> { order(:id) }
+
+    scope :upcoming, -> { where('start_at > ?', Time.zone.now) }
+    scope :available, -> { where('start_at <= ? AND (end_at > ? OR end_at IS NULL)', Time.zone.now, Time.zone.now) }
+    scope :completed, -> { where('end_at < ?', Time.zone.now) }
+
+    validates :title, presence: true
+    validates :start_at, presence: true
+
+    validate(if: -> { start_at.present? && end_at.present? }) do
+      errors.add(:end_at, 'must be after the start date') unless end_at > start_at
+    end
+
+    validate(if: -> { registration_start_at.present? && registration_end_at.present? }) do
+      errors.add(:registration_end_at, 'must be after the registration start date') unless registration_end_at > registration_start_at
+    end
+
+    # before_destroy do
+    #   if (count = mentorship_groups.length) > 0
+    #     raise("#{count} groups belong to this cycle")
+    #   end
+    # end
+
+    def self.effective_mentorships_mentorship_cycle?
+      true
+    end
+
+    def self.latest_cycle
+      order(id: :desc).first
+    end
+
+    def to_s
+      title.presence || model_name.human
+    end
+
+    # Returns a duplicated event object, or throws an exception
+    def duplicate
+      MentorshipCycle.new(attributes.except('id', 'updated_at', 'created_at', 'token')).tap do |mentorship|
+        mentorship.start_at = mentorship.start_at.advance(years: 1) if mentorship.start_at.present?
+        mentorship.end_at = mentorship.end_at.advance(years: 1) if mentorship.end_at.present?
+        mentorship.registration_start_at = mentorship.registration_start_at.advance(years: 1) if mentorship.registration_start_at.present?
+        mentorship.registration_end_at = mentorship.registration_end_at.advance(years: 1) if mentorship.registration_end_at.present?
+
+        mentorship.title = mentorship.title + ' (Copy)'
+
+        mentorship.rich_texts.each { |rt| self.send("rich_text_#{rt.name}=", rt.body) }
+      end
+    end
+
+    # def available?
+    #   started? && !ended?
+    # end
+
+    # def unavailable?
+    #   !available?
+    # end
+
+    # def started?
+    #   start_at.present? && Time.zone.now >= start_at
+    # end
+
+    # def ended?
+    #   end_at.present? && end_at < Time.zone.now
+    # end
+
+    # def available_date
+    #   if start_at && end_at
+    #     "#{start_at.strftime('%F')} to #{end_at.strftime('%F')}"
+    #   elsif start_at
+    #     "#{start_at.strftime('%F')}"
+    #   end
+    # end
+
+  end
+end

data/app/models/effective/mentorship_group.rb

@@ -0,0 +1,5 @@
+module Effective
+  class MentorshipGroup < ActiveRecord::Base
+    effective_mentorships_group
+  end
+end

data/app/models/effective/mentorship_registration.rb

@@ -0,0 +1,5 @@
+module Effective
+  class MentorshipRegistration < ActiveRecord::Base
+    effective_mentorships_registration
+  end
+end

data/app/views/admin/mentorship_cycles/_form.html.haml

@@ -0,0 +1,8 @@
+= tabs do
+  = tab(Effective::MentorshipCycle) do
+    = render 'admin/mentorship_cycles/form_mentorship_cycle', mentorship_cycle: mentorship_cycle
+
+  - if mentorship_cycle.persisted?
+    - if mentorship_cycle.respond_to?(:logs_datatable)
+      = tab 'Logs' do
+        = render_inline_datatable(mentorship_cycle.logs_datatable)

data/app/views/admin/mentorship_cycles/_form_mentorship_cycle.html.haml

@@ -0,0 +1,31 @@
+= effective_form_with(model: [:admin, mentorship_cycle], engine: true) do |f|
+  = f.text_field :title,
+    hint: "The title of this #{mentorship_cycle_label}. Something like #{Time.zone.now.year} #{mentorships_name_label}"
+
+  .row
+    .col-md-6= f.datetime_field :start_at, label: "#{mentorships_name_label} start"
+    .col-md-6= f.datetime_field :end_at, label: "#{mentorships_name_label} end"
+
+  .row
+    .col-md-6
+      = f.number_field :max_pairings_mentor, 
+        label: "Max #{mentorships_mentors_label} per #{mentorship_group_label}",
+        hint: "The maximum number of #{mentorships_mentors_label} that will be assigned to a #{mentorship_group_label}. Leave blank for no maximum."
+
+      = f.number_field :max_pairings_mentee, label: "Max #{mentorships_mentees_label} per #{mentorship_group_label}",
+        hint: "The maximum number of #{mentorships_mentees_label} that will be assigned to a #{mentorship_group_label}. Leave blank for no maximum."
+
+  %hr
+
+  .row
+    .col-md-6
+      %h2 Registration Opt-In
+      %p The online registration opt-in will be available between:
+      = f.datetime_field :registration_start_at, label: "Registration start", hint: "The first day that #{mentorships_mentors_label} and #{mentorships_mentees_label} can register for this #{mentorship_cycle_label}"
+      = f.datetime_field :registration_end_at, label: "Registration end", hint: "The last day that #{mentorships_mentors_label} and #{mentorships_mentees_label} can register for this #{mentorship_cycle_label}"
+
+  = f.submit do
+    = f.save 'Save'
+    - if f.object.persisted?
+      = f.save 'Duplicate', class: 'btn btn-info'
+

data/app/views/effective/mentorships/_dashboard.html.haml

@@ -0,0 +1 @@
+%h2 #{mentorships_name_label}

data/app/views/effective/mentorships_mailer/README.md

@@ -0,0 +1 @@
+If you're not using effective_email_templates each of these views needs to be written.

data/config/effective_mentorships.rb

@@ -0,0 +1,31 @@
+EffectiveMentorships.setup do |config|
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  config.layout = {
+    mentorships: 'application',
+    admin: 'admin'
+  }
+
+  # Mentorship Class Settings
+  # Configure the class responsible for the mentorships
+  # config.mentorship_group_class_name = 'Effective::MentorshipGroup'
+  # config.mentorship_registration_class_name = 'Effective::MentorshipRegistration'
+
+  # Mailer Settings
+  # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
+  #
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::MentorshipMailer'
+  #
+  # Override effective_resource mailer defaults
+  #
+  # config.parent_mailer = nil      # The parent class responsible for sending emails
+  # config.deliver_method = nil     # The deliver method, deliver_later or deliver_now
+  # config.mailer_layout = nil      # Default mailer layout
+  # config.mailer_sender = nil      # Default From value
+  # config.mailer_froms = nil       # Default Froms collection
+  # config.mailer_admin = nil       # Default To value for Admin correspondence
+  # config.mailer_subject = nil     # Proc.new method used to customize Subject
+  #
+  # All mailers work through effective_email_templates
+end

data/config/locales/effective_mentorships.en.yml

@@ -0,0 +1,15 @@
+en:
+  effective_mentorships:
+    name: 'Mentorship Program'
+    acronym: 'Mentorships'
+    mentor: 'Mentor'
+    mentee: 'Mentee'
+
+  activerecord:
+    models:
+      # Application namespace
+      mentorship_group: 'Mentorship Group'
+      mentorship_registration: 'Mentorship Registration'
+
+      # Effective namespace
+      effective/mentorship_cycle: 'Mentorship Cycle'

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+  mount EffectiveMentorships::Engine => '/', as: 'effective_mentorships'
+end
+
+EffectiveMentorships::Engine.routes.draw do
+  scope module: 'effective' do
+  end
+
+  namespace :admin do
+    resources :mentorship_cycles, except: [:show]
+  end
+end

data/db/migrate/101_create_effective_mentorships.rb

@@ -0,0 +1,45 @@
+class CreateEffectiveMentorships < ActiveRecord::Migration[6.0]
+  def change
+    create_table :mentorship_cycles do |t|
+      t.string :title
+
+      t.datetime :start_at
+      t.datetime :end_at
+
+      t.datetime :registration_start_at
+      t.datetime :registration_end_at
+
+      t.integer :max_pairings_mentor
+      t.integer :max_pairings_mentee
+
+      t.integer :mentorship_groups_count, default: 0
+      t.integer :mentorship_registrations_count, default: 0
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table :mentorship_groups do |t|
+      t.integer :mentorship_cycle_id
+      t.integer :user_id
+
+      t.boolean :archived, default: false
+      t.string :token
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table :mentorship_registrations do |t|
+      t.integer :mentorship_cycle_id
+      t.integer :user_id
+
+      t.string :mentorship_role
+
+      t.string :token
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,20 @@
+puts "Running effective_mentorships seeds"
+
+now = Time.zone.now
+
+if Rails.env.test?
+  Effective::MentorshipCycle.delete_all
+  ActionText::RichText.where(record_type: ['Effective::MentorshipCycle']).delete_all
+end
+
+# Build the first MentorshipCycle
+cycle = Effective::MentorshipCycle.create!(
+  title: "#{now.year} Mentorship",
+  start_at: now.beginning_of_year,
+  end_at: now.end_of_year,
+  registration_start_at: now.beginning_of_year,
+  registration_end_at: now.end_of_year,
+  rich_text_all_steps_content: "All Steps Content",
+)
+
+puts "All Done"

data/lib/effective_mentorships/engine.rb

@@ -0,0 +1,20 @@
+module EffectiveMentorships
+  class Engine < ::Rails::Engine
+    engine_name 'effective_mentorships'
+
+    # Set up our default configuration options.
+    initializer 'effective_mentorships.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_mentorships.rb")
+    end
+
+    # Include concerns and allow any ActiveRecord object to call it
+    initializer 'effective_mentorships.active_record' do |app|
+      app.config.to_prepare do
+        ActiveRecord::Base.extend(EffectiveMentorshipsUser::Base)
+        ActiveRecord::Base.extend(EffectiveMentorshipsGroup::Base)
+        ActiveRecord::Base.extend(EffectiveMentorshipsRegistration::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_mentorships/version.rb

@@ -0,0 +1,3 @@
+module EffectiveMentorships
+  VERSION = '0.0.1'
+end

data/lib/effective_mentorships.rb

@@ -0,0 +1,47 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_mentorships/engine'
+require 'effective_mentorships/version'
+
+module EffectiveMentorships
+
+  def self.config_keys
+    [
+      :mentorship_cycles_table_name, :mentorship_groups_table_name, :mentorship_registrations_table_name,
+      :mentorship_group_class_name, :mentorship_registration_class_name,
+      :layout,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_froms, :mailer_admin, :mailer_subject,
+    ]
+  end
+
+  include EffectiveGem
+
+  def self.mailer_class
+    mailer&.constantize || Effective::MentorshipsMailer
+  end
+
+  def self.MentorshipGroup
+    mentorship_group_class_name&.constantize || Effective::MentorshipGroup
+  end
+
+  def self.MentorshipRegistration
+    mentorship_registration_class_name&.constantize || Effective::MentorshipRegistration
+  end
+
+  def self.MentorshipCycle
+    Effective::MentorshipCycle
+  end
+
+  def self.current_mentorship_cycle(date: nil)
+    date ||= Time.zone.now
+    mentorship_cycles = Effective::MentorshipCycle.all.reorder(start_at: :asc).all.where('start_at <= ?', date)
+    mentorship_cycles.to_a.last
+  end
+
+  def self.previous_mentorship_cycle(date: nil)
+    date ||= Time.zone.now
+    mentorship_cycles = Effective::MentorshipCycle.all.reorder(start_at: :asc).all.where('start_at <= ?', date)
+    mentorship_cycles.to_a.last(2).first
+  end
+
+end

data/lib/generators/effective_mentorships/install_generator.rb

@@ -0,0 +1,42 @@
+module EffectiveMentorships
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveMentorships initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_mentorship.rb', 'config/initializers/effective_mentorship.rb'
+      end
+
+      def copy_locale
+        template ('../' * 3) + 'config/locales/effective_mentorships.en.yml', 'config/locales/effective_mentorships.en.yml'
+      end
+
+      def create_migration_file
+        migration_template ('../' * 3) + 'db/migrate/101_create_effective_mentorships.rb.erb', 'db/migrate/create_effective_mentorships.rb'
+      end
+
+      def copy_mailer_preview
+        mailer_preview_path = (Rails.application.config.action_mailer.preview_path rescue nil)
+
+        if mailer_preview_path.present?
+          template 'effective_mentorships_mailer_preview.rb', File.join(mailer_preview_path, 'effective_mentorships_mailer_preview.rb')
+        else
+          puts "couldn't find action_mailer.preview_path. Skipping effective_mentorships_mailer_preview."
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_mentorship_mailer_preview.rb

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

data/lib/tasks/effective_mentorships_tasks.rake

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

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: effective_mentorships
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Code and Effect
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_datatables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_email_templates
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wicked
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_developer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_roles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Mentorship matching for mentors and mentees rails engine
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/effective_mentorships_manifest.js
+- app/assets/javascripts/effective_mentorships.js
+- app/assets/stylesheets/effective_mentorships.scss
+- app/controllers/admin/mentorship_cycles_controller.rb
+- app/controllers/effective/mentorship_cycles_controller.rb
+- app/datatables/admin/effective_mentorship_cycles_datatable.rb
+- app/helpers/effective_mentorships_helper.rb
+- app/mailers/effective/mentorships_mailer.rb
+- app/models/concerns/effective_mentorships_group.rb
+- app/models/concerns/effective_mentorships_registration.rb
+- app/models/concerns/effective_mentorships_user.rb
+- app/models/effective/mentorship_cycle.rb
+- app/models/effective/mentorship_group.rb
+- app/models/effective/mentorship_registration.rb
+- app/views/admin/mentorship_cycles/_form.html.haml
+- app/views/admin/mentorship_cycles/_form_mentorship_cycle.html.haml
+- app/views/effective/mentorships/_dashboard.html.haml
+- app/views/effective/mentorships_mailer/README.md
+- config/effective_mentorships.rb
+- config/locales/effective_mentorships.en.yml
+- config/routes.rb
+- db/migrate/101_create_effective_mentorships.rb
+- db/seeds.rb
+- lib/effective_mentorships.rb
+- lib/effective_mentorships/engine.rb
+- lib/effective_mentorships/version.rb
+- lib/generators/effective_mentorships/install_generator.rb
+- lib/generators/templates/effective_mentorship_mailer_preview.rb
+- lib/tasks/effective_mentorships_tasks.rake
+homepage: https://github.com/code-and-effect/effective_mentorships
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Mentorship matching for mentors and mentees rails engine
+test_files: []