effective_organizations 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbee46f5235da4b9d6fa04d84daab02383cfe373532138dc6ec601fc3110ced
-  data.tar.gz: a400d6e2ecec13c3a98b6e58beda724471628e9262100dbeb5f9b414940fd417
+  metadata.gz: a2ee1cb9ffc7df883ea343966168245ab3d77ba59ef9753a20d825702ba46aaa
+  data.tar.gz: fcd8f65d9dbc66c5073077e6bd7fe9f48774c4444d965c7c4ce95d09c3d97935
 SHA512:
-  metadata.gz: c7a6df31f4b94032905653c0ba44489ba4ac87b47f7e48e488726e4e9c9d8a26b41a02211f94f277ce91c871765ef0bce77a33ebf4aa0dbaef9a5f71ddf83520
-  data.tar.gz: 84dfedd0a963e6080faac3e7e8553e7739d9179d9e13d4aabb251516848fae840668d02c627884d6acb78d12588d5a221a3d287ee0d63d9b75f7f4b0389dce30
+  metadata.gz: a34485e30e3d66f85cb4dff1ed2ccd6656134ac5171c2ceae64e8fc30336144c1ac6c9889dab98b018dbdad0c2b3bda96e583f70583a9907f09eaf1ed4ebe1a0
+  data.tar.gz: fb7e677000619da597b0b43f5ae827211d2d55fca0d51326559b27bb7fc7fbd7b3155260afa37f7768360a0f695d2d80667dabc680414f2479582c645c438dac

data/README.md

@@ -71,16 +71,85 @@ Add a link to the admin menu:
 
 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(:caaa) 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::Representative' => {
