dice_box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edf058b8c28a23ef4bb53a55a9580797bb633f9f
+  data.tar.gz: 2a7e287a785e8d5dc8590092a3bb3fc9b91ab345
+SHA512:
+  metadata.gz: c6fd3e0c0486d889b73f4ab4d365631a4db5e87d5be9f06b43458303cb61f733871846cdef2b38165a792a329fdcad7b9838806527a964433fc3656569235f5c
+  data.tar.gz: 5fac7ec74f9d61bcd92a8fcc8299b1974880d597bce01b829e39f597cd037f731f9df7062c4a053ee662e6580cffbddccb2d7f5aeec04fe5a59097b3e8373998

data/.cane

@@ -0,0 +1,5 @@
+--color
+--abc-max 15
+--no-style
+--no-doc
+--gte coverage/.last_run.json,99

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.yardoc
+Gemfile.lock
+coverage/
+doc/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Style/EmptyLineBetweenDefs:
+  Severity: error
+
+Style/HashSyntax:
+  Severity: error
+
+Style/LineLength:
+  Max: 120
+  Severity: error
+
+Style/MethodLength:
+  Max: 25
+  Severity: error
+
+Style/TrailingWhitespace:
+  Severity: error
+
+Style/TrailingBlankLines:
+  Severity: error
+
+### Disabled checks
+
+Documentation:
+  Enabled: false
+
+Style/SelfAssignment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+addons:
+  code_climate:
+    repo_token: eb81b5b2208352b78077fbe41f8c1602616905aaf83d922764b3fbbaec9417a1
+
+script: 'bundle exec rake test'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafaël Gonzalez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# DiceBox
+
+![Dice Box](https://raw.githubusercontent.com/rafaelgonzalez/dice_box/master/dice.jpg)
+
+[![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)
+
+A gem of dices, to get rolling with Ruby.
+
+**Supported Ruby versions:**
+
+- 2.1.0
+- 2.0.0
+- 1.9.3
+
+## Installation
+
+Via RubyGems:
+
+    $ gem install dice_box
+
+Or in a Gemfile:
+
+    gem 'dice_box'
+
+## Usage
+
+Complete documentation available [here](http://rubydoc.info/github/rafaelgonzalez/dice_box/frames).
+
+- [DiceBox::Dice](http://rubydoc.info/github/rafaelgonzalez/dice_box/DiceBox/Dice) (rolling dices)
+  ```ruby
+  # 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.rolled # => nil
+  dice.roll # => 24
+  dice.rolled # => 24
+  ```
+
+- [DiceBox::Dice::Sides](http://rubydoc.info/github/rafaelgonzalez/dice_box/DiceBox/Dice/Side) (cheating with sides weights)
+  ```ruby
+  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
+  ```
+
+## Versioning
+
+DiceBox follows the principles of [semantic versioning](http://semver.org).
+
+> Given a version number MAJOR.MINOR.PATCH, increment the:
+
+> - 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.
+
+> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
+
+## License
+
+Copyright :copyright: 2014 Rafaël Gonzalez
+
+Released under the terms of the MIT licence. See the [LICENSE](https://raw.githubusercontent.com/rafaelgonzalez/dice_box/master/LICENSE.txt) file for more details.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :test
+
+desc 'Run the test suite'
+task test: :spec
+
+begin
+  require 'cane/rake_task'
+
+  desc 'Run Cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.canefile = '.cane'
+  end
+rescue LoadError
+  warn 'Cane not available, :quality task not provided.'
+end
+
+begin
+  require 'rubocop/rake_task'
+
+  desc 'Run RuboCop'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.fail_on_error = false
+  end
+rescue LoadError
+  warn 'RuboCop not available, :rubocop task not provided.'
+end
+
+Rake::Task[:test].enhance do
+  Rake::Task[:quality].invoke
+  Rake::Task[:rubocop].invoke
+end

data/dice_box.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dice_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dice_box'
+  spec.version       = DiceBox::VERSION
+  spec.authors       = ['Rafaël Gonzalez']
+  spec.email         = ['github@rafaelgonzalez.me']
+  spec.summary       = %q{A gem with dices, to get rolling with Ruby.}
+  spec.description   = %q{A gem with dices, to get rolling with Ruby.}
+  spec.homepage      = 'https://github.com/rafaelgonzalez/dice_box'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/dice_box/dice/side.rb

@@ -0,0 +1,21 @@
+module DiceBox
+  class Dice
+    # Representation of the side of a dice
+    class Side
+      # @!attribute [r] value
+      # @return [Integer] the actual value of the Side
+      attr_reader :value
+
+      # @!attribute [rw] weight
+      # @return [Float] the weight of the Side
+      attr_accessor :weight
+
+      # @param value [Integer] the actual value of the Side
+      # @param weight [Float] the weight of the Side
+      def initialize(value, weight = 1.0)
+        @value = value
+        @weight = weight
+      end
+    end
+  end
+end

data/lib/dice_box/dice.rb

@@ -0,0 +1,86 @@
+module DiceBox
+  # Representation of a dice
+  class Dice
+    # @!attribute [r] sides
+    # @return [Array] the Array of Sides of the Dice
+    attr_reader :sides
+
+    # @!attribute [r] rolled_side
+    # @return [Array] the last rolled Side
+    attr_reader :rolled_side
+
+    # @param sides_number [Integer] the number of Sides this Dice should have
+    def initialize(sides_number)
+      @sides = build_sides(sides_number)
+      @rolled_side = nil
+    end
+
+    # Rolls multiple dices with the same number of sides
+    # @param sides_number [Integer] the number of sides of the dices
+    # @param amount [Integer] the number of dices rolled
+    # @return [Integer] the total roll result
+    def self.roll(sides_number, amount = 1)
+      return 0 if amount.nil? || amount <= 0
+
+      amount.times.map do
+        Random.new.rand(1..sides_number)
+      end.reduce(&:+)
+    end
+
+    # Rolls the dice
+    # @note Sets #rolled_side to the rolled Side
+    # @return [Integer] the value of the rolled Side
+    def roll
+      @rolled_side = balanced? ? sides.sample : weighted_roll
+      rolled_side.value
+    end
+
+    # Returns the last value rolled
+    # @return [Integer] the last rolled value.
+    def rolled
+      @rolled_side ? @rolled_side.value : nil
+    end
+
+    # Determines if all Sides of the Dice have the same weight
+    # @return [Boolean]
+    def balanced?
+      !crooked?
+    end
+
+    # Determines if at least one Side has a different weight than any other Side of the Dice
+    # @return [Boolean]
+    def crooked?
+      sides.map(&:weight).any? do |weight|
+        weight != sides.first.weight
+      end
+    end
+
+    # The weight of the Dice, sum of all Sides weights
+    # @return [Float] the weight of the Dice
+    def weight
+      sides.map(&:weight).reduce(&:+)
+    end
+
+    private
+
+    # Instanciates multiple Sides
+    # @param sides_number [Integer] the number of Sides to instanciate
+    # @return [Array] the Array of instanciated Sides
+    def build_sides(sides_number)
+      sides_number.times.map do |number|
+        Side.new(number + 1)
+      end
+    end
+
+    # Rolls the Dice taking Sides weights into account
+    # @return [Side] the rolled Side
+    def weighted_roll
+      num = rand(0..weight)
+
+      sides.each do |side|
+        return side if side.weight > num
+        num = num - side.weight
+      end
+    end
+  end
+end

data/lib/dice_box/version.rb

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

data/lib/dice_box.rb

@@ -0,0 +1,7 @@
+# Global namespace of the library
+module DiceBox
+end
+
+require 'dice_box/version'
+require 'dice_box/dice'
+require 'dice_box/dice/side'

data/spec/dice_box/dice/side_spec.rb

@@ -0,0 +1,15 @@
+describe DiceBox::Dice::Side do
+  subject { described_class.new(12) }
+
+  describe '#value' do
+    it 'returns the value' do
+      expect(subject.value).to eql 12
+    end
+  end
+
+  describe '#weight' do
+    it 'returns the value' do
+      expect(subject.weight).to eql 1.0
+    end
+  end
+end

data/spec/dice_box/dice_spec.rb

@@ -0,0 +1,163 @@
+describe DiceBox::Dice do
+  subject { described_class.new(4) }
+
+  describe '#sides' do
+    it 'returns an Array of Sides' do
+      expect(subject.sides).to be_a(Array)
+
+      subject.sides.each do |side|
+        expect(side).to be_a(DiceBox::Dice::Side)
+      end
+    end
+
+    it 'has the correct number of sides' do
+      expect(subject.sides.length).to eql 4
+    end
+  end
+
+  describe '#rolled_side' do
+    context 'with a non-rolled Dice' do
+      it 'returns nil' do
+        expect(subject.rolled_side).to be_nil
+      end
+    end
+
+    context 'with a rolled Dice' do
+      it 'returns the last rolled side' do
+        rolled_value = subject.roll
+
+        expect(subject.rolled_side.value).to eql rolled_value
+      end
+    end
+  end
+
+  describe '.roll' do
+    context 'with 1 dice of 6 sides' do
+      it 'is always superior to 0' do
+        expect(described_class.roll(6, 1)).to be > 0
+      end
+
+      it 'is always inferior to 7' do
+        expect(described_class.roll(6, 1)).to be < 7
+      end
+    end
+
+    context 'with 5 dices of 3 sides' do
+      it 'is always superior to 5' do
+        expect(described_class.roll(3, 5)).to be > 4
+      end
+
+      it 'is always inferior to 16' do
+        expect(described_class.roll(3, 5)).to be < 16
+      end
+    end
+
+    context 'with 0 dice' do
+      it 'returns 0' do
+        expect(described_class.roll(6, 0)).to eql 0
+      end
+    end
+
+    context 'with a negative amount of dices' do
+      it 'returns 0' do
+        expect(described_class.roll(6, -1)).to eql 0
+      end
+    end
+  end
+
+  describe '#roll' do
+    it 'sets #rolled_side to the rolled value' do
+      rolled_value = subject.roll
+
+      expect(subject.rolled_side.value).to eql rolled_value
+    end
+
+    context 'with a dice of 6 sides' do
+      subject { described_class.new(6) }
+
+      it 'is always superior to 0' do
+        expect(subject.roll).to be > 0
+      end
+
+      it 'is always inferior to 7' do
+        expect(subject.roll).to be < 7
+      end
+    end
+
+    context 'with a crooked dice' do
+      subject { described_class.new(3) }
+
+      before do
+        subject.sides[0].weight = 0
+        subject.sides[1].weight = 0
+      end
+
+      it 'rolls the side with weight' do
+        expect(subject.roll).to eql 3
+      end
+    end
+  end
+
+  describe '#rolled' do
+    context 'with a non-rolled Dice' do
+      it 'returns nil' do
+        expect(subject.rolled).to be_nil
+      end
+    end
+
+    context 'with a rolled Dice' do
+      it 'returns the last rolled side' do
+        rolled_value = subject.roll
+
+        expect(subject.rolled).to eql rolled_value
+      end
+    end
+  end
+
+  describe '#balanced?' do
+    context 'with Sides of the same weight' do
+      it 'returns true' do
+        expect(subject).to be_balanced
+      end
+    end
+
+    context 'with Sides with different weight' do
+      before { subject.sides.first.weight = 2.0 }
+
+      it 'returns false' do
+        expect(subject).not_to be_balanced
+      end
+    end
+  end
+
+  describe '#crooked?' do
+    context 'with Sides of the same weight' do
+      it 'returns false' do
+        expect(subject).not_to be_crooked
+      end
+    end
+
+    context 'with Sides with different weight' do
+      before { subject.sides.first.weight = 2.0 }
+
+      it 'returns true' do
+        expect(subject).to be_crooked
+      end
+    end
+  end
+
+  describe '#weight' do
+    subject { described_class.new(4) }
+
+    before do
+      subject.sides[0].weight = 2.32
+      subject.sides[1].weight = 3.0
+      subject.sides[2].weight = 1.26
+      subject.sides[3].weight = 0.72
+    end
+
+    it 'returns the total of Sides weights' do
+      expect(subject.weight).to eql 7.3
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+CodeClimate::TestReporter.start
+
+require 'dice_box'
+
+RSpec.configure do
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: dice_box
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafaël Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem with dices, to get rolling with Ruby.
+email:
+- github@rafaelgonzalez.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dice.jpg
+- dice_box.gemspec
+- lib/dice_box.rb
+- lib/dice_box/dice.rb
+- lib/dice_box/dice/side.rb
+- lib/dice_box/version.rb
+- spec/dice_box/dice/side_spec.rb
+- spec/dice_box/dice_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rafaelgonzalez/dice_box
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem with dices, to get rolling with Ruby.
+test_files:
+- spec/dice_box/dice/side_spec.rb
+- spec/dice_box/dice_spec.rb
+- spec/spec_helper.rb
+has_rdoc: