hazard 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798d50bb480535332b66c5bdfd01715893be5a79
-  data.tar.gz: 52c324e17e1ce718f0a8c3175b8da5e3d08bc6f1
+  metadata.gz: 5017ca137a9ac74552972f1301a18878035016cf
+  data.tar.gz: 6ff5453dda46882f844cca27cb2ca0f964588f61
 SHA512:
-  metadata.gz: a7816bdecd991afd5450705d3e7dd6063a5b451f6a2dd4a3753144a84173eb9888fa1952a4617d8ab719e127441edf893de6e18fad7d004107d2bf58b2a607ea
-  data.tar.gz: 25880dfe5439217ada4cd46ad67e38439378cc446f23f7758edaef1416ac23b335ca407e9e3613bb4090b615cae328ea2e8030208004445346262f53c6956621
+  metadata.gz: ed5948b03b7f4f69860eb84954ce03582520402116603eb3d2b8507450e7b08daed645c7398282a79b0cf86fad93b9ddafb899b8b3960688fe49cb8a2b91f100
+  data.tar.gz: 7e89790f4dd30f8f1414ec41c6b930bf2188dbd97186c1d08fe0f64a532dd8955fba85375999c4755f1774a597fef15eb963d2101d64f035be013e5c61652920

data/README.md

@@ -1,10 +1,11 @@
 # Hazard
 
 [![Gem Version](https://badge.fury.io/rb/hazard.svg)](https://badge.fury.io/rb/hazard)
+[![Build Status](https://travis-ci.org/czuger/hazard.svg?branch=master)](https://travis-ci.org/czuger/hazard)
 [![Code Climate](https://codeclimate.com/github/czuger/hazard/badges/gpa.svg)](https://codeclimate.com/github/czuger/hazard)
 [![Test Coverage](https://codeclimate.com/github/czuger/hazard/badges/coverage.svg)](https://codeclimate.com/github/czuger/hazard/coverage)
 
-Hazard is a very simple dices library for ruby (see [usage](#usage)).
+Hazard is a very simple dice library for ruby (see [usage](#usage)).
 
 ## Installation
 
@@ -28,10 +29,10 @@ If needed :
 
 ## Usage
 
-Roll a simple dice
+**Roll a simple die**
 
     >> Hazard.d<n>        # where n is an number
-    => Roll a n-sided dice
+    => Roll a n-sided die
 
 Examples : 
 
@@ -45,10 +46,10 @@ Examples :
     => 38
      
     
-Roll multiple dices
+**Roll multiple dice**
 
     >> Hazard.r<m>d<n>    # where m and n are numbers
-    => Roll m n-sided dices and return the sum
+    => Roll m n-sided dice and return the sum
 
 Examples : 
    
@@ -62,10 +63,10 @@ Examples :
      => 356
          
          
-Roll dices but get the detail
+**Roll dice and get the details**
 
     >> Hazard.s<m>d<n>    # where m and n are numbers
-    => Roll m n-sided dices and return a RolledDices object
+    => Roll m n-sided dice and return a RolledDice object
 
 Examples : 
          
@@ -73,17 +74,27 @@ Examples :
     => [1, 6]     
           
     >> Hazard.s2d6.result
+    => 3
+    
+    # Caution, each time you call Hazard it will reroll the dice
+    # If you want to work on result and rolls, save them in a variable    
+    >> roll = Hazard.s2d6
+    
+    >> roll.rolls
+    => [1, 6]
+    
+    >> roll.result
     => 7
     
     # Under the hood
     >> Hazard.s2d6
-    => #<RolledDices:0x007f62e55a0010 @rolls=[1, 6], @result=7>
+    => #<RolledDice:0x007f62e55a0010 @rolls=[1, 6], @result=7>
     
-Some real cases
+**Some real cases**
          
     # Assuming you are playing DD Next
     
-    # You may want to roll 2 d20 dices with advantage (take the greatest)
+    # You may want to roll 2 d20 dice with advantage (take the greatest)
     # This will rolls 2 d20, get the rolls and get the best of them
     
     >> Hazard.s2d20.rolls.max 

data/hazard.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['ced']
   spec.email         = ['zuger.cedric@gmail.com']
 
-  spec.summary       = 'Dices library for ruby'
-  spec.description   = 'A very simple dices library for ruby'
+  spec.summary       = 'Dice library for ruby'
+  spec.description   = 'A very simple dice library for ruby'
   spec.homepage      = 'https://github.com/czuger/hazard'
   spec.license       = 'MIT'
 

data/lib/hazard/version.rb

@@ -1,3 +1,3 @@
 class Hazard
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/hazard.rb

@@ -1,4 +1,4 @@
-require_relative 'rolled_dices'
+require_relative 'rolled_dice'
 
 class Hazard
 
@@ -14,26 +14,26 @@ class Hazard
       splitted_result = true
     end
 
-    # Parse the method name to get how many dices and what size of dices was required
-    dices_match = method_name.to_s.match( /(\d*)d(\d+)/ )
+    # Parse the method name to get how many dice and what size of dice was required
+    dice_match = method_name.to_s.match( /(\d*)d(\d+)/ )
     # Raise an error if match fail
-    raise "Method mising : #{method_name}" unless dices_match
+    raise "Method mising : #{method_name}" unless dice_match
 
-    # Get the dices amount
-    dices_amount = dices_match[1].to_i
+    # Get the dice amount
+    dice_amount = dice_match[1].to_i
     # If no amount is given then the amount is 1
-    dices_amount = 1 if dices_amount == 0
-    # Get the type of dices
-    dice_type = dices_match[2].to_i
+    dice_amount = 1 if dice_amount == 0
+    # Get the type of dice
+    dice_type = dice_match[2].to_i
 
-    # Rolls the dices
-    rolls = (1..dices_amount).map{ Kernel.rand( 1..dice_type ) }
+    # Rolls the dice
+    rolls = (1..dice_amount).map{ Kernel.rand( 1..dice_type ) }
 
-    # Unless splitted_result was requested, return the sum of the rolled dices
+    # Unless splitted_result was requested, return the sum of the rolled dice
     return rolls.reduce(:+) unless splitted_result
 
-    # Return a RolledDices otherwise
-    RolledDices.new( rolls )
+    # Return a RolledDice otherwise
+    RolledDice.new(rolls )
 
   end
 

data/lib/{rolled_dices.rb → rolled_dice.rb}

@@ -1,4 +1,4 @@
-class RolledDices
+class RolledDice
 
   attr_reader :result, :rolls
 
@@ -8,8 +8,8 @@ class RolledDices
   end
 
   # Required for tests
-  def ==( rolled_dices )
-    @rolls == rolled_dices.rolls && @result == rolled_dices.result
+  def ==( rolled_dice )
+    @rolls == rolled_dice.rolls && @result == rolled_dice.result
   end
 
 end

data/test/hazard_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class HazardTest < Minitest::Test
 
-  def test_dices
+  def test_dice
 
     Kernel.stubs( :rand ).returns( 6 )
 
@@ -11,7 +11,7 @@ class HazardTest < Minitest::Test
     assert_equal 12, Hazard.r2d6
     assert_equal 12, Hazard._2d6
 
-    assert_equal RolledDices.new( [ 6, 6 ] ), Hazard.s2d6
+    assert_equal RolledDice.new([6, 6 ] ), Hazard.s2d6
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hazard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - ced
@@ -52,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
-description: A very simple dices library for ruby
+description: A very simple dice library for ruby
 email:
 - zuger.cedric@gmail.com
 executables: []
@@ -69,7 +69,7 @@ files:
 - hazard.gemspec
 - lib/hazard.rb
 - lib/hazard/version.rb
-- lib/rolled_dices.rb
+- lib/rolled_dice.rb
 - test/hazard_test.rb
 - test/test_helper.rb
 homepage: https://github.com/czuger/hazard
@@ -95,7 +95,7 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Dices library for ruby
+summary: Dice library for ruby
 test_files:
 - test/hazard_test.rb
 - test/test_helper.rb