slavadev/project_la_poste

Project LaPoste is a gem that allows you to calculate delivery prices and discounts following predefined rules.

Project LaPoste

Project LaPoste is a gem that allows you to calculate delivery prices and discounts following predefined rules.

Prerequisites

• Ruby >= 2.5
• (optional, for tests) Bundler >= 2

Usage

To run LaPoste you need provide a file with transactions(input.txt is used by default):

$ bin/run your_input.txt

To run tests

$ bin/setup
$ bin/test

Highlights

• Project LaPoste is designed as a gem, which allows you to easily integrate it to your project or run independently
• It's designed to be easily changeable and extendable. Things which are especially easy to add:
  • New providers and new sources of providers
  • New producers of transactions
  • New rules
• The code:
  • Is covered by tests
  • Follows style guides
  • Includes YARD documentation comments
  • Has clear commits history following Conventional Commits specification
  • Is automatically checked by CI(Github Actions)

Next steps:

• (Important) Replace Float type with some kind of Money class(1,2) in all places where we deal with money. It will save us from rounding and other nasty problems.
• Add test coverage reports
• Add some kind of monitoring, e.g. DataDog
• (Optional) Add Sorbet types if the team is interested