crapshoot 0.4.2 → 0.5.0

data/README.rdoc

@@ -37,10 +37,12 @@ Generally, whitespace is allowed around arithmetic operations, but not inside a
 == Describing a Roll
 
 The return value from +Crapshoot.roll+ is a Crapshoot::Result object,
-which is an Integer with a description field:
+which is an Integer with a +description+ field and a +detailed_description+
+field:
 
     r = Crapshoot.roll '4d4^ + 6d6 - 10' # => 22
     r.description # => "(2+2+2+3-3)+(1+3+5+5+6+6)-10"
+    r.detailed_description # => [["4d4^", "2+2+2+3-3"], ["+", "+"], ["6d6", "1+3+5+5+6+6"], ["-", "-"], ["10", "10"]]
     r + 5 # => 27
 
 == Developing with Ragel

data/crapshoot.gemspec

@@ -7,7 +7,6 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bryce Kerley"]
-  s.date = %q{2011-09-03}
   s.description = "Crapshoot is a dice-rolling gem for most of your pen-and-paper gaming needs; roll 4d6v to find out how much time it will save."
   s.email = "bkerley@brycekerley.net"
   s.extra_rdoc_files = [

data/lib/crapshoot/result.rb

@@ -10,5 +10,8 @@ module Crapshoot
 
     # The derivation of the result, as a String.
     attr_accessor :description
+
+    # The derivation of the result, broken down by tokens, as an Array.
+    attr_accessor :detailed_description
   end
 end

data/lib/crapshoot/tokens/arithmetic.rb

@@ -23,6 +23,7 @@ module Crapshoot
         l = stack.pop
         @result = Result.new l.send(@operation.to_sym, r)
         @result.description = "#{l.description}#{@operation}#{r.description}"
+        @result.detailed_description = l.detailed_description + [[@operation, @operation]] + r.detailed_description
         return @result
       end
 

data/lib/crapshoot/tokens/constant.rb

@@ -4,6 +4,7 @@ module Crapshoot
       def initialize(number)
         @value = Result.new number.to_i
         @value.description = @value.to_s
+        @value.detailed_description = [[@value.to_s, @value.to_s]]
       end
 
       def eval(stack)

data/lib/crapshoot/tokens/series.rb

@@ -24,6 +24,7 @@ module Crapshoot
         end
         @result = Result.new numeric_result
         @result.description = "(#{roll_description})"
+        @result.detailed_description = [["#{@count}d#{@sides}#{@drop}", roll_description]]
 
         return @result
       end

data/lib/crapshoot/version.rb

@@ -1,3 +1,3 @@
 module Crapshoot
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/test/crapshoot_test.rb

@@ -15,12 +15,23 @@ class TestCrapshoot < Test::Unit::TestCase
   end
 
   def self.should_describe(from, matcher)
-    should "evaluate #{from.inspect} into something resembling #{matcher.inspect}" do
+    should "describe #{from.inspect} into something resembling #{matcher.inspect}" do
       result = Crapshoot.roll from
       assert_match matcher, result.description
     end
   end
 
+  def self.should_array_describe(from, matcher)
+    should "describe #{from.inspect} into a big array resembling #{matcher.inspect}" do
+      result = Crapshoot.roll from
+      result.detailed_description.zip(matcher) do |result_piece, matcher_piece|
+        result_piece.zip(matcher_piece) do |r, m|
+          assert_match m, r
+        end
+      end
+    end
+  end
+
   context 'The Crapshoot module' do
     should_roll '4d6', '>='=>4, '<='=>24
     should_roll '4d6 + 200', '>='=>204, '<='=>224
@@ -40,5 +51,16 @@ class TestCrapshoot < Test::Unit::TestCase
     should_describe '2d6 + 5', /\(\d\+\d\)\+5/
     should_describe '2d6 + 5 + 4d2v', /\(\d\+\d\)\+5\+\(\d\+\d\+\d\+\d\-\d\)/
     should_describe '2d6 + 5 + 4d2^', /\(\d\+\d\)\+5\+\(\d\+\d\+\d\+\d\-\d\)/
+
+    should_array_describe '1 + 2', [['1', '1'], ['+', '+'], ['2', '2']]
+    should_array_describe '10 - 5', [['10', '10'], ['-', '-'], ['5', '5']]
+    should_array_describe '2d6', [['2d6', /\d\+\d/]]
+    should_array_describe '2d6 + 5', [['2d6', /\d\+\d/], ['+', '+'], ['5', '5']]
+    should_array_describe '2d6 + 5 + 4d2v', [['2d6', /\d\+\d/],
+                                             ['+', '+'],
+                                             ['5', '5'],
+                                             ['+', '+'],
+                                             ['4d2v', /\d\+\d\+\d\+\d\-\d/]]
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crapshoot
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000Z
+date: 2011-12-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70268233908940 !ruby/object:Gem::Requirement
+  requirement: &70102833186080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70268233908940
+  version_requirements: *70102833186080
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &70268233908200 !ruby/object:Gem::Requirement
+  requirement: &70102833185500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.4
   type: :development
   prerelease: false
-  version_requirements: *70268233908200
+  version_requirements: *70102833185500
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70268233906760 !ruby/object:Gem::Requirement
+  requirement: &70102833184980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *70268233906760
+  version_requirements: *70102833184980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70268233905320 !ruby/object:Gem::Requirement
+  requirement: &70102833184220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.0.7
   type: :development
   prerelease: false
-  version_requirements: *70268233905320
+  version_requirements: *70102833184220
 description: Crapshoot is a dice-rolling gem for most of your pen-and-paper gaming
   needs; roll 4d6v to find out how much time it will save.
 email: bkerley@brycekerley.net