Effective Committees

Committees are groups of users that can all share files.

Getting Started

This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.

Please first install the effective_datatables gem.

Please download and install the Twitter Bootstrap4

Add to your Gemfile:

gem 'haml-rails' # or try using gem 'hamlit-rails'
gem 'effective_committees'

Run the bundle command to install it:

bundle install

Then run the generator:

rails generate effective_committees: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:

rake db:migrate

Please add the following to your User model:

effective_committees_user

Use the following datatables to display to your user their applicants dues:

```haml
%h2 My Committees
= render 'effective/committees/dashboard'

and

Add a link to the admin menu:

```haml
- if can? :admin, :effective_committees
  = nav_dropdown 'Committees' do
    - if can? :index, Effective::Committee
      = nav_link_to 'Committees', effective_committees.admin_committees_path

    - if can? :index, Effective::CommitteeMember
      = nav_link_to 'Committee Members', effective_committees.admin_committee_members_path

    - if can? :index, Effective::CommitteeFolder
      = nav_link_to 'Committee Folders', effective_committees.admin_committee_folders_path

    - if can? :index, Effective::CommitteeFile
      = nav_link_to 'Committee Files', effective_committees.admin_committee_files_path

Configuration

Authorization

All authorization checks are handled via the effective_resources gem found in the config/initializers/effective_resources.rb file.

Effective Roles

This gem works with effective roles for the representative roles.

Configure your config/initializers/effective_roles.rb something like this:

EffectiveRoles.setup do |config|
  config.roles = [:admin, :reserved, :owner, :billing] # Only add to the end of this array. Never prepend roles.

  # config.role_descriptions
  # ========================
  # This setting configures the text that is displayed by form helpers (see README.md)

  config.role_descriptions = {
    'User' => {
      # User roles
      admin: 'can log in to the /admin section of the website. full access to everything.',
    },
    'Effective::CommitteeMember' => {
      owner: 'committee owner. full access to everything.',
      billing: 'the billing contact. full access to everything.'
    }
  }

  # config.assignable_roles
  # Which roles can be assigned by whom
  # =======================
  # When current_user is passed into a form helper function (see README.md)
  # this setting determines which roles that current_user may assign
  config.assignable_roles = {
    'User' => { admin: [:admin] },

    'Effective::CommitteeMember' => {
      admin: [:owner, :billing],
      owner: [:owner, :billing],
      billing: [:billing]
    }
  }
end

Permissions

The permissions you actually want to define are as follows (using CanCan):

if user.persisted?
  can :index, Effective::Committee
  can(:show, Effective::Committee) { |committee| user.committees.include?(committee) }

  can([:edit, :update], Effective::Committee) do |committee|
    user.committee_member(committee: committee)&.is?(:owner)
  end

  can :index, Effective::CommitteeMember

  can(:show, Effective::CommitteeMember) { |member| user.committees.include?(member.committee) }
  can(:new, Effective::CommitteeMember)

  can([:create, :edit, :update], Effective::CommitteeMember) do |cm|
    user.committee_member(committee: cm.committee)&.is?(:owner)
  end

  can(:destroy, Effective::CommitteeMember) do |member|
    user.committee_member(committee: member.committee)&.is?(:owner) && !member.is?(:owner)
  end

  can(:show, Effective::CommitteeFolder) { |folder| user.committees.include?(folder.committee) }
  can(:show, Effective::CommitteeFile) { |file| user.committees.include?(file.committee) }
end

if user.admin?
  can :admin, :effective_committees

  can(crud - [:destroy], Effective::Committee)
  can(:destroy, Effective::Committee) { |committee| committee.committee_members_count == 0 }

  can(crud - [:destroy], Effective::CommitteeFolder)
  can(:destroy, Effective::CommitteeFolder) { |folder| folder.committee_files_count == 0 }

  can(crud, Effective::CommitteeMember)
  can(crud, Effective::CommitteeFile)
end

License

MIT License. Copyright Code and Effect Inc.

Testing

Run tests by:

rails test

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Bonus points for test coverage
Create new Pull Request