tablescript 0.0.4

data/README.md

@@ -0,0 +1,127 @@
+# Tablescript.rb
+
+This is a Ruby Gem that helps RPG-playing nerds like me generate random things from tables.
+
+For example, a Dungeons & Dragons wandering monster table like this:
+
+    Wandering Monsters (d10):
+    
+    1-5: d6 orcs
+    6-9: 3d6 ancient red dragons
+    10: a cuddly bunny
+
+can be automated in Ruby-ish ways like this:
+
+    table :wandering_monsters do
+      f( 1..5 ) { "#{roll_dice('d6')} orcs" }
+      f( 6..9 ) { "#{roll_dice('3d6')} ancient red dragons" }
+      f { "a cuddly bunny" }
+    end
+    
+    puts roll_on( :wandering_monsters )
+
+# Syntax
+
+Tablescript.rb is a simple DSL built on Ruby that helps to define and roll on tables.
+
+Define a table as follows:
+
+    table :table_name do
+      ...
+    end
+
+Roll on a table as follows:
+
+    roll_on( :table_name )
+
+Table entries define blocks that are returned if the die roll matches the entry. Entries can be simple text:
+
+    f { "a cuddly bunny" }
+
+complex/interpolated text:
+
+    f { "#{roll_dice('3d6')} cuddly bunnies" }
+
+or arbitrary Ruby code:
+
+    f { { :effect => roll_on( :random_limb_loss ), :damage => roll_dice( '4d10' ) }
+
+Table entries are either "f" or "d" for "fixed" and "dynamic" respectively.
+
+Fixed entries are defined for specify die rolls. For example:
+
+    f( 1 ) { ... }
+
+defines the result for the roll of 1.
+
+    f( 5..9 ) { ... }
+
+defines the result for a roll of 5, 6, 7, 8, or 9.
+
+    f { ... }
+
+defines the result for the _next_ roll. If it's the first entry, it defaults to 1. Otherwise, it's whatever the previous entry was + 1.
+
+The :wandering_monsters example table above defines 3 entries: 1-5, 6-9, and 10.
+
+Dynamic entries are defined for groups of rolls. For example:
+
+    d( 10 ) { ... }
+    d( 50 ) { ... }
+    d( 40 ) { ... }
+
+defines 3 groups of results. The first is for rolls of 1-10 (i.e. the first 10). The second is for rolls of 11-60 (i.e. the next 50). And the third is for rolls of 51-100 (i.e. the next 40). In this case the total number of entries works out to 100, so the entries are effectively 10%, 50%, and 40%.
+
+Entries do not have to total 100. For example:
+
+    d( 1 ) { ... }
+    d( 2 ) { ... }
+
+defines 2 groups of results where the second has twice the chance of the first. Tablescript will effectively roll a d3.
+
+# Reference
+
+Tablescript includes the following global functions:
+
+## table( name, &blk )
+
+Defines a table, as in the above examples.
+
+## roll_on( name )
+
+Generates a random number from 1 to the highest defined entry, and returns the corresponding table entry from table named _name_.
+
+## roll_on_and_ignore_duplicates( name, times, *args )
+
+Rolls on the _name_ table _times_ times and ignores duplicate rolls.
+
+## lookup( name, roll )
+
+Returns the entry from table _name_ corresponding to the roll _roll_ as if that number had been randomly generated.
+
+## roll_dice( dice )
+
+Returns a random number generated by the dice described by _dice_.
+
+The following formats are acceptable:
+
+    dX: rolls a single X-sided die
+    YdX: rolls Y X-sided dice and returns the sum of all rolls
+    YdXdl[Z]: rolls Y X-sided dice, drops the lowest Z rolls, and returns the sum of the remainder
+    YdXdh[Z]: rolls Y X-sided dice, drops the highest Z rolls, and returns the sum of the remainder
+
+## choose( options )
+
+Returns a random selection from the passed array of options. For example:
+
+    puts choose( [ "red", "green", "blue" ] )
+
+is equivalent to:
+
+    table :temporary do
+      f { "red" }
+      f { "green" }
+      f { "blue" }
+    end
+    
+    puts roll_on( :temporary )

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'

data/lib/tablescript/dice_roller.rb

@@ -0,0 +1,94 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  
+  class DiceRoller
+  
+    @@DICE_REGEXP = /(\d*)d(\d+)((dl)(\d*)|(dh)(\d*))?/
+    
+    def random_value_in_range( range )
+      rand( range )
+    end
+    
+    def roll_dice( roll_descriptor )
+      rolled_values = roll_all_dice_from_descriptor( roll_descriptor )
+      drop_lowest( rolled_values, roll_descriptor )
+      drop_highest( rolled_values, roll_descriptor )
+      total( rolled_values )
+    end
+  
+    def roll( dice )
+      while m = dice.downcase.match( @@DICE_REGEXP ) do
+        rolled_value = roll_dice( RollDescriptor.new( m ) )
+        dice[ m.begin( 0 )...m.end( 0 ) ] = rolled_value.to_s
+      end
+      eval( dice )
+    end
+  
+    def roll_and_ignore( dice, args )
+      ignored_values = collect_ignored_values( args )
+      rolled_value = nil
+      while rolled_value.nil? do
+        rolled_value = roll( dice )
+        if ignored_values.include? rolled_value
+          rolled_value = nil
+        end
+      end
+      rolled_value
+    end
+  
+    private
+  
+      def roll_all_dice_from_descriptor( roll_descriptor )
+        rolled_values = []
+        1.upto roll_descriptor.count do
+          rolled_values << random_value_in_range( 1..roll_descriptor.die )
+        end
+        rolled_values.sort
+      end
+      
+      def drop_lowest( rolled_values, roll_descriptor )
+        rolled_values.slice!( 0, roll_descriptor.drop_lowest )
+      end
+      
+      def drop_highest( rolled_values, roll_descriptor )
+        rolled_values.slice!( rolled_values.size - roll_descriptor.drop_highest, roll_descriptor.drop_highest )
+      end
+      
+      def total( rolled_values )
+        rolled_values.inject( :+ )
+      end
+      
+      def collect_ignored_values( args )
+        ignored_values = []
+        until args.empty? do
+          value = args.shift
+          if value.is_a?(Integer)
+            ignored_values << value
+          elsif value.class == Range
+            value.each do |i|
+              ignored_values << i
+            end
+          end
+        end
+        ignored_values.uniq
+      end
+  
+  end
+
+end

data/lib/tablescript/roll_descriptor.rb

@@ -0,0 +1,55 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  
+  class RollDescriptor
+
+    attr_reader :die, :count, :drop_lowest, :drop_highest
+  
+    def initialize( match )
+      initialize_die( match )
+      initialize_count( match )
+      initialize_dropped_dice( match )
+    end
+  
+    private
+  
+      def initialize_die( match )
+        @die = match[ 2 ].to_i
+      end
+    
+      def initialize_count( match )
+        @count = 1
+        @count = match[ 1 ].to_i unless match[ 1 ].empty?
+      end
+    
+      def initialize_dropped_dice( match )
+        @drop_lowest = 0
+        @drop_highest = 0
+        if match[ 4 ] == "dl"
+          @drop_lowest = 1
+          @drop_lowest = match[ 5 ].to_i unless match[ 5 ].empty?
+        elsif match[ 6 ] == "dh"
+          @drop_highest = 1
+          @drop_highest = match[ 7 ].to_i unless match[ 7 ].empty?
+        end
+      end
+  
+  end
+
+end

data/lib/tablescript/table.rb

@@ -0,0 +1,53 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  
+  class Table
+  
+    attr_reader :entries
+  
+    def initialize( name, roller )
+      @name = name
+      @roller = roller
+      @entries = nil
+    end
+  
+    def build( &blk )
+      @entries = TableEntryEnvironment.new( @name, @roller )
+      @entries.instance_eval( &blk )
+    end
+  
+    def random_entry
+      @roller.rollD( @entries.die_to_roll )
+    end
+  
+    def lookup( index )
+      @entries.lookup( index )
+    end
+  
+    def roll
+      @entries.reroll
+    end
+    
+    def roll_and_ignore_duplicates( times, args )
+      @entries.reroll_and_ignore_duplicates( times, args )
+    end
+  
+  end
+
+end

data/lib/tablescript/table_entry.rb

@@ -0,0 +1,31 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  
+  class TableEntry
+    
+    def initialize( blk )
+      @blk = blk
+    end
+    
+    def evaluate( roll )
+      @blk.call( roll )
+    end
+  end
+
+end

data/lib/tablescript/table_entry_environment.rb

@@ -0,0 +1,124 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  
+  class TableEntryEnvironment
+  
+    def initialize( table_name, roller )
+      @table_name = table_name
+      @roller = roller
+      @entries = []
+    end
+  
+    def fixed( *args, &blk )
+      if args.empty?
+        @entries << TableEntry.new( blk )
+      else
+        roll = args.shift
+        if roll.is_a?(Integer)
+          @entries[ roll - 1 ] = TableEntry.new( blk )
+        elsif roll.class == Range
+          entry = TableEntry.new( blk )
+          roll.each do |i|
+            @entries[ i - 1 ] = entry
+          end
+        end
+        raise "Too many parameters for f in table #{@table_name}" unless args.empty?
+      end
+    end
+    
+    alias :f :fixed
+    
+    def dynamic( *args, &blk )
+      if args.empty?
+        @entries << TableEntry.new( blk )
+      else
+        count = args.shift
+        if count.is_a?(Integer)
+          entry = TableEntry.new( blk )
+          1.upto count do
+            @entries << entry
+          end
+        end
+        raise "Too many parameters for d in table #{@table_name}" unless args.empty?
+      end
+    end
+    
+    alias :d :dynamic
+  
+    def dice_to_roll
+      "d#{@entries.size}"
+    end
+  
+    def lookup( index )
+      raise "No table entry for a roll of #{index}." if ( index <= 0 or index > @entries.size )
+      @entries[ index - 1 ].evaluate( index )
+    end
+    
+    def reroll
+      rolled_value = @roller.roll( dice_to_roll )
+      lookup( rolled_value )
+    end
+  
+    def reroll_and_ignore( *args )
+      validate_ignored_values( args )
+      rolled_value = @roller.roll_and_ignore( dice_to_roll, args )
+      lookup( rolled_value )
+    end
+    
+    def reroll_and_ignore_duplicates( times, *args )
+      ignored_entries = entries_from_ignored_values( args )
+      evaluated_rolled_entries = []
+      until evaluated_rolled_entries.size == times do
+        rolled_value = @roller.roll( dice_to_roll )
+        rolled_entry = @entries[ rolled_value - 1 ]
+        unless ignored_entries.include? rolled_entry
+          ignored_entries << rolled_entry
+          evaluated_rolled_entries << rolled_entry.evaluate( rolled_value )
+        end
+      end
+      evaluated_rolled_entries
+    end
+    
+    def method_missing( method_id, *args )
+      raise "Undefined command '#{method_id}' in table #{@table_name}"
+    end
+  
+    private
+    
+      def entries_from_ignored_values( args )
+        entries = []
+        args.each do |arg|
+          if arg.is_a?(Integer)
+            entries << lookup( arg )
+          elsif arg.class == Range
+            arg.each do |i|
+              entries << lookup( arg )
+            end
+          end
+        end
+        entries.uniq
+      end
+  
+      def validate_ignored_values( args )
+        raise "No ignored values specified" if args.empty?
+      end
+  
+  end
+
+end

data/lib/tablescript/version.rb

@@ -0,0 +1,20 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+module TableScript
+  VERSION = "0.0.4"
+end

data/lib/tablescript.rb

@@ -0,0 +1,81 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+require 'tablescript/dice_roller'
+require 'tablescript/roll_descriptor'
+require 'tablescript/table'
+require 'tablescript/table_entry'
+require 'tablescript/table_entry_environment'
+
+$LOAD_PATH.push File.expand_path( ENV[ "TS_PATH" ] ) unless ENV[ "TS_PATH" ].nil?
+
+$all_tables = {}
+
+def table( name, &blk )
+  begin
+    new_table = TableScript::Table.new( name, TableScript::DiceRoller.new )
+    new_table.build( &blk )
+    $all_tables[ name ] = new_table
+  rescue Exception => e
+    puts e
+    exit
+  end
+end
+
+def roll_on( name )
+  raise "No table named '#{name}'" if $all_tables[ name ].nil?
+  $all_tables[ name ].roll
+end
+
+def roll_on_and_ignore_duplicates( name, times, *args )
+  begin
+    raise "No table named '#{name}'" if $all_tables[ name ].nil?
+    $all_tables[ name ].roll_and_ignore_duplicates( times, args )
+  rescue Exception => e
+    puts e
+    exit
+  end
+end
+
+def lookup( name, roll )
+  begin
+    raise "No table named '#{name}'" if $all_tables[ name ].nil?
+    $all_tables[ name ].lookup( roll )
+  rescue Exception => e
+    puts e
+    exit
+  end
+end
+
+def roll_dice( dice )
+  begin
+    TableScript::DiceRoller.new.roll( dice.dup )
+  rescue Exception => e
+    puts e
+    exit
+  end
+end
+
+def choose( options )
+  options[ TableScript::DiceRoller.new.random_value_in_range( 1..options.size ) - 1 ]
+end
+
+class String
+  def roll
+    roll_dice(self)
+  end
+end

data/tablescript.gemspec

@@ -0,0 +1,38 @@
+# Copyright 2015 Jamie Hale
+#
+# This file is part of the Tablescript.rb gem.
+#
+# Tablescript.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Tablescript.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+    
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'tablescript/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'tablescript'
+  s.version     = TableScript::VERSION
+  s.date        = '2015-05-05'
+  s.summary     = "TableScript RPG Tool"
+  s.description = "Library for creating role-playing game random tables."
+  s.authors     = [ 'Jamie Hale' ]
+  s.email       = [ 'jamie@smallarmyofnerds.com' ]
+  s.homepage    = 'http://smallarmyofnerds.com/tablescript'
+  s.license     = "GPL-3.0"
+  s.platform    = Gem::Platform::RUBY
+  s.files       = `git ls-files -z`.split( "\x0" )
+  s.require_paths = [ 'lib' ]
+  s.metadata['allowed_push_host'] = 'https://rubygems.org'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: tablescript
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jamie Hale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies: []
+description: Library for creating role-playing game random tables.
+email:
+- jamie@smallarmyofnerds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- COPYING
+- README.md
+- Rakefile
+- lib/tablescript.rb
+- lib/tablescript/dice_roller.rb
+- lib/tablescript/roll_descriptor.rb
+- lib/tablescript/table.rb
+- lib/tablescript/table_entry.rb
+- lib/tablescript/table_entry_environment.rb
+- lib/tablescript/version.rb
+- tablescript.gemspec
+homepage: http://smallarmyofnerds.com/tablescript
+licenses:
+- GPL-3.0
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: TableScript RPG Tool
+test_files: []