dice_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baa939eb7c810a0cc7340c117116c1828d5f7512
+  data.tar.gz: f4aa186523587a1bcca4b903ed73f215aa30e0cf
+SHA512:
+  metadata.gz: 4cd0edbb580d6df4974f50a5d0747212686286abee440a8a8fe954502d6e52b724b06942700b5eb8a4ee4a9c53a8857c7aa5a94dbc9a1dbbe2a44c9611ea5d02
+  data.tar.gz: e5f816f66ff554b48b24b3ba026411558e10851f9ca52cf146e094db6375535234dc48ea25ba2754dca14cf62fad21ea727f9dfa6f24061d73126b82628326f6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dice.gemspec
+gemspec
+
+gem 'minitest'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2014 Stuart Coyle
+
+MIT License
+
+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,51 @@
+# Dice
+
+A parser for Dice notation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dice'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dice
+
+## Usage
+
+The supported dice notation:
+
+* NdX - Roll N dice with X sides and add the result. e.g. 3d6, 4d10, 1d100.
+* dX  - Roll one die with X sides.
+* d%  - Roll one percentile (100 sided) die.
+* hY  - Keep the highest Y rolls. e.g. 4d6h3 would give a roll in the range 3..18
+* kY  - A synonym for h (keep).
+* lZ  - Keep the lowest Z rolls. e.g. 2d6l1 would take the lowest one of two dice.
+
+Basic arithmetic is also supported:
+integers, floats, +, -, *, / and () are all allowed.
+
+Examples:
+```
+  Dice.roll('3d6+6')
+  Dice.roll('2d100/2')
+  Dice.roll('4d6 - 3d4')
+  Dice.roll('100/4d6h3')
+
+```
+
+Currently the gem just uses Random.rand for it's random number generation.
+Other random number generators could easily be added by overriding the Dice.rng method.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test
+

data/dice.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dice/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Stuart Coyle"]
+  gem.email         = ["stuart.coyle@gmail.com"]
+  gem.description   = %q{A parser for dice notation. Rolls dice and does various arithmetic.}
+  gem.summary       = %q{Dice notation parser}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dice_parser"
+  gem.require_paths = ["lib"]
+  gem.version       = Dice::VERSION
+  gem.requirements  << 'Treetop version 1.4 or later.'
+  gem.add_dependency "treetop"
+end

data/lib/dice/dice_nodes.rb

@@ -0,0 +1,62 @@
+module DiceString
+  class DiceNode < Treetop::Runtime::SyntaxNode
+    def evaluate
+      n = num_dice.text_value == "" ? 1 : num_dice.evaluate
+      s = sides.text_value == '%' ? 100 : sides.evaluate
+      rolls = Array.new(n){ Dice.rng.call(s) }
+      sum rolls
+    end
+
+    def maximum
+      n = num_dice.text_value == "" ? 1 : num_dice.evaluate
+      s = sides.text_value == '%' ? 100 : sides.evaluate
+      rolls = Array.new(n){ s }
+      sum rolls
+    end
+
+    def minimum
+      n = num_dice.text_value == "" ? 1 : num_dice.evaluate
+      rolls = Array.new(n){ 1 }
+      sum rolls
+    end
+
+  private
+    def sum rolls
+      rolls = keep.evaluate(rolls) if keep.text_value != ""
+      rolls.inject(0){|v,l| v += l}
+    end
+  end
+
+  class BinopNode < Treetop::Runtime::SyntaxNode
+    def evaluate
+      tail.elements.inject(head.evaluate) do |value, element|
+        element.operator.apply(value, element.operand.evaluate)
+      end
+    end
+
+    def maximum
+      tail.elements.inject(head.maximum) do |value, element|
+        element.operator.apply(value, element.operand.maximum)
+      end
+    end
+
+    def minimum
+      tail.elements.inject(head.minimum) do |value, element|
+        element.operator.apply(value, element.operand.minimum)
+      end
+    end
+  end
+
+  class KeepNode < Treetop::Runtime::SyntaxNode
+    def evaluate rolls
+      case op.text_value
+      when 'h'
+        rolls.sort.reverse.take n.evaluate
+      when 'l'
+        rolls.sort.take n.evaluate
+      else
+        rolls
+      end
+    end
+  end
+end

data/lib/dice/dicestring.treetop

@@ -0,0 +1,106 @@
+require File.join(File.dirname(__FILE__),'dice_nodes.rb')
+
+grammar DiceString
+
+  rule expression
+    additive
+  end
+
+  rule additive
+    head:multitive
+    tail:(space operator:additive_op space operand:multitive)* <BinopNode>
+  end
+
+  rule multitive
+    head:primary
+    tail:(space operator:multitive_op space operand:primary)* <BinopNode>
+  end
+
+  rule additive_op
+    '+' {
+      def apply(a,b)
+        a + b
+      end
+    } / '-' {
+      def apply(a,b)
+        a - b
+      end
+    }
+  end
+
+  rule multitive_op
+    '*' {
+      def apply(a,b)
+        a * b
+      end
+    } / '/'  {
+      def apply(a,b)
+        a / b
+      end
+      }
+  end
+
+  rule primary
+    dice / number / '(' space expression space ')' {
+      def evaluate
+        expression.evaluate
+      end
+
+      def minimum
+        expression.minimum
+      end
+
+      def maximum
+        expression.maximum
+      end
+    }
+  end
+
+  rule number
+    float / integer
+  end
+
+  rule float
+    integer '.' integer {
+      def evaluate
+        text_value.to_f
+      end
+
+      def minimum
+        evaluate
+      end
+
+      def maximum
+        evaluate
+      end
+    }
+  end
+
+  rule integer
+    ([1-9] [0-9]* / '0') {
+      def evaluate
+        text_value.to_i
+      end
+
+      def minimum
+        evaluate
+      end
+
+      def maximum
+        evaluate
+      end
+    }
+  end
+
+  rule space
+    ' '*
+  end
+
+  rule dice
+    num_dice:integer? 'd' sides:(integer / '%') keep:keep? <DiceNode>
+  end
+
+  rule keep
+    op:('h' / 'l') n:integer <KeepNode>
+  end
+end

