gm-notepad 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fad1534243d237bace667966a495af3e787a0bc67ef40283e96a2d7ca49942f
-  data.tar.gz: b37925618ac94a01fdceadba354c641f704756ce55788c839a518e4e3a474b24
+  metadata.gz: da3bbc8cbf352187a313f8815110edef14d41c7c37e4f2dd1f3bb49e43200bcf
+  data.tar.gz: 12ffebdda56b6d2e3a4c43da401c884b8c1a659767ea618081792346530ca15c
 SHA512:
-  metadata.gz: 80173f33eff4c3f0aa01f4ec706f2759d8f91b698b0c45872c299b94e0ac327f5deb1d9b2bf85fa468eaf28b9744f08aa7af67ccb20dd201fe8ce7159ba15e11
-  data.tar.gz: 49ef7f14a885164ff70dc9e46bb2d05867fe53a9345cb5223efd2624fad4cad54e3f27d85f4aca4df0233cf973899f73786f1d824f958d9f09a8ceda837e7f3b
+  metadata.gz: fa277d748161cb37f2b1105d02d17cc551769f171953746bfd8aed13cd009c48fbb155a96c08a980f1c34ab66e6c6afa07cf42b804eac77cf5a5a79016533f4e
+  data.tar.gz: a0539f38a29bcce258255da060388f29cbeab6cd59505fbcb2af2f757f8094637d8b821f63e339f8002169ffe720b9346d5b10c5fd6a03ead9ad6ba759308116

data/README.md

@@ -177,6 +177,10 @@ Hello SamWise
 The line with starting with `=>` is the `interactive` buffer. The other line
 is written to the `output` buffer.
 
+You can also roll within a table. In the `gm-notepad` type the following:
+`{first-name[1d4]}`. The system will output "Frodo", "Merry", "Pippin", or "Sam".
+You won't get a "SamWise" or "FrodoWise" (or "FrodoWiseWise").
+
 To wrap up our first session, let's try one more thing. In your `gm-notepad`
 session type the following: `{first-name} owes [2d6]gp to {first-name}`:
 
@@ -213,7 +217,7 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [X] Skip table lines that begin with `#`
 - [X] Skip processing input lines that begin with `#`
 - [X] Allow configuration to specify table delimiter
-- [ ] Add option to dump all tables to the given directory
+- [ ] Raise load error if table index is a "dice" expression
 - [X] Allow configuration for where to dump data
 - [ ] Normalize `WriteToTableHandler` to use a renderer
 - [ ] Normalize `WriteToTableHandler` to deliver on `grep` and `index` behavior
@@ -221,7 +225,6 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [X] Gracefully handle `+name[]`, where "name" is a registered table
 - [ ] Add time to live for line expansion (to prevent infinite loops); I suspect 100 to be reasonable
 - [X] Enable "up" and "down" to scroll through history
-- [ ] Add config that expands dice results while including the requested roll
 - [X] Add index name when rendering table entries
 - [ ] Gracefully handle loading a malformed data file (maybe?)
 - [X] Add concept of history
@@ -229,7 +232,8 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [ ] Separate the InputHandler into pre-amble (e.g. allow overrides to where we are writing, determine what command we are writing)
 - [X] Create a configuration object that captures the initial input (reduce passing around parameters and persisting copies of the config)
 - [ ] Add concept of "journal entry"; its not a table (perhaps) but something that you could capture notes.
-- [ ] Add column handling `{table[][]}`
+- [X] Add column handling `{table[][]}`
+- [ ] Gracefully handle cell lookup when named cell for entry is not found
 - [X] Support `\{\{table}-name}` You should be able to do `\{\{culture}-name}` and first evaluate to `{arabic-name}` and then get a value from the `arabic-name` table
 - [X] Ensure index names are lower-case
 - [ ] Hit 100% spec coverage
@@ -245,3 +249,5 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [ ] Add auto index expansion for "["
 - [ ] Determine feasibility of adding dice to the `{}` expansion syntax (instead of the `[]` syntax)
 - [ ] Add force write results to `output`
+- [ ] Add option to dump all tables to the given directory
+- [ ] Add config that expands dice results while including the requested roll

data/examples/basic_example_file

@@ -1,14 +1,32 @@
 # Write entry `1|entry one` to in memory table `basic_example`
-<#basic_example:1|entry one
+<basic_example:1|entry one
+
 # Should render to interactive the internal help
 ?
+
+# Should roll the dice
+[2d6] goblins attack
+
 # Should render to interactive the given tables
 +
+
 # Should render to interactive the table `basic_example`
 +basic_example
+
 # Should render `entry one`
 {basic_example}
+
 # Should append entry `2|entry two` into memory table `basic_example`
 <basic_example:2|entry two
-# Should dump basic_example onto the file system
-+basic_example>
+
+# Should show that there are two entries in `basic example`
++basic_example
+
+# Should lookup entry 1 and 2
+{basic_example[1]} and {basic_example[2]}
+
+# Should lookup entry 1 and 2
+{basic_example[1d1]}
+
+# Should lookup entry 1 and 2
+{2d6} {basic_example[1d1]}

data/exe/gm-notepad

@@ -80,7 +80,7 @@ end
 begin
   @notepad = Gm::Notepad.new(**config)
   if config.fetch(:skip_readlines)
-    input_getter = -> { print "#{config.fetch(:shell_prompt)}  "; ARGF.gets }
+    input_getter = ARGF.method(:gets)
   else
     require 'gm/notepad/readline'
     input_getter = Gm::Notepad::Readline.input_getter(**config)

data/lib/gm/notepad/configuration.rb

@@ -14,11 +14,10 @@ module Gm
         output_buffer: $stdout,
         paths: ['.'],
         column_delimiter: Gm::Notepad::DEFAULT_COLUMN_DELIMITER,
-        shell_prompt: Gm::Notepad::DEFAULT_SHELL_PROMPT,
         skip_readlines: false,
         table_extension: '.txt',
         with_timestamp: false
-      }.freeze
+      }
 
       # NOTE: ORDER MATTERS! I have a temporal dependency in these
       # defaults

data/lib/gm/notepad/evaluators/dice_evaluator.rb

@@ -0,0 +1,16 @@
+require 'dice'
+module Gm
+  module Notepad
+    module Evaluators
+      module DiceEvaluator
+        def self.call(text:, fallback: text)
+          if parsed_text = Dice.parse(text)
+            parsed_text.evaluate.to_s
+          else
+            fallback.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gm/notepad/exceptions.rb

@@ -9,13 +9,16 @@ module Gm
     end
     class MissingTableError < RuntimeError
       def initialize(name:)
+        @name = name
         super(%(Missing table "#{name}"))
       end
+      alias to_buffer_message to_s
     end
     class MissingTableEntryError < RuntimeError
       def initialize(table_name:, index:)
         super(%(Missing index "#{index}" for table "#{table_name}"))
       end
+      alias to_buffer_message to_s
     end
   end
 end

data/lib/gm/notepad/line_evaluator.rb

@@ -1,5 +1,6 @@
 require 'dice'
 require 'gm/notepad/parameters/table_lookup'
+require 'gm/notepad/evaluators/dice_evaluator'
 module Gm
   module Notepad
     # Responsible for recording entries and then dumping them accordingly.
@@ -20,15 +21,8 @@ module Gm
 
       def parse_table(text:)
         while match = text.match(TABLE_NAME_REGEXP)
-          table_lookup = Parameters::TableLookup.new(text: match[:table_name].strip)
-          if table_lookup.index
-            if index = Dice.parse(table_lookup.index)
-              table_lookup.index = index.evaluate
-            end
-            entry = table_registry.lookup(index: table_lookup.index, table_name: table_lookup.table_name)
-          else
-            entry = table_registry.lookup(table_name: table_lookup.table_name)
-          end
+          table_lookup = Parameters::TableLookup.new(text: match[:table_name].strip, roll_dice: true)
+          entry = table_registry.lookup(**table_lookup.parameters)
           text = text.sub(match[:table_name_container], entry)
         end
         text
@@ -36,11 +30,7 @@ module Gm
       DICE_REGEXP = %r{(?<dice_container>\[(?<dice>[^\]]+)\])}
       def parse_dice(text:)
         while match = text.match(DICE_REGEXP)
-          if parsed_dice = Dice.parse(match[:dice])
-            evaluated_dice = "#{parsed_dice.evaluate}"
-          else
-            evaluated_dice = "(#{match[:dice]})"
-          end
+          evaluated_dice = Evaluators::DiceEvaluator.call(text: match[:dice], fallback: "(#{match[:dice]})")
           text = text.sub(match[:dice_container], evaluated_dice)
         end
         text

data/lib/gm/notepad/pad.rb

@@ -20,6 +20,7 @@ module Gm
       private
 
       def open!