+      owner: 'the 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::Representative' => {
+      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, EffectiveOrganizations.Organization
+  can(:show, EffectiveOrganizations.Organization) { |organization| user.organizations.include?(organization) }
+
+  can([:edit, :update], EffectiveOrganizations.Organization) do |organization|
+    rep = user.representative(organization: organization)
+    rep && (rep.is?(:owner) || rep.is?(:billing))
+  end
+
+  can :index, Effective::Representative
+  can(:new, Effective::Representative)
+
+  can([:create, :edit, :update], Effective::Representative) do |representative|
+    rep = user.representative(organization: representative.organization)
+    rep && (rep.is?(:owner) || rep.is?(:billing))
+  end
+
+  can(:destroy, Effective::Representative) do |representative|
+    allowed = !(representative.is?(:owner) || representative.is?(:billing))
+    rep = user.representative(organization: representative.organization)
+
+    allowed && rep && (rep.is?(:owner) || rep.is?(:billing))
+  end
+end
 
 if user.admin?
   can :admin, :effective_organizations
-  can :manage, Effective::Organization
-  can :manage, Effective::Representative
+  can(crud, EffectiveOrganizations.Organization)
+
+  can(crud - [:destroy], Effective::Representative)
+  can(:destroy, Effective::Representative) { |rep| !rep.is?(:owner) }
 end
 ```
 

data/app/datatables/effective_representatives_datatable.rb

@@ -11,11 +11,24 @@ class EffectiveRepresentativesDatatable < Effective::Datatable
 
     col :roles, search: roles_collection
 
-    actions_col
+    unless attributes[:actions] == false
+      actions_col
+    end
+
   end
 
   collection do
-    Effective::Representative.deep.all.where(organization: current_user.organizations)
+    scope = Effective::Representative.deep.all.where(organization: current_user.organizations)
+
+    if attributes[:organization_id]
+      scope = scope.where(organization_id: attributes[:organization_id])
+    end
+
+    if attributes[:user_id]
+      scope = scope.where(user_id: attributes[:user_id])
+    end
+
+    scope
   end
 
   def roles_collection

data/app/models/concerns/effective_organizations_organization.rb

@@ -6,7 +6,11 @@ module EffectiveOrganizationsOrganization
   extend ActiveSupport::Concern
 
   module Base
-    def effective_organizations_organization
+    def effective_organizations_organization(users_source_type: nil)
+      @effective_organizations_organization_opts = {
+        users_source_type: users_source_type
+      }
+
       include ::EffectiveOrganizationsOrganization
     end
   end
@@ -20,7 +24,7 @@ module EffectiveOrganizationsOrganization
   end
 
   included do
-    log_changes(except: :representatives) if respond_to?(:log_changes)
+    log_changes(except: [:representatives, :users]) if respond_to?(:log_changes)
 
     # rich_text_body
     # has_many_rich_texts
@@ -28,7 +32,10 @@ module EffectiveOrganizationsOrganization
     has_many :representatives, -> { Effective::Representative.sorted },
       class_name: 'Effective::Representative', inverse_of: :organization, dependent: :delete_all
 
-    has_many :users, through: :representatives
+    accepts_nested_attributes_for :representatives, allow_destroy: true
+
+    has_many :users, through: :representatives,
+      source_type: (@effective_organizations_organization_opts[:users_source_type] || (name.start_with?('Effective') ? '::User' : "#{name.split('::').first}::Organization"))
 
     effective_resource do
       title                 :string
@@ -53,4 +60,13 @@ module EffectiveOrganizationsOrganization
     title.presence || 'New Organization'
   end
 
+  def representative(user:)
+    representatives.find { |rep| rep.user_id == user.id }
+  end
+
+  # Find or build
+  def build_representative(user:)
+    representative(user: user) || representatives.build(user: user)
+  end
+
 end

data/app/models/concerns/effective_organizations_user.rb

@@ -6,7 +6,11 @@ module EffectiveOrganizationsUser
   extend ActiveSupport::Concern
 
   module Base
-    def effective_organizations_user
+    def effective_organizations_user(organizations_source_type: nil)
+      @effective_organizations_user_opts = {
+        organizations_source_type: organizations_source_type
+      }
+
       include ::EffectiveOrganizationsUser
     end
   end
@@ -20,8 +24,11 @@ module EffectiveOrganizationsUser
     has_many :representatives, -> { Effective::Representative.sorted },
       class_name: 'Effective::Representative', inverse_of: :user, dependent: :delete_all
 
+    accepts_nested_attributes_for :representatives, allow_destroy: true
+
     # App scoped
-    has_many :organizations, through: :representatives
+    has_many :organizations, through: :representatives,
+      source_type: @effective_organizations_user_opts[:organizations_source_type] || "#{name.split('::').first}::Organization"
   end
 
   def representative(organization:)

data/app/models/effective/organization.rb

@@ -3,5 +3,6 @@ module Effective
     self.table_name = EffectiveOrganizations.organizations_table_name.to_s
 
     effective_organizations_organization
+
   end
 end

data/app/models/effective/representative.rb

@@ -7,9 +7,10 @@ module Effective
 
     log_changes(to: :organization) if respond_to?(:log_changes)
 
-    belongs_to :organization, counter_cache: true
+    belongs_to :organization, polymorphic: true, counter_cache: true
     belongs_to :user, polymorphic: true
 
+    accepts_nested_attributes_for :organization
     accepts_nested_attributes_for :user
 
     effective_resource do
@@ -28,8 +29,8 @@ module Effective
     validates :organization, presence: true
     validates :user, presence: true
 
-    validates :user_id, if: -> { user_id && user_type && organization_id },
-      uniqueness: { scope: [:organization_id], message: 'already belongs to this organization' }
+    validates :user_id, if: -> { user_id && user_type && organization_id && organization_type },
+      uniqueness: { scope: [:organization_id, :organization_type], message: 'already belongs to this organization' }
 
     def to_s
       user.to_s
@@ -40,5 +41,10 @@ module Effective
       self.user = user_type.constantize.new(attributes)
     end
 
+    def build_organization(attributes = {})
+      raise('please assign organization_type first') if organization_type.blank?
+      self.organization = organization_type.constantize.new(attributes)
+    end
+
   end
 end

data/app/views/admin/organizations/_fields.html.haml

@@ -0,0 +1,6 @@
+- categories = EffectiveOrganizations.Organization.categories
+
+- if categories.present?
+  = f.select :category, categories, required: true
+
+= f.text_field :title

data/app/views/admin/organizations/_form_organization.html.haml

@@ -1,14 +1,9 @@
 = effective_form_with(model: [:admin, organization], engine: true) do |f|
-  - categories = EffectiveOrganizations.Organization.categories
-
-  - if categories.present?
-    = f.select :category, categories, required: true
-
-  = f.text_field :title
+  = render 'admin/organizations/fields', f: f
 
   = effective_submit(f)
 
 - if organization.persisted?
   %h2 Representatives
-  - datatable = Admin::EffectiveRepresentativesDatatable.new(organization_id: organization.id)
+  - datatable = Admin::EffectiveRepresentativesDatatable.new(organization_id: organization.id, organization_type: organization.class.name)
   = render_inline_datatable(datatable)

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

@@ -4,12 +4,13 @@
   = f.hidden_field :user_id
   = f.hidden_field :user_type
   = f.hidden_field :organization_id
+  = f.hidden_field :organization_type
 
   - if f.object.new_record?
     - unless inline_datatable? && inline_datatable.attributes[:organization_id].present?
-      = f.select :organization_id, EffectiveOrganizations.Organization.sorted
+      = f.select :organization, { 'Organizations' => EffectiveOrganizations.Organization.sorted }, polymorphic: true
 
-    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object, skip_disabled: true)
 
     - unless inline_datatable? && inline_datatable.attributes[:user_id].present?
       = f.radios :new_representative_user_action, ['Invite new user', 'Add existing user'], inline: true, label: 'Representative'
@@ -28,7 +29,7 @@
     - unless inline_datatable? && inline_datatable.attributes[:user_id].present?
       = f.static_field :user
 
-    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object, skip_disabled: true)
 
     - unless inline_datatable? && inline_datatable.attributes[:user_id].present?
       = f.fields_for :user, f.object.user do |fu|

data/app/views/effective/organizations/_fields.html.haml

@@ -0,0 +1,6 @@
+- categories = EffectiveOrganizations.Organization.categories
+
+- if categories.present?
+  = f.select :category, categories, required: true
+
+= f.text_field :title

data/app/views/effective/organizations/_form_organization.html.haml

@@ -1,16 +1,11 @@
 - url = (organization.persisted? ? effective_organizations.organization_path(organization) : effective_organizations.organizations_path)
 
 = effective_form_with(model: organization, url: url) do |f|
-  - categories = EffectiveOrganizations.Organization.categories
-
-  - if categories.present?
-    = f.select :category, categories, required: true
-
-  = f.text_field :title
+  = render 'effective/organizations/fields', f: f
 
   = f.submit
 
 - if organization.persisted?
   %h2 Representatives
-  - datatable = EffectiveRepresentativesDatatable.new(organization_id: organization.id)
+  - datatable = EffectiveRepresentativesDatatable.new(organization: organization)
   = render_inline_datatable(datatable)

data/app/views/effective/representatives/_form.html.haml

@@ -4,12 +4,13 @@
   = f.hidden_field :user_id
   = f.hidden_field :user_type
   = f.hidden_field :organization_id
+  = f.hidden_field :organization_type
 
   - if f.object.new_record?
     - unless inline_datatable? && inline_datatable.attributes[:organization_id].present?
-      = f.select :organization_id, EffectiveOrganizations.Organization.sorted
+      = f.select :organization, { 'Organizations' => EffectiveOrganizations.Organization.sorted }, polymorphic: true
 
-    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object, skip_disabled: true)
 
     - unless inline_datatable? && inline_datatable.attributes[:user_id].present?
       = f.hidden_field :new_representative_user_action, value: 'Invite new user'
@@ -24,7 +25,7 @@
     - unless inline_datatable? && inline_datatable.attributes[:user_id].present?
       = f.static_field :user
 
-    = f.checks :roles, EffectiveRoles.roles_collection(f.object)
+    = f.checks :roles, EffectiveRoles.roles_collection(f.object, skip_disabled: true)
 
     = f.fields_for :user, f.object.user do |fu|
       = render 'effective/representatives/user_fields', f: fu

data/db/migrate/01_create_effective_organizations.rb.erb

@@ -18,7 +18,6 @@ class CreateEffectiveOrganizations < ActiveRecord::Migration[6.0]
     # Representatives
     create_table :representatives do |t|
       t.integer :organization_id
-      t.string :organization_type
 
       t.integer :user_id
       t.string :user_type
@@ -29,7 +28,7 @@ class CreateEffectiveOrganizations < ActiveRecord::Migration[6.0]
       t.datetime :created_at
     end
 
-    add_index :representatives, [:organization_id, :organization_type]
+    add_index :representatives, [:organization_id]
     add_index :representatives, [:user_id, :user_type]
 
   end

data/lib/effective_organizations/version.rb

@@ -1,3 +1,3 @@
 module EffectiveOrganizations
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_organizations
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !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: :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
@@ -178,11 +192,13 @@ files:
 - app/models/concerns/effective_organizations_user.rb
 - app/models/effective/organization.rb
 - app/models/effective/representative.rb
+- app/views/admin/organizations/_fields.html.haml
 - app/views/admin/organizations/_form.html.haml
 - app/views/admin/organizations/_form_organization.html.haml
 - app/views/admin/representatives/_form.html.haml
 - app/views/admin/representatives/_user_fields.html.haml
 - app/views/effective/organizations/_dashboard.html.haml
+- app/views/effective/organizations/_fields.html.haml
 - app/views/effective/organizations/_form.html.haml
 - app/views/effective/organizations/_form_organization.html.haml
 - app/views/effective/representatives/_form.html.haml