tablescript 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2303467e7858c51a92faeeb841c25048bf7ad744
-  data.tar.gz: a62fdd87ace512e90d1cf660642482760437ab8c
+  metadata.gz: d0f5efd6fa78b6b445096266758357d4a397b6cf
+  data.tar.gz: e020ae53ff35f27661b20fc1c7a8be50d251c9db
 SHA512:
-  metadata.gz: fb1dcf8a0d11abb17c71a0b973df1af967db9b49db2799ec0634da9c476d9dbeea25f569972d492422b6503a41ab5c3a4eaf54ee2b50955ed7ba7e1b9e93b22e
-  data.tar.gz: 4b265adcc28d757b34e3d921f6f9f06fcfff498693ef4e192bae04583de43c3dff202a864a299d20fd92f6294a97305a75e343ca1b62334d57c250e6ad574395
+  metadata.gz: 4a6b0ba6fd88cc0064534224c3abfaba8a40b7ef056a194431c7b11a31c6fa2a0dfdeebbd2fd3666b346f0a25130ee629967a87fe886f1ebcea73b589699eb22
+  data.tar.gz: afefce70890f7c2be9a2c43078e752fc717bbea70864c613d0a372533798025eabc21f4bfb68c229e09aa1609c0f8cb2934af348a64d380374205c5c5898854d

data/.gitignore

@@ -1,2 +1,4 @@
-pkg
+/pkg
 *.swp
+/Gemfile.lock
+/coverage

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Metrics/LineLength:
+    Enabled: false
+Metrics/ModuleLength:
+    Enabled: false
+Metrics/BlockLength:
+    Enabled: true
+    Exclude:
+        - res/*.rb
+        - spec/**/*.rb

data/Gemfile

@@ -0,0 +1,20 @@
+# Copyright 2017 Jamie Hale
+#
+# This file is part of the Tablescript gem.
+#
+# Tablescript 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 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 Tablescript.  If not, see <http://www.gnu.org/licenses/>.
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,24 +1,24 @@
 # Tablescript.rb
 
-This is a Ruby Gem that helps RPG-playing nerds like me generate random things from tables.
+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
+    6-19: 3d6 ancient red dragons
+    20: 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(1..5) { "#{roll('d6')} orcs" }
+      f(6..19) { "#{roll('3d6')} ancient red dragons" }
       f { "a cuddly bunny" }
     end
     
-    puts roll_on( :wandering_monsters )
+    puts roll_on(:wandering_monsters)
 
 # Syntax
 
@@ -32,7 +32,7 @@ Define a table as follows:
 
 Roll on a table as follows:
 
-    roll_on( :table_name )
+    roll_on(:table_name)
 
 Table entries define blocks that are returned if the die roll matches the entry. Entries can be simple text:
 
@@ -40,21 +40,21 @@ Table entries define blocks that are returned if the die roll matches the entry.
 
 complex/interpolated text:
 
-    f { "#{roll_dice('3d6')} cuddly bunnies" }
+    f { "#{roll('3d6')} cuddly bunnies" }
 
 or arbitrary Ruby code:
 
-    f { { :effect => roll_on( :random_limb_loss ), :damage => roll_dice( '4d10' ) }
+    f { { effect: roll_on(:random_limb_loss), damage: roll('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 ) { ... }
+    f(1) { ... }
 
 defines the result for the roll of 1.
 
-    f( 5..9 ) { ... }
+    f(5..9) { ... }
 
 defines the result for a roll of 5, 6, 7, 8, or 9.
 
@@ -62,66 +62,77 @@ defines the result for a roll of 5, 6, 7, 8, or 9.
 
 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.
+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 ) { ... }
+    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 ) { ... }
+    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:
+Include the Tablescript API into your global namespace as follows:
 
-## table( name, &blk )
+    include Tablescript::Api
 
-Defines a table, as in the above examples.
+The Tablescript API includes the following global functions:
 
-## roll_on( name )
+## namespace(name, &blk)
 
-Generates a random number from 1 to the highest defined entry, and returns the corresponding table entry from table named _name_.
+Defines a namespace. Namespaces can contain other namespaces, and tables.
 
-## roll_on_and_ignore_duplicates( name, times, *args )
+## table(name, &blk)
 
-Rolls on the _name_ table _times_ times and ignores duplicate rolls.
+Defines a table, as in the above examples. Tables defined inside a namespace are accessible in that namespace, or by providing an absolute (/path/to/table) or relative (path/to/table or ../path/to/table) path. See the examples.
 
-## lookup( name, roll )
+## roll\_on(name)
 
-Returns the entry from table _name_ corresponding to the roll _roll_ as if that number had been randomly generated.
+Generates a random number from 1 to the highest defined entry, and returns the corresponding table entry -- evaluated -- from table named _name_.
 
-## roll_dice( dice )
+## roll\_on\_and\_ignore(name, \*args)
 
-Returns a random number generated by the dice described by _dice_.
+Rolls on the _name_ table and ignores rolls that match the passed arguments. For example:
 
-The following formats are acceptable:
+    roll_on_and_ignore(:wandering_monsters, 1..5)
 
-    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
+will roll until it gets something other than orcs.
 
-## choose( options )
+    roll_on_and_ignore(:wandering_monsters, 1..5, 10)
 
-Returns a random selection from the passed array of options. For example:
+will only return ancient red dragons.
 
-    puts choose( [ "red", "green", "blue" ] )
+## roll\_on\_and\_ignore\_duplicates(name, times)
 
-is equivalent to:
+Rolls on the _name_ table _times_ times and ignores duplicate entries.
 
-    table :temporary do
-      f { "red" }
-      f { "green" }
-      f { "blue" }
-    end
-    
-    puts roll_on( :temporary )
+## lookup(name, roll)
+
+Returns the entry from table _name_ corresponding to the roll _roll_ as if that number had been randomly generated.
+
+# Installation
+
+    $> gem install tablescript
+
+Include Tablescript:
+
+    require 'tablescript'
+    include Tablescript::Api
+
+The include is optional. You can use the Tablescript library directly, or in another namespace if you so choose.
+
+# Development
+
+Tablescript runs in Ruby 2.4. It hasn't been tested in previous versions.
+
+    $> rake spec
+    $> rake rubocop

data/Rakefile

@@ -1,4 +1,28 @@
-require "bundler/gem_tasks"
+# Copyright 2017 Jamie Hale
+#
+# This file is part of the Tablescript gem.
+#
+# Tablescript 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 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 Tablescript.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'bundler/gem_tasks'
 require 'rake/clean'
-require 'rubygems'
-require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :rubocop do
+  sh 'bundle exec rubocop'
+end

data/examples/namespaces.rb

@@ -0,0 +1,33 @@
+#! /usr/bin/env ruby
+
+require 'tablescript'
+include Tablescript::Api
+
+namespace :utils do
+  namespace :special do
+    table :things do
+      f { 'lamp' }
+      f { 'coin' }
+      f { 'tapestry' }
+    end
+  end
+
+  table :colours do
+    f { 'red' }
+    f { 'green' }
+    f { 'black' }
+    f { 'blue' }
+  end
+
+  table :things do
+    f { 'carpet' }
+    f { 'chair' }
+    f { roll_on('special/things') }
+  end
+end
+
+table :stuff do
+  f { "a #{roll_on('/utils/colours')} #{roll_on('/utils/things')}" }
+end
+
+puts roll_on(:stuff)

data/examples/wandering_monsters.rb

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+
+require 'tablescript'
+include Tablescript::Api
+
+require 'rpg_lib'
+include RpgLib::Api
+
+table :wandering_monsters do
+  f(1..5) { "#{roll('d6')} orcs" }
+  f(6..19) { "#{roll('3d6')} ancient red dragons" }
+  f(20) { 'a cuddly bunny' }
+end
+
+puts roll_on(:wandering_monsters)

data/lib/tablescript.rb

@@ -1,81 +1,37 @@
-# Copyright 2015 Jamie Hale
+# Copyright 2017 Jamie Hale
 #
-# This file is part of the Tablescript.rb gem.
+# This file is part of the Tablescript gem.
 #
-# Tablescript.rb is free software: you can redistribute it and/or modify
+# Tablescript 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,
+# Tablescript 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
+# along with Tablescript.  If not, see <http://www.gnu.org/licenses/>.
 
-def roll_on( name )
-  raise "No table named '#{name}'" if $all_tables[ name ].nil?
-  $all_tables[ name ].roll
-end
+require 'rpg_lib'
 
-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
+require 'tablescript/version'
+require 'tablescript/exception'
+require 'tablescript/roll_strategy'
+require 'tablescript/roll_and_ignore_strategy'
+require 'tablescript/roll_and_ignore_duplicates_strategy'
+require 'tablescript/lookup_strategy'
+require 'tablescript/table_entries'
+require 'tablescript/table'
+require 'tablescript/table_entry'
+require 'tablescript/roll_context'
 
-def choose( options )
-  options[ TableScript::DiceRoller.new.random_value_in_range( 1..options.size ) - 1 ]
-end
+$LOAD_PATH.push File.expand_path(ENV['TS_PATH']) unless ENV['TS_PATH'].nil?
 
-class String
-  def roll
-    roll_dice(self)
-  end
-end
+require 'tablescript/namespace_generator'
+require 'tablescript/namespace'
+require 'tablescript/library'
+require 'tablescript/api'
+require 'tablescript/library_dumper'

data/lib/tablescript/api.rb

@@ -0,0 +1,50 @@
+# Copyright 2017 Jamie Hale
+#
+# This file is part of the Tablescript gem.
+#
+# Tablescript 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 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 Tablescript.  If not, see <http://www.gnu.org/licenses/>.
+
+module Tablescript
+  ##
+  # Api
+  #
+  module Api
+    def namespace(name, &blk)
+      generator = NamespaceGenerator.new(Library.instance.root.namespace(name.to_s))
+      generator.instance_eval(&blk)
+    end
+
+    def table(name, &blk)
+      root_namespace = Library.instance.root
+      table = Table.new(name.to_s, root_namespace, &blk)
+      root_namespace.add(table)
+    end
+
+    def roll_on(path)
+      RollStrategy.new(Library.instance.table(path.to_s)).value
+    end
+
+    def roll_on_and_ignore(path, *args)
+      RollAndIgnoreStrategy.new(Library.instance.table(path.to_s), RpgLib::RollSet.new(*args)).value
+    end
+
+    def roll_on_and_ignore_duplicates(path, times)
+      RollAndIgnoreDuplicatesStrategy.new(Library.instance.table(path.to_s), times).values
+    end
+
+    def lookup(path, roll)
+      LookupStrategy.new(Library.instance.table(path.to_s), roll).value
+    end
+  end
+end