RpgTools 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76b4b5396a8ebfd678ca5ac5dbf115c3d0eeb028
-  data.tar.gz: dcf5233ee0231ad7b1977c4800ac857472f13150
+  metadata.gz: 437924d49047a2130a12dee90acaea5c446ea0cb
+  data.tar.gz: 7440243205aa3f8c74d52188fc7bcabb0a0cef94
 SHA512:
-  metadata.gz: a80e08868aee9e9ab8861b8a71c0593020923db1458e9cab1a55f63869a32b2744a013f9a31d91af467c6e9aa3f9febb0a4d94685a1127f02a9492f1aab2c4b1
-  data.tar.gz: cdc14519c78f42c845654783a6f2c39753b8f4572900b84daec2f4a4babddb1e4ddbc19dc99498bdff749f491e9a47427d4447f000db1bc030aa3a88fd9c2b19
+  metadata.gz: ecdea0456bd828ed25aac3c7b8504e4359ec835fb382e325e8655985a5dd8ec1b60f2a5f73fabe1231c3e49407de65a5fe94e98bf29cc7ee46af03787781b4b3
+  data.tar.gz: 6134672b09c2228c941e65a023232ae775f613218d0f91954b38e3b8f7be783fa4069b12630e46fdb57e93279ecff737cf0ce32b4d28194268f09474d3ee5579

data/README.md

@@ -1,13 +1,48 @@
 RpgTools [![Dependency Status](https://gemnasium.com/Yinfei/rpg_tools.svg)](https://gemnasium.com/Yinfei/rpg_tools)
 =======
 
-A gem that gives you tools for your RPGs : dices, coins, cards !
+A gem that gives you tools for your RPGs : dices, coins and playing cards !
 
 ## Usage
 
-* <tt>RpgTools::Coin.flip</tt> returns a "heads" or "tails" string.
-* <tt>RpgTools::Dice.roll(arg)</tt> returns an array of dices of your choice (arg format : "1d6", "4D10", "1d6+3" or "4D6-1" for example).
-* <tt>RpgTools::Card.pick</tt> returns a card of a 52 cards deck + 2 jokers.
+### Coins
+
+`RpgTools::Coin.new`
+
+* The `flip` method set its value to a "heads" or "tails" string.
+
+### Dices
+
+`RpgTools::Coin.new(arg)` <i>(`arg` is case insensitive)</i>.
+
+* It can be a stardard dice like `"dX"` for a X sided dice,
+it also accepts modifiers like '+X' or '-X' to alter the roll result.
+
+  `RpgTools::Dice.new("d6+2")` will create a 6 sided dice that adds 2 to each
+  roll result.
+
+* It can also be a fudge dice `"df"` : a three sided dice (-1, 0, +1).
+
+* The `roll` method rolls it and set its value according to the result.
+
+### Dice Bags
+
+`RpgTools::DiceBag.new(arg)` <i>(`arg` is case insensitive)</i>.
+
+* You can only create standard dice and fudge dice bags.
+
+  `RpgTools::DiceBag.new("4d6-2)` will create a bag of four 6 sided dices with a -2 modifier.
+
+* The `roll` method rolls each dice of the bag.
+* The `total` attribute stores the sum of each dice result.
+* The `set` attribute stores an array of each dice result.
+
+### Playing card deck
+`RpgTools::PlayingCardDeck.new(arg)` <i>(`arg` can only be 32 or 52)</i>.
+
+* The `card` method returns a card of a 32 or 52 cards deck + 2 jokers, depending
+of `arg` value.
+* The `hand` method return an array of 5 `card` calls.
 
 ## Contributing
 

data/lib/rpg_tools.rb

@@ -1,3 +1,4 @@
-require './lib/rpg_tools/card'
-require './lib/rpg_tools/coin'
-require './lib/rpg_tools/dice'
+require 'rpg_tools/coin'
+require 'rpg_tools/dice'
+require 'rpg_tools/dice_bag'
+require 'rpg_tools/playing_card_deck'

data/lib/rpg_tools/coin.rb

@@ -1,9 +1,20 @@
 module RpgTools
   class Coin
-    class << self
-      def flip
-        rand(2) == 1 ? 'heads' : 'tails'
-      end
+    attr_accessor :value, :flips, :heads, :tails
+
+    def initialize
+      @value = nil
+      @flips = 0
+      @heads = 0
+      @tails = 0
+    end
+
+    def flip
+      @flips += 1
+      @value = rand(2) == 1 ? 'Heads' : 'Tails'
+      @heads += 1 if @value == 'Heads'
+      @tails += 1 if @value == 'Tails'
+      @value
     end
   end
 end

data/lib/rpg_tools/dice.rb

@@ -1,54 +1,69 @@
 module RpgTools
   class Dice
-    class << self
-      def roll(dice)
-        dices = dice.split(/d/i).first.to_i
-        max_value = dice.split(/d/i).last.to_i
-
-        # I mean, seriously ?
-        return true if dices.zero?
-
-        # We don't roll d0 and d1 for obvious reasons.
-        return true if [0, 1].include?(max_value)
-
-        # We do a normal roll if no bonus/malus is set on the dice
-        return standard_roll(dices, max_value) if dice =~ /^\d+[Dd]\d+$/
-
-        # We apply bonuses/maluses properly if any
-        if dice =~ /^\d+[Dd]\d+(\+)(\d+)/
-          bonus = dice.gsub(/^\d+[Dd]\d+(\+)/, '').to_i
-          roll_with_bonus(dices, max_value, bonus)
-        elsif dice =~ /^\d+[Dd]\d+(\-)(\d+)/
-          malus = dice.gsub(/^\d+[Dd]\d+(\-)/, '').to_i
-          roll_with_malus(dices, max_value, malus)
-        else
-          true
-        end
-      end
+    attr_accessor :base, :sides, :value, :type, :rolls, :bonus, :malus
+
+    def initialize(base)
+      @base  = base
+      base_check
+      @value = nil
+      @type  = (@base =~ /^.[fF]$/).nil? ? 'Standard' : 'Fudge'
+      @sides = @type == 'Fudge' ? 3 : base.gsub(/^./, '').to_i
+      sides_check
+      @rolls = 0
+      set_modifiers if @type == 'Standard'
+    end
+
+    def roll
+      return fudge_roll      if @type == 'Fudge'
+      return standard_roll   if @bonus.nil? && @malus.nil?
+      return roll_with_bonus if @malus.nil?
+      return roll_with_malus if @bonus.nil?
+    end
 
-      def standard_roll(dices, max_value)
-        [].tap do |dice_set|
-          dices.times do
-            dice_set << rand(1..max_value)
-          end
-        end
+    private
+
+    def modifier_check
+      unless @base.gsub(/^[dD]{1}[fF]?\d+|[+-]\d+/, '').empty?
+        raise ArgumentError.new("You can only use + or - as modifiers.")
       end
+    end
+
+    def set_modifiers
+      modifier_check
+      @bonus = (@base =~ /[Dd]\d+\+(\d+)/).nil? ? nil : @base.gsub(/[Dd]\d+\+/, '').to_i
+      @malus = (@base =~ /[Dd]\d+\-(\d+)/).nil? ? nil : @base.gsub(/[Dd]\d+\-/, '').to_i
+    end
 
-      def roll_with_bonus(dices, max_value, bonus)
-        [].tap do |dice_set|
-          dices.times do
-            dice_set << (rand(1..max_value) + bonus)
-          end
-        end
+    def base_check
+      unless ['d', 'D', 'f', 'F'].include?(@base[0])
+        raise ArgumentError.new("You can only create strandard and fudge dices.")
       end
+    end
 
-      def roll_with_malus(dices, max_value, malus)
-        [].tap do |dice_set|
-          dices.times do
-            dice_set << (rand(1..max_value) - malus)
-          end
-        end
+    def sides_check
+      if [0, 1].include?(@sides)
+        raise ArgumentError.new("You can't create dices with less than 2 sides.")
       end
     end
+
+    def fudge_roll
+      @rolls += 1
+      @value = (rand(1..3) - 2)
+    end
+
+    def standard_roll
+      @rolls += 1
+      @value = rand(1..@sides)
+    end
+
+    def roll_with_bonus
+      @rolls += 1
+      @value = rand(1..@sides) + @bonus
+    end
+
+    def roll_with_malus
+      @rolls += 1
+      @value = rand(1..@sides) - @malus
+    end
   end
 end

data/lib/rpg_tools/dice_bag.rb

@@ -0,0 +1,44 @@
+module RpgTools
+  class DiceBag
+    attr_accessor :base, :dices, :rolls, :set, :total
+
+    def initialize(base)
+      @base  = base
+      @dices = set_bag_content(@base.gsub(/[dD].+/, '').to_i)
+      @rolls = 0
+      @set   = nil
+      @total = 0
+    end
+
+    def roll
+      @dices.each do |dice|
+        dice.roll
+      end
+
+      @set =  [].tap do |response|
+                @dices.each do |dice|
+                  response << dice.value
+                end
+              end
+      @total = @set.inject{ |sum, x| sum + x }
+      @set
+    end
+
+    private
+
+    def empty_bag_check(dice_number)
+      if dice_number.zero?
+        raise ArgumentError.new("You can't create an empty bag.")
+      end
+    end
+
+    def set_bag_content(dice_number)
+      empty_bag_check(dice_number)
+      [].tap do |bag|
+        dice_number.times do |dice|
+          bag << Dice.new(@base.gsub(/^\d+/, ''))
+        end
+      end
+    end
+  end
+end

data/lib/rpg_tools/playing_card_deck.rb

@@ -0,0 +1,55 @@
+module RpgTools
+  class PlayingCardDeck
+    attr_accessor :type, :card_picks, :value
+
+    def initialize(type)
+      @type = type
+      type_check
+      @card_picks = 0
+      @value = nil
+    end
+
+    def card
+      @card_picks += 1
+      @value = joker_pick_check == true ? 'Joker' : standard_card
+    end
+
+    def hand
+      [].tap do |hand|
+        until hand.count == 5
+          card = standard_card
+          hand << card unless hand.include?(card) || hand.count('Joker') == 2
+        end
+      end
+    end
+
+    private
+
+    def type_check
+      unless [32, 52].include?(@type)
+        raise ArgumentError.new('A playing card deck contains 32 or 52 cards only.')
+      end
+    end
+
+    def joker_pick_check
+      [0, 1].include?((0..54).to_a.sample(1).first)
+    end
+
+    def number
+      if @type == 32
+        [(7..10).to_a, 'Jack', 'Queen', 'King'].flatten.sample(1)
+      else
+        [(1..10).to_a, 'Jack', 'Queen', 'King'].flatten.sample(1)
+      end
+    end
+
+    def color
+      ['Clubs', 'Hearts', 'Diamonds', 'Spades'].sample(1)
+    end
+
+    def standard_card
+      @card_picks += 1
+      @value = [number, color].join(' of ')
+    end
+  end
+end

data/rpg_tools.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = %q{RpgTools}
-  s.version     = '0.3.1'
+  s.version     = '0.4.0'
   s.author      = 'Yohan Piron'
   s.email       = 'yinfei84@gmail.com'
-  s.date        = %q{2015-01-07}
+  s.date        = %q{2015-01-11}
   s.summary     = %q{RpgTools is a toolbox for tabletop games and RPGs}
   s.description = 'RpgTools gives you tools for your RPGs : dices, coins, cards...'
   s.homepage    = 'https://github.com/Yinfei/rpg_tools.git'

data/spec/coin_spec.rb

@@ -2,7 +2,7 @@ require 'rpg_tools'
 require 'spec_helper'
 
 describe RpgTools::Coin do
-  it "can't return anything else than 'heads' or 'tails'" do
-    expect(['heads', 'tails'].include?(described_class.flip)).to eq(true)
+  it "can't return anything else than 'Heads' or 'Tails'" do
+    expect(['Heads', 'Tails'].include?(described_class.new.flip)).to eq(true)
   end
 end

data/spec/dice_bag_spec.rb

@@ -0,0 +1,20 @@
+require 'rpg_tools'
+require 'spec_helper'
+
+describe RpgTools::DiceBag do
+  it 'creates a bag with the right number of dices' do
+    expect(described_class.new('4d6').dices.count).to eq(4)
+  end
+
+  it "doesn't roll the dices inside the bag at creation" do
+    expect(described_class.new('2df').dices.first.value).to eq(nil)
+  end
+
+  it "doesn't create a bag with odd modifier dices" do
+    expect { described_class.new('4d1%4') }.to raise_error(ArgumentError)
+  end
+
+  it "doesn't create empty bag" do
+    expect { described_class.new('0D10') }.to raise_error(ArgumentError)
+  end
+end

data/spec/dice_spec.rb

@@ -2,36 +2,37 @@ require 'rpg_tools'
 require 'spec_helper'
 
 describe RpgTools::Dice do
-  it "doesn't roll a '0d' dice" do
-    expect(described_class.roll('0d6')).to eq(true)
+  it "doesn't create a 'd0' dice" do
+    expect { described_class.new('d0') }.to raise_error(ArgumentError)
   end
 
-  it "doesn't roll a 'd0' dice" do
-    expect(described_class.roll('1d0')).to eq(true)
+  it "doesn't create a 'd1' dice" do
+    expect { described_class.new('d1') }.to raise_error(ArgumentError)
   end
 
-  it "doesn't roll a 'd1' dice" do
-    expect(described_class.roll('1d1')).to eq(true)
+  it 'creates fudge dices' do
+    expect { described_class.new('df') }.not_to raise_error
   end
 
-  it 'returns the right number of dices' do
-    expect(described_class.roll('2d6').count).to eq(2)
+  it "creates a dice may the 'd' char be capitalized or not" do
+    expect { described_class.new('d6') }.not_to raise_error
+    expect { described_class.new('D6') }.not_to raise_error
   end
 
-  it "rolls a dice may the 'd' char be capitalized or not" do
-    expect(described_class.roll('1d6').count).to eq(1)
-    expect(described_class.roll('1D6').count).to eq(1)
+  it "creates a dice may the 'f' char be capitalized or not" do
+    expect { described_class.new('dF') }.not_to raise_error
+    expect { described_class.new('Df') }.not_to raise_error
   end
 
-  it 'rolls a dice with a bonus' do
-    expect(described_class.roll('1d6+2').count).to eq(1)
+  it 'creates a dice with a bonus' do
+    expect { described_class.new('d6+2') }.not_to raise_error
   end
 
-  it 'rolls a dice with a malus' do
-    expect(described_class.roll('1D6-2').count).to eq(1)
+  it 'creates a dice with a malus' do
+    expect { described_class.new('D6-2') }.not_to raise_error
   end
 
-  it "doesn't roll a dice with an odd symbol" do
-    expect(described_class.roll('1d6%2')).to eq(true)
+  it "doesn't create a dice with an odd symbol" do
+    expect { described_class.new('d6%2') }.to raise_error(ArgumentError)
   end
 end

data/spec/playing_card_deck_spec.rb

@@ -0,0 +1,28 @@
+require 'rpg_tools'
+require 'spec_helper'
+
+describe RpgTools::PlayingCardDeck do
+  it 'must return a card name' do
+    expect(described_class.new(32).card).not_to eq(true)
+    expect(described_class.new(32).card).not_to eq(false)
+    expect(described_class.new(32).card).not_to eq(nil)
+    expect(described_class.new(52).card).not_to eq(true)
+    expect(described_class.new(52).card).not_to eq(false)
+    expect(described_class.new(52).card).not_to eq(nil)
+  end
+
+  it 'must return 5 cards for a full hand' do
+    expect(described_class.new(32).hand.count).to eq(5)
+    expect(described_class.new(52).hand.count).to eq(5)
+  end
+
+  it "can't pick the same card twice" do
+    expect(described_class.new(32).hand.uniq.count).to eq(5)
+    expect(described_class.new(52).hand.uniq.count).to eq(5)
+  end
+
+  it "can't use anything else than a 32 or 52 cards deck" do
+    expect { described_class.new(42) }.to raise_error(ArgumentError)
+    expect { described_class.new(666) }.to raise_error(ArgumentError)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RpgTools
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yohan Piron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,13 +48,15 @@ files:
 - README.md
 - Rakefile
 - lib/rpg_tools.rb
-- lib/rpg_tools/card.rb
 - lib/rpg_tools/coin.rb
 - lib/rpg_tools/dice.rb
+- lib/rpg_tools/dice_bag.rb
+- lib/rpg_tools/playing_card_deck.rb
 - rpg_tools.gemspec
-- spec/card_spec.rb
 - spec/coin_spec.rb
+- spec/dice_bag_spec.rb
 - spec/dice_spec.rb
+- spec/playing_card_deck_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Yinfei/rpg_tools.git
 licenses:
@@ -81,7 +83,8 @@ signing_key:
 specification_version: 4
 summary: RpgTools is a toolbox for tabletop games and RPGs
 test_files:
-- spec/card_spec.rb
 - spec/coin_spec.rb
+- spec/dice_bag_spec.rb
 - spec/dice_spec.rb
+- spec/playing_card_deck_spec.rb
 - spec/spec_helper.rb

data/lib/rpg_tools/card.rb

@@ -1,17 +0,0 @@
-module RpgTools
-  class Card
-    def self.pick
-      joker_pick_check == true ? 'Joker' : standard_card
-    end
-
-    def self.joker_pick_check
-      [0, 1].include?((0..54).to_a.sample(1).first)
-    end
-
-    def self.standard_card
-      number = [(1..10).to_a, 'Jack', 'Queen', 'King'].flatten.sample(1)
-      color  = ['clubs', 'hearts', 'diamonds', 'spades'].sample(1)
-      [number, color].join(' of ')
-    end
-  end
-end

data/spec/card_spec.rb

@@ -1,10 +0,0 @@
-require 'rpg_tools'
-require 'spec_helper'
-
-describe RpgTools::Card do
-  it 'must return a card name' do
-    expect(described_class.pick).not_to eq(true)
-    expect(described_class.pick).not_to eq(false)
-    expect(described_class.pick).not_to eq(nil)
-  end
-end