OpenSlides/client/src/app/site/assignments/services/assignment-poll.service.ts

251 lines
9.0 KiB
TypeScript
Raw Normal View History

2019-03-04 18:28:21 +01:00
import { Injectable } from '@angular/core';
import { ConfigService } from 'app/core/ui-services/config.service';
import {
PollService,
PollMajorityMethod,
MajorityMethod,
CalculablePollKey,
PollVoteValue
} from 'app/core/ui-services/poll.service';
import { ViewAssignmentPollOption } from '../models/view-assignment-poll-option';
import { ViewAssignmentPoll } from '../models/view-assignment-poll';
2019-03-04 18:28:21 +01:00
type AssignmentPollValues = 'auto' | 'votes' | 'yesnoabstain' | 'yesno';
export type AssignmentPollMethod = 'yn' | 'yna' | 'votes';
2019-04-18 17:09:59 +02:00
export type AssignmentPercentBase = 'YES_NO_ABSTAIN' | 'YES_NO' | 'VALID' | 'CAST' | 'DISABLED';
2019-03-04 18:28:21 +01:00
2019-04-25 15:34:42 +02:00
/**
* Vote entries included once for summary (e.g. total votes cast)
*/
export type SummaryPollKey = 'votescast' | 'votesvalid' | 'votesinvalid' | 'votesno' | 'votesabstain';
2019-03-04 18:28:21 +01:00
/**
* Service class for assignment polls.
2019-03-04 18:28:21 +01:00
*/
@Injectable({
providedIn: 'root'
})
export class AssignmentPollService extends PollService {
/**
* list of poll keys that are numbers and can be part of a quorum calculation
*/
public pollValues: CalculablePollKey[] = ['votesno', 'votesabstain', 'votesvalid', 'votesinvalid', 'votescast'];
2019-03-04 18:28:21 +01:00
/**
* the method used for polls (as per config)
*/
public pollMethod: AssignmentPollValues;
/**
* the method used to determine the '100%' base (set in config)
*/
public percentBase: AssignmentPercentBase;
/**
* convenience function for displaying the available majorities
*/
public get majorityMethods(): MajorityMethod[] {
return PollMajorityMethod;
}
/**
* Constructor. Subscribes to the configuration values needed
*
2019-03-04 18:28:21 +01:00
* @param config ConfigService
*/
public constructor(config: ConfigService) {
super();
config
.get<string>('assignments_poll_default_majority_method')
.subscribe(method => (this.defaultMajorityMethod = method));
config
.get<AssignmentPollValues>('assignments_poll_vote_values')
.subscribe(method => (this.pollMethod = method));
config
.get<AssignmentPercentBase>('assignments_poll_100_percent_base')
.subscribe(base => (this.percentBase = base));
}
public getVoteOptionsByPoll(poll: ViewAssignmentPoll): CalculablePollKey[] {
return this.pollValues.filter(name => poll[name] !== undefined);
}
2019-03-04 18:28:21 +01:00
/**
* Get the base amount for the 100% calculations. Note that some poll methods
* (e.g. yes/no/abstain may have a different percentage base and will return null here)
2019-03-04 18:28:21 +01:00
*
* @param poll
* @returns The amount of votes indicating the 100% base
*/
public getBaseAmount(poll: ViewAssignmentPoll): number | null {
2019-03-04 18:28:21 +01:00
switch (this.percentBase) {
case 'DISABLED':
return null;
case 'YES_NO':
case 'YES_NO_ABSTAIN':
if (poll.pollmethod === 'votes') {
const yes = poll.options.map(option => {
2019-04-18 17:09:59 +02:00
const yesValue = option.votes.find(v => v.value === 'Votes');
2019-03-04 18:28:21 +01:00
return yesValue ? yesValue.weight : -99;
});
if (Math.min(...yes) < 0) {
return null;
} else {
// TODO: Counting 'No (and possibly 'Abstain') here?
2019-03-04 18:28:21 +01:00
return yes.reduce((a, b) => a + b);
}
} else {
return null;
}
case 'CAST':
return poll.votescast > 0 && poll.votesinvalid >= 0 ? poll.votescast : null;
case 'VALID':
return poll.votesvalid > 0 ? poll.votesvalid : null;
2019-03-04 18:28:21 +01:00
default:
return null;
}
}
/**
* Get the percentage for an option
2019-03-04 18:28:21 +01:00
*
* @param poll
* @param option
* @param value
* @returns a percentage number with two digits, null if the value cannot be calculated
*/
public getPercent(poll: ViewAssignmentPoll, option: ViewAssignmentPollOption, value: PollVoteValue): number | null {
2019-04-18 17:09:59 +02:00
let base = 0;
if (this.percentBase === 'DISABLED') {
return null;
} else if (this.percentBase === 'VALID') {
base = poll.votesvalid;
} else if (this.percentBase === 'CAST') {
base = poll.votescast;
} else {
base = poll.pollmethod === 'votes' ? poll.pollBase : this.getOptionBaseAmount(poll, option);
}
if (!base || base < 0) {
2019-03-04 18:28:21 +01:00
return null;
}
const vote = option.votes.find(v => v.value === value);
if (!vote) {
return null;
}
return Math.round(((vote.weight * 100) / base) * 100) / 100;
}
/**
* get the percentage for a non-abstract per-poll value
* TODO: similar code to getPercent. Mergeable?
*
* @param poll the poll this value refers to
* @param value a per-poll value (e.g. 'votesvalid')
* @returns a percentage number with two digits, null if the value cannot be calculated
*/
public getValuePercent(poll: ViewAssignmentPoll, value: CalculablePollKey): number | null {
if (!poll.pollBase) {
return null;
}
const amount = poll[value];
if (amount === undefined || amount < 0) {
return null;
}
return Math.round(((amount * 100) / poll.pollBase) * 100) / 100;
}
2019-03-04 18:28:21 +01:00
/**
* Check if the option in a poll is abstract (percentages should not be calculated)
*
* @param poll
* @param option
2019-04-18 17:09:59 +02:00
* @param key (optional) the key to calculate
2019-03-04 18:28:21 +01:00
* @returns true if the poll has no percentages, the poll option is a special value,
* or if the calculations are disabled in the config
*/
2019-04-18 17:09:59 +02:00
public isAbstractOption(poll: ViewAssignmentPoll, option: ViewAssignmentPollOption, key?: PollVoteValue): boolean {
if (this.percentBase === 'DISABLED' || !option.votes || !option.votes.length) {
return true;
}
if (key === 'Abstain' && this.percentBase === 'YES_NO') {
2019-03-04 18:28:21 +01:00
return true;
}
if (poll.pollmethod === 'votes') {
return poll.pollBase ? false : true;
} else {
return option.votes.some(v => v.weight < 0);
}
}
/**
* Check for abstract (not usable as percentage) options in non-option
* 'meta' values
*
* @param poll
* @param value
* @returns true if percentages cannot be calculated
* TODO: Yes, No, etc. in an option will always return true.
* Use {@link isAbstractOption} for these
*/
public isAbstractValue(poll: ViewAssignmentPoll, value: CalculablePollKey): boolean {
2019-04-18 17:09:59 +02:00
if (this.percentBase === 'DISABLED' || !poll.pollBase || !this.pollValues.includes(value)) {
2019-03-04 18:28:21 +01:00
return true;
}
if (this.percentBase === 'CAST' && poll[value] >= 0) {
return false;
} else if (this.percentBase === 'VALID' && value === 'votesvalid' && poll[value] > 0) {
return false;
}
return true;
}
/**
* Calculate the base amount inside an option. Only useful if poll method is not 'votes'
*
* @returns an positive integer to be used as percentage base, or null
*/
private getOptionBaseAmount(poll: ViewAssignmentPoll, option: ViewAssignmentPollOption): number | null {
2019-04-18 17:09:59 +02:00
if (this.percentBase === 'DISABLED' || poll.pollmethod === 'votes') {
2019-03-04 18:28:21 +01:00
return null;
2019-04-18 17:09:59 +02:00
} else if (this.percentBase === 'CAST') {
return poll.votescast > 0 ? poll.votescast : null;
} else if (this.percentBase === 'VALID') {
return poll.votesvalid > 0 ? poll.votesvalid : null;
2019-03-04 18:28:21 +01:00
}
const yes = option.votes.find(v => v.value === 'Yes');
const no = option.votes.find(v => v.value === 'No');
2019-04-18 17:09:59 +02:00
if (this.percentBase === 'YES_NO') {
2019-03-04 18:28:21 +01:00
if (!yes || yes.weight === undefined || !no || no.weight === undefined) {
return null;
}
return yes.weight >= 0 && no.weight >= 0 ? yes.weight + no.weight : null;
2019-04-18 17:09:59 +02:00
} else if (this.percentBase === 'YES_NO_ABSTAIN') {
2019-03-04 18:28:21 +01:00
const abstain = option.votes.find(v => v.value === 'Abstain');
if (!abstain || abstain.weight === undefined) {
return null;
}
return yes.weight >= 0 && no.weight >= 0 && abstain.weight >= 0
? yes.weight + no.weight + abstain.weight
: null;
}
}
/**
* Get the minimum amount of votes needed for an option to pass the quorum
*
* @param method
* @param poll
* @param option
* @returns a positive integer number; may return null if quorum is not calculable
*/
public yesQuorum(
method: MajorityMethod,
poll: ViewAssignmentPoll,
option: ViewAssignmentPollOption
): number | null {
2019-03-04 18:28:21 +01:00
const baseAmount = poll.pollmethod === 'votes' ? poll.pollBase : this.getOptionBaseAmount(poll, option);
return method.calc(baseAmount);
}
}