data/lib/dice/version.rb

@@ -0,0 +1,3 @@
+module Dice
+  VERSION = "1.0.0"
+end

data/lib/dice.rb

@@ -0,0 +1,49 @@
+require 'treetop'
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'dice', 'dice_nodes.rb')
+
+# This class encapsulates the dice parser from treetop.
+class Dice
+  Treetop.load(File.join(File.expand_path(File.dirname(__FILE__)), 'dice', 'dicestring'))
+  @parser = DiceStringParser.new
+
+  attr_accessor :dice_string
+
+  def self.parse string
+    @parser.parse string
+  end
+
+  def self.rng= generator
+    @rng = generator
+  end
+
+  def self.rng
+    @rng ||= -> (n) { Random.rand(n) + 1 }
+  end
+
+  def self.roll string
+    parse(string).evaluate
+  end
+
+  def initialize dice_string
+    @dice_string = dice_string
+  end
+
+  def roll
+    dice.evaluate
+  end
+
+  def maximum
+    dice.maximum
+  end
+
+  def minimum
+    dice.minimum
+  end
+
+  private
+
+  def dice
+    self.class.parse(dice_string)
+  end
+end

data/test/dice_parser_test.rb

@@ -0,0 +1,91 @@
+require 'minitest/autorun'
+require 'dice'
+
+class DiceParserTest < MiniTest::Test
+
+  def test_integer
+    assert_equal 0, Dice.roll('0')
+    assert_equal 32, Dice.roll('32')
+  end
+
+  def test_float
+    assert_equal 1.2301, Dice.roll('1.2301')
+    assert_equal 23.123, Dice.roll('23.123')
+  end
+
+  def test_addition
+    assert_equal 4, Dice.roll('1+3')
+  end
+
+  def test_subtraction
+    assert_equal 3, Dice.roll('4-1')
+  end
+
+  def test_multiplication
+    assert_equal 6, Dice.roll('2*3')
+  end
+
+  def test_division
+    assert_equal 4, Dice.roll('8/2')
+  end
+
+  def test_parens
+    assert_equal 7, Dice.roll('1+2*3')
+    assert_equal 9, Dice.roll('(1+2)*3')
+    assert_equal(-2, Dice.roll('5-(3+4)'))
+  end
+
+  def test_dice
+    Random.stub :rand, 4 do
+     assert_equal 10, Dice.roll('2d6')
+     assert_equal 15, Dice.roll('3d12')
+   end
+  end
+
+  def test_percentile
+    Random.stub :rand, 40 do
+      assert_equal 41, Dice.roll('1d%')
+    end
+  end
+
+  def test_keep_highest
+    stub_random [5, 2, 3] do
+      assert_equal 10, Dice.roll('3d6h2')
+    end
+  end
+
+  def test_keep_lowest
+    stub_random [5, 2, 3] do
+      assert_equal 7, Dice.roll('3d6l2')
+    end
+  end
+
+  def test_multiple_dice_sets
+    stub_random [4, 8, 1, 3, 2] do
+      assert_equal 23, Dice.roll('2d10+3d4')
+    end
+  end
+
+  def test_assumed_one
+    Random.stub :rand, 50 do
+      assert_equal 51, Dice.roll('d100')
+      assert_equal 53, Dice.roll('2+d100')
+    end
+  end
+
+  def test_adding_an_integer_returns_a_fixnum_not_a_float
+    assert_equal Fixnum, Dice.roll("1d6 + 1").class
+  end
+
+  def test_complex_case
+    stub_random [4,8,1,3,2,24] do
+      assert_equal 10*(5 + 9)*(2 + (2 + 4 + 3)) /(3 - 25)+3.5, Dice.roll('10*2d10*(2+3d4)/(3-d%)+3.5')
+    end
+  end
+
+  def stub_random rolls
+    Random.stub :rand, -> (_) { rolls.shift } do
+      yield
+    end
+  end
+end

data/test/dice_test.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require 'treetop'
+require 'dice'
+
+class DiceTest < MiniTest::Test
+  def test_new_assigns_the_dice_string
+    assert_equal '3d6', Dice.new('3d6').dice_string
+  end
+
+  def test_roll
+    Random.stub :rand, 4 do
+      assert_equal 15, Dice.new('3d6').roll
+    end
+  end
+
+  def test_maximum
+    assert_equal 20, Dice.new('3d6+2').maximum
+  end
+
+  # def test_maximum_complex
+  #   assert_equal 12 - 3 - 5, Dice.new('3d4 - 3 - 5d10').maximum
+  # end
+
+  def test_minimum
+    assert_equal 4, Dice.new('3d6+1').minimum
+  end
+
+  # def test_minimum_complex
+  #   assert_equal 3-24, Dice.new('3d6 - 4d6').minimum
+  # end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: dice_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stuart Coyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A parser for dice notation. Rolls dice and does various arithmetic.
+email:
+- stuart.coyle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dice.gemspec
+- lib/dice.rb
+- lib/dice/dice_nodes.rb
+- lib/dice/dicestring.treetop
+- lib/dice/version.rb
+- test/dice_parser_test.rb
+- test/dice_test.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Treetop version 1.4 or later.
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Dice notation parser
+test_files:
+- test/dice_parser_test.rb
+- test/dice_test.rb