dice_box 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edf058b8c28a23ef4bb53a55a9580797bb633f9f
-  data.tar.gz: 2a7e287a785e8d5dc8590092a3bb3fc9b91ab345
+  metadata.gz: 4a4dcaca70ba3a0420120279c4933da3f01c35e7
+  data.tar.gz: 54f5b75307f7caae345b22de1ed080ef9ff331ba
 SHA512:
-  metadata.gz: c6fd3e0c0486d889b73f4ab4d365631a4db5e87d5be9f06b43458303cb61f733871846cdef2b38165a792a329fdcad7b9838806527a964433fc3656569235f5c
-  data.tar.gz: 5fac7ec74f9d61bcd92a8fcc8299b1974880d597bce01b829e39f597cd037f731f9df7062c4a053ee662e6580cffbddccb2d7f5aeec04fe5a59097b3e8373998
+  metadata.gz: 0ebefdba428de973713c83c9b531dfe7fe11d06c9e5518a90c2cc170a7e41e2de3f4c9c5386b648a238e6c2e538ef8688635e6f8b2e7fbadec5c056ca7d88721
+  data.tar.gz: 508e21422f71948c1aea7507c4a757dcdf68afda48c697d80a8d3d758dcc3cc5e437fe3f9e74070dca13b855359e2a13c60db0c7487b1607bd7ed092a9a15000

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 coverage/
 doc/
+pkg/

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 2.1.0
   - 2.0.0
-  - 1.9.3
+  - jruby-1.7.13
 
 addons:
   code_climate:

data/README.md

