rdice 1.0.0 → 1.0.1

data/README.md

@@ -16,7 +16,7 @@ gem "rdice"
 ## Usage
 
 
-Them most basic use you can create a new instance of Dice and perform some rolls. The returned value is a integer containing the sum of all dices rolled
+The most basic use you can create a new instance of Dice and perform some rolls. The returned value is a integer containing the sum of all dices rolled
 
 ```ruby
 dice = Dice.new

data/lib/dice/config.rb

@@ -1,27 +1,36 @@
 class Dice
+  # This class is responsible for default settings of Dice class
+  # these methods allow change the preferences of a dice and sets
+  # some getter methods for check preferences
   class Config
+    # Return the default number of dice sides
     def self.sides
       @sides
     end
   
+    # Set the number of dice sides
     def self.sides=(sides)
       raise ArgumentError, 'Must be a Integer' unless sides.is_a? Integer
       @sides = sides
     end  
   
+    # Return the default number of dices rolled
     def self.dices
       @dices
     end
   
+    # Set the number of default dices rolled
     def self.dices=(dices)
       raise ArgumentError, 'Must be a Integer' unless dices.is_a? Integer
       @dices = dices
     end
     
+    # Used to check if results is an array or not. Return true if setted for array
     def self.array?
       @array || false
     end
   
+    # Set true or false for results in array format
     def self.array=(array)
       raise ArgumentError, 'Must be true or false' unless [true, false].include?(array)
       @array = array

data/lib/dice/dice.rb

@@ -1,14 +1,53 @@
+# RDice
+# Author::    Denis Tierno  (de.tierno@gmail.com)
+# 
+# This program is intended to allow a dice creation and perform some rolls
+# the most basic use you can create a new instance of Dice and perform some rolls.
+# 
+# Dice.new creates a object with one dice with six sides by default and the result is a Integer 
+# 
+# To change the defaults just pass it on creation
+#   dice = Dice.new(20,2,true)
+# This will set the defaults as 2 dices with 20 sides each and result as a Array
+#   dice.roll # => [9, 15]
+# 
+# To override the defaults sides and dices just write how many dices you wanna roll
+#   dice = Dice.new(20,2)
+#   
+#   dice.roll          # rolls two d20 by default
+#   dice.roll_two      # rolls two d20
+#   dice.roll_four     # rolls four d20
+#   dice.roll_d20      # rolls two d20
+#   dice.roll_three_d8 # rolls three d8
+#   dice.roll_10_d3    # rolls 10 d3
+
 class Dice
+  # Set the defaults values for Dice object
   def initialize(sides=6, dices=1, array=false)
     Dice::Config.sides = sides
     Dice::Config.dices = dices
     Dice::Config.array = array
   end
-
+  
+  # To perform a roll without use method missing exception call <tt>roll</tt>
+  # with desired number of sides and dices.
+  # First argument is an integer with number of dice sides and
+  # second is an integer with the number of dices rolled by default.
+  # Result can be a sum or a array.
   def roll(sides=preferred_sides, dices=preferred_dices)
     get_result(sides, dices)
   end
   
+  # Provides some handy shortcuts for a Dice object allowing to call
+  # methods like:
+  # 
+  #   dice = Dice.new
+  #
+  #   dice.roll
+  #   dice.roll_two 
+  #   dice.roll_d20
+  #   dice.roll_three_d8
+  #   dice.roll_10_d3
   def method_missing(method, *args, &block)
     if method =~ /roll_d(\w+)/
       roll($1.to_i)

data/lib/dice/version.rb

@@ -1,3 +1,3 @@
 class Dice
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70235608766060 !ruby/object:Gem::Requirement
+  requirement: &70219989185120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235608766060
+  version_requirements: *70219989185120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70235608765140 !ruby/object:Gem::Requirement
+  requirement: &70219989182020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235608765140
+  version_requirements: *70219989182020
 description: ! 'This gem allow you to set dices and roll it. You can set custom defaults
   and change behavior to fit your purpose '
 email:
@@ -70,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 747301994299439198
+      hash: -2035843853156825772
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 747301994299439198
+      hash: -2035843853156825772
 requirements: []
 rubyforge_project: rdice
 rubygems_version: 1.8.10