gm-notepad 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf576a76ad9f5f2c4676b9a14d9f3557eeddddf74e2050ebc17a97e3d9f65f65
-  data.tar.gz: 81b1342b09f2321b1efa7dbd3b53acedc21303d27ce8bdb2b3e56888805b896c
+  metadata.gz: 6fad1534243d237bace667966a495af3e787a0bc67ef40283e96a2d7ca49942f
+  data.tar.gz: b37925618ac94a01fdceadba354c641f704756ce55788c839a518e4e3a474b24
 SHA512:
-  metadata.gz: 78d7865d2e222c20e8acb490637b0442426bad4fb9d739cfb32bbb1f4c283ac92ca5037e96ec80b58bb8bdab55ad48b7dd3d699ac5b28f1817bdc86e4b6cb696
-  data.tar.gz: 00262af2d6920303a49c22946cf7224f8e09e6b0bfe8da2275ae283ce097079256e61574e3bb00f19c17dd48fe0d13aa4a4fd06d85ad0028806cf3661924edd2
+  metadata.gz: 80173f33eff4c3f0aa01f4ec706f2759d8f91b698b0c45872c299b94e0ac327f5deb1d9b2bf85fa468eaf28b9744f08aa7af67ccb20dd201fe8ce7159ba15e11
+  data.tar.gz: 49ef7f14a885164ff70dc9e46bb2d05867fe53a9345cb5223efd2624fad4cad54e3f27d85f4aca4df0233cf973899f73786f1d824f958d9f09a8ceda837e7f3b

data/README.md

@@ -207,7 +207,9 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [X] Colorize puts to `interactive` buffer
 - [X] Disable colors as a configuration option
 - [ ] Write expected interface document
-- [ ] Allow `{critical[2d6+1]}` to roll the dice then lookup the value in the critical table
+- [X] Handle `{critical[5]}`
+- [X] Allow `{critical[{2d6+1}]}` to roll the dice then lookup the value in the critical table
+- [ ] For `{critical[{2d6+1}]}`, how to handle out of bounds
 - [X] Skip table lines that begin with `#`
 - [X] Skip processing input lines that begin with `#`
 - [X] Allow configuration to specify table delimiter
@@ -222,7 +224,6 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [ ] 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?)
-- [ ] Add force write results to `output`
 - [X] Add concept of history
 - [ ] When expanding tables account for line expansion (via \n and \t)
 - [ ] Separate the InputHandler into pre-amble (e.g. allow overrides to where we are writing, determine what command we are writing)
@@ -243,3 +244,4 @@ entry has a 1 in 3 chance of being randomly chosen.
 - [ ] Add auto table expansion for "+"
 - [ ] Add auto index expansion for "["
 - [ ] Determine feasibility of adding dice to the `{}` expansion syntax (instead of the `[]` syntax)
+- [ ] Add force write results to `output`

data/lib/gm/notepad/exceptions.rb

@@ -1,9 +1,21 @@
 module Gm
   module Notepad
+    class RuntimeError < ::RuntimeError
+    end
     class DuplicateKeyError < RuntimeError
       def initialize(key:, object:)
         super("Duplicate key for #{key.inspect} in #{object}")
       end
     end
+    class MissingTableError < RuntimeError
+      def initialize(name:)
+        super(%(Missing table "#{name}"))
+      end
+    end
+    class MissingTableEntryError < RuntimeError
+      def initialize(table_name:, index:)
+        super(%(Missing index "#{index}" for table "#{table_name}"))
+      end
+    end
   end
 end

data/lib/gm/notepad/input_handlers/query_table_handler.rb

@@ -1,4 +1,7 @@
+require 'forwardable'
+require 'gm/notepad/exceptions'
 require "gm/notepad/input_handlers/default_handler"
+require "gm/notepad/parameters/table_lookup"
 module Gm
   module Notepad
     module InputHandlers
@@ -14,11 +17,6 @@ module Gm
           true
         end
 
-        WITH_GREP_REGEXP = %r{(?<declaration>\/(?<grep>[^\/]+)/)}
-        WITH_INDEX_REGEXP = %r{(?<declaration>\[(?<index>[^\]]+)\])}
-        WITH_EMPTY_INDEX_REGEX = %r{(?<declaration>\[\])}
-        WITH_EMPTY_GREP_REGEX = %r{(?<declaration>\/\/)}
-        NON_EXPANDING_CHARATER = '!'.freeze
         def after_initialize!
           self.expand_line = false
           self.to_output = false
@@ -26,30 +24,16 @@ module Gm
 
           line = input[1..-1].to_s
           self.expand_line = false
-          if match = WITH_EMPTY_INDEX_REGEX.match(line)
-            line = line.sub(match[:declaration], '')
-          elsif match = WITH_INDEX_REGEXP.match(line)
-            line = line.sub(match[:declaration], '')
-            self.index = match[:index]
-          elsif match = WITH_EMPTY_GREP_REGEX.match(line)
-            line = line.sub(match[:declaration], '')
-          elsif match = WITH_GREP_REGEXP.match(line)
-            line = line.sub(match[:declaration], '')
-            grep = match[:grep]
-            self.grep = grep
-          end
-          if line[-1] == NON_EXPANDING_CHARATER
-            line = line[0..-2]
-          end
-          self.table_name = line.downcase
+          @table_lookup_parameters = Parameters::TableLookup.new(text: line)
         end
 
-        attr_accessor :index, :grep, :table_name
+        extend Forwardable
+        def_delegators :@table_lookup_parameters, :index, :grep, :table_name
 
         def lines
           begin
             table = table_registry.fetch_table(name: table_name)
-          rescue KeyError
+          rescue MissingTableError
             message = "Unknown table #{table_name.inspect}. Did you mean: "
             message += table_registry.table_names.grep(/\A#{table_name}/).map(&:inspect).join(", ")
             return [message]
@@ -57,7 +41,7 @@ module Gm
           if index
             begin
               [table.lookup(index: index)]
-            rescue KeyError
+            rescue MissingTableEntryError
               [%(Entry with index "#{index}" not found in "#{table_name}" table)]
             end
           elsif grep

data/lib/gm/notepad/line_evaluator.rb

@@ -1,27 +1,49 @@
 require 'dice'
+require 'gm/notepad/parameters/table_lookup'
 module Gm
   module Notepad
     # Responsible for recording entries and then dumping them accordingly.
     class LineEvaluator
+      def initialize(table_registry:)
+        @table_registry = table_registry
+      end
+      attr_reader :table_registry
+
       TABLE_NAME_REGEXP = %r{(?<table_name_container>\{(?<table_name>[^\{\}]+)\})}
-      DICE_REGEXP = %r{(?<dice_container>\[(?<dice>[^\]]+)\])}
-      def call(line:, table_lookup_function:, expand_line: true)
+      def call(line:, expand_line: true)
         return line unless expand_line
-        match = line.match(TABLE_NAME_REGEXP)
-        while match
-          evaluated_table_name = table_lookup_function.call(table_name: match[:table_name].strip)
-          line = line.sub(match[:table_name_container], evaluated_table_name)
-          match = line.match(TABLE_NAME_REGEXP)
+        text = parse_table(text: line)
+        parse_dice(text: text)
+      end
+
+      private
+
+      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
+          text = text.sub(match[:table_name_container], entry)
         end
-        while match = line.match(DICE_REGEXP)
+        text
+      end
+      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
-          line = line.sub(match[:dice_container], evaluated_dice)
+          text = text.sub(match[:dice_container], evaluated_dice)
         end
-        line
+        text
       end
     end
   end

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

@@ -0,0 +1,45 @@
+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:)
+          @text = text
+          extract_parameters!
+        end
+
+        attr_accessor :index, :grep, :table_name
+
+        def parameters
+          parameters = { table_name: table_name }
+          parameters[:grep] = grep if grep
+          parameters[:index] = index if index
+          parameters
+        end
+
+        private
+        def extract_parameters!
+          @parameters = {}
+          text = @text
+          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], '')
+            @index = match[:index]
+          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]
+          end
+          @table_name = text.downcase
+        end
+      end
+    end
+  end
+end

data/lib/gm/notepad/table.rb

@@ -10,7 +10,11 @@ module Gm
 
       def lookup(index: false)
         if index
-          @table.fetch(index)
+          begin
+            @table.fetch(index.to_s)
+          rescue KeyError
+            raise MissingTableEntryError.new(table_name: table_name, index: index.to_s)
+          end
         else
           @table.values[random_index]
         end

data/lib/gm/notepad/table_registry.rb

@@ -14,7 +14,7 @@ module Gm
 
       Configuration.init!(target: self, from_config: [:paths, :table_extension, :filesystem_directory]) do
         @registry = {}
-        @line_evaluator = LineEvaluator.new
+        @line_evaluator = LineEvaluator.new(table_registry: self)
       end
 
       def load!
@@ -34,13 +34,15 @@ module Gm
 
       def fetch_table(name:)
         registry.fetch(name.downcase)
+      rescue KeyError
+        raise MissingTableError.new(name: name.downcase)
       end
 
       def append(table_name:, line:, write:)
         table = nil
         begin
           table = fetch_table(name: table_name)
-        rescue KeyError
+        rescue MissingTableError
           filename = File.join(filesystem_directory, "#{table_name}#{table_extension}")
           table = register(table_name: table_name, lines: [], filename: filename)
         end
@@ -57,14 +59,19 @@ module Gm
       end
 
       def lookup(table_name:, **kwargs)
-        table = fetch_table(name: table_name)
-        table.lookup(**kwargs)
-      rescue KeyError
-        "(undefined #{table_name})"
+        # 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
       end
 
       def evaluate(line:)
-        line_evaluator.call(line: line, table_lookup_function: method(:lookup))
+        line_evaluator.call(line: line)
       end
 
       private

data/lib/gm/notepad/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gm-notepad
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -159,6 +159,7 @@ files:
 - lib/gm/notepad/line_evaluator.rb
 - lib/gm/notepad/line_renderer.rb
 - lib/gm/notepad/pad.rb
+- lib/gm/notepad/parameters/table_lookup.rb
 - lib/gm/notepad/readline.rb
 - lib/gm/notepad/table.rb
 - lib/gm/notepad/table_entry.rb