rpg-tools 0.2.0 → 0.2.1

data/README.textile

@@ -124,6 +124,27 @@ Rolling a CheckRoll:
   check_roll.detailed_result # => [true, [12, [6, 4]]]
 </code></pre>
 
+Using <code>greater_than_threshold</code> and <code>greater_to_threshold</code> attributes:
+<pre><code>
+  dice = [Tools::Die.new(6),Tools::Die.new(6)]
+  offset = 2
+  throw = Tools::Throw.new dice,offset #Creates a new throw with 2D6+2
+  threshold = 9
+  #Creating a "greater and equal to" check
+  check_roll1 = Tools::CheckRoll.new throw, threshold #1,true,true (by default)
+  check_roll1.to_s # => "2D6+2 must be greater or equal to 9."
+  #Creating a "greater than" check
+  check_roll2 = Tools::CheckRoll.new throw, threshold, 1, true, false
+  check_roll2.to_s # => "2D6+2 must be greater than 9." 
+  #Creating a "less than" check
+  check_roll3 = Tools::CheckRoll.new throw, threshold, 1, false, false
+  check_roll3.to_s # => "2D6+2 must be less than 9."
+  #Creating a "less and equal to" check
+  check_roll4 = Tools::CheckRoll.new throw, threshold, 1, false, true
+  check_roll4.to_s # => "2D6+2 must be less or equal to 9."
+</code></pre>
+
+
 More methods of CheckRoll:
 <pre><code>
   #Converting CheckRoll into string

data/app/models/tools/check_roll.rb

@@ -1,14 +1,18 @@
 module Tools
   class CheckRoll
 
-    attr_accessor :throw, :threshold, :rolling_chances, :greater_than_threshold, :equal_than_threshold
+    attr_accessor :throw, :threshold, :rolling_chances, :greater_than_threshold, :equal_to_threshold
     attr_reader :result
-    def initialize throw, threshold, rolling_chances=1, greater_than_threshold=true, equal_than_threshold=true
+    # Creates a new +CheckRoll+ with a +Throw+, a +Fixnum+ as +threshold+ and, optionally:
+    # * +rolling_chances+: The number of times the Throw will be rolled before checking. By default is +1+.
+    # * +greater_than_threshold+: Wheter the check is done as greater than (>) or less than (<). By default is +true+.
+    # * +equal_to_threshold+: Wheter the check accepts the threshold as success (>= and <= if +true+, > and < if +false+). By default is +true+.
+    def initialize throw, threshold, rolling_chances=1, greater_than_threshold=true, equal_to_threshold=true
       @throw = throw
       @threshold = threshold
       @rolling_chances = rolling_chances
       @greater_than_threshold = greater_than_threshold
-      @equal_than_threshold = equal_than_threshold
+      @equal_to_threshold = equal_to_threshold
     end
 
     # Rolls the Throw as many times as rolling chances are set.If has already
@@ -75,7 +79,7 @@ module Tools
 
     def compare rolled_throw, threshold
       gtt = @greater_than_threshold
-      ett = @equal_than_threshold
+      ett = @equal_to_threshold
       if gtt and ett
       return rolled_throw >= threshold
       elsif gtt and !ett
@@ -89,7 +93,7 @@ module Tools
 
     def comparatives_text
       gtt = @greater_than_threshold
-      ett = @equal_than_threshold
+      ett = @equal_to_threshold
       if gtt and ett
         return I18n.t 'rpg_tools.check_roll.greater_and_equal'
       elsif gtt and !ett

data/app/models/tools/die.rb

@@ -1,6 +1,7 @@
 module Tools
   class Die
     attr_accessor :sides
+    # Creates a new +Die+ with a +Fixnum+ as the number of +sides+
     def initialize sides=20
       @sides = sides
     end

data/app/models/tools/throw.rb

@@ -1,6 +1,8 @@
 module Tools
   class Throw
     attr_accessor :dice, :offset
+    
+    # Creates a new +Throw+ with an +Array+ of +Die+ and a +Fixnum+ as +offset+
     def initialize dice, offset=0
       @dice = dice.sort_by{|die| die.sides}
       @offset = offset

data/rpg_tools.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
 	s.name = "rpg-tools"
-	s.version = "0.2.0"
+	s.version = "0.2.1"
 	s.authors = ["Eduardo Casanova Cuesta"]
-	s.summary = "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
-	s.description = "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
+	s.summary = "RPG Tools is a compilation of helpful tools when developing a Role Playing Game (RPG). For now the gem has three classes: Die, Throw and CheckRoll. "
+	s.description = "RPG Tools is a compilation of helpful tools when developing a Role Playing Game (RPG). For now the gem has three classes: Die, Throw and CheckRoll."
 	s.email = "ecasanovac@gmail.com"
 	s.homepage = "https://github.com/roendal/rpg-tools"
 	s.files = `git ls-files`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rpg-tools
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -112,7 +112,7 @@ dependencies:
   type: :development
   name: capybara
   version_requirements: *id006
-description: "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
+description: "RPG Tools is a compilation of helpful tools when developing a Role Playing Game (RPG). For now the gem has three classes: Die, Throw and CheckRoll."
 email: ecasanovac@gmail.com
 executables: []
 
@@ -211,6 +211,6 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: "Some tools useful when creating a RPG: Die, Throw and CheckRoll."
+summary: "RPG Tools is a compilation of helpful tools when developing a Role Playing Game (RPG). For now the gem has three classes: Die, Throw and CheckRoll."
 test_files: []