gm-notepad 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72cbb20c02dd2fa334bf57d7d88c40e7772d05ccf03bee599ddbf651e416c645
-  data.tar.gz: 1e474a0b888297ae5655e68710f5d40efcfbb59030aac36dab60e4fc765043de
+  metadata.gz: 639ecbd6c3ab1d9ca709d743c23b88fbfc2deab18a25254bf3c27c71d1c4328e
+  data.tar.gz: e0adf1f064950a784c0a84349c92a7e10240990967a2c042166e2845e246d869
 SHA512:
-  metadata.gz: 49a06ad0a6f85eddaefa70f9f05dd358f39f163cc3c7555f0116d2c645436260910ef8f4ec4b955e26bbf8d332a0957a6dfa401c39b3a7664a44c6f787f6be60
-  data.tar.gz: a0f8bd008eb2220a4f8c68726aa96fcd68b110f50725b01091dc7ef5c57096e41d908674d4fa1bd46c0a552f61f01e68dddac3c508a499674d305361845363b4
+  metadata.gz: 45e58dd1073d6a3b269b7ee87ef30643833ba0f71737265a4197802577b9254bc97c2a91042ef566ee440c39ac4dc0f24782cedd61d1d54a7e8712d3c76e4b4c
+  data.tar.gz: b06fd07045eb893e31c832117fa849cadeccd0447a0386c5ee09a46e9eae6bdbe87decadc72f4c9264b0a182eb4784d3e0f2358c241f1430146b4f69798b0ccb

data/README.md

@@ -184,7 +184,7 @@ You can also roll within a table. In the `gm-notepad` type the following:
 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}`:
+session type the following: `{first-name} owes {2d6}gp to {first-name}`:
 
 ```console
 Frodo owes 3gp to SamWise
@@ -213,6 +213,7 @@ columns. _I am still working on retrieving by column names as well as rendering
 - [ ] Write expected interface document
 - [X] Handle `{critical[5]}`
 - [X] Allow `{critical[{2d6+1}]}` to roll the dice then lookup the value in the critical table
+- [X] Handle `{critical[{2d6}]} for {2d6} damage`
 - [ ] 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 `#`
@@ -223,7 +224,7 @@ columns. _I am still working on retrieving by column names as well as rendering
 - [ ] Normalize `WriteToTableHandler` to deliver on `grep` and `index` behavior
 - [X] Gracefully handle requesting an entry from a table with an index that does not exist (e.g. with test data try `+name[23]`)
 - [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] 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
 - [X] Add index name when rendering table entries
 - [ ] Gracefully handle loading a malformed data file (maybe?)

data/exe/gm-notepad

@@ -39,6 +39,10 @@ OptionParser.new do |options|
     config[:table_extension] = table_extension
   end
 
+  options.on("-lTTL", "--time_to_live=TTL", Integer, "Per line of input, how many times to allow text expansion (Default: #{defaults.time_to_live.inspect})") do |time_to_live|
+    config[:time_to_live] = time_to_live
+  end
+
   options.on("-dDELIM", "--delimiter=DELIM", String, "Default column delimiter for tables (Default: #{defaults.column_delimiter.inspect})") do |column_delimiter|
     map = { "t" => "\t" }
     config[:column_delimiter] = map.fetch(column_delimiter) { column_delimiter }

data/lib/gm/notepad/app.rb

@@ -1,21 +1,25 @@
 require 'dry-initializer'
 require 'gm/notepad/container'
+require 'gm/notepad/line_renderer'
 require 'gm/notepad/throughput_text'
+require 'gm/notepad/input_processor'
 
 module Gm
   module Notepad
     # Responsible for recording entries and then dumping them accordingly.
     class App
       extend Dry::Initializer
-      option :renderer, default: -> { Container.resolve(:renderer) }
-      option :input_processor, default: -> { Container.resolve(:input_processor) }
+      option :table_registry, default: -> { Container.resolve(:table_registry) }, reader: :private
       option :report_config, default: -> { Container.resolve(:config).report_config }, reader: :private
       option :list_tables, default: -> { Container.resolve(:config).list_tables }, reader: :private
 
-      def initialize(*args)
+      def initialize(*args, input_processor: nil, renderer: nil)
         super
+        @renderer = renderer || LineRenderer.new(table_registry: table_registry)
+        @input_processor = input_processor || InputProcessor.new(table_registry: table_registry)
         open!
       end
+      attr_reader :renderer, :input_processor
 
       def process(text:)
         output = input_processor.convert_to_output(input: text)

data/lib/gm/notepad/config.rb

@@ -4,19 +4,20 @@ module Gm
     class Config
       extend Dry::Configurable
 
-      setting :report_config, false, reader: true
+      setting :column_delimiter, "|", reader: true
       setting :filesystem_directory, '.', reader: true
+      setting :include_original_command_as_comment, true, reader: true
       setting :index_entry_prefix, "index", reader: true
       setting :interactive_buffer, $stderr, reader: true
       setting :interactive_color, :faint, reader: true
-      setting :output_color, false, reader: true
       setting :list_tables, false, reader: true
       setting :output_buffer, $stdout, reader: true
+      setting :output_color, false, reader: true
       setting :paths, ['.'], reader: true
-      setting :column_delimiter, "|", reader: true
+      setting :report_config, false, reader: true
       setting :skip_readlines, false, reader: true
-      setting :include_original_command_as_comment, true, reader: true
       setting :table_extension, '.txt', reader: true
+      setting :time_to_live, 20, reader: true
       setting :with_timestamp, false, reader: true
 
       def self.index_entry_prefix_regexp

data/lib/gm/notepad/container.rb

@@ -6,11 +6,6 @@ module Gm
     class Container
       extend Dry::Container::Mixin
 
-      register "input_processor" do
-        require 'gm/notepad/input_processor'
-        InputProcessor.new
-      end
-
       register "config" do
         require 'gm/notepad/config'
         Config
@@ -21,11 +16,6 @@ module Gm
         TableRegistry.build_and_load
       end
 
-      register "renderer" do
-        require 'gm/notepad/line_renderer'
-        LineRenderer.new
-      end
-
       register "input_handler_registry" do
         # Order matters. The first registered will be the first to
         # answer "Can you handle the input?"

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

@@ -4,7 +4,7 @@ module Gm
     module Evaluators
       module DiceEvaluator
         def self.call(text:, fallback: text)
-          if parsed_text = Dice.parse(text)
+          if parsed_text = Dice.parse(text.strip)
             parsed_text.evaluate.to_s
           else
             fallback.to_s

data/lib/gm/notepad/exceptions.rb

@@ -20,5 +20,14 @@ module Gm
       end
       alias to_buffer_message to_s
     end
