Skip to content

cpf-fmt v3 #24

@juliolmuller

Description

@juliolmuller

Version 3+ will be structured similarly yo the PHP and Python version of the packages:

  • Main component should be object-oriented, so a class should wrap the logic of formatting CPF.
  • Create a class to manage formatter options and apply default values when necessary.
    • Options are meant to be changed by using properties assignment, not getters and setters functions anymore.
  • Create custom errors for ALL exepcted errors.
  • Validate and parse arguments, when possible, and throw a custom TypeError.
  • The following components are now expeced to be exported from the final bundle:
    • CpfFormatter (base class)
    • CpfFormatterOptions
    • cpfFmt (should be a bound function of the format method of a default instance).
    • CnpjFormatterTypeError (abstract)
    • CpfFormatterInputTypeError
    • CpfFormatterOptionTypeError
    • CpfFormatterException (abstract)
    • CpfFormatterOptionHiddenRangeException
    • CpfFormatterInputLengthException
    • CpfFormatterInputInvalidException
  • Update unit tests
  • Update documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions