hazard 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95dbcf77daa7235693220c74d60b47e42ab3e635
-  data.tar.gz: 062155ee83ebdddb008e8c7f6f133b4c4d8292bf
+  metadata.gz: '08657cc882b26b86eb7897b444e125cb51799659'
+  data.tar.gz: b4e26bda3ada9032117860ef51f41706478f1502
 SHA512:
-  metadata.gz: 8b77918372e932a63734eabf940a5c06fd6a5263df7f9290c26b88a7ee18f80dbdc004d1aa341b96e5c07d3ec864460cf1a8509338af9a76fd7272f3bfbf54b2
-  data.tar.gz: da19de999a0edcead798d6ffb9716154fbde19288bcda76219dff6edacb7bf9750a0dbc3d8421ad418a3144ac4cf3ef62e3510f1342c139d186f9bf6bee84249
+  metadata.gz: 23ef045fd2f8ec1548bd8e24efa5a64b2db98967d5b3c27c34676d8be30908f47ef7cd84b66111749665302927c9fd645ed2308a9464567fdfd92ead6a298570
+  data.tar.gz: d5715f5e44b94c8a8f6555dd4212ef94d7b5b3ee84bc78a8aef894ca9e0905beb748b920ccddcd323f7e5920e168493bac98b634b123bba48ebea179ba168c78

data/README.md

@@ -151,8 +151,7 @@ Assuming you are playing DD Next
         
 ## Weighted Tables
 
-Weighted tables are object that allow to get weighted random. 
-Example : if you have two time foo and one time bar in your table.
+Weighted tables are object that allow to get weighted random.
  
 ### If you have the weights
 

data/lib/hazard/version.rb

@@ -1,3 +1,3 @@
 class Hazard
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/lib/hazard.rb

@@ -1,20 +1,38 @@
 require_relative 'rolled_dice'
 require_relative 'weighted_table'
 
+# This class roll the dice.
+#
+# @author Cédric ZUGER
 class Hazard
 
+  # Regular entry point. This is where you will go when you call Hazard.d6 for instance.
+  #
+  # @param method_name [String] the description of the dice. See help for detail.
+  #
+  # @return [Object] if detail has been asked, it will return a [RolledDice] object, otherwise it will return an [Integer] containing the sum of the dice.
   def self.method_missing( method_name )
     # Transform the method_name to string
     method_name = method_name.to_s
     self.roll_dice( method_name )
   end
 
+  # From string entry point, in case you have your dice description in a database for instance.
+  #
+  # @param dice_string [String] the description of the dice. See help for detail.
+  #
+  # @return [Object] if detail has been asked, it will return a [RolledDice] object, otherwise it will return an [Integer] containing the sum of the dice.
   def self.from_string( dice_string )
     roll_dice( dice_string )
   end
 
   private
 
+  # Roll dice according to method name
+  #
+  # @param method_name [String] the description of the dice. See help for detail.
+  #
+  # @return [Object] if detail has been asked, it will return a [RolledDice] object, otherwise it will return an [Integer] containing the sum of the dice.
   def self.roll_dice( method_name )
     # Parse the method name to get how many dice and what size of dice was required
     dice_match = method_name.to_s.match( /(d|r|m|s)?(\d*)d(\d+)/ )

data/lib/rolled_dice.rb

@@ -1,13 +1,23 @@
+# This class represents the result of a roll, for people that need to work wit dice details.
+#
+# @author Cédric ZUGER
 class RolledDice
 
   attr_reader :result, :rolls
 
+  # Create a RolledDice object
+  #
+  # @param rolls [Array] an array of integer containing the dice rolls.
   def initialize( rolls )
     @rolls = rolls
     @result = rolls.reduce(:+)
   end
 
-  # Required for tests
+  # Compare two rolls
+  #
+  # @param rolled_dice [RolledDice] the other RolledDice to compare
+  #
+  # @return [Boolean] the result of the comparison
   def ==( rolled_dice )
     @rolls == rolled_dice.rolls && @result == rolled_dice.result
   end

data/lib/weighted_table.rb

@@ -1,5 +1,8 @@
 require 'yaml'
 
+# This class contains objects and associate weights to them. So that you can sample the object according to their weights.
+#
+# @author Cédric ZUGER
 class WeightedTable
 
   BASE_WEIGHT = 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hazard
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Cédric ZUGER
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler