/kujibiki

Enable Array#sample to return weighted results

Primary LanguageRubyMIT LicenseMIT

Kujibiki

This gem allow Ruby Array#sample to accept weight option.

Installation

Add this line to your application's Gemfile:

gem 'kujibiki'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kujibiki

Usage

require 'Kujibiki/array'

%w( GreatBlessing Blessing Curse ).sample(weight: [1, 3, 1])
#=> "Blessing" ("Blessing" is 3 times easy to be returned than others)

%w( GreadBlessing MiddleBlessing Blessing Curse GreatCurse ).sample(2, weight: [1, 3, 3, 2, 1])
#=> ["Blessing", "MiddleBlessing"] (["Blessing", "MiddleBlessing"] is easy to be returned than other combinations)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 a new version, update the version number in version.rb, 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/deme0607/kujibiki.

License

The gem is available as open source under the terms of the MIT License.