https://github.com/djpowers/divvy_up

A Ruby gem to help you divide a list of items and prices into (roughly) even parts
https://github.com/djpowers/divvy_up

Last synced: about 1 month ago
JSON representation

A Ruby gem to help you divide a list of items and prices into (roughly) even parts

• Host: GitHub
• URL: https://github.com/djpowers/divvy_up
• Owner: djpowers
• License: mit
• Created: 2015-03-10T02:19:20.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-08-05T01:08:50.000Z (over 9 years ago)
• Last Synced: 2024-10-16T07:50:00.843Z (3 months ago)
• Language: Ruby
• Homepage: https://rubygems.org/gems/divvy_up
• Size: 246 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# DivvyUp

[![Gem Version](https://badge.fury.io/rb/divvy_up.svg)](http://badge.fury.io/rb/divvy_up)

A Ruby gem to divvy up a list of item prices into smaller groups,

for the purpose of splitting up purchases (somewhat) equally.

A variation of sorts on the [knapsack problem](http://en.wikipedia.org/wiki/Knapsack_problem).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'divvy_up'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install divvy_up

## Usage

```ruby

shopping_list = {

  orange_juice: { price: 3, quantity: 2 },

  lettuce: 7,

  strawberries: 3,

  eggs: { price: 2.79 },

  carrots: 2.5,

  onion: 1.25,

  tomato: 1.25,

  blueberries: 3.99,

  butter: 2.69,

  pasta_sauce: 2.5,

  pepper: 2,

  celery: 1.69

}

DivvyUp::List.new(shopping_list).split(3)

# =>

# [

#   [{:eggs=>2.79, :carrots=>2.5, :onion=>1.25, :butter=>2.69, :pepper=>2}, 11.23],

#   [{:tomato=>1.25, :blueberries=>3.99, :orange_juice_1=>3, :orange_juice_2=>3}, 11.24],

#   [{:lettuce=>7, :pasta_sauce=>2.5, :celery=>1.69}, 11.19]

# ]

```

Pass a hash as an argument when creating a new List, where the keys are the item

names, and the values are the prices, as an integer or float.

Optionally, you may specify the price in an attributes hash. If you have more

than one of an item, you can specify the quantity here as well.

Output of `#split` method consists of an array of arrays, where each subarray

is a hash of items and the total value of those items.

## Contributing

1. Fork it ( https://github.com/djpowers/divvy_up/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request