nairda-dice 0.1.1

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2008 Adrian Pacała
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -0,0 +1 @@
+Simple Ruby class for simulating dice rolls.

data/lib/dice.rb

@@ -0,0 +1,102 @@
+require 'pathname'
+
+DICE_ROOT = Pathname(__FILE__).dirname.expand_path + 'dice'
+
+require DICE_ROOT + 'core_ext'
+require DICE_ROOT + 'version'
+
+# = Dice
+#
+# Original code & copyright by Jamis Buck <jamis@37signals.com>.
+#
+# Class representing one or more traditional dice used in role-playing games.
+#
+#   Dice.new(1, 6) # => Creates one six-sided die.
+#   Dice.new(9, 10, 20) # => Nine ten-sided dice modified by twenty.
+#
+# === Using role-play notation methods
+#
+# By extending the Integer class you get the feeling of the standard dice
+# notation:
+#
+#   1.d6 # => Same as Dice.new(1, 6)
+#   5.d20 + 7 # => Dice.new(5, 20, 7)
+#
+# By default, only the common dice types are implemented (d4, d6, d8, d10,
+# d12, d20, and d100).
+class Dice
+  include Comparable
+
+  # Number of dice.
+  attr_reader :count
+
+  # Number of sides.
+  attr_reader :sides
+
+  # Roll modifier.
+  attr_reader :modifier
+
+  # Creates new Dice object.
+  #
+  # * +dice+ - dice count
+  # * +die_type+ - sides count
+  # * +mod+ - value added (or subtracted) to the result (optional)
+  def initialize(dice, die_type, mod = 0)
+    @count    = dice > 0 ? dice : 1
+    @sides    = die_type > 0 ? die_type : 1
+    @modifier = mod
+  end
+
+  # Returns new Dice object incremented (or decremented) by +n+.
+  def +(n); self.class.new(@count, @sides, @modifier + n) end
+
+  # Same as calling + method with a negative modifier.
+  def -(n); self.+(-n) end
+
+  # Maximum result of the roll.
+  def max
+    @count * @sides + @modifier
+  end
+
+  # Minimum result of the roll.
+  def min
+    @count + @modifier
+  end
+
+  # Average result of the roll.
+  def avg
+    ((max + min) / 2.0).round
+  end
+
+  # Rolls the dice.
+  #
+  # * +collect+ - specifies if result should returned either as Fixnum or
+  # Array
+  # * +block+ - if given, every roll will be yielded separately
+  #
+  # Note that the modifier is only added when returning result as Fixnum.
+  def roll(collect = false, &block) #:yields: result
+    result = (1..@count).collect { block_given? ? yield(roll_one) : roll_one }
+    result << @modifier unless result.is_a?(Array) || @modifier.zero?
+    collect ? result : result.inject(nil) { |sum, x| sum ? sum + x : x }
+  end
+
+  alias_method :to_i, :roll
+
+  # Same as calling roll(+true+).
+  def to_a; roll(true) end
+
+  # Returns standard, role-play dice format. Custom die +mark+ can be
+  # specified (default is _d_).
+  def to_s(mark = 'd')
+    s = "#{@count}#{mark}#{@sides}"
+    s << "+#{@modifier}" unless @modifier.zero?
+    s
+  end
+
+  private
+    # Returns result of one particular roll.
+    def roll_one
+      rand(@sides) + 1
+    end
+end

data/lib/dice/core_ext.rb

@@ -0,0 +1 @@
+require DICE_ROOT + 'core_ext/fixnum'

data/lib/dice/core_ext/fixnum.rb

@@ -0,0 +1,4 @@
+class Fixnum
+  # Define aliases to create Dice objects easier.
+  [4, 6, 8, 10, 12, 20, 100].each { |sides| define_method("d#{sides}") { Dice.new(self, sides) } }
+end

data/lib/dice/version.rb

@@ -0,0 +1,3 @@
+class Dice
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'pathname'
+require 'rubygems'
+require 'spec'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dice'

data/spec/unit/core_ext/fixnum_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Fixnum do
+  it 'should implement all dice methods' do
+    [4, 6, 8, 10, 12, 20, 100].each do |sides|
+      1.send("d#{sides}").should be_instance_of(Dice)
+    end
+  end
+end

data/spec/unit/dice_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Dice do
+  before(:each) do
+    @dice = Dice.new(6, 12)
+    @complex_dice = Dice.new(10, 20, 7)
+  end
+
+  it 'should create new Dice object' do
+    @dice.should be_instance_of(Dice)
+    @dice.count.should equal(6)
+    @dice.sides.should equal(12)
+    @dice.modifier.should equal(0)
+  end
+
+  it 'should create new Dice object with modifier' do
+    @complex_dice.count.should equal(10)
+    @complex_dice.sides.should equal(20)
+    @complex_dice.modifier.should equal(7)
+  end
+
+  it 'should add positive modifier' do
+    dice = @dice + 7
+    dice.modifier.should equal(7)
+    complex_dice = @complex_dice + 3
+    complex_dice.modifier.should equal(10)
+  end
+
+  it 'should add negative modifier' do
+    dice = @dice - 9
+    dice.modifier.should equal(-9)
+    complex_dice = @complex_dice - 6
+    complex_dice.modifier.should equal(1)
+  end
+
+  it 'should calculate maximum, minimum, and average result of the roll' do
+    @dice.max.should equal(72)
+    @dice.min.should equal(6)
+    @dice.avg.should equal(39)
+    @complex_dice.max.should equal(207)
+    @complex_dice.min.should equal(17)
+    @complex_dice.avg.should equal(112)
+  end
+
+  it 'should roll and return the result as a number' do
+    @dice.roll.should satisfy { |r| r > 0 && r < 73 }
+    @complex_dice.roll.should satisfy { |r| r > 0 && r < 208 }
+  end
+
+  it 'should roll and return the result as a array' do
+    @dice.roll(true).should have(6).items
+    @complex_dice.roll(true).should have(10).items
+  end
+
+  it 'should roll and yield the results' do
+    @dice.roll { |r| r.should satisfy { r > 0 && r < 13 } }
+  end
+
+  it 'should return a string representation of the dice' do
+    @dice.to_s.should eql('6d12')
+    @complex_dice.to_s.should eql('10d20+7')
+  end
+
+  it 'should return custom string representation of the dice' do
+    @dice.to_s('kitteh').should eql('6kitteh12')
+    @complex_dice.to_s('_hai_').should eql('10_hai_20+7')
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: nairda-dice
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Adrian Paca\xC5\x82a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: adrian@zenbe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/dice/core_ext/fixnum.rb
+- lib/dice/version.rb
+- lib/dice/core_ext.rb
+- lib/dice.rb
+- spec/unit/dice_spec.rb
+- spec/unit/core_ext/fixnum_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nairda/dice
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- - --charset
+  - utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Simple Ruby class for simulating dice rolls.
+test_files: []
+