@@ -2,6 +2,7 @@
 
 ![Dice Box](https://raw.githubusercontent.com/rafaelgonzalez/dice_box/master/dice.jpg)
 
+[![Gem Version](https://badge.fury.io/rb/dice_box.svg)](http://badge.fury.io/rb/dice_box)
 [![Build Status](https://travis-ci.org/rafaelgonzalez/dice_box.svg?branch=master)](https://travis-ci.org/rafaelgonzalez/dice_box)
 [![Code Climate](https://codeclimate.com/github/rafaelgonzalez/dice_box.png)](https://codeclimate.com/github/rafaelgonzalez/dice_box)
 [![Test Coverage](https://codeclimate.com/github/rafaelgonzalez/dice_box/coverage.png)](https://codeclimate.com/github/rafaelgonzalez/dice_box)
@@ -10,9 +11,9 @@ A gem of dices, to get rolling with Ruby.
 
 **Supported Ruby versions:**
 
-- 2.1.0
-- 2.0.0
-- 1.9.3
+- MRI 2.1.0
+- MRI 2.0.0
+- JRuby 1.7.13
 
 ## Installation
 
@@ -38,9 +39,9 @@ Complete documentation available [here](http://rubydoc.info/github/rafaelgonzale
 
   # Using an instance
   dice = DiceBox::Dice.new(12)
-  dice.rolled # => nil
+  dice.result # => nil
   dice.roll # => 24
-  dice.rolled # => 24
+  dice.result # => 24
   ```
 
 - [DiceBox::Dice::Sides](http://rubydoc.info/github/rafaelgonzalez/dice_box/DiceBox/Dice/Side) (cheating with sides weights)
@@ -56,17 +57,35 @@ Complete documentation available [here](http://rubydoc.info/github/rafaelgonzale
   dice.roll # => 2
   ```
 
+- [DiceBox::Cup](http://rubydoc.info/github/rafaelgonzalez/dice_box/DiceBox/Cup) (rolling multiple dice instances)
+
+  ```ruby
+  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](http://semver.org).
 
-> Given a version number MAJOR.MINOR.PATCH, increment the:
+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
 
-> - MAJOR version when you make incompatible API changes,
-> - MINOR version when you add functionality in a backwards-compatible manner, and
-> - PATCH version when you make backwards-compatible bug fixes.
+## Similar Libraries
 
-> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
+- [GamesDice](https://github.com/neilslater/games_dice) (Ruby gem)
+- [Droll](https://github.com/thebinarypenguin/droll) (Javascript)
 
 ## License
 

data/lib/dice_box.rb

@@ -2,6 +2,7 @@
 module DiceBox
 end
 
-require 'dice_box/version'
+require 'dice_box/cup'
 require 'dice_box/dice'
 require 'dice_box/dice/side'
+require 'dice_box/version'

data/lib/dice_box/cup.rb

@@ -0,0 +1,47 @@
+module DiceBox
+  # Commodity class to use multiple Dice instances at the same time
+  class Cup
+    # @!attribute [rw] dices
+    # @return [Array] the Array of Dices
+    attr_accessor :dices
+
+    # @!attribute [r] rolled_sides
+    # @return [Array] the last rolled Sides of each Dice
+    attr_reader :rolled_sides
+
+    # @!attribute [r] result
+    # @return [Integer] the result from the previous roll
+    attr_reader :result
+    alias_method :rolled, :result
+    alias_method :rolled_value, :result
+
+    # @param dices [Array] an Array of Dices to put in the Cup
+    def initialize(dices = [])
+      @dices = dices
+      @rolled_sides = []
+    end
+
+    # Rolls all the Dices in the Cup
+    # @return [Integer] the sum of the rolled Dices
+    def roll
+      @result = dices.map { |dice| dice.roll }.reduce(&:+)
+      @rolled_sides = dices.map(&:rolled_side)
+
+      result
+    end
+
+    # Returns the highest value the Cup can roll
+    # @return [Integer] minimum roll value
+    def maximum
+      dices.map(&:maximum).reduce(:+)
+    end
+    alias_method :max, :maximum
+
+    # Returns the lowest value the Cup can roll
+    # @return [Integer] minimum roll value
+    def minimum
+      dices.map(&:minimum).reduce(:+)
+    end
+    alias_method :min, :minimum
+  end
+end

data/lib/dice_box/dice.rb

@@ -6,13 +6,20 @@ module DiceBox
     attr_reader :sides
 
     # @!attribute [r] rolled_side
-    # @return [Array] the last rolled Side
+    # @return [Dice::Side] the last rolled Side
     attr_reader :rolled_side
 
+    # @!attribute [r] result
+    # @return [Integer] the result from the previous roll
+    attr_reader :result
+    alias_method :rolled, :result
+    alias_method :rolled_value, :result
+
     # @param sides_number [Integer] the number of Sides this Dice should have
     def initialize(sides_number)
       @sides = build_sides(sides_number)
       @rolled_side = nil
+      @rolled = nil
     end
 
     # Rolls multiple dices with the same number of sides
@@ -29,17 +36,26 @@ module DiceBox
 
     # Rolls the dice
     # @note Sets #rolled_side to the rolled Side
+    # @note Sets #rolled_value to the rolled Side's value
     # @return [Integer] the value of the rolled Side
     def roll
       @rolled_side = balanced? ? sides.sample : weighted_roll
-      rolled_side.value
+      @result = rolled_side.value
+    end
+
+    # Returns the highest value the Dice can roll
+    # @return [Integer] maximum roll value
+    def maximum
+      sides.map(&:value).max
     end
+    alias_method :max, :maximum
 
-    # Returns the last value rolled
-    # @return [Integer] the last rolled value.
-    def rolled
-      @rolled_side ? @rolled_side.value : nil
+    # Returns the lowest value the Dice can roll
+    # @return [Integer] minimum roll value
+    def minimum
+      sides.map(&:value).min
     end
+    alias_method :min, :minimum
 
     # Determines if all Sides of the Dice have the same weight
     # @return [Boolean]
@@ -63,9 +79,9 @@ module DiceBox
 
     private
 
-    # Instanciates multiple Sides
-    # @param sides_number [Integer] the number of Sides to instanciate
-    # @return [Array] the Array of instanciated Sides
+    # Instantiates multiple Sides
+    # @param sides_number [Integer] the number of Sides to instantiate
+    # @return [Array] the Array of instantiated Sides
     def build_sides(sides_number)
       sides_number.times.map do |number|
         Side.new(number + 1)

data/lib/dice_box/dice/side.rb

@@ -2,9 +2,9 @@ module DiceBox
   class Dice
     # Representation of the side of a dice
     class Side
-      # @!attribute [r] value
+      # @!attribute [rw] value
       # @return [Integer] the actual value of the Side
-      attr_reader :value
+      attr_accessor :value
 
       # @!attribute [rw] weight
       # @return [Float] the weight of the Side

data/lib/dice_box/version.rb

@@ -1,4 +1,4 @@
 module DiceBox
   # Current version number of the library
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/dice_box/cup_spec.rb

@@ -0,0 +1,126 @@
+describe DiceBox::Cup do
+  let(:dices) { [] }
+  subject { described_class.new(dices) }
+
+  describe '#roll' do
+    let(:dice_1) { DiceBox::Dice.new(6) }
+    let(:dice_2) { DiceBox::Dice.new(4) }
+    let(:dice_3) { DiceBox::Dice.new(12) }
+    let(:dices) { [dice_1, dice_2, dice_3] }
+
+    it 'returns the sum of the rolled values' do
+      expect(dice_1).to receive(:roll).and_return(3)
+      expect(dice_2).to receive(:roll).and_return(1)
+      expect(dice_3).to receive(:roll).and_return(10)
+
+      expect(subject.roll).to eql 14
+    end
+  end
+
+  describe '#result' do
+    let(:dice_1) { DiceBox::Dice.new(6) }
+    let(:dice_2) { DiceBox::Dice.new(4) }
+    let(:dice_3) { DiceBox::Dice.new(12) }
+    let(:dices) { [dice_1, dice_2, dice_3] }
+
+    it 'returns the sum of the last rolled values' do
+      rolled_value = subject.roll
+
+      expect(subject.result).to eql rolled_value
+    end
+
+    it 'does not change value if dices are rerolled' do
+      rolled_value = subject.roll
+
+      expect(subject.result).to eql rolled_value
+
+      expect(dice_1).to receive(:roll).and_return(1)
+      expect(dice_2).to receive(:roll).and_return(1)
+      expect(dice_3).to receive(:roll).and_return(1)
+
+      dice_1.roll
+      dice_2.roll
+      dice_3.roll
+
+      expect(subject.result).to eql rolled_value
+    end
+  end
+
+  describe '#rolled_sides' do
+    let(:dice_1) { DiceBox::Dice.new(6) }
+    let(:dice_2) { DiceBox::Dice.new(4) }
+    let(:dice_3) { DiceBox::Dice.new(12) }
+    let(:dices) { [dice_1, dice_2, dice_3] }
+
+    it 'returns an Array of Sides' do
+      expect(subject.rolled_sides).to be_an(Array)
+      expect(subject.rolled_sides).to be_empty
+
+      subject.roll
+
+      expect(subject.rolled_sides).to be_an(Array)
+      expect(subject.rolled_sides).to be_an(Array)
+    end
+
+    it 'does not change if dices are not rolled with the cup' do
+      subject.roll
+      rolled_sides = subject.rolled_sides
+
+      dice_1.roll
+      dice_2.roll
+      dice_3.roll
+      expect(subject.rolled_sides).to eql rolled_sides
+    end
+  end
+
+  describe '#maximum' do
+    let(:dices) { [DiceBox::Dice.new(6), DiceBox::Dice.new(20), DiceBox::Dice.new(100)] }
+    subject { DiceBox::Cup.new(dices) }
+
+    context 'with classical dices' do
+      it 'returns the highest value the cup can roll' do
+        expect(subject.maximum).to eql 126
+      end
+    end
+
+    context 'with dices with changed side values' do
+      before do
+        dices[0].sides[0].value = 56
+        dices[1].sides[0].value = 98
+        dices[2].sides[0].value = 112
+      end
+
+      it 'returns the highest value the cup can roll' do
+        expect(subject.maximum).to eql 266
+      end
+    end
+  end
+
+  describe '#minimum' do
+    let(:dices) { [DiceBox::Dice.new(6), DiceBox::Dice.new(6), DiceBox::Dice.new(6)] }
+    subject { DiceBox::Cup.new(dices) }
+
+    context 'with classical dices' do
+      it 'returns the lowest value the cup can roll' do
+        expect(subject.minimum).to eql 3
+      end
+    end
+
+    context 'with dices with changed side values' do
+      before do
+        dices.each do |dice|
+          dice.sides[0].value = 102
+          dice.sides[1].value = 206
+          dice.sides[2].value = 191
+          dice.sides[3].value = 76
+          dice.sides[4].value = 213
+          dice.sides[5].value = 87
+        end
+      end
+
+      it 'returns the lowest value the cup can roll' do
+        expect(subject.minimum).to eql 228
+      end
+    end
+  end
+end

data/spec/dice_box/dice_spec.rb

@@ -112,6 +112,68 @@ describe DiceBox::Dice do
         expect(subject.rolled).to eql rolled_value
       end
     end
+
+    context 'with a rolled side that changes value' do
+      it 'returns the rolled value' do
+        rolled_value = subject.roll
+
+        expect(subject.rolled).to eql rolled_value
+
+        subject.rolled_side.value = 1000
+
+        expect(subject.rolled).to eql rolled_value
+      end
+    end
+  end
+
+  describe '#maximum' do
+    subject { DiceBox::Dice.new(6) }
+
+    context 'with a classical dice' do
+      it 'returns the highest value the dice can roll' do
+        expect(subject.maximum).to eql 6
+      end
+    end
+
+    context 'with a dice with changed side values' do
+      before do
+        subject.sides[0].value = 247
+        subject.sides[1].value = 12
+        subject.sides[2].value = 271
+        subject.sides[3].value = 9
+        subject.sides[4].value = 46
+        subject.sides[5].value = 5
+      end
+
+      it 'returns the highest value the dice can roll' do
+        expect(subject.maximum).to eql 271
+      end
+    end
+  end
+
+  describe '#minimum' do
+    subject { DiceBox::Dice.new(6) }
+
+    context 'with a classical dice' do
+      it 'returns the lowest value the dice can roll' do
+        expect(subject.minimum).to eql 1
+      end
+    end
+
+    context 'with a dice with changed side values' do
+      before do
+        subject.sides[0].value = 247
+        subject.sides[1].value = 12
+        subject.sides[2].value = 271
+        subject.sides[3].value = 9
+        subject.sides[4].value = 46
+        subject.sides[5].value = 5
+      end
+
+      it 'returns the lowest value the dice can roll' do
+        expect(subject.minimum).to eql 5
+      end
+    end
   end
 
   describe '#balanced?' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dice_box
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafaël Gonzalez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,9 +142,11 @@ files:
 - dice.jpg
 - dice_box.gemspec
 - lib/dice_box.rb
+- lib/dice_box/cup.rb
 - lib/dice_box/dice.rb
 - lib/dice_box/dice/side.rb
 - lib/dice_box/version.rb
+- spec/dice_box/cup_spec.rb
 - spec/dice_box/dice/side_spec.rb
 - spec/dice_box/dice_spec.rb
 - spec/spec_helper.rb
@@ -173,6 +175,7 @@ signing_key:
 specification_version: 4
 summary: A gem with dices, to get rolling with Ruby.
 test_files:
+- spec/dice_box/cup_spec.rb
 - spec/dice_box/dice/side_spec.rb
 - spec/dice_box/dice_spec.rb
 - spec/spec_helper.rb