10. Dragon ADR Damage Take

  • ADR - Architecture Design Records

10.1. Problem

  • Make DMG points damage to the dragon

10.2. Option 1

>>> dragon.set_damage(DMG)

  • Good: easy to use

  • Good: clear intent

  • Good: encapsulation

  • Bad: the name indicates a setter of a damage attribute

  • Bad: not Pythonic way

  • Decision: rejected, method name indicates something else

10.3. Option 2

>>> dragon.wound(DMG)       # dragon  -> enemy
>>> dragon.hurt(DMG)        # dragon <-  enemy
>>> dragon.hit(DMG)         # dragon <-> enemy
>>> dragon.damage(DMG)      # dragon  -> enemy

  • Bad: Indication of direction is too weak dragon <-> enemy

  • Decision: rejected, indication of direction is too weak

Rationale:

dragon --> enemy
dragon  -> enemy
dragon <-> enemy
dragon <-  enemy
dragon <-- enemy

10.4. Option 3

>>> dragon.hurt_self(DMG)
>>> dragon.receive_damage(DMG)

  • Good: Explicit relation dragon --> enemy

  • Good: Consistent with deal_damage()

  • Bad: hurt_self() is too use-case specific

  • Bad: Inconsistent with make_damage()

  • Decision: rejected, method names are too use-case specific

10.5. Option 4

>>> dragon.take_damage(DMG)

  • Good: Explicit relation dragon --> enemy

  • Good: Consistent with make_damage()

  • Decision: candidate

10.6. Option 5

>>> dragon.health - DMG
>>> dragon.health -= DMG

  • Good: simple

  • Good: can use @property for validation if needed

  • Bad: requires knowledge of API

  • Bad: violates encapsulation

  • Decision: rejected, violates encapsulation

10.7. Option 6

>>> dragon.health - Damage(20)
>>> dragon.health -= Damage(20)

  • Good: simple

  • Good: can use @property for validation if needed

  • Bad: requires knowledge of API

  • Bad: violates encapsulation

  • Decision: rejected, violates encapsulation

10.8. Option 7

>>> dragon - DMG
>>> dragon -= DMG

  • Good: simple

  • Good: can use .__sub__() for validation if needed

  • Bad: requires knowledge of API

  • Decision: rejected, not explicit and requires knowledge of API

10.9. Option 8

>>> dragon - Damage(20)
>>> dragon -= Damage(20)

  • Good: simple

  • Good: can use .__sub__() for validation if needed

  • Bad: requires knowledge of API

  • Decision: rejected, not explicit and requires knowledge of API

10.10. Option 9

>>> dragon < Damage(20)
>>> dragon <= Damage(20)

  • Good: simple

  • Good: can use .__lt__(), .__le__() for validation if needed

  • Bad: requires knowledge of API

  • Decision: rejected, not explicit and requires knowledge of API

10.11. Option 10

>>> dragon.__sub__(DMG)
>>> dragon.__isub__(DMG)

  • Good: provides encapsulation

  • Bad: not Pythonic way

  • Bad: not simple

  • Bad: requires knowledge of API

  • Decision: rejected, not explicit and requires knowledge of API

10.12. Decision

>>> dragon.take_damage(DMG)

  • Good: provides encapsulation

  • Good: easy to use

  • Good: explicit relation dragon --> enemy