A practice sandbox on the theme of a billing system. Pushing testing, separation of concerns, and modeling.
PHP Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Resources/doc
lib/Renoirb/Biller
spec/Renoirb/Biller/Model
tests
.gitignore
Gemfile
Gemfile.lock
Guardfile
README.md
composer.json
composer.lock
phpunit.xml.dist

README.md

testing-sandbox

Upcoming library to provide Billing functionality to any PSR compliant project.

Current state: A practice sandbox on the theme of a billing system. Pushing testing, separation of concerns, and modeling.

IMPORTANT: This code is not ready for usage yet.

INSTALLING

  1. Get Composer, see: http://getcomposer.org/download/

  2. Get the dependencies by using composer

    php composer.phar --dev install

  3. Adjust phpunit.xml file

    cp phpunit.xml.dist phpunit.xml

  4. Execute testing:

    bin/phpunit

USE IN A PROJECT

Edit your project's composer.json file with the following configurations:

        "require": {
            "renoirb/testing-sandbox": "dev-master",
        },
        "repositories": [
            {
                "type": "vcs",
                "url": "git@github.com:renoirb/testing-sandbox.git"
            }
        ]

SCOPE

The scope of this project is to deliver the following:

  • Provide structure to implement billing system
  • Provide utilities to convert items from an inventory, and create a bill statement based on them
  • Provide mechanism to calculate taxes, and also support compound taxes
  • Provide base entity class for Tax, InventoryItem, Bill, (Bill) Line
  • Provide event based hooks to add your own logic on top of the provided system