rafaelgonzalez / dice_box

:game_die: A gem of dices, to get rolling with Ruby.

DiceBox

A gem of dices, to get rolling with Ruby.

Supported Ruby versions:

• MRI 2.2.0
• MRI 2.1.5
• MRI 2.1.0
• MRI 2.0.0
• MRI 1.9.3

Installation

Via RubyGems:

$ gem install dice_box

Or in a Gemfile:

gem 'dice_box'

Usage

Complete documentation available here.

• DiceBox::Dice (rolling dices)

  # Roll a dice with 7 sides
  DiceBox::Dice.roll(7) # => 4
  
  # Roll 3 dices with 12 sides
  DiceBox::Dice.roll(12, 3) # => 27
  
  # Using an instance
  dice = DiceBox::Dice.new(12)
  dice.result # => nil
  dice.roll # => 24
  dice.result # => 24

• DiceBox::Dice::Sides (cheating with sides weights)

  dice = DiceBox::Dice.new(3)
  dice.sides[0].weight = 0.0
  dice.sides[1].weight = 2.0
  
  dice.roll # => 2
  dice.roll # => 3
  dice.roll # => 2
  dice.roll # => 2
  dice.roll # => 2

• DiceBox::Cup (rolling multiple dice instances)

  dices = [DiceBox::Dice.new(6), DiceBox::Dice.new(20), DiceBox::Dice.new(100)]
  cup = DiceBox::Cup.new(dices)
  
  cup.result # => nil
  cup.roll # => 103
  cup.result # => 103
  
  cup.dices[0].result # => 2
  cup.dices[1].result # => 19
  cup.dices[2].result # => 88

Versioning

DiceBox follows the principles of semantic versioning 2.0.0.

Given a version number MAJOR.MINOR.PATCH:

• MAJOR is incremented when incompatible API changes are made
• MINOR is incremented when functionalities are added in a backwards-compatible manner
• PATCH is incremented when backwards-compatible bug fixes are made

Similar Libraries

• GamesDice (Ruby gem)
• Droll (Javascript)

License

Copyright ©️ 2014 Rafaël Gonzalez

Released under the terms of the MIT licence. See the LICENSE file for more details.

dice_box's Issues

Add `Shaker` as an alternative to `Cup`

Deprecate Cup ?

Implement probabilities for Dice

Add probability methods to DiceBox::Cup and DiceBox::Dice.

• Dice#probabilities
• Dice#probability(value)
• Dice#probability_greater_than(value) (aka #probability_gt)
• Dice#probability_greater_than_or_equal(value) (aka #probability_gte)
• Dice#probability_lower_than(value) (aka #probability_lt)
• Dice#probability_lower_than_or_equal(value) (aka #probability_lte)

Rewrite specs

Make more use of is_expected with let() to alter specs within contexts.

Document Dice private methods

Rename private method Dice#probability_for_sides

Rename Dice @rolled instance variable

Wrong variable name used in initialization. This does not cause a bug but should be addressed nonetheless.

class Dice
  def initialize(sides_number)
    @sides = build_sides(sides_number)
    @rolled_side = nil
    @rolled = nil # Rename to result
  end
end

Initialize Dice with given Side values

Allow to pass an Array of values to Dice#new. In the future this would allow to specify any type of Side#value (characters and strings)

For example:

class Dice
  def initialize(fixnum_or_array)
    if fixnum_or_array.is_a? Array
      # create as many Sides as fixnum_or_array.size and populate with the values
    elsif fixnum_or_array.is_a? Fixnum
      # do what's already being done
    else
      # throw an ArgumentError
    end
  end
end

Implement probabilities for Cup

• Cup#probabilities
• Cup#probability_equal_to(value)
• Cup#probability_greater_than(value)
• Cup#probability_greater_than_or_equal_to(value)
• Cup#probability_lower_than(value)
• Cup#probability_lower_than_or_equal_to(value)
• Cup#probability_at_least(number, side_value)

Add Fudge dice

http://en.wikipedia.org/wiki/Fudge_%28role-playing_game_system%29#Fudge_dice

Add `Dice#values` and/or `Dice#sides_values`

Allow Sides to have any type of value