+
+    class ExceededTimeToLiveError < RuntimeError
+      attr_reader :text_when_time_to_live_exceeded
+      def initialize(text:, time_to_live:, text_when_time_to_live_exceeded:)
+        @text_when_time_to_live_exceeded = text_when_time_to_live_exceeded
+        super(%(Expanding the given text "#{text}" exceed the time to live of #{time_to_live}))
+      end
+      alias to_buffer_message to_s
+    end
   end
 end

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

@@ -35,18 +35,7 @@ module Gm
           else
             expand_line = true
           end
-          input.render_current_text(to_interactive: true  , to_output: false, to_filesystem: true, expand_line: expand_line)
-        end
-
-        def lines
-          if index
-          elsif grep
-          end
-          if expand_line
-          else
-          end
-          table_registry.append(table_name: table_name, line: input.text_to_evaluate, write: true)
-          []
+          input.for_rendering(table_name: table_name, text: input.text_to_evaluate, to_interactive: true  , to_output: false, to_filesystem: true, expand_line: expand_line)
         end
       end
     end

data/lib/gm/notepad/line_evaluator.rb

@@ -10,30 +10,35 @@ module Gm
     class LineEvaluator
       extend Dry::Initializer
       option :table_registry, default: -> { Container.resolve(:table_registry) }, reader: :private
+      option :time_to_live, default: -> { Container.resolve(:config).time_to_live }, reader: :private
 
-      TABLE_NAME_REGEXP = %r{(?<table_name_container>\{(?<table_name>[^\{\}]+)\})}
       def call(line:, expand_line: true)
         input = ThroughputText.new(original_text: line, table_registry: table_registry)
         return input unless expand_line
-        parse_table(input: input)
-        parse_dice(input: input)
+        parse(input: input)
         input
       end
 
       private
 
-      def parse_table(input:)
-        while match = input.match(TABLE_NAME_REGEXP)
-          table_lookup = Parameters::TableLookup.new(text: match[:table_name].strip, roll_dice: true)
-          entry = table_registry.lookup(**table_lookup.parameters)
-          input.sub!(match[:table_name_container], entry)
-        end
-      end
-      DICE_REGEXP = %r{(?<dice_container>\[(?<dice>[^\]]+)\])}
-      def parse_dice(input:)
-        while match = input.match(DICE_REGEXP)
-          evaluated_dice = Evaluators::DiceEvaluator.call(text: match[:dice], fallback: "(#{match[:dice]})")
-          input.sub!(match[:dice_container], evaluated_dice)
+      TEXT_TO_EXPAND_REGEXP = %r{(?<text_container>\{(?<text>[^\{\}]+)\})}
+      def parse(input:)
+        lives = 0
+        while match = input.match(TEXT_TO_EXPAND_REGEXP)
+          lives += 1
+          if lives > time_to_live
+            raise ExceededTimeToLiveError.new(text: input.original_text, time_to_live: time_to_live, text_when_time_to_live_exceeded: input.to_s)
+          end
+          rolled_text = Evaluators::DiceEvaluator.call(text: match[:text])
+          # We sent the text through a dice roller. It came back unchanged, therefore
+          # the text is not a dice expression. Now expand the table.
+          if rolled_text == match[:text]
+            table_lookup = Parameters::TableLookup.new(text: match[:text], roll_dice: true)
+            entry = table_registry.lookup(**table_lookup.parameters)
+            input.sub!(match[:text_container], entry)
+          else
+            input.sub!(match[:text_container], rolled_text)
+          end
         end
       end
     end

data/lib/gm/notepad/line_renderer.rb

@@ -11,6 +11,7 @@ module Gm
       option :with_timestamp, default: -> { Container[:config].with_timestamp }
       option :interactive_buffer, type: -> (buffer, renderer) { BufferWrapper.for_interactive(buffer: buffer) }, default: -> { Container[:config].interactive_buffer }
       option :output_buffer, type: -> (buffer, renderer) { BufferWrapper.for_output(buffer: buffer) }, default: -> { Container[:config].output_buffer }
+      option :table_registry, default: -> { Container.resolve(:table_registry) }
 
       def render(output:, as_of: Time.now)
         output.evaluate!
@@ -22,6 +23,10 @@ module Gm
           next unless line.to_output
           render_output(line, as_of: as_of)
         end
+        output.lines_for_rendering.each do |line|
+          next unless line.to_filesystem
+          render_filesystem(line)
+        end
       end
 
       def call(lines, to_output: false, to_interactive: true, as_of: Time.now)
@@ -51,6 +56,14 @@ module Gm
         end
       end
 
+      def render_filesystem(lines)
+        return unless lines.table_name
+        table_name = lines.table_name
+        each_expanded_line(lines: lines) do |line|
+          table_registry.append(table_name: table_name, line: line, write: true)
+        end
+      end
+
       # Gracefully expand the \t and \n for the output buffer
       def each_expanded_line(lines:)
         Array(lines).each do |unexpanded_line|

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

@@ -5,7 +5,7 @@ module Gm
       # Responsible for teasing apart the table logic
       class TableLookup
         def initialize(text:, roll_dice: false)
-          @text = text
+          @text = text.strip
           @role_dice = false
           @parameters = {}
           extract_parameters!

data/lib/gm/notepad/table.rb

@@ -15,6 +15,7 @@ module Gm
 
       def initialize(*args)
         super
+        @table = {}
         set_null_table_column_set!
         process(lines: lines)
       end
@@ -89,7 +90,6 @@ module Gm
 
       STARTS_WITH_COMMENT_REGEXP = %r{\A#}
       def process(lines:)
-        @table = {}
         lines.each do |line|
           line = line.strip
           # Handle Comment

data/lib/gm/notepad/table_registry.rb

@@ -24,8 +24,6 @@ module Gm
         instance_exec(&block) if block_given?
       end
 
-      attr_reader :line_evaluator, :registry
-
       def table_names
         registry.keys.sort
       end

data/lib/gm/notepad/throughput_text.rb

@@ -65,6 +65,7 @@ module Gm
       option :to_interactive
       option :to_output
       option :to_filesystem, default: -> { false }
+      option :table_name, default: -> { nil }
       option :expand_line, default: -> { true }
       option :table_registry, default: -> { Container.resolve(:table_registry) }, reader: :private
 

data/lib/gm/notepad/version.rb

@@ -1,5 +1,5 @@
 module Gm
   module Notepad
-    VERSION = "0.0.11"
+    VERSION = "0.0.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gm-notepad
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dice_parser