+        renderer.call("Welcome to gm-notepad. type \"?\" for help.", to_interactive: true, to_output: false)
         return unless config.report_config
         lines = ["# Configuration Parameters:"]
         config.each_pair do |key, value|

data/lib/gm/notepad/parameters/table_lookup.rb

@@ -1,43 +1,73 @@
+require 'gm/notepad/evaluators/dice_evaluator'
 module Gm
   module Notepad
     module Parameters
       # Responsible for teasing apart the table logic
       class TableLookup
-        WITH_GREP_REGEXP = %r{(?<declaration>\/(?<grep>[^\/]+)/)}
-        WITH_INDEX_REGEXP = %r{(?<declaration>\[(?<index>[^\]]+)\])}
-        WITH_EMPTY_INDEX_REGEX = %r{(?<declaration>\[\])}
-        WITH_EMPTY_GREP_REGEX = %r{(?<declaration>\/\/)}
-
-        def initialize(text:)
+        def initialize(text:, roll_dice: false)
           @text = text
+          @role_dice = false
+          @parameters = {}
           extract_parameters!
+          roll_them_bones! if roll_dice
         end
 
-        attr_accessor :index, :grep, :table_name
+        attr_reader :cell, :index, :grep, :table_name
 
         def parameters
           parameters = { table_name: table_name }
           parameters[:grep] = grep if grep
           parameters[:index] = index if index
+          parameters[:cell] = cell if cell
           parameters
         end
 
         private
+
+        attr_writer :cell, :index, :grep, :table_name
+
+        def roll_them_bones!
+          if index
+            self.index = Evaluators::DiceEvaluator.call(text: index)
+          end
+          if cell
+            self.cell = Evaluators::DiceEvaluator.call(text: cell)
+          end
+        end
+
+        WITH_GREP_REGEXP = %r{(?<declaration>\/(?<found>[^\/]+)/)}
+        WITH_INDEX_REGEXP = %r{(?<declaration>\[(?<found>[^\]]+)\])}
+        CELL_WITHOUT_INDEX_REGEXP = %r{(?<declaration>\[\]\[(?<found>[^\]]+)\])}
+        EMPTY_INDEX_EMPTY_CELL_REGEXP = %r{(?<declaration>\[\]\[\])}
+        WITH_EMPTY_INDEX_REGEX = %r{(?<declaration>\[\])}
+        WITH_EMPTY_GREP_REGEX = %r{(?<declaration>\/\/)}
+
         def extract_parameters!
-          @parameters = {}
           text = @text
-          if match = WITH_EMPTY_INDEX_REGEX.match(text)
+          if match = EMPTY_INDEX_EMPTY_CELL_REGEXP.match(text)
+            text = text.sub(match[:declaration], '')
+          elsif match = CELL_WITHOUT_INDEX_REGEXP.match(text)
+            text = text.sub(match[:declaration], '')
+            self.cell = match[:found]
+          elsif match = WITH_EMPTY_INDEX_REGEX.match(text)
             text = text.sub(match[:declaration], '')
           elsif match = WITH_INDEX_REGEXP.match(text)
             text = text.sub(match[:declaration], '')
-            @index = match[:index]
+            self.index = match[:found]
+            # Moving on to the cell
+            if match = WITH_EMPTY_INDEX_REGEX.match(text)
+              text = text.sub(match[:declaration], '')
+            elsif match = WITH_INDEX_REGEXP.match(text)
+              text = text.sub(match[:declaration], '')
+              self.cell = match[:found]
+            end
           elsif match = WITH_EMPTY_GREP_REGEX.match(text)
             text = text.sub(match[:declaration], '')
           elsif match = WITH_GREP_REGEXP.match(text)
             text = text.sub(match[:declaration], '')
-            @grep  =  match[:grep]
+            self.grep  =  match[:found]
           end
-          @table_name = text.downcase
+          self.table_name = text.downcase
         end
       end
     end

data/lib/gm/notepad/readline.rb

@@ -29,7 +29,7 @@ module Gm
       ::Readline.output = $stderr
 
       def self.input_getter(**config)
-        -> { ::Readline.readline("#{config.fetch(:shell_prompt, ">")}  ", true) }
+        -> { ::Readline.readline("", true) }
       end
     end
   end

data/lib/gm/notepad/table.rb

@@ -8,15 +8,15 @@ module Gm
         process(lines: lines)
       end
 
