effective_committees 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b793fe3d40958ea8fc7e853979a10ef40cdbdfc043893b93690ad62f8d5c7604
+  data.tar.gz: 414192d935ae2fc8f6b5b24617a97c219e72a069728c8e3a22241ef7449301bb
+SHA512:
+  metadata.gz: 784a0ccd91b3d7fdff1023a75f41506a771b17293ad73cb4c14de8d1184cd1c580a10c46d29072302c182ed906d13910f6837e191169306e052fbf77b30a5a74
+  data.tar.gz: 0b09e1874e3a24d4e29b71e12ecddf4920634d4c57fcdbf0a1c5d6e49210fb5e5b18c80d9d4507d0fbec1bd8852f19b18d4c13a0befe7530c0e6924c4d5d7495

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 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,186 @@
+# 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](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' # or try using gem 'hamlit-rails'
+gem 'effective_committees'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+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:
+
+```ruby
+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):
+
+```ruby
+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.](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_committees_manifest.js

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

data/app/assets/javascripts/effective_committeesjs

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

data/app/assets/stylesheets/effective_committees.scss

@@ -0,0 +1 @@
+@import 'effective_committees/base';

data/app/controllers/admin/committee_files_controller.rb

@@ -0,0 +1,16 @@
+module Admin
+  class CommitteeFilesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_committees) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_committee_file) ? :effective_committee_file : :committee_file)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/committee_folders_controller.rb

@@ -0,0 +1,16 @@
+module Admin
+  class CommitteeFoldersController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_committees) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_committee_folder) ? :effective_committee_folder : :committee_folder)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/committee_members_controller.rb

@@ -0,0 +1,16 @@
+module Admin
+  class CommitteeMembersController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_committees) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_committee_member) ? :effective_committee_member : :committee_member)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/committees_controller.rb

@@ -0,0 +1,22 @@
+module Admin
+  class CommitteesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_committees) }
+
+    include Effective::CrudController
+
+    submit :save, 'Save'
+    submit :save, 'Save and Add New', redirect: :new
+    submit :save, 'Save and View', redirect: -> { effective_committees.committee_path(resource) }
+
+    resource_scope -> { Effective::Committee.deep.all }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_committee) ? :effective_committee : :committee)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/effective/committee_folders_controller.rb

@@ -0,0 +1,7 @@
+module Effective
+  class CommitteeFoldersController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::CrudController
+  end
+end

data/app/controllers/effective/committee_members_controller.rb

@@ -0,0 +1,19 @@
+module Effective
+  class CommitteeMembersController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::CrudController
+
+    resource_scope -> {
+      committees = Effective::Committee.deep.where(id: current_user.committees)
+      Effective::CommitteeMember.deep.where(committee: committees)
+    }
+
+    private
+
+    def permitted_params
+      params.require(:effective_committee_member).permit!
+    end
+
+  end
+end

data/app/controllers/effective/committees_controller.rb

@@ -0,0 +1,17 @@
+module Effective
+  class CommitteesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::CrudController
+
+    resource_scope -> { Effective::Committee.all.deep }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_committee) ? :effective_committee : :committee)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_committee_files_datatable.rb

@@ -0,0 +1,24 @@
+module Admin
+  class EffectiveCommitteeFilesDatatable < Effective::Datatable
+    datatable do
+      col :updated_at, visible: false
+      col :created_at, visible: false
+
+      col :id, visible: false
+
+      col :committee, search: :string
+      col :committee_folder, search: :string, label: 'Folder'
+
+      col :file
+      col :title
+      col :notes
+
+      actions_col
+    end
+
+    collection do
+      Effective::CommitteeFile.deep.all
+    end
+
+  end
+end

data/app/datatables/admin/effective_committee_folders_datatable.rb

@@ -0,0 +1,28 @@
+module Admin
+  class EffectiveCommitteeFoldersDatatable < Effective::Datatable
+    datatable do
+      reorder :position
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+
+      col :id, visible: false
+
+      col :committee, search: :string
+
+      col :title, label: 'Folder'
+      col :slug, visible: false
+      col :body
+
+      col :committee_files, label: 'Files', search: :string
+      col :committee_files_count, label: 'Files Count', visible: false
+
+      actions_col
+    end
+
+    collection do
+      Effective::CommitteeFolder.deep.all
+    end
+
+  end
+end

data/app/datatables/admin/effective_committee_members_datatable.rb

@@ -0,0 +1,32 @@
+module Admin
+  class EffectiveCommitteeMembersDatatable < Effective::Datatable
+    datatable do
+      col :id, visible: false
+      col :user_id, visible: false
+
+      col :committee
+      col :user
+
+      unless attributes[:user_id]
+        col :email do |committee_member|
+          mail_to(committee_member.user.email)
+        end
+      end
+
+      if EffectiveCommittees.use_effective_roles
+        col :roles, search: roles_collection
+      end
+
+      actions_col
+    end
+
+    collection do
+      Effective::CommitteeMember.deep.all
+    end
+
+    def roles_collection
+      EffectiveRoles.roles_collection(Effective::CommitteeMember.new).map(&:second)
+    end
+
+  end
+end

data/app/datatables/admin/effective_committees_datatable.rb

