hazard 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08657cc882b26b86eb7897b444e125cb51799659'
-  data.tar.gz: b4e26bda3ada9032117860ef51f41706478f1502
+  metadata.gz: e1e25f4c424287018d994674779d8d269c7fa6b4
+  data.tar.gz: 47c5f83f912a690514abdf59f6529412945ef82e
 SHA512:
-  metadata.gz: 23ef045fd2f8ec1548bd8e24efa5a64b2db98967d5b3c27c34676d8be30908f47ef7cd84b66111749665302927c9fd645ed2308a9464567fdfd92ead6a298570
-  data.tar.gz: d5715f5e44b94c8a8f6555dd4212ef94d7b5b3ee84bc78a8aef894ca9e0905beb748b920ccddcd323f7e5920e168493bac98b634b123bba48ebea179ba168c78
+  metadata.gz: 04f3188932596ec902ab3cd2fb30bceaa197cdc4f3f01284b2bfd9b84150080686d7478cf586202c7295b3bce11196feade4a6872e9066aed94e7f7a58237069
+  data.tar.gz: e370ad454d0865bf28ba73831695ffb19605a0b3a60b2c6e0c5a8194438fb34bdea7ba3fa321c38e31807cbda6ca2a6f0ea7d0ac8155241ba808d0ec4476bb7c

data/.travis.yml

@@ -8,6 +8,7 @@ env:
 
 language: ruby
 rvm:
+  - 2.6
   - 2.5
   - 2.4
   - 2.3

data/Gemfile

@@ -3,10 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hazard.gemspec
 gemspec
 
-gem 'mocha', group: 'test'
-
 group :test do
-  gem 'simplecov'
   gem 'codeclimate-test-reporter', '~> 1.0.0'
   gem 'mocha'
+  gem 'simplecov'
 end

data/README.md

@@ -20,7 +20,7 @@ Hazard is a very simple dice library for ruby that allows you to :
     1. [Some real cases](#some-real-cases)
 1. [Weighted Tables](#weighted-tables)
     1. [If you have the weights](#if-you-have-the-weights)
-    1. [If you don't have the weights (or are to lazy to get them)](#if-you-dont-have-the-weights-or-are-to-lazy-to-get-them)
+    1. [If you don't have the weights (or are too lazy to get them)](#if-you-dont-have-the-weights-or-are-too-lazy-to-get-them)
     1. [Saving and loading](#saving-and-loading)    
     
 ## Installation
@@ -28,7 +28,7 @@ Hazard is a very simple dice library for ruby that allows you to :
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hazard', '~> 1.2.0'
+gem 'hazard', '~> 1.2'
 ```
 
 And then execute:
@@ -88,6 +88,20 @@ Examples :
     >> Hazard.d2d6
     => 8      
     
+### Lucky
+
+Some times, you just need to test an unlikely case. Lucky roll a die and return true if you rolled the highest value.
+ 
+Examples : 
+   
+    >> Hazard.lucky?( 6 )
+    => true
+    # Means that you rolled 6
+     
+    >> Hazard.lucky?( 6 )
+    => false
+    # Means that you rolled something else than 6
+        
 ## Advanced Usage
         
 ### Roll dice and get the details
@@ -163,12 +177,12 @@ Weighted tables are object that allow to get weighted random.
     
 Examples : 
 
-    >> wt = WeightedTable.new.from_weighted_table( [ 2, :foo ], [ 1, :bar ] ]
+    >> wt = WeightedTable.from_weighted_table( [ 2, :foo ], [ 1, :bar ] ]
     >> wt.sample
     # This ensure that you will get 66% foo and 33% bar
     
     
-### If you don't have the weights (or are to lazy to get them)
+### If you don't have the weights (or are too lazy to get them)
     
     >> wt = WeightedTable.from_flat_table( <object1>, <object1>, <object2>, ... ]
     # Create a weighted table storing objects computing the weight of the objects according to theire occurences
@@ -178,7 +192,7 @@ Examples :
         
 Examples : 
         
-    >> wt = WeightedTable.new.from_flat_table( :foo, :foo, :bar ]
+    >> wt = WeightedTable.from_flat_table( :foo, :foo, :bar ]
     >> wt.sample
     # This ensure that you will get 66% foo and 33% bar
                
@@ -188,7 +202,9 @@ Examples :
     >> wt.to_file( filename )
     
     # And load it
-    >> wt = WeightedTable.from_file( filename )   
+    >> wt = WeightedTable.from_file( filename )  
+    
+    # Note : backup format is YAML
                                       
 ## Contributing
 

data/hazard.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  # spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
 

data/lib/hazard/version.rb

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

data/lib/hazard.rb

@@ -6,15 +6,21 @@ require_relative 'weighted_table'
 # @author Cédric ZUGER
 class Hazard
 
+  DICE_NAME_REGEXP = /(d|r|m|s)?(\d*)d(\d+)/.freeze
+
   # 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 )
+
+    if method_name =~ DICE_NAME_REGEXP
+      roll_dice( method_name )
+    else
+      super
+    end
   end
 
   # From string entry point, in case you have your dice description in a database for instance.
@@ -26,6 +32,20 @@ class Hazard
     roll_dice( dice_string )
   end
 
+  # Hook the method_missing
+  def self.respond_to_missing?(method_name, include_private = false)
+    method_name.to_s =~ DICE_NAME_REGEXP || super
+  end
+
+  # Roll a dice and return true if you rolled the highest number
+  #
+  # @param dice [Integer] the dice you want to roll.
+  #
+  # @return [Boolean] true if you scored the highest number, false otherwise.
+  def self.lucky?( dice )
+    roll_dice( "d#{dice}" ) == dice
+  end
+
   private
 
   # Roll dice according to method name
@@ -35,29 +55,30 @@ class Hazard
   # @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+)/ )
-    # Raise an error if match fail
-    raise "Method mising : #{method_name}" unless dice_match
+    dice_match = method_name.to_s.match DICE_NAME_REGEXP
 
     # Get the roll type
     roll_type = dice_match[1]
-    splited_result = true if roll_type == 's'
+    splitted_result = true if roll_type == 's'
 
-    # Get the dice amount
-    dice_amount = dice_match[2].to_i
-    # If no amount is given then the amount is 1
-    dice_amount = 1 if dice_amount == 0
     # Get the type of dice
     dice_type = dice_match[3].to_i
 
     # Rolls the dice
-    rolls = ( 1..dice_amount ).map{ Kernel.rand( 1..dice_type ) }
+    rolls = ( 1..dice_amount(dice_match) ).map{ Kernel.rand( 1..dice_type ) }
 
     # Unless splitted_result was requested, return the sum of the rolled dice
-    return rolls.reduce(:+) unless splited_result
+    return rolls.reduce(:+) unless splitted_result
 
     # Return a RolledDice otherwise
     RolledDice.new( rolls )
   end
 
+  def self.dice_amount( dice_match )
+    # Get the dice amount
+    dice_amount = dice_match[2].to_i
+    # If no amount is given then the amount is 1
+    dice_amount.zero? ? 1 : dice_amount
+  end
+
 end

data/lib/rolled_dice.rb

@@ -8,7 +8,7 @@ class RolledDice
   # Create a RolledDice object
   #
   # @param rolls [Array] an array of integer containing the dice rolls.
-  def initialize( rolls )
+  def initialize(rolls)
     @rolls = rolls
     @result = rolls.reduce(:+)
   end
@@ -18,7 +18,7 @@ class RolledDice
   # @param rolled_dice [RolledDice] the other RolledDice to compare
   #
   # @return [Boolean] the result of the comparison
-  def ==( rolled_dice )
+  def ==(rolled_dice)
     @rolls == rolled_dice.rolls && @result == rolled_dice.result
   end
 

data/test/hazard_test.rb

@@ -34,5 +34,26 @@ class HazardTest < Minitest::Test
 
   end
 
+  def test_lucky
+    total = 0
+    hits = 0
+
+    1.upto(1000).each do
+      total += 1
+      hits += 1 if Hazard.lucky?( 6 )
+    end
+
+    assert_in_delta hits.to_f/total, 1.0/6, 1.0/10
+  end
+
+  def test_method_missing
+    assert Hazard.respond_to?(:d6)
+    refute Hazard.respond_to?(:foo)
+
+    assert_raises do
+      Hazard.foo
+    end
+  end
+
 
 end

data/test/test_helper.rb

@@ -6,6 +6,6 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'hazard'
 
 require 'minitest/autorun'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'pp'
 

data/test/weighted_table_test.rb

@@ -84,4 +84,10 @@ class HazardTest < Minitest::Test
     `rm wt.yaml`
   end
 
+  def test_out_of_range
+    Kernel.stubs( :rand ).returns( 99 )
+    assert_raises do
+      WeightedTable.from_weighted_table( [ [ 3, :foo ], [ 1, :bar ], [ 1, :foobar ] ] ).sample
+    end
+  end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hazard
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Cédric ZUGER
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement