dicechucker 0.6.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Tabler
+
+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,55 @@
+Dicechucker
+===========
+
+Dicechucker is a die-rolling library for Ruby that accepts standard die notation (XdY+Z). It can return results either as an integer total, an array of individual die rolls plus the modifier, or as a string describing results in English.
+
+Basic Usage
+-----------
+
+Manually set a Dice object:
+    foo = Dicechucker::Dice.new(number_of_dice, sides_on_die, modifier)
+
+Parse a string to make a Dice object:
+    foo = Dicechucker::Dice.parse(XdY+Z)`
+
+Basic Rolls:
+    bar = foo.roll  #total only
+    bar = foo.roll(true)  #array of die rolls plus modifier
+    bar = foo.roll_english  #string describing results`
+
+Other Dice methods:
+-------------------
+
+check_dc(dc): rolls the dice and compares them to DC. Returns True if roll is greater than or equal to DC.
+
+drop_high(number_to_drop = 1, individual_results = false): Rolls the dice, and drops the highest number_to_drop results. Returns either a total or an array of individual results.
+
+drop_low(number_to_drop = 1, individual_results = false): Rolls the dice, and drops the lowest number_to_drop results. Returns either a total or an array of individual results.
+
+explode(individual_results = false). Rolls the dice. For each die which has a maximum result (e.g., 6 on a d6), that result is kept and another die is rolled. Returns either a total or an array of individual results.
+
+Examples
+------
+To create a die set containing three six-sided dice and a modifier of one:
+    stat_dice = Dicechucker::Dice.new(3, 6, 1)
+
+To parse standard notation for same:
+    stat_dice = Dicechucker::Dice.parse('3d6+1')
+
+To roll the dice and get a total result (assume 4, 5, 6 rolled):
+    stat_dice.roll  # => 16
+
+To roll the dice and get individual dice and the modifier back:
+    stat_dice.roll(true) # => [4, 5, 6, 1]
+
+To get a plain English result:
+    stat_dice.roll_english # => 'rolled 4, 5, 6 plus one for a total of 16.'
+
+To roll 4d6+0 and drop the low die (results assume 3, 4, 5, 6 rolled):
+    easy_stat_dice = Dicechucker::Dice.parse('4d6')
+    stat = easy_stat_dice.drop_low  # => 15 
+
+Copyright
+---------
+
+Copyright (c) 2010 Mark Tabler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dicechucker"
+    gem.summary = "dice notation (XdY+Z) library"
+    gem.description = "creates and rolls die sets using standard XdY+Z notation"
+    gem.email = "mark.tabler@fallingmanstudios.net"
+    gem.homepage = "http://github.com/marktabler/dicechucker"
+    gem.authors = ["Mark Tabler"]
+    gem.add_development_dependency "mocha", ">= 0"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dicechucker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/bin/roll

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/dicechucker.rb', __FILE__)
+
+begin
+  dice = Dicechucker::Dice.parse(ARGV[0])
+  puts "You #{dice.roll_english}"
+rescue => err
+  abort "#{err} -- aborting."
+end
+

data/lib/dicechucker/dice.rb

@@ -0,0 +1,71 @@
+require File.expand_path('../game_logic.rb', __FILE__)
+
+module Dicechucker
+  
+  class Dice
+    include GameLogic
+
+    class NotationError < ArgumentError
+    end
+ 
+    PATTERN = /^(?:(?<dice>\d+)d)?(?<size>\d+)(?<mod>[+\-]\d+)?$/
+
+    attr_accessor :dice, :size, :mod
+
+    def self.parse(raw)
+      if (match = raw.match(PATTERN))
+        dice = Integer(match[:dice]) rescue 1
+        size = Integer(match[:size]) 
+        mod = Integer(match[:mod]) rescue 0
+        Dice.new(dice, size, mod)
+      else
+        raise NotationError, "Invalid die notation, #{raw}"
+      end
+    end
+    
+    def initialize(dice, size, mod)
+      @dice = dice
+      @size = size
+      @mod = mod
+    end
+
+    def roll(individual_rolls = false)
+      dice = roll_dice
+      report(dice, individual_rolls)
+    end
+
+    def roll_english
+      dice = roll_dice
+      total = dice.inject(:+) + @mod
+      dice = dice.join(', ')
+      if @mod > 0
+        mod_english = "plus #{@mod} "
+      elsif @mod < 0
+        mod_english = "minus #{@mod.abs} "
+      else
+        mod_english = ''
+      end
+      "rolled #{dice} #{mod_english}for a total of #{total}."
+    end
+    
+    def ==(other)
+      @dice == other.dice && @size == other.size && @mod == other.mod
+    end
+
+    private
+
+    def report(dice, individual_rolls)
+      if individual_rolls
+        dice << @mod
+      else
+        dice = dice.inject(:+) + @mod
+      end
+      dice
+    end
+    
+    def roll_dice
+      Array.new(@dice) { (rand * @size + 1).to_i }
+    end
+  end
+end
+

data/lib/dicechucker/game_logic.rb

@@ -0,0 +1,29 @@
+module Dicechucker
+  module GameLogic
+
+    def check_dc(dc)
+      self.roll >= dc
+    end
+    
+    def explode(individual_rolls = false)
+      dice = roll_dice
+      dice.each do |roll|
+        if roll == @size
+          dice << (rand(@size)+1)
+        end
+      end
+      report(dice, individual_rolls) 
+    end
+    
+    def drop_high(number_to_drop = 1, individual_rolls = false)
+      dice = roll_dice.sort.reverse.drop(number_to_drop)
+      report(dice, individual_rolls)
+    end
+    
+    def drop_low(number_to_drop = 1, individual_rolls = false)
+      dice = roll_dice.sort.drop(number_to_drop)
+      report(dice, individual_rolls)
+    end
+
+  end
+end

data/lib/dicechucker.rb

@@ -0,0 +1,4 @@
+module Dicechucker
+  autoload :Dice,      File.expand_path('../dicechucker/dice.rb', __FILE__)
+  autoload :GameLogic, File.expand_path('../dicechucker/game_logic.rb', __FILE__)
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'dicechucker'
+require 'minitest/unit'
+require 'mocha'
+MiniTest::Unit.autorun
+

data/test/test_dice.rb

@@ -0,0 +1,52 @@
+require 'helper'
+
+class TestDice < MiniTest::Unit::TestCase
+  include Dicechucker
+
+  def setup
+    Dice.any_instance.stubs(:rand => 0.5)
+  end
+  
+  def test_dice_parse_single_implied
+    first = Dice.new(1, 20, 0)
+    second = Dice.parse('20')
+    assert_equal first, second
+  end
+  
+  def test_dice_parse_plural_positive_mod
+    first = Dice.new(2, 20, -4)
+    second = Dice.parse('2d20-4')
+    assert_equal first, second
+  end
+
+  def test_dice_parse_large_numbers
+    first = Dice.new(300, 5000, 2000)
+    second = Dice.parse('300d5000+2000')
+    assert_equal first, second
+  end
+  
+  def test_dice_average_single
+    testroll = Dice.new(1, 6, 0)
+    assert_equal testroll.roll, 4
+    
+  end
+
+  def test_dice_roll_plural
+    testroll = Dice.new(2, 6, 0)
+    assert_equal testroll.roll, 8
+  end
+
+  def test_dice_average_plural_mod
+    testroll = Dice.new(2, 6, 2)
+    assert_equal testroll.roll, 10
+  end
+
+  def test_dice_roll_english
+    testroll = Dice.new(2, 20, 4)
+    result = testroll.roll_english
+    sample = 'rolled 11, 11 plus 4 for a total of 26.'
+    assert_equal result, sample
+  end
+
+end
+

data/test/test_game_logic.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestLogic < MiniTest::Unit::TestCase
+  include Dicechucker
+
+  def setup
+    Dice.any_instance.stubs(:rand => 0.5)
+  end
+
+  def test_dice_drop_low
+    testroll = Dice.new(100, 6, 0)
+    result = testroll.drop_low(10, true)
+    assert_equal result.size, 91 #90 dice plus 1 modifier of 0
+  end
+
+  def test_dice_drop_high
+    testroll = Dice.new(100, 6, 0)
+    result = testroll.drop_high(10, true)
+    assert_equal result.size, 91 #90 dice plus 1 modifier of 0
+  end
+
+  def test_explode
+    testroll = Dice.new(100, 6, 0)
+    result = testroll.explode(true)
+    assert_equal result.size, 101 #all random rolls are 4, nothing explodes
+  end
+
+  def test_check_dc
+    testroll = Dice.new(1, 20, 2)
+    assert testroll.check_dc(14) == false
+    assert testroll.check_dc(13) == true
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: dicechucker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors: 
+- Mark Tabler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-06 00:00:00 -07:00
+default_executable: roll
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: creates and rolls die sets using standard XdY+Z notation
+email: mark.tabler@fallingmanstudios.net
+executables: 
+- roll
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/roll
+- lib/dicechucker.rb
+- lib/dicechucker/dice.rb
+- lib/dicechucker/game_logic.rb
+- test/helper.rb
+- test/test_dice.rb
+- test/test_game_logic.rb
+has_rdoc: true
+homepage: http://github.com/marktabler/dicechucker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: dice notation (XdY+Z) library
+test_files: 
+- test/helper.rb
+- test/test_game_logic.rb
+- test/test_dice.rb