-      def lookup(index: false)
-        if index
-          begin
-            @table.fetch(index.to_s)
-          rescue KeyError
-            raise MissingTableEntryError.new(table_name: table_name, index: index.to_s)
-          end
+      def lookup(index: false, cell: false)
+        if index && cell
+          lookup_entry_by(index: index).lookup(cell: cell)
+        elsif index
+          lookup_entry_by(index: index)
+        elsif cell
+          lookup_random_entry.lookup(cell: cell)
         else
-          @table.values[random_index]
+          lookup_random_entry
         end
       end
 
@@ -45,6 +45,18 @@ module Gm
 
       private
 
+      def lookup_entry_by(index:)
+        begin
+          @table.fetch(index.to_s)
+        rescue KeyError
+          raise MissingTableEntryError.new(table_name: table_name, index: index.to_s)
+        end
+      end
+
+      def lookup_random_entry
+        @table.values[random_index]
+      end
+
       attr_accessor :filename, :config
       attr_reader :table_name
 
@@ -60,7 +72,7 @@ module Gm
         @table = {}
         lines.each do |line|
           next if line[0] == '#'
-          entry = TableEntry.new(line: line, **config)
+          entry = TableEntry.new(line: line, config: config)
           entry.lookup_range.each do |i|
             key = i.to_s
             raise DuplicateKeyError.new(key: table_name, object: self) if @table.key?(key)

data/lib/gm/notepad/table_entry.rb

@@ -4,7 +4,9 @@ module Gm
     TABLE_ENTRY_RANGE_MARKER = "-".freeze
     class TableEntry
       Configuration.init!(target: self, from_config: [:column_delimiter], additional_params: [:line]) do
-        self.lookup_column, self.entry_column = line.split(column_delimiter)
+        row = line.split(column_delimiter)
+        self.index = row.shift
+        self.cells = row
       end
 
       include Comparable
@@ -12,30 +14,40 @@ module Gm
         to_str <=> String(other)
       end
 
+      def lookup(cell:)
+        # TODO: Need to deal with named columns
+        cells[cell.to_i]
+      end
+
       NUMBER_RANGE_REGEXP = %r{(?<left>\d+) *- *(?<right>\d+)}
       def lookup_range
-        if match = NUMBER_RANGE_REGEXP.match(lookup_column)
+        if match = NUMBER_RANGE_REGEXP.match(index)
           (match[:left].to_i..match[:right].to_i).map(&:to_s)
         else
-          [lookup_column]
+          [index]
         end
       end
 
-      attr_reader :lookup_column, :entry_column
+      attr_reader :index, :cells
+
+      def entry
+        cells.join("\t")
+      end
+      alias entry_column entry
 
       def to_s
-        "[#{lookup_column}]\t#{entry_column}"
+        "[#{index}]\t#{entry}"
       end
-      alias to_str entry_column
+      alias to_str entry
 
       private
 
-      def lookup_column=(input)
-        @lookup_column = input.strip.downcase.freeze
+      def index=(input)
+        @index = input.strip.downcase.freeze
       end
 
-      def entry_column=(input)
-        @entry_column = input.strip.freeze
+      def cells=(input)
+        @cells = Array(input).map { |i| i.strip.freeze }.freeze
       end
     end
   end

data/lib/gm/notepad/table_registry.rb

@@ -59,15 +59,10 @@ module Gm
       end
 
       def lookup(table_name:, **kwargs)
-        # TODO: Push this onto the table, as it removes nosy neighbor syndrom
-        begin
-          table = fetch_table(name: table_name)
-          table.lookup(**kwargs)
-        rescue MissingTableError
-          "(undefined table_name: #{table_name.inspect})"
-        rescue KeyError
-          "(missing entry for #{kwargs.inspect})"
-        end
+        table = fetch_table(name: table_name)
+        table.lookup(**kwargs)
+      rescue MissingTableError, MissingTableEntryError => e
+        e.to_buffer_message
       end
 
       def evaluate(line:)

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.6"
+    VERSION = "0.0.8"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gm-notepad
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-27 00:00:00.000000000 Z
+date: 2019-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dice_parser
@@ -146,6 +146,7 @@ files:
 - lib/gm/notepad.rb
 - lib/gm/notepad/configuration.rb
 - lib/gm/notepad/defaults.rb
+- lib/gm/notepad/evaluators/dice_evaluator.rb
 - lib/gm/notepad/exceptions.rb
 - lib/gm/notepad/input_handler_registry.rb
 - lib/gm/notepad/input_handlers/comment_handler.rb