/splittable

This gem solves the problem of several decimal places in divisions where the result must be presented in cents, that is converting the division result to only two decimal places and the difference is attributed to the first plot.

Primary LanguageRubyMIT LicenseMIT

Splittable

Gem Version Ruby

Goal

This gem solves the problem of several decimal places in divisions where the result must be presented in cents, that is converting the division result to only two decimal places and the difference is attributed to the first plot.

Installation

Add this line to your application's Gemfile:

gem 'splittable'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install splittable

Usage

Using division method:

Splittable.division(value: 0.1188888, quantity: 3)

Result: the total truncated value was divided by the number of plots informed and attributed the difference in the first installment:

=> [0.5e-1, 0.3e-1, 0.3e-1] # => [0.05, 0.03, 0.03]

Default precision is 2 decimal places, but, you can customize this with precision parameter:

Splittable.division(value: 10, quantity: 3, precision: 3)

Result:

=> [0.3334e1, 0.3333e1, 0.3333e1] # => [0.334, 0.333, 0.333]

Using normalize method:

Splittable.normalize(value: 100.003, installments: [33.33, 21.433, 43.33333])

Result: all values are truncated and them the difference is attributed in the first installment:

=> [0.3524e2, 0.2143e2, 0.4333e2] # => [35.24, 21.43, 43.33]

In this method, you have the same optional precision parameter:

Splittable.normalize(value: 100, installments: [33.33333333, 33.33333333, 33.33333333], precision: 3)

Result:

=> [0.33334e2, 0.33333e2, 0.33333e2] # => [33.334, 33.333, 33.333]

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To Release

Fill the CHANGELOG.md with relevants update.

To automatic release a new version, update the version number in lib/splittable/version.rb and merge it to master branch.

To manual release update the version and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Pagnet/splittable/blob/master/CONTRIBUTING.md.

Code of Conduct

Welcome on GitHub at https://github.com/Pagnet/splittable/blob/master/CODE_OF_CONDUCT.md.