implementation of the revenue sharing model #2

dachary · 2022-08-15T15:41:38Z

dachary commented

2022-08-15 15:41:38 +00:00

Signed-off-by: Loïc Dachary loic@dachary.org

Signed-off-by: Loïc Dachary <loic@dachary.org>

dachary added 1 commit 2022-08-15 15:41:38 +00:00

0c24ce9ac6

implementation of the revenue sharing model

Signed-off-by: Loïc Dachary <loic@dachary.org>

dachary requested review from realaravinth 2022-08-15 15:41:59 +00:00

dachary requested review from Gusted 2022-08-15 15:41:59 +00:00

Gusted reviewed 2022-08-15 17:26:13 +00:00

Gusted left a comment

Can confirm this is implemented according to specification.

👍 1

share.py Outdated

													
				@ -0,0 +9,4 @@

				# See https://forum.hostea.org/t/decision-revenue-sharing-model/92

				#

				def share_income(income, members):

				    if income <= 0:

Gusted commented

2022-08-15 17:11:24 +00:00

Add a comment:

# If the income is negative or zero, then return members as nobody could be paid out

Add a comment: ``` # If the income is negative or zero, then return members as nobody could be paid out ```

dachary commented

2022-08-15 23:05:23 +00:00

Poster

Your suggestions inspired me to extensively comment on the function and the implementation.

dachary marked this conversation as resolved

share.py Outdated

													
				@ -0,0 +11,4 @@

				def share_income(income, members):

				    if income <= 0:

				        return members

				    if income < len(members):

Gusted commented

2022-08-15 17:12:49 +00:00

# If the income is lower or equal to the amount of members, everyone gets one share.

Just to simplify the case for income == len(members), you could do income <= len(members)

``` # If the income is lower or equal to the amount of members, everyone gets one share. ``` Just to simplify the case for `income == len(members)`, you could do `income <= len(members)`

dachary commented

2022-08-15 23:03:43 +00:00

Poster

done

dachary marked this conversation as resolved

share.py Outdated

													
				@ -0,0 +15,4 @@

				        share = 1

				        count = income

				    else:

				        share = min(int(income / len(members)), min(members, key=lambda m: m[EXPENSE])[EXPENSE])

Gusted commented

2022-08-15 17:25:21 +00:00

# Calculate the share by getting the minimum amount from:
# 1. Get the member with the least amount of expense. (This is to prevent that someone gets more income than necessary when the income is evenly divided among members)
# 2. Income divided by amount of members. (This is to prevent that when the member with least amount of expenses is higher than `amount of members times that amount of expense`, so we don't distrubute more income than we have)

``` # Calculate the share by getting the minimum amount from: # 1. Get the member with the least amount of expense. (This is to prevent that someone gets more income than necessary when the income is evenly divided among members) # 2. Income divided by amount of members. (This is to prevent that when the member with least amount of expenses is higher than `amount of members times that amount of expense`, so we don't distrubute more income than we have) ```

dachary marked this conversation as resolved

share.py Outdated

													
				@ -0,0 +18,4 @@

				        share = min(int(income / len(members)), min(members, key=lambda m: m[EXPENSE])[EXPENSE])

				        count = len(members)

				    remaining = []

				    for i in range(count):

Gusted commented

2022-08-15 17:26:00 +00:00

# Loop trough the possible members and subtract the share of their expense.

``` # Loop trough the possible members and subtract the share of their expense. ```

dachary marked this conversation as resolved

dachary force-pushed wip-share from 0c24ce9ac6 to ba9f610c61

2022-08-15 23:03:08 +00:00

Compare

dachary commented

2022-08-15 23:12:02 +00:00

Poster

@Gusted I'm glad you enjoyed the implementation :-) Since it is a terminal recursion it could be a loop but it would make it a little bit less elegant.

while income >= 0:
   ...
   income = income - share * count
   members = remaining
return members

instead of

return share_income(income - share * count, remaining)

@Gusted I'm glad you enjoyed the implementation :-) Since it is a terminal recursion it could be a loop but it would make it a little bit less elegant. ``` while income >= 0: ... income = income - share * count members = remaining return members ``` instead of ``` return share_income(income - share * count, remaining) ```

Gusted commented

2022-08-16 00:06:37 +00:00

It could be a loop but it would make it a little bit less elegant.

You will end up with a big loop as you would need to handle the edge-cases already being checked for in the first few lines. The recusion seems better for now

> It could be a loop but it would make it a little bit less elegant. You will end up with a big loop as you would need to handle the edge-cases already being checked for in the first few lines. The recusion seems better for now

👍 1

dachary force-pushed wip-share from ba9f610c61 to 332efe15d0

2022-08-16 00:22:04 +00:00

Compare

realaravinth approved these changes 2022-08-16 04:56:34 +00:00

realaravinth left a comment

LGTM. Ran tests locally, must configure CI if we are going to co-dev this tool :)

👍 1

dachary merged commit 4c56b2008d into master

2022-08-16 05:12:08 +00:00

dachary referenced this issue from a commit

2022-08-16 05:12:09 +00:00