@@ -0,0 +1,34 @@
+module Admin
+  class EffectiveCommitteesDatatable < Effective::Datatable
+    datatable do
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+
+      col :id, visible: false
+
+      col :title, label: 'Committee'
+      col :slug, visible: false
+      col :body
+
+      col :committee_members, label: 'Members', search: :string
+      col :committee_members_count, label: 'Members Count', visible: false
+
+      col :committee_folders, label: 'Folders', search: :string
+      col :committee_folders_count, label: 'Folders Count', visible: false
+
+      col :committee_files, label: 'Files', search: :string
+      col :committee_files_count, label: 'Files Count', visible: false
+
+      actions_col do |committee|
+        dropdown_link_to('View Committee', effective_committees.committee_path(committee), target: '_blank')
+      end
+
+    end
+
+    collection do
+      Effective::Committee.deep.all
+    end
+
+  end
+end

data/app/datatables/effective_committee_members_datatable.rb

@@ -0,0 +1,42 @@
+class EffectiveCommitteeMembersDatatable < Effective::Datatable
+  datatable do
+    col :id, visible: false
+
+    col :committee
+    col :user
+
+    unless attributes[:user_id]
+      col :email do |committee_member|
+        mail_to(committee_member.user.email)
+      end
+    end
+
+    if EffectiveCommittees.use_effective_roles
+      col :roles, search: roles_collection
+    end
+
+    unless attributes[:actions] == false
+      actions_col
+    end
+
+  end
+
+  collection do
+    scope = Effective::CommitteeMember.deep.all.where(committee: current_user.committees)
+
+    if attributes[:committee_id]
+      scope = scope.where(committee_id: attributes[:committee_id])
+    end
+
+    if attributes[:user_id]
+      scope = scope.where(user_id: attributes[:user_id])
+    end
+
+    scope
+  end
+
+  def roles_collection
+    EffectiveRoles.roles_collection(Effective::CommitteeMember.new).map(&:second)
+  end
+
+end

data/app/datatables/effective_committees_datatable.rb

@@ -0,0 +1,31 @@
+# Dashboard Committees
+class EffectiveCommitteesDatatable < Effective::Datatable
+  datatable do
+    order :title
+
+    col :id, visible: false
+
+    col :title, label: 'Committee'
+
+    col :committee_members, search: :string, label: 'Members'
+
+    col :committee_folders, search: :string, label: 'Folders'
+
+    col :committee_folders_count, label: 'Folders', visible: false do |committee|
+      pluralize(committee.committee_folders_count, 'folders')
+    end
+
+    col :committee_files, search: :string, label: 'Files', visible: false
+
+    col :committee_files_count, label: 'Files' do |committee|
+      pluralize(committee.committee_files_count, 'files')
+    end
+
+    actions_col
+  end
+
+  collection do
+    Effective::Committee.deep.where(id: current_user.committees)
+  end
+
+end

data/app/helpers/effective_committees_helper.rb

@@ -0,0 +1,3 @@
+module EffectiveCommitteesHelper
+
+end

data/app/models/concerns/effective_committees_user.rb

@@ -0,0 +1,40 @@
+# EffectiveCommitteesUser
+#
+# Mark your user model with effective_committees_user to get all the includes
+
+module EffectiveCommitteesUser
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_committees_user
+      include ::EffectiveCommitteesUser
+    end
+  end
+
+  module ClassMethods
+    def effective_committees_user?; true; end
+  end
+
+  included do
+    has_many :committee_members, -> { Effective::CommitteeMember.sorted },
+      class_name: 'Effective::CommitteeMember', inverse_of: :user, dependent: :delete_all
+
+    accepts_nested_attributes_for :committee_members, allow_destroy: true
+  end
+
+  # Instance Methods
+
+  def committee_member(committee:)
+    committee_members.find { |rep| rep.committee_id == committee.id }
+  end
+
+  # Find or build
+  def build_committee_member(committee:)
+    committee_member(committee: committee) || committee_members.build(committee: committee)
+  end
+
+  def committees
+    committee_members.reject(&:marked_for_destruction?).map(&:committee)
+  end
+
+end

data/app/models/effective/committee.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Effective
+  class Committee < ActiveRecord::Base
+    self.table_name = EffectiveCommittees.committees_table_name.to_s
+
+    acts_as_slugged
+
+    log_changes if respond_to?(:log_changes)
+    has_rich_text :body
+
+    has_many :committee_members, -> { Effective::CommitteeMember.sorted }, class_name: 'Effective::CommitteeMember', inverse_of: :committee, dependent: :delete_all
+    accepts_nested_attributes_for :committee_members, allow_destroy: true
+
+    has_many :committee_folders, -> { Effective::CommitteeFolder.sorted }, class_name: 'Effective::CommitteeFolder', inverse_of: :committee, dependent: :delete_all
+    accepts_nested_attributes_for :committee_folders, allow_destroy: true
+
+    has_many :committee_files, -> { Effective::CommitteeFile.sorted }, class_name: 'Effective::CommitteeFile', inverse_of: :committee, dependent: :delete_all
+    accepts_nested_attributes_for :committee_files, allow_destroy: true
+
+    effective_resource do
+      title                     :string
+      slug                      :string
+
+      committee_members_count   :integer # Counter Cache
+      committee_folders_count   :integer # Counter Cache
+      committee_files_count     :integer # Counter Cache
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:title) }
+    scope :deep, -> { includes(:committee_members) }
+
+    validates :title, presence: true, uniqueness: true, length: { maximum: 255 }
+
+    def to_s
+      title.presence || 'New Committee'
+    end
+
+    def committee_member(user:)
+      committee_members.find { |member| member.user_id == user.id }
+    end
+
+    # Find or build
+    def build_committee_member(user:)
+      committee_member(user: user) || committee_members.build(user: user)
+    end
+
+    def users
+      committee_members.reject(&:marked_for_destruction?).map(&:user)
+    end
+
+  end
+end